About the guest agent

Linux Windows

This document provides an overview of the guest agent architecture. The guestagent is a critical component of the guest environment. The guest environmentcontains scripts, daemons, and binaries that instances need to run on Compute Engine.For more information, seeGuest environment.

The guest agent sets up services and defines minimum configurations forfeatures such as snapshot script execution, Windows failover, OS login, andmetadata-based SSH authentication. For more information about core functions ofthe guest agent, seeGuest agent functionality.

Guest agent architecture

Starting with version20250901.00, the guest agent architecture isupdated from a monolithic design to a modern, plugin-based system. Thisevolution improves flexibility, reliability, and extensibility.

  • Monolithic architecture: guest agents earlier than20250901.00feature a single, unified process centered around the metadata server'sdescription of instances. The metadata server is a per-instance HTTP serverthat runs alongside every Compute Engine instance. For moreinformation about the metadata server, seeVM metadata.

    The guest agent long polls the metadata server and takes actionbased on state changes. With this architecture, the agent's state is sharedacross all tasks such as SSH and network setup.This monolithic approach lacked interface and component isolation. Changesor feature introductions in one area of the agent affect the entire systemsimultaneously. This pattern makes feature additions and testing coveragechallenging.

  • Plugin-based architecture: starting with version20250901.00, theguest agent is divided into distinct, independent plugins managed by acentral manager. Each plugin can interact with the metadata server and, asdirected by a central manager, makes changes as needed. Thismodular approach ensures that a crash in one plugin does not affect the coreagent or other plugins.

The plugin-based architecture

This architecture is built around a central manager that controls variousplugins, separating core functionalities from optional, service-specificplugins, referred to as extensions.

Key components

The following diagram shows the key components of the guest agent and theirinteractions.

A central guest agent manager controls a core plugin and extensions.    The guest agent manager communicates with VM Extension Manager on Google's    backend to manage the extensions.
Figure 1. Guest agent architecture
  • Core plugin: this plugin encapsulates the functionality of the originalguest agent. It performs the essential tasks that your instance needs to runon Google Cloud. These include tasks such as the following:

    • Network configuration: sets up the primary network interface to enablecommunication.
    • SSH access: manages user SSH keys to allow secure connections to yourinstance.
    • Metadata access: provides a pathway for the instance to access instanceand project metadata.

    You can't disable the core plugin.

    For more information about core functions of the guest agent, seeGuest agent functionality.

  • Extensions (Optional plugins): you can provision these extensions to integrate with otherGoogle Cloud services to perform tasks such as:

    For more information about installing and managing these extensions, seeVM Extension Manager.

  • VM Extension Manager: this managed Google Cloud service runs onGoogle's backend infrastructure. VM Extension Manager manages the lifecycle ofextensions, including their installation, updates, and configuration,by communicating with the guest agent manager on the instance.

  • Guest agent manager: this central process starts, stops, andmonitors the status of all plugins. The guest agent manager facilitatescommunication between the core plugin and VM Extension Manager.Lifecycle management for extensions includes the following:

    • Installation and updates: the guest agent manager installs, starts,stops, and configures extensions based on instructions fromVM Extension Manager.
    • Health monitoring: the guest agent manager monitors the health andstatus of extensions, including their CPU and memory usage, andreports this information back to VM Extension Manager.
    • Policy management: use Compute Engine APIs to create policies thatcontrol the installation and versioning of extensions.

Benefits

The plugin-based architecture offers several advantages over the monolithicdesign. These benefits include the following:

  • Plugin isolation: each plugin runs in a separate process, so a crash inone doesn't affect the core agent or other plugins.
  • Resource protection: the guest agent uses OS-level features to enforceresource limits on plugins, preventing any single plugin from consumingexcessive CPU or memory.
  • Automatic crash recovery: the system automatically recovers from aplugin crash by stopping and relaunching the plugin.
  • Selective enablement: you can disable extensions that are notneeded, which lets you secure or optimize your instance.
  • Reduced overhead for extensions: the guest agent managerautomatically handles the installation and updates of extensions,reducing the manual effort required to keep them up-to-date.

