guest-agent.yml

### YamlMime:AzureCLIGroup
uid: az_scvmm_vm_guest-agent
name: az scvmm vm guest-agent
extensionInformation: >-
  > [!NOTE]

  > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Vm guest agent.
status: GA
sourceType: Extension
directCommands:
- uid: az_scvmm_vm_guest-agent_enable
  name: az scvmm vm guest-agent enable
  summary: |-
    Enable guest agent on the vm.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm vm guest-agent enable --password
                                   --resource-group
                                   --username
                                   --vm-name
                                   [--https-proxy]
                                   [--no-wait]
  examples:
  - summary: |-
      Enable guest agent on the vm
    syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass                --resource-group contoso-rg --subscription contoso-sub                --vm-name contoso-vm
  requiredParameters:
  - isRequired: true
    name: --password
    summary: |-
      Username password credentials to use for connecting to the VM.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - isRequired: true
    name: --username
    summary: |-
      Username to use for connecting to the vm.
  - isRequired: true
    name: --vm-name
    summary: |-
      Name of the VM.
  optionalParameters:
  - name: --https-proxy
    summary: |-
      HTTPS proxy server url for the VM.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
- uid: az_scvmm_vm_guest-agent_show
  name: az scvmm vm guest-agent show
  summary: |-
    Get details of a guest agent by guest agent name, resource-group and vm name.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm vm guest-agent show --resource-group
                                 --vm-name
  examples:
  - summary: |-
      Get details of a guest agent
    syntax: az scvmm vm guest-agent show --resource-group contoso-rg                --vm-name contoso-vm
  requiredParameters:
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - isRequired: true
    name: --vm-name
    summary: |-
      Name of the VM.
commands:
- az_scvmm_vm_guest-agent_enable
- az_scvmm_vm_guest-agent_show
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Vm guest agent.