Share via


az arcappliance createconfig

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

Command group for creating configuration files for Arc resource bridge.

This command features two modes - interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. It is initiated by passing only the required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted.

Commands

Name Description Type Status
az arcappliance createconfig hci

Command to create configuration files for Arc Resource Bridge on HCI.

Extension GA
az arcappliance createconfig scvmm

Command to create Arc resource bridge configuration files for Arc-enabled SCVMM.

Extension GA
az arcappliance createconfig vmware

Command to create Arc resource bridge configuration files for Arc-enabled VMware.

Extension GA

az arcappliance createconfig hci

Command to create configuration files for Arc Resource Bridge on HCI.

This command features two modes - interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. It is initiated by passing only the required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted.

az arcappliance createconfig hci --location
                                 --name
                                 --resource-group
                                 [--authenticationport]
                                 [--certificateFilePath]
                                 [--cloudagent]
                                 [--controlPlaneEndpoint]
                                 [--dnsservers]
                                 [--gateway]
                                 [--http]
                                 [--https]
                                 [--ipaddressprefix]
                                 [--k8snodeippoolend]
                                 [--k8snodeippoolstart]
                                 [--loginconfigfile]
                                 [--noproxy]
                                 [--out-dir]
                                 [--overwrite-existing]
                                 [--port]
                                 [--storagecontainer]
                                 [--vlanid]
                                 [--vswitchname]
                                 [--working-dir]

Examples

Create Appliance HCI Configuration

az arcappliance createconfig 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 a valid location where the self-service VM feature for Azure Stack HCI is available and 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

--authenticationport

Network port used by appliance VM IP to communicate with the cloud agent service endpoint. This port should be open on the firewall to enable communication between the two if the Windows Server physical cluster nodes and Arc resource bridge VM are on separate VLANs.

--certificateFilePath

Certificate file path if your proxy server requires the proxy clients to trust a certificate. Only pass a single proxy certificate, not a bundle.

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

--controlPlaneEndpoint

Arc resource bridge on-premises appliance VM hosts a management kubernetes cluster with a control plane that requires a static IP address. This static IP address must lie within the subnet range specified in the IP address prefix.

--dnsservers

IP address(es) of DNS server(s) used by Arc resource bridge on-premises appliance VM for DNS resolution. Appliance VM must be able to resolve external sites and internal endpoints. Enter multiple IP addresses as a comma-separated list.

--gateway

Static gateway IP address, must lie within the subnet range specified in the IP address prefix.

--http

HTTP proxy URL and port information entered as http://:. Example: http://192.168.0.10:80.

--https

HTTPS URL and port information entered as http://:. Example: https://192.168.0.10:443.

--ipaddressprefix

Arc resource bridge requires 3 IP addresses for the on-premises appliance VM (appliance VM IP, upgrade VM IP, control plane IP). All IPs should reside within the same subnet and fall within the range specified in the IP address prefix. IP address prefix is entered as the subnet's IP address range for the virtual network and subnet mask (IP Mask) in CIDR notation (ex: 192.168.7.1/24). An IP Subnet CIDR calculator can be used for this. Example: For IPs within a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--k8snodeippoolend

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the end range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--k8snodeippoolstart

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the start range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--loginconfigfile

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

--noproxy

The list of comma-separated entries for excluded networks, hosts, or domains from being accessed through the proxy server.

--out-dir

Output directory for Arc resource bridge configuration files, defaults to ./ (current directory).

--overwrite-existing

Overwrite existing configuration files. Default: False.

Default value: False
--port

Port.

--storagecontainer

Azure Stack HCI storage container.

--vlanid

VLAN ID.

--vswitchname

Azure Stack HCI virtual network switch name.

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

Command to create Arc resource bridge configuration files for Arc-enabled SCVMM.

This command features two modes - interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. It is initiated by passing only the required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted.

