gcloud-help/gcloud/bms/nfs-shares/update

NAME
    gcloud bms nfs-shares update - update a Bare Metal Solution NFS share

SYNOPSIS
    gcloud bms nfs-shares update (NFS_SHARE : --region=REGION) [--async]
        [--update-labels=[KEY=VALUE,...]]
        [--add-allowed-client=[PROPERTY=VALUE,...] | --clear-allowed-clients
          | --remove-allowed-client=[PROPERTY=VALUE,...]]
        [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    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
    describe command for the NFS share.

EXAMPLES
    To update an NFS share called my-share in region us-central1 with a new
    label key1=value1, run:

        $ gcloud bms nfs-shares update my-share --region=us-central1 \
            --update-labels=key1=value1

    To clear all labels, run:

        $ gcloud bms nfs-shares update my-share --region=us-central1 \
            --clear-labels

    To remove label key1, run:

        $ gcloud bms nfs-shares update my-share --region=us-central1 \
            --remove-labels=key1

POSITIONAL ARGUMENTS
     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 project attribute:
      ◆ provide the argument nfs_share on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

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

          To set the nfs_share attribute:
          ▸ provide the argument nfs_share on the command line.

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

       --region=REGION
          Region of the resource.

          To set the region attribute:
          ▸ provide the argument nfs_share on the command line with a fully
            specified name;
          ▸ provide the argument --region on the command line.

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

     --update-labels=[KEY=VALUE,...]
        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
        (-), underscores (_), lowercase characters, and numbers. Values must
        contain only hyphens (-), underscores (_), lowercase characters, and
        numbers.

     At most one of these can be specified:

       --add-allowed-client=[PROPERTY=VALUE,...]
          Adds an allowed client to the NFS share. This flag can be repeated to
          specify multiple allowed clients.

           network
              The name of the network to allow.

           network-project-id
              The project ID of the allowed client network. If not present, the
              project ID of the NFS share will be used.

           cidr
              The subnet of IP addresses permitted to access the NFS share.

           mount-permissions
              The mount permissions for the allowed client. MOUNT_PERMISSIONS
              must be one of: READ_ONLY, READ_WRITE.

           allow-dev
              If yes, allows creation of devices.

           allow-suid
              If yes, allows SUID.

           enable-root-squash
              If yes, enables root squashing which is a special mapping of the
              remote superuser (root) identity when using identity
              authentication .

       --clear-allowed-clients
          Removes all IP range reservations in the network.

       --remove-allowed-client=[PROPERTY=VALUE,...]
          Removes an allowed client for the NFS share given its network name
          and cidr. This flag can be repeated to remove multiple allowed
          clients.

           network
              The name of the network of the allowed client to remove.

           network-project-id
              The project ID of the allowed client network. If not present, the
              project ID of the NFS share will be used.

           cidr
              The subnet of permitted IP addresses of the allowed client to
              remove.

     At most one of these can be specified:

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

          For example, to remove all labels:

              $ gcloud bms nfs-shares update --clear-labels

          To remove all existing labels and create two new labels, foo and baz:

              $ gcloud bms nfs-shares update --clear-labels \
                --update-labels foo=bar,baz=qux

       --remove-labels=[KEY,...]
          List of label keys to remove. If a label does not exist it is
          silently ignored. If --update-labels is also specified then
          --update-labels is applied first.

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 help for details.

NOTES
    This variant is also available:

        $ gcloud alpha bms nfs-shares update