.TH "GCLOUD_ALPHA_FILESTORE_INSTANCES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha filestore instances update \- update a Filestore instance



.SH "SYNOPSIS"
.HP
\f5gcloud alpha filestore instances update\fR (\fIINSTANCE\fR\ :\ \fB\-\-zone\fR=\fIZONE\fR) [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [[\fB\-\-file\-share\fR=[\fIcapacity\fR=\fICAPACITY\fR],[\fIname\fR=\fINAME\fR],[\fInfs\-export\-options\fR=\fINFS\-EXPORT\-OPTIONS\fR],[\fIsource\-snapshot\fR=\fISOURCE\-SNAPSHOT\fR],[\fIsource\-snapshot\-region\fR=\fISOURCE\-SNAPSHOT\-REGION\fR]\ :\ \fB\-\-clear\-nfs\-export\-options\fR]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update a Filestore instance.



.SH "EXAMPLES"

The following command updates the Filestore instance NAME to change the
description to "A new description."

.RS 2m
$ gcloud alpha filestore instances update NAME \e
    \-\-description="A new description."
.RE

The following command updates a Filestore instance named NAME to add the label
"key1=value1" and remove any metadata with the label "key2".

.RS 2m
$ gcloud alpha filestore instances update NAME \e
    \-\-update\-labels=key1=value1 \-\-remove\-labels=key2
.RE

.RS 2m
$ gcloud alpha filestore instances update NAME \-\-zone=ZONE \e
    \-\-flags\-file=FILE_PATH
.RE

Example json configuration file:.RS 2m
{
"\-\-file\-share":
{
  "capacity": "102400",
  "name": "my_vol",
  "nfs\-export\-options": [
    {
      "access\-mode": "READ_WRITE",
      "ip\-ranges": [
        "10.0.0.0/29",
        "10.2.0.0/29"
      ],
      "squash\-mode": "ROOT_SQUASH",
      "anon_uid": 1003,
      "anon_gid": 1003
    }
  ]
}
}

.RE


The following command updates a Filestore instance named NAME to change the
capacity to CAPACITY.

.RS 2m
$ gcloud alpha filestore instances update NAME \e
    \-\-project=PROJECT_ID \-\-zone=ZONE \e
    \-\-file\-share=name=VOLUME_NAME,capacity=CAPACITY
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- The instance to update. 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\-\-zone\fR=\fIZONE\fR

The zone of the instance.

To set the \f5zone\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\-\-zone\fR on the command line;
.IP "\(bu" 2m
provide the argument \f5region\fR on the command line;
.IP "\(bu" 2m
provide the argument \f5location\fR on the command line;
.IP "\(bu" 2m
set the property \f5filestore/zone\fR;
.IP "\(bu" 2m
set the property \f5filestore/region\fR;
.IP "\(bu" 2m
set the property \f5filestore/location\fR.
.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\-\-description\fR=\fIDESCRIPTION\fR

A description of the Cloud Filestore instance.

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

Location of the Cloud Filestore instance/operation.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Region of the Cloud Filestore instance.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


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

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud alpha filestore instances update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud alpha filestore instances update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.TP 2m

Parameters for file\-share.


.RS 2m
.TP 2m
\fB\-\-file\-share\fR=[\fIcapacity\fR=\fICAPACITY\fR],[\fIname\fR=\fINAME\fR],[\fInfs\-export\-options\fR=\fINFS\-EXPORT\-OPTIONS\fR],[\fIsource\-snapshot\fR=\fISOURCE\-SNAPSHOT\fR],[\fIsource\-snapshot\-region\fR=\fISOURCE\-SNAPSHOT\-REGION\fR]

File share configuration for an instance. Specifying both \f5name\fR and
\f5capacity\fR is required.

.RS 2m
.TP 2m
\fBcapacity\fR
The desired capacity of the volume in GB or TB units. If no capacity unit is
specified, GB is assumed. Acceptable instance capacities for each tier are as
follows:
.IP "\(bu" 2m
BASIC_HDD: 1TB\-63.9TB in 1GB increments or its multiples.
.IP "\(bu" 2m
BASIC_SSD: 2.5TB\-63.9TB in 1GB increments or its multiples.
.IP "\(bu" 2m
HIGH_SCALE_SSD: 10TB\-100TB in 2.5TB increments or its multiples.
.IP "\(bu" 2m
ZONAL: 1TB\-100TB:
.RS 2m
.IP "\(em" 2m
1TB\-9.75TB in 256GB increments or its multiples.
.IP "\(em" 2m
10TB\-100TB in 2.5TB increments or its multiples.
.RE
.sp
.IP "\(bu" 2m
ENTERPRISE: 1TB\-10TB in 256GB increments or its multiples.
.IP "\(bu" 2m
REGIONAL: 1TB\-100TB:
.RS 2m
.IP "\(em" 2m
1TB\-9.75TB in 256GB increments or its multiples.
.IP "\(em" 2m
10TB\-100TB in 2.5TB increments or its multiples.
.RE
.sp

.TP 2m
\fBname\fR
The desired logical name of the volume.

.TP 2m
\fBnfs\-export\-options\fR
The NfsExportOptions for the Cloud Filestore instance file share. Configuring
NfsExportOptions is optional and can only be set using flags\-file. Use the
\f5\-\-flags\-file\fR flag to specify the path to a JSON or YAML configuration
file that contains the required NfsExportOptions flags.

.TP 2m
\fBip\-ranges\fR
A list of IPv4 addresses or CIDR ranges that are allowed to mount the file
share. IPv4 addresses format: {octet 1}.{octet 2}.{octet 3}.{octet 4}. CIDR
range format: {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size}. Overlapping
IP ranges are allowed for all tiers other than BASIC_HDD and BASIC_SSD. The
limit of IP ranges/addresses for each FileShareConfig among all NfsExportOptions
is 64 per instance.

.TP 2m
\fBaccess\-mode\fR
The type of access allowed for the specified IP\-addresses or CIDR ranges.
READ_ONLY: Allows only read requests on the exported file share. READ_WRITE:
Allows both read and write requests on the exported file share. The default
setting is READ_WRITE.

.TP 2m
\fBsquash\-mode\fR
Enables or disables root squash for the specified IP addresses or CIDR ranges.
NO_ROOT_SQUASH: Disables root squash to allow root access on the exported file
share. ROOT_SQUASH. Enables root squash to remove root access on the exported
file share. The default setting is NO_ROOT_SQUASH.

.TP 2m
\fBanon_uid\fR
An integer that represents the user ID of anonymous users. Anon_uid may only be
set when squash_mode is set to ROOT_SQUASH. If NO_ROOT_SQUASH is specified, an
error will be returned. The default value is 65534.

.TP 2m
\fBanon_gid\fR
An integer that represents the group ID of anonymous groups. Anon_gid may only
be set when squash_mode is set to ROOT_SQUASH. If NO_ROOT_SQUASH is specified,
an error will be returned. The default value is 65534.

.TP 2m
\fBsecurity\-flavors\fR
A list of security flavors that are allowed to be used during mount command in
NFSv4.1 filestore instances. The security flavors supported are:
.RS 2m
.IP "\(em" 2m
SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to AUTH_SYS.
.IP "\(em" 2m
AUTH_SYS: The user's UNIX user\-id and group\-ids are passed in the clear.
.IP "\(em" 2m
KRB5: The end\-user authentication is done using Kerberos V5.
.IP "\(em" 2m
KRB5I: KRB5 plus integrity protection (data packets are tamper proof).
.IP "\(em" 2m
KRB5P: KRB5I plus privacy protection (data packets are tamper proof and
encrypted).
.RE
.sp

.TP 2m
\fBnetwork\fR
The source VPC network for \f5ip\-ranges\fR. Required for instances using
Private Service Connect, optional otherwise. If provided, must be the same
network specified in the \f5network.name\fR field.

.TP 2m
\fBsource\-snapshot\fR
The name of the snapshot to restore from. Supported for BASIC instances only.

.TP 2m
\fBsource\-snapshot\-region\fR
The region of the source snapshot. If unspecified, it is assumed that the
Filestore snapshot is local and instance\-zone will be used.

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

.RE
.sp
.TP 2m
\fB\-\-clear\-nfs\-export\-options\fR

Clears the NfsExportOptions. Must specify \f5\-\-file\-share\fR flag if
\-\-clear\-nfs\-export\-options is specified.


.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 "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:

.RS 2m
$ gcloud filestore instances update
.RE

.RS 2m
$ gcloud beta filestore instances update
.RE