gcloud beta compute instances add-partner-metadata Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta compute instances add-partner-metadata - add or update partner metadata
- SYNOPSIS
gcloud beta compute instances add-partner-metadataINSTANCE_NAME[--partner-metadata=[NAMESPACE/KEY=VALUE,…]][--partner-metadata-from-file=LOCAL_FILE_PATH][--zone=ZONE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)gcloud beta compute instances add-partner-metadata can beused to add or update or patch partner metadata of a virtual machine instance.Every instance has access to a metadata server that can be used to query partnermetadata that has been set through this tool. For information on metadata, seeAbout VMmetadata.Only namespaces keys that are provided are mutated. Existing Namespaces entrieswill remain unaffected.
In order to retrieve partner metadata, run:
gcloudcomputeinstancesdescribeexample-instance--zoneus-central1-a--view=FULL--format="value(partnerMetadata)"where example-instance is the name of the virtual machine instance you'requerying partner metadata from.
- EXAMPLES
- To add partner metadata under namespace
to instancetest.compute.googleapis.comrun:TEST_INSTANCEgcloudbetacomputeinstancesadd-partner-metadataTEST_INSTANCE--partner-metadata=test.compute.googleapis.com/entries="{ "engine": { "type": V8 } }"To add partner metadata from a file:
gcloudbetacomputeinstancesadd-partner-metadataTEST_INSTANCE--partner-metadata-from-file=examples/engine.json - POSITIONAL ARGUMENTS
INSTANCE_NAME- Name of the instance to set partner metadata on. For details on valid instancenames, refer to the criteria documented under the field 'name' at:https://cloud.google.com/compute/docs/reference/rest/v1/instances
- FLAGS
--partner-metadata=[NAMESPACE/KEY=VALUE,…]- Partner metadata specifying namespace and its entries. The entries can bekey-value pairs or in json format.
--partner-metadata-from-file=LOCAL_FILE_PATH- Path to a local json file containing partner metadata. Use a full or relativepath to a local file containing the value of partner_metadata.
--zone=ZONE- Zone of the instance to set partner metadata on. If not specified, you might beprompted to select a zone (interactive mode only).
gcloudattempts to identify theappropriate zone by searching for resources in your currently active project. Ifthe zone cannot be determined,gcloudprompts you for a selection withall available Google Cloud Platform zones.To avoid prompting when this flag is omitted, the user can set the
property:compute/zonegcloudconfigsetcompute/zoneZONEA list of zones can be fetched by running:
gcloudcomputezoneslistTo unset the property, run:
gcloudconfigunsetcompute/zoneAlternatively, 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 helpfor details. - NOTES
- This command is currently in beta and might change without notice. This variantis also available:
gcloudalphacomputeinstancesadd-partner-metadata
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.