- NAME
-
- gcloud alpha lustre instances mirrors update - updates the parameters of a single Managed Lustre mirror
- SYNOPSIS
-
-
gcloud alpha lustre instances mirrors update(MIRROR:--instance=INSTANCE--location=LOCATION) [--async] [--[no-]deleted-files-retained] [--description=DESCRIPTION] [--direction=DIRECTION] [--request-id=REQUEST_ID] [--clear-gcs-path--gcs-path-uri=GCS_PATH_URI] [--clear-lustre-path--lustre-path=LUSTRE_PATH] [--labels=[LABELS,…] |--update-labels=[UPDATE_LABELS,…]--clear-labels|--remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Updates the parameters of a single Managed Lustre mirror. - EXAMPLES
-
To update the description of mirror
my-mirrorfor instancemy-instancein locationus-central1-arun:gcloud alpha lustre instances mirrors update my-mirror --instance=my-instance --location=us-central1-a --description="<updated description>" - POSITIONAL ARGUMENTS
-
-
Mirror resource - Identifier. Name of the mirror. Format:
projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
To set the
projectattribute:-
provide the argument
mirroron the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
MIRROR-
ID of the mirror or fully qualified identifier for the mirror.
To set the
mirrorattribute:-
provide the argument
mirroron the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--instance=INSTANCE-
The instance id of the mirror resource.
To set the
instanceattribute:-
provide the argument
mirroron the command line with a fully specified name; -
provide the argument
--instanceon the command line.
-
provide the argument
--location=LOCATION-
The location id of the mirror resource.
To set the
locationattribute:-
provide the argument
mirroron the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Mirror resource - Identifier. Name of the mirror. Format:
projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--[no-]deleted-files-retained-
If true, files will be retained in lustre after the corresponding files are
deleted from cloud storage. Default is false. Use
--deleted-files-retainedto enable and--no-deleted-files-retainedto disable. --description=DESCRIPTION- Description of the mirror.
--direction=DIRECTION-
Represents the direction of the mirror.
DIRECTIONmust be (only one value is supported):from-cloud-storage- Mirror from Cloud Storage to Lustre.
--request-id=REQUEST_ID-
The unique ID to identify requests. Specify a unique request ID so that if you
must retry your request, the server will know to ignore the request if it has
already been completed. The server guarantees that a request doesn't result in
the same update request being executed for at least 60 minutes.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request.
The request ID must be a valid UUID version 4 with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000). This request is only idempotent if arequest_idis provided. - Specifies a Cloud Storage bucket and, optionally, a path inside the bucket.
--clear-gcs-path- Set mirror.gcsPath back to default value.
--gcs-path-uri=GCS_PATH_URI-
The URI to a Cloud Storage bucket, or a path within a bucket, using the format
gs://<bucket_name>/<optional_path_inside_bucket>/. If a path inside the bucket is specified, it must end with a forward slash (/). - The root directory path to the Lustre file system.
--clear-lustre-path- Set mirror.lustrePath back to default value.
--lustre-path=LUSTRE_PATH-
The root directory path to the Managed Lustre file system. Must start with
/. Default is/. If you're importing data into Managed Lustre, any path other than the default must already exist on the file system. -
Update labels.
At most one of these can be specified:
--labels=[LABELS,…]-
Set labels to new value. Labels to apply to the mirror.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--labels=string=string
JSON Example:--labels='{"string": "string"}'
File Example:--labels=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--update-labels=[UPDATE_LABELS,…]-
Update labels value or add key value pair. Labels to apply to the mirror.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--update-labels=string=string
JSON Example:--update-labels='{"string": "string"}'
File Example:--update-labels=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-labels- Clear labels value and set to empty map.
--remove-labels=REMOVE_LABELS-
Remove existing value from map labels. Sets
remove_labelsvalue.Shorthand Example:--remove-labels=string,stringJSON Example:--remove-labels=["string"]
File Example:--remove-labels=path_to_file.(yaml|json)
- 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. - API REFERENCE
-
This command uses the
lustre/v1alphaAPI. The full documentation for this API can be found at: https://cloud.google.com/managed-lustre/docs - 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.
gcloud alpha lustre instances mirrors update
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 2026-09-22 UTC.
[null,null,["Last updated 2026-09-22 UTC."],[],[]]