- NAME
-
- gcloud alpha compute project-info add-metadata - add or update project-wide metadata
- SYNOPSIS
-
-
gcloud alpha compute project-info add-metadata
[--metadata
=KEY
=VALUE
,[KEY
=VALUE
,…]] [--metadata-from-file
=KEY
=LOCAL_FILE_PATH
,[…]] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
gcloud alpha compute project-info add-metadata
can be used to add or update project-wide metadata. Every instance has access to a metadata server that can be used to query metadata that has been set through this tool. Project-wide metadata entries are visible to all instances. To set metadata for individual instances, usegcloud compute instances add-metadata
. For information on metadata, see https://cloud.google.com/compute/docs/metadataOnly metadata keys that are provided are mutated. Existing metadata entries will remain unaffected.
If you are using this command to manage SSH keys for your project, please note the risks of manual SSH key management as well as the required format for SSH key metadata, available at https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys
- FLAGS
-
--metadata
=KEY
=VALUE
,[KEY
=VALUE
,…]-
Metadata to be made available to the guest operating system running on the
instances. Each metadata entry is a key/value pair separated by an equals sign.
Each metadata key must be unique and have a max of 128 bytes in length. Each
value must have a max of 256 KB in length. Multiple arguments can be passed to
this flag, e.g.,
. The combined total size for all metadata entries is 512 KB.--metadata key-1=value-1,key-2=value-2,key-3=value-3
In images that have Compute Engine tools installed on them, such as the official images, the following metadata keys have special meanings:
startup-script
-
Specifies a script that will be executed by the instances once they start
running. For convenience,
can be used to pull the value from a file.--metadata-from-file
startup-script-url
-
Same as
except that the script contents are pulled from a publicly-accessible location on the web. For startup scripts on Windows instances, the following metadata keys have special meanings:startup-script
,windows-startup-script-url
,windows-startup-script-cmd
,windows-startup-script-bat
,windows-startup-script-ps1
,sysprep-specialize-script-url
,sysprep-specialize-script-cmd
, andsysprep-specialize-script-bat
. For more information, see Running startup scripts. At least one of [--metadata] or [--metadata-from-file] is required.sysprep-specialize-script-ps1
--metadata-from-file
=KEY
=LOCAL_FILE_PATH
,[…]-
Same as
except that the value for the entry will be read from a local file. This is useful for values that are too large such as--metadata
contents. At least one of [--metadata] or [--metadata-from-file] is required.startup-script
- 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. These variants are also available:
gcloud compute project-info add-metadata
gcloud beta compute project-info add-metadata
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-04 UTC.