WAAGENT(1)

NAME
waagent - Azure Linux VM Agent

SYNOPSIS
waagent [-verbose] [-force] [-help] [SUBCOMMAND]...

DESCRIPTION
The Azure Linux Agent (waagent) manages virtual machine interaction with the Azure fabric controller. Most subcommands are not meant to be run directly by the user. However, some subcommands may be useful for debugging (such as collect-logs, version, and show-configuration) and deprovisioning.

SUBCOMMANDS

-collect-logs
    Runs the log collector utility that collects relevant agent logs for debugging and stores them in the agent folder on disk. Exact location will be shown when run. Use flag -full for more exhaustive log collection.

-configuration-path FILE
    Used together with -start or -daemon to specify configuration file. Default to /etc/waagent.conf.

-daemon -start
    Run waagent as a daemon in background.

-deprovision
    Attempt to clean the system and make it suitable for re-provisioning. WARNING: Deprovision does not guarantee that the image is cleared of all sensitive information and suitable for redistribution.

-deprovision+user
    Same as -deprovision, but also removes the last provisioned user account.

-register-service
    Register waagent as a service and enable it.

-run-exthandlers
    Run check for updates to waagent and extension handler. Note that outputs to /dev/console will be temporarily suspended.

-setup-firewall=IP
    Set up firewall rules for endpoint IP.

-show-configuration
    Print the current configuration, including values read from waagent.conf.

-help
    Display usage information.

-version
    Show the current version of the agent.

CONFIGURATION
The agent is configured via this file by default: /etc/waagent.conf This file contains key=value settings that control agent behavior, including provisioning, disk formatting, resource limits, and certificate handling. Example entries:
    Provisioning.Enabled=y ResourceDisk.Format=y ResourceDisk.MountPoint=/mnt/resource RSA.KeyLength=2048 Logs.Verbose=y

FILES AND DIRECTORIES

/etc/waagent.conf
    Main configuration file.

/var/lib/waagent
    State files and provisioning artifacts.

/var/log/waagent.log
    Agent log file.

SERVICES
On systemd systems, the agent runs as:
    systemctl start <waagent.service|walinuxagent.service> systemctl enable <waagent.service|walinuxagent.service>

EXIT STATUS
Zero on success, non-zero on error.

EXAMPLES

Deprovision before capturing an image:
    waagent -deprovision+user && rm -rf /var/lib/waagent && shutdown -h now

SEE ALSO
systemctl(1), cloud-init(1)

HOMEPAGE
https://github.com/Azure/WALinuxAgent https://learn.microsoft.com/en-us/azure/virtual-machines/extensions/agent-linux

COPYRIGHT
Copyright 2018 Microsoft Corporation

AUTHORS
Microsoft Azure Linux Team