Share via

az arcappliance upgrade

Note

This reference is part of the arcappliance extension for the Azure CLI (version 2.73.0 or higher). The extension will automatically install the first time you run an az arcappliance upgrade command. Learn more about extensions.

Command group for upgrading an Appliance cluster.

Commands

Name Description Type Status
az arcappliance upgrade hci

Command to upgrade an Appliance on Azure Stack HCI.

 Extension GA
az arcappliance upgrade scvmm

Command to upgrade an Appliance on SCVMM.

 Extension GA
az arcappliance upgrade vmware

Command to upgrade an Appliance on VMware.

 Extension GA

az arcappliance upgrade hci

Command to upgrade an Appliance on Azure Stack HCI.

az arcappliance upgrade hci [--cloudagent]
                            [--config-file]
                            [--kubeconfig]
                            [--location]
                            [--loginconfigfile]
                            [--name]
                            [--no-wait]
                            [--resource-group]

Examples

Upgrade HCI Appliance

az arcappliance upgrade hci --resource-group [REQUIRED] --name [REQUIRED] --kubeconfig [REQUIRED] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]

Upgrade HCI Appliance using config

az arcappliance upgrade hci --config-file [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.

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

--config-file

Path to Appliance Config File.

--kubeconfig

Path to kubeconfig.

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

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--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 upgrade scvmm

Command to upgrade an Appliance on SCVMM.

az arcappliance upgrade scvmm [--address]
                              [--config-file]
                              [--kubeconfig]
                              [--location]
                              [--name]
                              [--no-wait]
                              [--password]
                              [--port]
                              [--resource-group]
                              [--username]

Examples

Upgrade SCVMM Appliance using config file

az arcappliance upgrade scvmm --config-file [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.

--config-file

Path to Appliance Config File.

--kubeconfig

Path to kubeconfig.

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

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--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 upgrade vmware

Command to upgrade an Appliance on VMware.

az arcappliance upgrade vmware [--address]
                               [--config-file]
                               [--kubeconfig]
                               [--location]
                               [--name]
                               [--no-wait]
                               [--password]
                               [--resource-group]
                               [--username]

Examples

Upgrade VMware Appliance

az arcappliance upgrade vmware --resource-group [REQUIRED] --name [REQUIRED] --kubeconfig [REQUIRED] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Upgrade VMware Appliance using config file

az arcappliance upgrade vmware --config-file [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.

--config-file

Path to Appliance Config File.

--kubeconfig

Path to kubeconfig.

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

--no-wait

Do not wait for the long-running operation to finish.

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