.TH "GCLOUD_ALPHA_BMS_NFS\-SHARES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha bms nfs\-shares update \- update a Bare Metal Solution NFS share



.SH "SYNOPSIS"
.HP
\f5gcloud alpha bms nfs\-shares update\fR (\fINFS_SHARE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-add\-allowed\-client\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]\ |\ \fB\-\-clear\-allowed\-clients\fR\ |\ \fB\-\-remove\-allowed\-client\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update a Bare Metal Solution NFS share.

This call returns immediately, but the update operation may take several minutes
to complete. To check if the operation is complete, use the \f5describe\fR
command for the NFS share.



.SH "EXAMPLES"

To update an NFS share called \f5\fImy\-share\fR\fR in region
\f5\fIus\-central1\fR\fR with a new label \f5\fIkey1=value1\fR\fR, run:

.RS 2m
$ gcloud alpha bms nfs\-shares update my\-share \-\-region=us\-central1 \e
    \-\-update\-labels=key1=value1
.RE

To clear all labels, run:

.RS 2m
$ gcloud alpha bms nfs\-shares update my\-share \-\-region=us\-central1 \e
    \-\-clear\-labels
.RE

To remove label \f5\fIkey1\fR\fR, run:

.RS 2m
$ gcloud alpha bms nfs\-shares update my\-share \-\-region=us\-central1 \e
    \-\-remove\-labels=key1
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Nfs share resource \- nfs_share. 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 \f5nfs_share\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
\fINFS_SHARE\fR

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

To set the \f5nfs_share\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5nfs_share\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\-\-region\fR=\fIREGION\fR

Region of the resource.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5nfs_share\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\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\-\-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\-\-add\-allowed\-client\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]

Adds an allowed client to the NFS share. This flag can be repeated to specify
multiple allowed clients.

.RS 2m
.TP 2m
\fBnetwork\fR
The name of the network to allow.

.TP 2m
\fBnetwork\-project\-id\fR
The project ID of the allowed client network. If not present, the project ID of
the NFS share will be used.

.TP 2m
\fBcidr\fR
The subnet of IP addresses permitted to access the NFS share.

.TP 2m
\fBmount\-permissions\fR
The mount permissions for the allowed client. \f5\fIMOUNT_PERMISSIONS\fR\fR must
be one of: \f5READ_ONLY\fR, \f5READ_WRITE\fR.

.TP 2m
\fBallow\-dev\fR
If \f5\fIyes\fR\fR, allows creation of devices.

.TP 2m
\fBallow\-suid\fR
If \f5\fIyes\fR\fR, allows SUID.

.TP 2m
\fBenable\-root\-squash\fR
If \f5\fIyes\fR\fR, enables root squashing which is a special mapping of the
remote superuser (root) identity when using identity authentication .

.RE
.sp
.TP 2m
\fB\-\-clear\-allowed\-clients\fR

Removes all IP range reservations in the network.

.TP 2m
\fB\-\-remove\-allowed\-client\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]

Removes an allowed client for the NFS share given its network name and cidr.
This flag can be repeated to remove multiple allowed clients.

.RS 2m
.TP 2m
\fBnetwork\fR
The name of the network of the allowed client to remove.

.TP 2m
\fBnetwork\-project\-id\fR
The project ID of the allowed client network. If not present, the project ID of
the NFS share will be used.

.TP 2m
\fBcidr\fR
The subnet of permitted IP addresses of the allowed client to remove.

.RE
.RE
.sp
.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 bms nfs\-shares 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 bms nfs\-shares 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
.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. This variant is also available:

.RS 2m
$ gcloud bms nfs\-shares update
.RE