Location of guest agent binaries

The following tables list the file paths for the different guest agent binarieson Linux and Windows instances, depending on the architecture.

Plugin-based agent binaries

This table lists the file paths for the plugin-based guest agent binaries onLinux and Windows instances:

ComponentPath on LinuxPath on Windows
Guest agent manager/usr/bin/google_guest_agent_managerC:\ProgramData\Google\Compute Engine\agent\GCEWindowsAgentManager.exe
Core plugin binary/usr/lib/google/guest_agent/core_pluginC:\Program Files\Google\Compute Engine\agent\CorePlugin.exe
Metadata script runner/usr/bin/gce_metadata_script_runnerC:\Program Files\Google\Compute Engine\agent\GCEMetadataScriptRunner.exe

Monolithic agent binaries

The following table lists the file paths for the monolithic guest agentbinaries on Linux and Windows instances:

ComponentPath on LinuxPath on Windows
Guest agent/usr/bin/google_guest_agentC:\Program Files\Google\Compute Engine\agent\GCEWindowsAgent.exe
Metadata script runner/usr/bin/google_metadata_script_runnerC:\Program Files\Google\Compute Engine\metadata_scripts\GCEMetadataScripts.exe
Authorized keysNot applicableC:\Program Files\Google\Compute Engine\agent\GCEAuthorizedKeys.exe

Guest agent daemon services

The following tables list the guest agent daemon services installed on Linux andWindows instances. These services run assystemd units on Linux and as Windowsservices on Windows.

ComponentService Name on LinuxService Name on WindowsStatus
Guest agent managergoogle-guest-agent-manager.serviceGCEAgentManagerEnabled in all modes, including backward compatibility.
Guest agentgoogle-guest-agent.serviceGCEAgentDisabled by default.
Enabled only inbackward compatibility mode.
Guest agent compatibility managergoogle-guest-compat-manager.serviceGCEWindowsCompatManagerEnabled in all modes, including backward compatibility.
Workload certificate refreshergce-workload-cert-refresh.timerN/ADisabled by default.
Enabled only in backward compatibility mode.
Startup scriptsgoogle-startup-scripts.serviceGCEStartup
Shutdown scriptsgoogle-shutdown-scripts.serviceShutdown
Important: The guest agent service and the core plugin are mutually exclusive andonly one can run at a time. The guest agent service is installed butdisabledby default. This is the expected state. Don't manually start this service, asrunning both processes simultaneously causes conflicts. The guest agentcompatibility manager automatically enables the guest agent service only whenbackward compatibility mode is required.

Backward compatibility

To ensure a smooth transition from the previous, monolithic guest agent to theplugin-based system, the guest agent package includes several componentsdesigned for backward compatibility. These components are not part of theplugin-based architecture and activate only if you manually choose to revert tothe monolithic agent by setting the metadata attributeenable-guest-agent-core-plugin tofalse.

The components that support this compatibility include the following:

  • Guest agent compatibility manager: this package manages the switch betweenthe plugin-based agent and the monolithic agent.
  • Metadata script runner compatibility manager: this package ensures that thecorrect script runner is used, depending on whether the monolithic orplugin-based agent is active.
  • Authorized keys compatibility manager (Windows only): this package handlesSSH keys, ensuring that the correct keys are used for either the old or newagent.
ComponentPath on LinuxPath on Windows
Guest agent compatibility manager/usr/bin/google_guest_compat_managerC:\Program Files\Google\Compute Engine\agent\GCEWindowsCompatManager.exe
Metadata script runner compatibility manager/usr/bin/metadata_script_runner_compatC:\Program Files\Google\Compute Engine\metadata_scripts\GCECompatMetadataScripts.exe
Authorized keys compatibility managerNot applicableC:\Program Files\Google\Compute Engine\agent\GCEWindowsAuthorizedKeysCompat.exe

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.