gcloud alpha compute os-config troubleshoot

NAME
gcloud alpha compute os-config troubleshoot - troubleshoot issues with the setup of VM Manager on a specified VM instance
SYNOPSIS
gcloud alpha compute os-config troubleshootINSTANCE_NAME[--enable-log-analysis][--zone=ZONE][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA)gcloud alpha compute os-config troubleshoottroubleshoots issues with the setup of VM Manager on a specified VM instance

The troubleshoot command investigates the following settings or configurationsfor your VM Manager setup:

  • Checks if the OS Config API is enabled in the project.
  • Checks if the required metadata is set up correctly in the VM instance.
  • Checks if the latest version of the OS Config agent is running on the VMinstance.
  • Checks if a service account is attached to the VM instance.
  • Checks if the VM Manager service agent is enabled.
  • Checks if the VM instance has a public IP or Private Google Access.
EXAMPLES
To troubleshoot an instance namedmy-instance in zoneus-west1-a, run
gcloudalphacomputeos-configtroubleshootmy-instance--zone=us-west1-a

To troubleshoot the same instance in the same zone with log analysis, run

gcloudalphacomputeos-configtroubleshootmy-instance--zone=us-west1-a--enable-log-analysis
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to operate on. For details on valid instance names, referto the criteria documented under the field 'name' at:https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--enable-log-analysis
Enable the checking of audit logs created by Cloud Logging. The troubleshooterchecks the VM's Cloud Logging logs and serial log output for errors, providesyou with the analysis data, and allows you to download the logs.
--zone=ZONE
Zone of the instance to operate on. If not specified, you might be prompted toselect a zone (interactive mode only).gcloud attempts to identify theappropriate zone by searching for resources in your currently active project. Ifthe zone cannot be determined,gcloud prompts you for a selection withall available Google Cloud Platform zones.

To avoid prompting when this flag is omitted, the user can set thecompute/zone property:

gcloudconfigsetcompute/zoneZONE

A list of zones can be fetched by running:

gcloudcomputezoneslist

To unset the property, run:

gcloudconfigunsetcompute/zone

Alternatively, the zone can be stored in the environment variableCLOUDSDK_COMPUTE_ZONE.

GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudcomputeos-configtroubleshoot

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 2025-05-07 UTC.