gcloud-help/gcloud/netapp/volumes/update

NAME
    gcloud netapp volumes update - update a Cloud NetApp Volume

SYNOPSIS
    gcloud netapp volumes update (VOLUME : --location=LOCATION) [--async]
        [--backup-config=[backup-policies=BACKUP-POLICIES],
          [backup-vault=BACKUP-VAULT],
          [enable-scheduled-backups=ENABLE-SCHEDULED-BACKUPS]]
        [--block-devices=[host-groups=HOST-GROUPS],
          [name=NAME],[os-type=OS-TYPE],[size-gib=SIZE-GIB]]
        [--cache-parameters=[cache-config=CACHE-CONFIG],
          [enable-global-file-lock=ENABLE-GLOBAL-FILE-LOCK],
          [peer-cluster-name=PEER-CLUSTER-NAME],
          [peer-ip-addresses=PEER-IP-ADDRESSES],
          [peer-svm-name=PEER-SVM-NAME],[peer-volume-name=PEER-VOLUME-NAME]]
        [--cache-pre-populate=[exclude-path-list=EXCLUDE-PATH-LIST],
          [path-list=PATH-LIST],[recursion=RECURSION]] [--capacity=CAPACITY]
        [--description=DESCRIPTION] [--enable-kerberos=ENABLE_KERBEROS]
        [--export-policy=[access-type=ACCESS-TYPE],
          [allowed-clients=ALLOWED-CLIENTS],[anon-uid=ANON-UID],
          [has-root-access=HAS-ROOT-ACCESS],
          [kerberos-5-read-only=KERBEROS-5-READ-ONLY],
          [kerberos-5-read-write=KERBEROS-5-READ-WRITE],
          [kerberos-5i-read-only=KERBEROS-5I-READ-ONLY],
          [kerberos-5i-read-write=KERBEROS-5I-READ-WRITE],
          [kerberos-5p-read-only=KERBEROS-5P-READ-ONLY],
          [kerberos-5p-read-write=KERBEROS-5P-READ-WRITE],
          [nfsv3=NFSV3],[nfsv4=NFSV4],[squash-mode=SQUASH-MODE]]
        [--protocols=PROTOCOL,[PROTOCOL,...]]
        [--restricted-actions=RESTRICTED_ACTION,[...]]
        [--security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"]
        [--share-name=SHARE_NAME]
        [--smb-settings=SMB_SETTING,[SMB_SETTING,...]]
        [--snap-reserve=SNAP_RESERVE]
        [--snapshot-daily=[hour=HOUR],
          [minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]]
        [--snapshot-directory=SNAPSHOT_DIRECTORY; default="true"]
        [--snapshot-hourly=[minute=MINUTE],
          [snapshots-to-keep=SNAPSHOTS-TO-KEEP]]
        [--snapshot-monthly=[day=DAY],
          [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]]
        [--snapshot-weekly=[day=DAY],
          [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]]
        [--source-snapshot=SOURCE_SNAPSHOT] [--storage-pool=STORAGE_POOL]
        [--throughput-mibps=THROUGHPUT_MIBPS]
        [--tiering-policy=[tier-action=ENABLED|PAUSED,...]]
        [--unix-permissions=UNIX_PERMISSIONS] [--update-labels=[KEY=VALUE,...]]
        [--clear-labels | --remove-labels=[KEY,...]]
        [--source-backup=SOURCE_BACKUP : --backup_vault=BACKUP_VAULT]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Update a Cloud NetApp Volume and its specified parameters

EXAMPLES
    The following command updates a Volume named NAME and its specified
    parameters

        $ gcloud netapp volumes update NAME --location=us-central1 \
          --capacity=4096 --description="new description" \
          --enable-kerberos=false --storage-pool=sp3 \
          --unix-permissions=0777

POSITIONAL ARGUMENTS
     Volume resource - The Volume 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 project attribute:
      ◆ provide the argument volume 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.

       VOLUME
          ID of the volume or fully qualified identifier for the volume.

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

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

       --location=LOCATION
          The location of the volume.

          To set the location attribute:
          ▸ provide the argument volume on the command line with a fully
            specified name;
          ▸ provide the argument --location on the command line;
          ▸ set the property netapp/location.

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

     --backup-config=[backup-policies=BACKUP-POLICIES],[backup-vault=BACKUP-VAULT],[enable-scheduled-backups=ENABLE-SCHEDULED-BACKUPS]
        Backup Config contains backup related config on a volume.

            Backup Config will have the following format
            `--backup-config=backup-policies=BACKUP_POLICIES,
            backup-vault=BACKUP_VAULT_NAME,
            enable-scheduled-backups=ENABLE_SCHEDULED_BACKUPS

        backup-policies is a pound-separated (#) list of backup policy names,
        backup-vault can include a single backup-vault resource name, and
        enable-scheduled-backups is a Boolean value indicating whether or not
        scheduled backups are enabled on the volume.

     --block-devices=[host-groups=HOST-GROUPS],[name=NAME],[os-type=OS-TYPE],[size-gib=SIZE-GIB]
        A block device to be created with the volume.

        This flag can be repeated to specify multiple block devices.

        The following keys are available:
         name
            A user-defined name for the block device.
         host-groups
            A comma-separated list of host groups that can mount the block
            volume.
         os-type
            The OS type of the volume. Allowed values are OS_TYPE_UNSPECIFIED,
            LINUX, WINDOWS.
         size-gib
            The size of the block device in GiB. Note that this value is
            ignored during volume creation and is system-managed.

     --cache-parameters=[cache-config=CACHE-CONFIG],[enable-global-file-lock=ENABLE-GLOBAL-FILE-LOCK],[peer-cluster-name=PEER-CLUSTER-NAME],[peer-ip-addresses=PEER-IP-ADDRESSES],[peer-svm-name=PEER-SVM-NAME],[peer-volume-name=PEER-VOLUME-NAME]
        Cache Parameters contains cache parameters of a volume.

            Cache Parameters will have the following format
            `--cache-parameters=peer-volume-name=PEER_VOLUME_NAME,
              peer-cluster-name=PEER_CLUSTER_NAME,
              peer-svm-name=PEER_SVM_NAME,
              peer-ip-addresses=[PEER-IP-ADDRESS1#PEER-IP-ADDRESS2#...],
              enable-global-file-lock=ENABLE_GLOBAL_FILE_LOCK,
              cache-config=CACHE_CONFIG`

            *peer-volume-name*::: Name of the user's local source volume
            *peer-cluster-name*::: Name of the user's local source cluster
            *peer-svm-name*::: Name of the user's local source vserver svm
            *peer-ip-addresses*::: Hashtag-separated(#) list of IP addresses
            *enable-global-file-lock*::: If true, enable global file lock
            *cache-config*::: Cache-config as a hashtag-separated(#) list of key-value pairs

     --cache-pre-populate=[exclude-path-list=EXCLUDE-PATH-LIST],[path-list=PATH-LIST],[recursion=RECURSION]
        Cache Pre-populate contains cache pre-populate parameters of a volume.

        Cache Pre-populate will have the following format
        --cache-pre-populate=path-list=PATH_LIST1#PATH_LIST2,
        exclude-path-list=EXCLUDE_PATH_LIST1#EXCLUDE_PATH_LIST2,
        recursion=RECURSION

         path-list
            Hashtag-separated(#) list of paths to be pre-populated
         exclude-path-list
            Hashtag-separated(#) list of paths to be excluded from
            pre-population
         recursion
            Boolean value indicating pre-populate recursion.

     --capacity=CAPACITY
        The desired capacity of the Volume in GiB or TiB units.If no capacity
        unit is specified, GiB is assumed.

     --description=DESCRIPTION
        A description of the Cloud NetApp Volume

     --enable-kerberos=ENABLE_KERBEROS
        Boolean flag indicating whether Volume is a kerberos Volume or not

     --export-policy=[access-type=ACCESS-TYPE],[allowed-clients=ALLOWED-CLIENTS],[anon-uid=ANON-UID],[has-root-access=HAS-ROOT-ACCESS],[kerberos-5-read-only=KERBEROS-5-READ-ONLY],[kerberos-5-read-write=KERBEROS-5-READ-WRITE],[kerberos-5i-read-only=KERBEROS-5I-READ-ONLY],[kerberos-5i-read-write=KERBEROS-5I-READ-WRITE],[kerberos-5p-read-only=KERBEROS-5P-READ-ONLY],[kerberos-5p-read-write=KERBEROS-5P-READ-WRITE],[nfsv3=NFSV3],[nfsv4=NFSV4],[squash-mode=SQUASH-MODE]
        Export Policy of a Cloud NetApp Files Volume. This will be a field
        similar to network in which export policy fields can be specified as
        such: --export-policy=allowed-clients=ALLOWED_CLIENTS_IP_ADDRESSES,
        has-root-access=HAS_ROOT_ACCESS_BOOL,access=ACCESS_TYPE,nfsv3=NFSV3,
        nfsv4=NFSV4,kerberos-5-read-only=KERBEROS_5_READ_ONLY,
        kerberos-5-read-write=KERBEROS_5_READ_WRITE,
        kerberos-5i-read-only=KERBEROS_5I_READ_ONLY,
        kerberos-5i-read-write=KERBEROS_5I_READ_WRITE,
        kerberos-5p-read-only=KERBEROS_5P_READ_ONLY,
        kerberos-5p-read-write=KERBEROS_5P_READ_WRITE,
        squash-mode=SQUASH_MODE,anon-uid=ANON_UID

     --protocols=PROTOCOL,[PROTOCOL,...]
        Type of File System protocols for the Cloud NetApp Volume. Valid
        component values are: NFSV3, NFSV4, SMB, ISCSI.

     --restricted-actions=RESTRICTED_ACTION,[...]
        Actions to be restricted for a volume. Valid restricted action options
        are: 'DELETE'.

     --security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"
        The security style of the Volume. This can either be UNIX or NTFS.

        SECURITY_STYLE must be one of:

         ntfs
            NTFS security style for Volume.
         unix
            UNIX security style for Volume

     --share-name=SHARE_NAME
        Share name of the Mount path clients will use.

     --smb-settings=SMB_SETTING,[SMB_SETTING,...]
        List of settings specific to SMB protocol for a Cloud NetApp Files
        Volume. Valid component values are: ENCRYPT_DATA, BROWSABLE,
        CHANGE_NOTIFY, NON_BROWSABLE, OPLOCKS, SHOW_SNAPSHOT,
        SHOW_PREVIOUS_VERSIONS, ACCESS_BASED_ENUMERATION,
        CONTINUOUSLY_AVAILABLE.

     --snap-reserve=SNAP_RESERVE
        (DEPRECATED) The percentage of volume storage reserved for snapshot
        storage. The default value for this is 0 percent

        The snap-reserve option is deprecated

     --snapshot-daily=[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]
        Make a snapshot every day e.g. at 06:00, 05:20, 23:50

     --snapshot-directory=SNAPSHOT_DIRECTORY; default="true"
        Snapshot Directory if enabled (true) makes the Volume contain a
        read-only .snapshot directory which provides access to each of the
        volume's snapshots

     --snapshot-hourly=[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]
        Make a snapshot every hour e.g. at 04:00, 05:20, 06:00

     --snapshot-monthly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]
        Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50

     --snapshot-weekly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]
        Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20,
        Sunday 23:50

     Snapshot resource - The source Snapshot to create the Volume from. This
     represents a Cloud 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 --source-snapshot on the command line with a
        fully specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     To set the location attribute:
      ◆ provide the argument --source-snapshot on the command line with a
        fully specified name;
      ◆ set the property netapp/location.

     To set the volume attribute:
      ◆ provide the argument --source-snapshot on the command line with a
        fully specified name.

     --source-snapshot=SOURCE_SNAPSHOT
        ID of the snapshot or fully qualified identifier for the snapshot.

        To set the snapshot attribute:
        ◆ provide the argument --source-snapshot on the command line.

     Storage pool resource - The Storage Pool to associate with Volume. This
     represents a Cloud 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 --storage-pool on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     To set the location attribute:
      ◆ provide the argument --storage-pool on the command line with a fully
        specified name;
      ◆ provide the argument --location on the command line;
      ◆ set the property netapp/location.

     --storage-pool=STORAGE_POOL
        ID of the storage_pool or fully qualified identifier for the
        storage_pool.

        To set the storage_pool attribute:
        ◆ provide the argument --storage-pool on the command line.

     --throughput-mibps=THROUGHPUT_MIBPS
        The desired throughput of the volume in MiB/s.

     --tiering-policy=[tier-action=ENABLED|PAUSED,...]
        Tiering Policy contains auto tiering policy on a volume.

            Tiering Policy will have the following format
            --tiering-policy=tier-action=TIER_ACTION,
            cooling-threshold-days=COOLING_THRESHOLD_DAYS

            tier-action is an enum, supported values are ENABLED or PAUSED,
        cooling-threshold-days is an integer represents time in days to mark
        the volume's data block as cold and make it eligible for tiering, can
        be range from 7-183. Default is 31.

     --unix-permissions=UNIX_PERMISSIONS
        Unix permissions the mount point will be created with. Unix permissions
        are only applicable with NFS protocol only

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

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

          For example, to remove all labels:

              $ gcloud netapp volumes update --clear-labels

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

              $ gcloud netapp volumes 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.

     Backup resource - The source Backup to create the Volume from. 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 --source-backup on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     To set the location attribute:
      ◆ provide the argument --source-backup on the command line with a fully
        specified name;
      ◆ set the property netapp/location.

     --source-backup=SOURCE_BACKUP
        ID of the backup or fully qualified identifier for the backup.

        To set the backup attribute:
        ◆ provide the argument --source-backup on the command line.

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

     --backup_vault=BACKUP_VAULT
        The Backup Vault of the backup.

        To set the backup_vault attribute:
        ◆ provide the argument --source-backup on the command line with a
          fully specified name;
        ◆ provide the argument --backup_vault on the command line;
        ◆ provide the argument --backup-vault on the command line.

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
    These variants are also available:

        $ gcloud alpha netapp volumes update

        $ gcloud beta netapp volumes update