Share via

az stack-hci-vm serial-console

Note

This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm serial-console command. Learn more about extensions.

Manage serial console access for Azure Local virtual machines (applies to multi-rack deployments only).

Commands

Name Description Type Status
az stack-hci-vm serial-console connect

Connect to the serial console of an Azure Local virtual machine (applies to multi-rack deployments only).

 Extension GA

az stack-hci-vm serial-console connect

Connect to the serial console of an Azure Local virtual machine (applies to multi-rack deployments only).

az stack-hci-vm serial-console connect --name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]

Examples

ConnectToSerialConsole

az stack-hci-vm serial-console connect --name "test-vm" --resource-group "test-rg"

Required Parameters

--name

Name of the virtual machine.

Usage: --name "test-vm".

--resource-group -g

Resource group of the virtual machine.

Usage: --resource-group "test-rg".

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
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