VmExtensionState

State of an extension on an instance.

JSON representation
{
  "name": string,
  "version": string,
  "healthStatus": enum (HealthStatus),
  "enforcementState": enum (EnforcementState),
  "enforcementMsg": string,
  "healthMsg": string,
  "policyId": string
}
Fields
name

string

The name of the extension.

version

string

The version of the extension.

healthStatus

enum (HealthStatus)

The health status of the extension.

enforcementState

enum (EnforcementState)

The enforcement state of the extension. If the extension is not enforced yet, then the health status will not be specified.

enforcementMsg

string

The status message of the extension if the extension fails to enforce.

healthMsg

string

The health status message of the extension.

policyId

string

The id of the policy that is enforced on the extension.

HealthStatus

Health Status of an extension.

Enums
HEALTH_STATUS_UNSPECIFIED Health status is unspecified.
STARTING The extension is starting.
RUNNING The extension is running.
STOPPING The extension is stopping.
STOPPED The extension is stopped.
CRASHED The extension crashed.

EnforcementState

The states enum during an extension enforcement process.

Enums
ENFORCEMENT_STATE_UNSPECIFIED Enforcement state of the extension is unspecified.
INSTALLING The extension is being installed.
INSTALL_FAILED The installation of the extension failed, and there's no recorded stable extension revision to rollback to.
INSTALLED The extension has been successfully installed.
ROLLING_BACK The extension is being rolled back to the last stable revision the system recorded.
ROLLBACK_FAILED The rollback of the extension failed.
ROLLED_BACK

The extension has been successfully rolled back.

This value describes the rollback state of the extension, not the health status. It's possible that the extension is rolled back to the last stable revision but still keeps crashing, e.g. there's a change to the VM and no extension revisions can run normally.

INCOMPATIBLE None of the extension revisions of the given extension version is compatible with the VM's architecture and Operating System.
REMOVING The extension is being removed from the resource.
SERVICE_DISABLED The service requiring this extension is disabled.
APPLYING_CONFIG A new configuration is being applied to the extension. Depending on each extensions' behavior, an extension restart might be involved in this process to get new configuration applied properly.