gcloud beta filestore instances update - update a Filestore instance

gcloud beta filestore instances update(INSTANCE :--zone=ZONE)[--async][--description=DESCRIPTION][--location=LOCATION][--performance=[max-iops=MAX-IOPS],[max-iops-per-tb=MAX-IOPS-PER-TB]][--region=REGION][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][--disconnect-managed-ad    |--managed-ad=[computer=COMPUTER],[domain=DOMAIN]][[--file-share=[capacity=CAPACITY],[name=NAME],[nfs-export-options=NFS-EXPORT-OPTIONS] :--clear-nfs-export-options]][--[no-]deletion-protection--deletion-protection-reason=DELETION_PROTECTION_REASON][GCLOUD_WIDE_FLAG …]

gcloudbetafilestoreinstancesupdateNAME--description="A new description."

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

gcloudbetafilestoreinstancesupdateNAME--update-labels=key1=value1--remove-labels=key2

gcloudbetafilestoreinstancesupdateNAME--zone=ZONE--flags-file=FILE_PATH

Example json configuration file:

{"--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}]}}

gcloudbetafilestoreinstancesupdateNAME--project=PROJECT_ID--zone=ZONE--file-share=name=VOLUME_NAME,capacity=CAPACITY

The following command updates a Filestore instance named NAME to configure themax-iops-per-tb to MAX-IOPS-PER-TB.

gcloudbetafilestoreinstancesupdateNAME--project=PROJECT_ID--zone=ZONE--performance=max-iops-per-tb=MAX-IOPS-PER-TB

Instance resource - The instance to update. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.

To set theproject attribute:

• provide the argumentinstance on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

INSTANCE

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

To set theinstance attribute:

• provide the argumentinstance on the command line.

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

--zone=ZONE

The zone of the instance.

To set thezone attribute:

• provide the argumentinstance on the command line with a fullyspecified name;
• provide the argument--zone on the command line;
• provide the argumentregion on the command line;
• provide the argumentlocation on the command line;
• set the propertyfilestore/zone;
• set the propertyfilestore/region;
• set the propertyfilestore/location.

--async

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

--description=DESCRIPTION

A description of the Cloud Filestore instance.

--location=LOCATION

Location of the Cloud Filestore instance/operation.

--performance=[max-iops=MAX-IOPS],[max-iops-per-tb=MAX-IOPS-PER-TB]

Performance configuration for the instance. This flag is used to configure theread IOPS provisioned for the instance. The instance's write IOPS and read/writethroughputs will be derived from the configured read IOPS. For more informationabout the derived performance limits and default performance see:https://cloud.google.com/filestore/docs/performance.Must be one of:

max-iopsThenumberofIOPStoprovisionfortheinstance.MAX-IOPSmustbeinmultipleof1000andinthesupportedIOPSrangeforthecurrentcapacityoftheinstance.Formoredetails,see:https://cloud.google.com/filestore/docs/performance.

max-iops-per-tbIsusedforsettingthemaxIOPSoftheinstancebyspecifyingtheIOPSperTB.Whenthisparameterisused,themaxIOPSarederivedfromtheinstancecapacity:TheinstancemaxIOPSwillbecalculatedbymultiplyingthecapacityoftheinstance(TB)byMAX-IOPS-PER-TB,androundingtothenearest1000.ThemaxIOPSwillbechangeddynamicallybasedontheinstancecapacity.MAX-IOPS-PER-TBmustbeinthesupportedrangeoftheinstance.Formoredetails,see:https://cloud.google.com/filestore/docs/performance.

Examples:

Configure an instance withmax-iops performance:

gcloudbetafilestoreinstancesupdateexample-cluster--performance=max-iops=17000

Configure an instance withmax-iops-per-tb performance:

gcloudbetafilestoreinstancesupdateexample-cluster--performance=max-iops-per-tb=17000

--region=REGION

Region of the Cloud Filestore instance.

--update-labels=[KEY=VALUE,…]

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

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. 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:

gcloudbetafilestoreinstancesupdate--clear-labels

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

gcloudbetafilestoreinstancesupdate--clear-labels--update-labelsfoo=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.

At most one of these can be specified:

--disconnect-managed-ad

Disconnect the instance from Managed Active Directory.

--managed-ad=[computer=COMPUTER],[domain=DOMAIN]

Managed Active Directory configuration for an instance. Specifies both thedomain name and a computer name (unique to the domain) to be created by thefilestore instance.

domainThedesireddomainfulluri.i.e.:projects/PROJECT/locations/global/domains/DOMAIN

computerThedesiredactivedirectorycomputernametobecreatedbythefilestoreinstancewhenconnectingtothedomain.

Parameters for file-share.

--file-share=[capacity=CAPACITY],[name=NAME],[nfs-export-options=NFS-EXPORT-OPTIONS]

File share configuration for an instance. Specifying bothname andcapacity is required.

capacity

The desired capacity of the volume in GB or TB units. If no capacity unit isspecified, GB is assumed. Acceptable instance capacities for each tier are asfollows:

BASIC_HDD: 1TB-63.9TB in 1GB increments or its multiples.

BASIC_SSD: 2.5TB-63.9TB in 1GB increments or its multiples.

HIGH_SCALE_SSD: 10TB-100TB in 2.5TB increments or its multiples.

ZONAL: 1TB-100TB:

• 1TB-9.75TB in 256GB increments or its multiples.
• 10TB-100TB in 2.5TB increments or its multiples.

ENTERPRISE: 1TB-10TB in 256GB increments or its multiples.

REGIONAL: 1TB-100TB:

• 1TB-9.75TB in 256GB increments or its multiples.
• 10TB-100TB in 2.5TB increments or its multiples.

name

The desired logical name of the volume.

nfs-export-options

The NfsExportOptions for the Cloud Filestore instance file share. ConfiguringNfsExportOptions is optional and can only be set using flags-file. Use the--flags-file flag to specify the path to a JSON or YAMLconfiguration file that contains the required NfsExportOptions flags.

ip-ranges

A list of IPv4 addresses or CIDR ranges that are allowed to mount the fileshare. IPv4 addresses format: {octet 1}.{octet 2}.{octet 3}.{octet 4}. CIDRrange format: {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size}. OverlappingIP ranges are allowed for all tiers other than BASIC_HDD and BASIC_SSD. Thelimit of IP ranges/addresses for each FileShareConfig among all NfsExportOptionsis 64 per instance.

access-mode

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 defaultsetting is READ_WRITE.

squash-mode

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 fileshare. ROOT_SQUASH. Enables root squash to remove root access on the exportedfile share. The default setting is NO_ROOT_SQUASH.

anon_uid

An integer that represents the user ID of anonymous users. Anon_uid may only beset when squash_mode is set to ROOT_SQUASH. If NO_ROOT_SQUASH is specified, anerror will be returned. The default value is 65534.

anon_gid

An integer that represents the group ID of anonymous groups. Anon_gid may onlybe 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.

security-flavors

A list of security flavors that are allowed to be used during mount command inNFSv4.1 filestore instances. The security flavors supported are:

• SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to AUTH_SYS.
• AUTH_SYS: The user's UNIX user-id and group-ids are passed in the clear.
• KRB5: The end-user authentication is done using Kerberos V5.
• KRB5I: KRB5 plus integrity protection (data packets are tamper proof).
• KRB5P: KRB5I plus privacy protection (data packets are tamper proof andencrypted).

network

The source VPC network forip-ranges. Required for instances usingPrivate Service Connect, optional otherwise. If provided, must be the samenetwork specified in thenetwork.name field.

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

--clear-nfs-export-options

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

Deletion protection control options. When deletion protection is enabled, theinstance cannot be deleted.

--[no-]deletion-protection

Enables deletion protection for the instance. Use--deletion-protection to enable and--no-deletion-protection to disable.

--deletion-protection-reason=DELETION_PROTECTION_REASON

The reason for enabling deletion protection for the instance.

Run$gcloud help for details.