.TH "GCLOUD_LUSTRE_INSTANCES_UPDATE" 1



.SH "NAME"
.HP
gcloud lustre instances update \- updates the parameters of a single Managed Lustre instance



.SH "SYNOPSIS"
.HP
\f5gcloud lustre instances update\fR (\fIINSTANCE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-capacity\-gib\fR=\fICAPACITY_GIB\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-[no\-]gke\-support\-enabled\fR] [\fB\-\-per\-unit\-storage\-throughput\fR=\fIPER_UNIT_STORAGE_THROUGHPUT\fR] [\fB\-\-placement\-policy\fR=\fIPLACEMENT_POLICY\fR] [\fB\-\-request\-id\fR=\fIREQUEST_ID\fR] [\fB\-\-clear\-\fR\ \fB\-\-default\-squash\-gid\fR=\fIDEFAULT_SQUASH_GID\fR\ \fB\-\-default\-squash\-mode\fR=\fIDEFAULT_SQUASH_MODE\fR\ \fB\-\-default\-squash\-uid\fR=\fIDEFAULT_SQUASH_UID\fR\ \fB\-\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]\ |\ \fB\-\-add\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]\ \fB\-\-clear\-access\-rules\fR\ |\ \fB\-\-remove\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]] [\fB\-\-labels\fR=[\fILABELS\fR,...]\ |\ \fB\-\-update\-labels\fR=[\fIUPDATE_LABELS\fR,...]\ \fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=\fIREMOVE_LABELS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Updates the parameters of a single Managed Lustre instance.



.SH "EXAMPLES"

To update the description of an instance \f5my\-instance\fR in location
\f5us\-central1\-a\fR run:

.RS 2m
$ gcloud lustre instances update my\-instance \e
    \-\-location=us\-central1\-a \-\-description="<updated description>"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- Identifier. The name of the instance. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIINSTANCE\fR

ID of the instance or fully qualified identifier for the instance.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location id of the instance resource.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-capacity\-gib\fR=\fICAPACITY_GIB\fR

The storage capacity of the instance in gibibytes (GiB). Allowed values are from
\f518000\fR to \f57632000\fR, depending on the \f5perUnitStorageThroughput\fR.
See Performance tiers and maximum storage capacities
(https://cloud.google.com/managed\-lustre/docs/create\-instance#performance\-tiers)
for specific minimums, maximums, and step sizes for each performance tier.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

A user\-readable description of the instance.

.TP 2m
\fB\-\-[no\-]gke\-support\-enabled\fR

Indicates whether you want to enable support for GKE clients. By default, GKE
clients are not supported. Deprecated. No longer required for GKE instance
creation. Use \fB\-\-gke\-support\-enabled\fR to enable and
\fB\-\-no\-gke\-support\-enabled\fR to disable.

.TP 2m
\fB\-\-per\-unit\-storage\-throughput\fR=\fIPER_UNIT_STORAGE_THROUGHPUT\fR

The throughput of the instance in MB/s/TiB. Valid values are 125, 250, 500,
1000. See Performance tiers and maximum storage capacities
(https://cloud.google.com/managed\-lustre/docs/create\-instance#performance\-tiers)
for more information.

.TP 2m
\fB\-\-placement\-policy\fR=\fIPLACEMENT_POLICY\fR

The placement policy name for the instance in the format of
projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

.TP 2m
\fB\-\-request\-id\fR=\fIREQUEST_ID\fR

An optional request 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 will guarantee that for at least 60
minutes since the first request.

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. This prevents clients from
accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not
supported (00000000\-0000\-0000\-0000\-000000000000).

.TP 2m

IP\-based access rules for the Managed Lustre instance. These options define the
root user squash configuration.


.RS 2m
.TP 2m
\fB\-\-clear\-\fR

Set instance.accessRulesOptions back to default value.

.TP 2m
\fB\-\-default\-squash\-gid\fR=\fIDEFAULT_SQUASH_GID\fR

The user squash GID for the default access rule. This user squash GID applies to
all root users connecting from clients that are not matched by any of the access
rules. If not set, the default is 0 (no GID squash).

.TP 2m
\fB\-\-default\-squash\-mode\fR=\fIDEFAULT_SQUASH_MODE\fR

The squash mode for the default access rule. \fIDEFAULT_SQUASH_MODE\fR must be
one of:

.RS 2m
.TP 2m
\fBno\-squash\fR
Squash is disabled.

If set inside an
[AccessRule][google.cloud.lustre.v1.AccessRulesOptions.AccessRule], root users
matching the [ip_ranges][AccessRule.ip_ranges] are not squashed.

If set as the
[default_squash_mode][google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode],
root squash is disabled for this instance.

If the default squash mode is \f5NO_SQUASH\fR, do not set the
[default_squash_uid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid]
or
[default_squash_gid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid],
or an \f5invalid argument\fR error is returned.
.TP 2m
\fBroot\-squash\fR
Root user squash is enabled.

Not supported inside an
[AccessRule][google.cloud.lustre.v1.AccessRulesOptions.AccessRule].

If set as the
[default_squash_mode][google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode],
root users not matching any of the
[access_rules][google.cloud.lustre.v1.AccessRulesOptions.access_rules] are
squashed to the
[default_squash_uid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid]
and
[default_squash_gid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid].
.RE
.sp


.TP 2m
\fB\-\-default\-squash\-uid\fR=\fIDEFAULT_SQUASH_UID\fR

The user squash UID for the default access rule. This user squash UID applies to
all root users connecting from clients that are not matched by any of the access
rules. If not set, the default is 0 (no UID squash).

.TP 2m

Update access_rules.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]

Set access_rules to new value. The access rules for the instance.

.RS 2m
.TP 2m
\fBipAddressRanges\fR
The IP address ranges to which to apply this access rule. Accepts
non\-overlapping CIDR ranges (e.g., \f5192.168.1.0/24\fR) and IP addresses
(e.g., \f5192.168.1.0\fR).

.TP 2m
\fBname\fR
The name of the access rule policy group. Must be 16 characters or less and
include only alphanumeric characters or '\fI'.

.TP 2m
\fBsquashMode\fR
Squash mode for the access rule.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string \-\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-access\-rules='[{"ipAddressRanges": ["string"], "name": "string", "squashMode": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-access\-rules=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-access\-rules\fR=[\fRipAddressRanges\fI=\fRIPADDRESSRANGES\fI],[\fRname\fI=\fRNAME\fI],[\fRsquashMode\fI=\fRSQUASHMODE\fI]

Add new value to access_rules list. The access rules for the instance.

.RS 2m
.TP 2m
\fBipAddressRanges\fR
The IP address ranges to which to apply this access rule. Accepts
non\-overlapping CIDR ranges (e.g., \f5192.168.1.0/24\fR) and IP addresses
(e.g., \f5192.168.1.0\fR).

.TP 2m
\fBname\fR
The name of the access rule policy group. Must be 16 characters or less and
include only alphanumeric characters or '\fR'.

.TP 2m
\fBsquashMode\fR
Squash mode for the access rule.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string \-\-add\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-access\-rules='[{"ipAddressRanges": ["string"], "name": "string", "squashMode": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-access\-rules=path_to_file.(yaml|json)
.RE


.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-access\-rules\fR

Clear access_rules value and set to empty list.

.TP 2m
\fB\-\-remove\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]

Remove existing value from access_rules list. The access rules for the instance.

.RS 2m
.TP 2m
\fBipAddressRanges\fR
The IP address ranges to which to apply this access rule. Accepts
non\-overlapping CIDR ranges (e.g., \f5192.168.1.0/24\fR) and IP addresses
(e.g., \f5192.168.1.0\fR).

.TP 2m
\fBname\fR
The name of the access rule policy group. Must be 16 characters or less and
include only alphanumeric characters or '\fI'.

.TP 2m
\fBsquashMode\fR
Squash mode for the access rule.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-remove\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string \-\-remove\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-remove\-access\-rules='[{"ipAddressRanges": ["string"], "name": "string", "squashMode": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-remove\-access\-rules=path_to_file.(yaml|json)
.RE


.RE
.RE
.RE
.sp
.TP 2m

Update labels.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-labels\fR=[\fRLABELS\fI,...]

Set labels to new value. Labels as key value pairs.

.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.

.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-labels=string=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-labels='{"string": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-labels=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-update\-labels\fR=[\fRUPDATE_LABELS\fI,...]

Update labels value or add key value pair. Labels as key value pairs.

.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.

.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-update\-labels=string=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-update\-labels='{"string": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-labels=path_to_file.(yaml|json)
.RE


.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Clear labels value and set to empty map.

.TP 2m
\fB\-\-remove\-labels\fR=\fRREMOVE_LABELS\fI

Remove existing value from map labels. Sets \f5remove_labels\fR value.

\fBShorthand Example:\fR


.RS 2m
\-\-remove\-labels=string,string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-remove\-labels=["string"]
.RE


\fBFile Example:\fR


.RS 2m
\-\-remove\-labels=path_to_file.(yaml|json)
.RE



\fR
.RE
.RE
.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 "API REFERENCE"

This command uses the \fBlustre/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/managed\-lustre/



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha lustre instances update
.RE