.TH "GCLOUD_BETA_FILESTORE_INSTANCES_CREATE" 1



.SH "NAME"
.HP
gcloud beta filestore instances create \- create a Filestore instance



.SH "SYNOPSIS"
.HP
\f5gcloud beta filestore instances create\fR (\fIINSTANCE\fR\ :\ \fB\-\-zone\fR=\fIZONE\fR) \fB\-\-file\-share\fR=[\fIcapacity\fR=\fICAPACITY\fR],[\fIname\fR=\fINAME\fR],[\fInfs\-export\-options\fR=\fINFS\-EXPORT\-OPTIONS\fR],[\fIsource\-backup\fR=\fISOURCE\-BACKUP\fR],[\fIsource\-backup\-region\fR=\fISOURCE\-BACKUP\-REGION\fR] \fB\-\-network\fR=[\fIconnect\-mode\fR=\fICONNECT\-MODE\fR],[\fIname\fR=\fINAME\fR],[\fIpsc\-endpoint\-project\fR=\fIPSC\-ENDPOINT\-PROJECT\fR],[\fIreserved\-ip\-range\fR=\fIRESERVED\-IP\-RANGE\fR] [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-managed\-ad\fR=[\fIcomputer\fR=\fICOMPUTER\fR],[\fIdomain\fR=\fIDOMAIN\fR]] [\fB\-\-performance\fR=[\fImax\-iops\fR=\fIMAX\-IOPS\fR],[\fImax\-iops\-per\-tb\fR=\fIMAX\-IOPS\-PER\-TB\fR]] [\fB\-\-protocol\fR=\fIPROTOCOL\fR;\ default=\f5"NFS_V3"\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-source\-instance\fR=\fISOURCE_INSTANCE\fR] [\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-tier\fR=\fITIER\fR;\ default=\f5"BASIC_HDD"\fR] [\fB\-\-deletion\-protection\fR\ :\ \fB\-\-deletion\-protection\-reason\fR=\fIDELETION_PROTECTION_REASON\fR] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Create a Filestore instance.



.SH "EXAMPLES"

The following command creates a Filestore instance named NAME with a single
volume.

.RS 2m
$ gcloud beta filestore instances create NAME \e
  \-\-description=DESCRIPTION \-\-tier=TIER \-\-protocol=PROTOCOL \e
  \-\-file\-share=name=VOLUME_NAME,capacity=CAPACITY \e
  \-\-network=name=NETWORK_NAME,\e
reserved\-ip\-range=RESERVED_IP_RANGE,connect\-mode=CONNECT_MODE,\e
psc\-endpoint\-project=PSC_ENDPOINT_PROJECT \-\-zone=ZONE \e
    \-\-performance=max\-iops\-per\-tb=MAX\-IOPS\-PER\-TB \e
    \-\-kms\-key=KMS\-KEY \-\-kms\-keyring=KMS_KEYRING \e
    \-\-kms\-location=KMS_LOCATION \-\-kms\-project=KMS_PROJECT \e
    \-\-managed\-ad=domain=DOMAIN,computer=COMPUTER \e
    \-\-flags\-file=FLAGS_FILE \-\-source\-instance=SOURCE_INSTANCE
.RE

.RS 2m
Example json configuration file:
{ "\-\-file\-share": {"capacity": "61440",
"name": "my_vol",
"nfs\-export\-options": [
  {
    "access\-mode": "READ_WRITE",
    "ip\-ranges": [
      "10.0.0.0/8",
    ],
    "squash\-mode": "NO_ROOT_SQUASH",
    "security\-flavors": [
        "AUTH_SYS",
        "KRB5P",
    ],
  },
   {
    "access\-mode": "READ_ONLY",
    "ip\-ranges": [
      "192.168.0.0/24"
    ],
    "squash\-mode": "ROOT_SQUASH"
    "anon_uid": 1003,
    "anon_gid": 1003
  }
],
 } }
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- The instance to create. 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 "REQUIRED FLAGS"

