mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-16 12:22:03 +00:00
93 lines
3.4 KiB
Text
93 lines
3.4 KiB
Text
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 troubleshoot INSTANCE_NAME
|
|
[--enable-log-analysis] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) gcloud alpha compute os-config troubleshoot troubleshoots issues
|
|
with the setup of VM Manager on a specified VM instance
|
|
|
|
The troubleshoot command investigates the following settings or
|
|
configurations for 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
|
|
VM instance.
|
|
|
|
▪ 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 named my-instance in zone us-west1-a, run
|
|
|
|
$ gcloud alpha compute os-config troubleshoot my-instance \
|
|
--zone=us-west1-a
|
|
|
|
To troubleshoot the same instance in the same zone with log analysis, run
|
|
|
|
$ gcloud alpha compute os-config troubleshoot my-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, refer to 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
|
|
troubleshooter checks the VM's Cloud Logging logs and serial log output
|
|
for errors, provides you 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 to select a zone (interactive mode only). gcloud attempts to
|
|
identify the appropriate zone by searching for resources in your
|
|
currently active project. If the zone cannot be determined, gcloud
|
|
prompts you for a selection with all available Google Cloud Platform
|
|
zones.
|
|
|
|
To avoid prompting when this flag is omitted, the user can set the
|
|
compute/zone property:
|
|
|
|
$ gcloud config set compute/zone ZONE
|
|
|
|
A list of zones can be fetched by running:
|
|
|
|
$ gcloud compute zones list
|
|
|
|
To unset the property, run:
|
|
|
|
$ gcloud config unset compute/zone
|
|
|
|
Alternatively, the zone can be stored in the environment variable
|
|
CLOUDSDK_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 this
|
|
command fails with API permission errors despite specifying the correct
|
|
project, you might be trying to access an API with an invitation-only early
|
|
access allowlist. This variant is also available:
|
|
|
|
$ gcloud compute os-config troubleshoot
|
|
|