Share via

az connectedvmware vm guest-agent

  • Reference

Note

This reference is part of the connectedvmware extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az connectedvmware vm guest-agent command. Learn more about extensions.

Vm guest agent.

Commands

Name Description Type Status
az connectedvmware vm guest-agent enable

Enable guest agent on the vm.

 Extension GA
az connectedvmware vm guest-agent show

Get details of a guest agent by guest agent name, resource-group and vm name.

 Extension GA

az connectedvmware vm guest-agent enable

Enable guest agent on the vm.

az connectedvmware vm guest-agent enable --resource-group
                                         --vm-name
                                         [--https-proxy]
                                         [--no-wait]
                                         [--password]
                                         [--private-link-scope]
                                         [--username]

Examples

Enable guest agent on the vm

az connectedvmware vm guest-agent enable --username "vm user name" --password "vm password" --resource-group "resource group name" --subscription "Name or ID of subscription" --vm-name "vm name"

Enable guest agent on the vm using private link

az connectedvmware vm guest-agent enable --username "vm user name" --password "vm password" --resource-group "resource group name" --subscription "Name or ID of subscription" --vm-name "vm name" --private-link-scope "/subscriptions/fedcba98-7654-3210-0123-456789abcdef/resourceGroups/contoso-rg/providers/Microsoft.HybirdCompute/privateLinkScopes/contoso-private-link-scope"

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vm-name

Name of the VM.

Optional Parameters

--https-proxy

HTTPS proxy server url for the VM.

--no-wait

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

Default value: False
--password

Username password credentials to use for connecting to the VM.

--private-link-scope

The resource id of the private link scope this machine is assigned to.

--username

Username to use for connecting to the vm.

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 connectedvmware vm guest-agent show

Get details of a guest agent by guest agent name, resource-group and vm name.

az connectedvmware vm guest-agent show --resource-group
                                       --vm-name

Examples

Get details of a guest agent

az connectedvmware vm guest-agent show --resource-group "resource group name"                --vm-name "name of the vm"

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vm-name

Name of the VM.

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.