az arcappliance createconfig scvmm --location
                                   --name
                                   --resource-group
                                   [--address]
                                   [--certificateFilePath]
                                   [--cloudid]
                                   [--controlPlaneEndpoint]
                                   [--dnsservers]
                                   [--gateway]
                                   [--highlyavailable]
                                   [--hostgroupid]
                                   [--http]
                                   [--https]
                                   [--ipaddressprefix]
                                   [--ippool]
                                   [--k8snodeippoolend]
                                   [--k8snodeippoolstart]
                                   [--libshare]
                                   [--macaddress]
                                   [--memorymib]
                                   [--network]
                                   [--noproxy]
                                   [--numcpus]
                                   [--out-dir]
                                   [--overwrite-existing]
                                   [--password]
                                   [--port]
                                   [--username]
                                   [--vlanid]
                                   [--working-dir]

Examples

Interactive mode to create Arc resource bridge configuration files for Arc-enabled SCVMM

az arcappliance createconfig scvmm --resource-group [REQUIRED] --name [REQUIRED] --location [REQUIRED] --out-dir [OPTIONAL]

Required Parameters

--location -l

The Azure location where the Arc resource bridgeAzure resource will be deployed. Must be a valid location where Arc-enabled SCVMM is available and 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.

--certificateFilePath

Certificate file path if your proxy server requires the proxy clients to trust a certificate (press enter to skip).

--cloudid

SCVMM cloud ID.

--controlPlaneEndpoint

Arc resource bridge on-premises appliance VM hosts a management kubernetes cluster with a control plane that requires a static IP address. This static IP address must lie within the subnet range specified in the IP address prefix.

--dnsservers

IP address(es) of DNS server(s) used by Arc resource bridge on-premises appliance VM for DNS resolution. Appliance VM must be able to resolve external sites and internal endpoints. Enter multiple IP addresses as a comma-separated list.

--gateway

Static gateway IP address, must lie within the subnet range specified in the IP address prefix.

--highlyavailable

Deploy resource bridge as Highly available.Highly available vm recommended for production environment.(Expected true/false).

--hostgroupid

SCVMM hostgroup ID.

--http

HTTP proxy URL and port information entered as http://:. Example: http://192.168.0.10:80.

--https

HTTPS URL and port information entered as http://:. Example: https://192.168.0.10:443.

--ipaddressprefix

Arc resource bridge requires 3 IP addresses for the on-premises appliance VM (appliance VM IP, upgrade VM IP, control plane IP). All IPs should reside within the same subnet and fall within the range specified in the IP address prefix. IP address prefix is entered as the subnet's IP address range for the virtual network and subnet mask (IP Mask) in CIDR notation (ex: 192.168.7.1/24). An IP Subnet CIDR calculator can be used for this. Example: For IPs within a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--ippool

SCVMM Static IP Pool ID.

--k8snodeippoolend

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the end range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--k8snodeippoolstart

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the start range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--libshare

SCVMM library share (Ensure VMM server has write access on the selected Library Share).

--macaddress

Static MAC address (Press enter to assign MAC from Default VMM MAC Pool).

--memorymib

Specify the memory (MB) for the Arc resource bridge on-premises appliance VM.

--network

SCVMM VM network ID.

--noproxy

The list of comma separated entries for excluded networks, hosts, or domains from being accessed through the proxy server.

--numcpus

Specify the number of CPUs to allocate to the Arc resource bridge on-premises appliance VM.

--out-dir

Output directory for Arc resource bridge configuration files, defaults to ./ (current directory).

--overwrite-existing

Overwrite existing configuration files. Default: False.

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

--vlanid

SCVMM Network VLAN ID (0 if VLAN is disabled on the network or a valid VLAN ID in the range (1-4095)).

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

Command to create Arc resource bridge configuration files for Arc-enabled VMware.

This command features two modes - interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. It is initiated by passing only the required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted.