.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\-backup\fR=\fISOURCE\-BACKUP\fR],[\fIsource\-backup\-region\fR=\fISOURCE\-BACKUP\-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:
.RS 2m
.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

.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.
.RS 2m
.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

.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\-backup\fR
The name of the backup to restore from.

.TP 2m
\fBsource\-backup\-region\fR
The region of the source backup.

.RE
.sp
.TP 2m
\fB\-\-network\fR=[\fIconnect\-mode\fR=\fICONNECT\-MODE\fR],[\fIname\fR=\fINAME\fR],[\fIpsc\-endpoint\-project\fR=\fIPSC\-ENDPOINT\-PROJECT\fR],[\fIreserved\-ip\-range\fR=\fIRESERVED\-IP\-RANGE\fR]

Network configuration for a Cloud Filestore instance. Specifying
\f5reserved\-ip\-range\fR and \f5connect\-mode\fR is optional.
.RS 2m
.TP 2m
\fBname\fR
The name of the Google Compute Engine VPC network to which the instance is
connected.
.TP 2m
\fBreserved\-ip\-range\fR
The \f5reserved\-ip\-range\fR can have one of the following two types of values:
a CIDR range value when using DIRECT_PEERING connect mode or an allocated IP
address range
(https://cloud.google.com/compute/docs/ip\-addresses/reserve\-static\-internal\-ip\-address)
when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP
address range is specified, it must be one of the ranges associated with the
private service access connection. When specified as a direct CIDR value, it
must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale,
Zonal, Enterprise or Regional tier in one of the internal IP address ranges
(https://www.arin.net/knowledge/address_filters.html) that identifies the range
of IP addresses reserved for this instance. For example, 10.0.0.0/29 or
192.168.0.0/24. The range you specify can't overlap with either existing subnets
or assigned IP address ranges for other Cloud Filestore instances in the
selected VPC network.
.TP 2m
\fBconnect\-mode\fR
Network connection mode used by instances. CONNECT_MODE must be one of:
DIRECT_PEERING, PRIVATE_SERVICE_ACCESS or PRIVATE_SERVICE_CONNECT.
.TP 2m
\fBpsc\-endpoint\-project\fR
Consumer service project in which the psc endpoint would be set up. This is
optional, and only relevant in case the network is a shared VPC. If this is not
specified, the psc endpoint would be setup in the VPC host project.


.RE
.RE
.sp

.SH "OPTIONAL 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\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

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
\fB\-\-location\fR=\fILOCATION\fR

Location of the Cloud Filestore instance/operation.

.TP 2m

Directory services configuration for an instance.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-managed\-ad\fR=[\fIcomputer\fR=\fICOMPUTER\fR],[\fIdomain\fR=\fIDOMAIN\fR]

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

.RS 2m
domain
   The desired domain full uri. i.e.:
   projects/PROJECT/locations/global/domains/DOMAIN
.RE

.RS 2m
computer
   The desired active directory computer name to be created by
   the filestore instance when connecting to the domain.
.RE

.RE
.sp
.TP 2m
\fB\-\-performance\fR=[\fImax\-iops\fR=\fIMAX\-IOPS\fR],[\fImax\-iops\-per\-tb\fR=\fIMAX\-IOPS\-PER\-TB\fR]

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

.RS 2m
max\-iops
  The number of IOPS to provision for the instance.
  MAX\-IOPS must be in multiple of 1000 and in the supported IOPS
  range for the current capacity of the instance.
  For more details, see: https://cloud.google.com/filestore/docs/performance.
.RE

.RS 2m
max\-iops\-per\-tb
  Is used for setting the max IOPS of the instance by
  specifying the IOPS per TB. When this parameter is used, the
  max IOPS are derived from the instance capacity:
  The instance max IOPS will be calculated by multiplying the
  capacity of the instance (TB) by MAX\-IOPS\-PER\-TB, and rounding
  to the nearest 1000. The max IOPS will be changed
  dynamically based on the instance capacity.
  MAX\-IOPS\-PER\-TB must be in the supported range of the instance.
  For more details, see: https://cloud.google.com/filestore/docs/performance.
.RE


Examples:

Configure an instance with \f5max\-iops\fR performance:

.RS 2m
$ gcloud beta filestore instances create example\-cluster \e
    \-\-performance=max\-iops=17000
.RE

Configure an instance with \f5max\-iops\-per\-tb\fR performance:

.RS 2m
$ gcloud beta filestore instances create example\-cluster \e
    \-\-performance=max\-iops\-per\-tb=17000
.RE

.TP 2m
\fB\-\-protocol\fR=\fIPROTOCOL\fR; default=\f5"NFS_V3"\fR

The service protocol for the Cloud Filestore instance. \fIPROTOCOL\fR must be
one of:

.RS 2m
.TP 2m
\fBnfs\-v3\fR
NFSv3 protocol.
.TP 2m
\fBnfs\-v4\-1\fR
NFSv4.1 protocol.
.RE
.sp


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

Region of the Cloud Filestore instance.

.TP 2m
\fB\-\-source\-instance\fR=\fISOURCE_INSTANCE\fR

The replication source instance of the Cloud Filestore instance.

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

List of tags KEY=VALUE pairs to bind. Each item must be expressed as
\f5<tag\-key\-namespaced\-name>=<tag\-value\-short\-name>\fR.

Example: \f5123/environment=production,123/costCenter=marketing\fR

.TP 2m
\fB\-\-tier\fR=\fITIER\fR; default=\f5"BASIC_HDD"\fR

The service tier for the Cloud Filestore instance. For more details, see:
https://cloud.google.com/filestore/docs/instance\-tiers

\fITIER\fR must be one of:

.RS 2m
.TP 2m
\fBbasic\-hdd\fR
Performant NFS storage system using HDD.
.TP 2m
\fBbasic\-ssd\fR
Performant NFS storage system using SSD.
.TP 2m
\fBenterprise\fR
Enterprise instance. Use REGIONAL instead whenever possible.
.TP 2m
\fBhigh\-scale\-ssd\fR
High Scale SSD instance, an alias for ZONAL. Use ZONAL instead whenever
possible.
.TP 2m
\fBpremium\fR
Premium Filestore instance, An alias for BASIC_SSD. Use BASIC_SSD instead
whenever possible.
.TP 2m
\fBregional\fR
Regional instances offer the features and availability needed for
mission\-critical workloads.
.TP 2m
\fBstandard\fR
Standard Filestore instance, An alias for BASIC_HDD. Use BASIC_HDD instead
whenever possible.
.TP 2m
\fBzonal\fR
Zonal instances offer NFS storage system suitable for high performance computing
application requirements. It offers fast performance that scales with capacity
and allows you to grow and shrink capacity.
.RE
.sp


.TP 2m

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


.RS 2m
.TP 2m
\fB\-\-deletion\-protection\fR

Enables deletion protection for the instance.

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

.TP 2m
\fB\-\-deletion\-protection\-reason\fR=\fIDELETION_PROTECTION_REASON\fR

The reason for enabling deletion protection for the instance.

.RE
.sp
.TP 2m

Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the instance. The 'Filestore Service Agent' service account must
hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The arguments in this
group can be used to specify the attributes of this resource.


.RS 2m
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

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

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

The KMS keyring of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

The Google Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

The Google Cloud project for the key.

To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp


.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 beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud filestore instances create
.RE

.RS 2m
$ gcloud alpha filestore instances create
.RE