HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/help/man/man1/gcloud_compute_os-config_troubleshoot.1
.TH "GCLOUD_COMPUTE_OS\-CONFIG_TROUBLESHOOT" 1



.SH "NAME"
.HP
gcloud compute os\-config troubleshoot \- troubleshoot issues with the setup of VM Manager on a specified VM instance



.SH "SYNOPSIS"
.HP
\f5gcloud compute os\-config troubleshoot\fR \fIINSTANCE_NAME\fR [\fB\-\-zone\fR=\fIZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fBgcloud compute os\-config troubleshoot\fR 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:

.RS 2m
.IP "\(bu" 2m
Checks if the OS Config API is enabled in the project.
.IP "\(bu" 2m
Checks if the required metadata is set up correctly in the VM instance.
.IP "\(bu" 2m
Checks if the latest version of the OS Config agent is running on the VM
instance.
.IP "\(bu" 2m
Checks if a service account is attached to the VM instance.
.IP "\(bu" 2m
Checks if the VM Manager service agent is enabled.
.IP "\(bu" 2m
Checks if the VM instance has a public IP or Private Google Access.
.RE
.sp



.SH "EXAMPLES"

To troubleshoot an instance named \f5my\-instance\fR in zone \f5us\-west1\-a\fR,
run

.RS 2m
$ gcloud compute os\-config troubleshoot my\-instance \-\-zone=us\-west1\-a
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE_NAME\fR

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


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

Zone of the instance to operate on. If not specified, you might be prompted to
select a zone (interactive mode only). \f5gcloud\fR attempts to identify the
appropriate zone by searching for resources in your currently active project. If
the zone cannot be determined, \f5gcloud\fR 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
\f5\fIcompute/zone\fR\fR property:

.RS 2m
$ gcloud config set compute/zone ZONE
.RE

A list of zones can be fetched by running:

.RS 2m
$ gcloud compute zones list
.RE

To unset the property, run:

.RS 2m
$ gcloud config unset compute/zone
.RE

Alternatively, the zone can be stored in the environment variable
\f5\fICLOUDSDK_COMPUTE_ZONE\fR\fR.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha compute os\-config troubleshoot
.RE