az arcappliance createconfig vmware --location
                                    --name
                                    --resource-group
                                    [--address]
                                    [--certificateFilePath]
                                    [--controlPlaneEndpoint]
                                    [--datacenter]
                                    [--datastore]
                                    [--disksizegib]
                                    [--dnsservers]
                                    [--folder]
                                    [--gateway]
                                    [--http]
                                    [--https]
                                    [--ipaddressprefix]
                                    [--k8snodeippoolend]
                                    [--k8snodeippoolstart]
                                    [--memorymib]
                                    [--network]
                                    [--noproxy]
                                    [--numcpus]
                                    [--out-dir]
                                    [--overwrite-existing]
                                    [--password]
                                    [--resourcepool]
                                    [--username]
                                    [--working-dir]

Examples

Interactive mode to create Arc resource bridge configuration files for Arc-enabled VMware

az arcappliance createconfig 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 a valid location where Arc-enabled VMware is available and 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.

--certificateFilePath

Certificate file path if your proxy server requires the proxy clients to trust a certificate. Only pass a single proxy certificate, not a bundle. (Press enter to skip).

--controlPlaneEndpoint

Arc resource bridge on-premises appliance VM hosts a management kubernetes cluster with a control plane that requires a static IP address. This static IP address must lie within the subnet range specified in the IP address prefix.

--datacenter

Name of the datacenter (as shown in vSphere) where the Arc resource bridge on-premises appliance VM should be deployed.

--datastore

Name of datastore to be used for Arc resource bridge on-premises appliance VM.

--disksizegib

Specify the disk size (GB) for the Arc resource bridge on-premises appliance VM.

--dnsservers

IP address(es) of DNS server(s) used by Arc resource bridge on-premises appliance VM for DNS resolution. Appliance VM must be able to resolve external sites and internal endpoints. Enter multiple IP addresses as a comma-separated list.

--folder

Full path to the vSphere folder, including vSphere VM name and template folder. This is where the Arc resource bridge appliance VM will be deployed. Ex: /DatacenterA/vm/FolderA.

--gateway

Static gateway IP address, must lie within the subnet range specified in the IP address prefix.

--http

HTTP proxy URL and port information entered as http://:. Example: http://192.168.0.10:80.

--https

HTTPS URL and port information entered as http://:. Example: https://192.168.0.10:443.

--ipaddressprefix

Arc resource bridge requires 3 IP addresses for the on-premises appliance VM (appliance VM IP, upgrade VM IP, control plane IP). All IPs should reside within the same subnet and fall within the range specified in the IP address prefix. IP address prefix is entered as the subnet's IP address range for the virtual network and subnet mask (IP Mask) in CIDR notation (ex: 192.168.7.1/24). An IP Subnet CIDR calculator can be used for this. Example: For IPs within a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--k8snodeippoolend

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the end range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--k8snodeippoolstart

Arc resource bridge on-premises appliance VM requires 2 IP addresses (appliance VM IP & upgrade VM IP) that should reside within the same subnet and fall within the range specified in the IP address prefix. IP addresses are specified as an IP range with a minimum size of 2 IP addresses. This parameter is to specify the start range IP. Example: For a subnet range of 192.168.7.1 - 192.168.7.254, the IP address prefix is 192.168.7.1/24. Within 192.168.7.1/24, set k8snodeippoolstart (appliance VM IP) to 192.168.7.2, k8snodeippoolend (upgrade VM IP) to 192.168.7.3 and control plane IP to 192.168.7.4.

--memorymib

Specify the memory (MB) for the Arc resource bridge on-premises appliance VM.

--network

Name of the virtual network or segment to connect Arc resource bridge on-premises appliance VM to. This network should allow the appliance VM to communicate with vCenter Server and the Azure endpoints (or internet).

--noproxy

The list of comma separated entries for excluded networks, hosts, or domains from being accessed through the proxy server.

--numcpus

Specify the number of CPUs to allocate to the Arc resource bridge on-premises appliance VM.

--out-dir

Output directory for Arc resource bridge configuration files, defaults to ./ (current directory).

--overwrite-existing

Overwrite existing configuration files. Default: False.

Default value: False
--password

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

--resourcepool

Full path to the vSphere resource pool where the on-premises appliance VM will be deployed. Ex: /DatacenterA/host/Cluster-1/Resources/ResourcePoolA.

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