File: //snap/google-cloud-cli/394/help/man/man1/gcloud_lustre_instances_create.1
.TH "GCLOUD_LUSTRE_INSTANCES_CREATE" 1
.SH "NAME"
.HP
gcloud lustre instances create \- creates a Managed Lustre instance
.SH "SYNOPSIS"
.HP
\f5gcloud lustre instances create\fR (\fIINSTANCE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-capacity\-gib\fR=\fICAPACITY_GIB\fR \fB\-\-filesystem\fR=\fIFILESYSTEM\fR \fB\-\-network\fR=\fINETWORK\fR \fB\-\-per\-unit\-storage\-throughput\fR=\fIPER_UNIT_STORAGE_THROUGHPUT\fR [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-gke\-support\-enabled\fR] [\fB\-\-labels\fR=[\fILABELS\fR,...]] [\fB\-\-placement\-policy\fR=\fIPLACEMENT_POLICY\fR] [\fB\-\-request\-id\fR=\fIREQUEST_ID\fR] [[\fB\-\-default\-squash\-mode\fR=\fIDEFAULT_SQUASH_MODE\fR\ :\ \fB\-\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]\ \fB\-\-default\-squash\-gid\fR=\fIDEFAULT_SQUASH_GID\fR\ \fB\-\-default\-squash\-uid\fR=\fIDEFAULT_SQUASH_UID\fR]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Creates a Managed Lustre instance.
.SH "EXAMPLES"
To create an instance \f5my\-instance\fR in location \f5us\-central1\-a\fR with
18000 Gib capacity run:
.RS 2m
$ gcloud lustre instances create my\-instance \-\-capacity\-gib=18000 \e
\-\-location=us\-central1\-a \e
\-\-network=projects/my\-project/global/networks/default \e
\-\-filesystem=lustrefs \-\-per\-unit\-storage\-throughput=1000
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Instance resource \- Identifier. The name of the instance. 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\-\-location\fR=\fILOCATION\fR
The location id of the instance resource.
To set the \f5location\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\-\-location\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
\fB\-\-capacity\-gib\fR=\fICAPACITY_GIB\fR
The storage capacity of the instance in gibibytes (GiB). Allowed values are from
\f518000\fR to \f57632000\fR, depending on the \f5perUnitStorageThroughput\fR.
See Performance tiers and maximum storage capacities
(https://cloud.google.com/managed\-lustre/docs/create\-instance#performance\-tiers)
for specific minimums, maximums, and step sizes for each performance tier.
.TP 2m
\fB\-\-filesystem\fR=\fIFILESYSTEM\fR
The filesystem name for this instance. This name is used by client\-side tools,
including when mounting the instance. Must be eight characters or less and can
only contain letters and numbers.
.TP 2m
Network resource \- The full name of the VPC network to which the instance is
connected. Must be in the format
\f5projects/{project_id}/global/networks/{network_name}\fR. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-network\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
\fB\-\-network\fR=\fINETWORK\fR
ID of the network or fully qualified identifier for the network.
To set the \f5network\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-network\fR on the command line.
.RE
.sp
.RE
.sp
.TP 2m
\fB\-\-per\-unit\-storage\-throughput\fR=\fIPER_UNIT_STORAGE_THROUGHPUT\fR
The throughput of the instance in MB/s/TiB. Valid values are 125, 250, 500,
1000. See Performance tiers and maximum storage capacities
(https://cloud.google.com/managed\-lustre/docs/create\-instance#performance\-tiers)
for more information.
.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 user\-readable description of the instance.
.TP 2m
\fB\-\-gke\-support\-enabled\fR
Indicates whether you want to enable support for GKE clients. By default, GKE
clients are not supported. Deprecated. No longer required for GKE instance
creation.
.TP 2m
\fB\-\-labels\fR=[\fILABELS\fR,...]
Labels as key value pairs.
.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.
.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.
.RE
.sp
\fBShorthand Example:\fR
.RS 2m
\-\-labels=string=string
.RE
\fBJSON Example:\fR
.RS 2m
\-\-labels='{"string": "string"}'
.RE
\fBFile Example:\fR
.RS 2m
\-\-labels=path_to_file.(yaml|json)
.RE
.TP 2m
\fB\-\-placement\-policy\fR=\fIPLACEMENT_POLICY\fR
The placement policy name for the instance in the format of
projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
.TP 2m
\fB\-\-request\-id\fR=\fIREQUEST_ID\fR
An optional request ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID, the
server can check if original operation with the same request ID was received,
and if so, will ignore the second request. This prevents clients from
accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not
supported (00000000\-0000\-0000\-0000\-000000000000).
.TP 2m
IP\-based access rules for the Managed Lustre instance. These options define the
root user squash configuration.
.RS 2m
.TP 2m
\fB\-\-default\-squash\-mode\fR=\fIDEFAULT_SQUASH_MODE\fR
The squash mode for the default access rule. \fIDEFAULT_SQUASH_MODE\fR must be
one of:
.RS 2m
.TP 2m
\fBno\-squash\fR
Squash is disabled.
If set inside an
[AccessRule][google.cloud.lustre.v1.AccessRulesOptions.AccessRule], root users
matching the [ip_ranges][AccessRule.ip_ranges] are not squashed.
If set as the
[default_squash_mode][google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode],
root squash is disabled for this instance.
If the default squash mode is \f5NO_SQUASH\fR, do not set the
[default_squash_uid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid]
or
[default_squash_gid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid],
or an \f5invalid argument\fR error is returned.
.TP 2m
\fBroot\-squash\fR
Root user squash is enabled.
Not supported inside an
[AccessRule][google.cloud.lustre.v1.AccessRulesOptions.AccessRule].
If set as the
[default_squash_mode][google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode],
root users not matching any of the
[access_rules][google.cloud.lustre.v1.AccessRulesOptions.access_rules] are
squashed to the
[default_squash_uid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid]
and
[default_squash_gid][google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid].
.RE
.sp
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-access\-rules\fR=[\fIipAddressRanges\fR=\fIIPADDRESSRANGES\fR],[\fIname\fR=\fINAME\fR],[\fIsquashMode\fR=\fISQUASHMODE\fR]
The access rules for the instance.
.RS 2m
.TP 2m
\fBipAddressRanges\fR
The IP address ranges to which to apply this access rule. Accepts
non\-overlapping CIDR ranges (e.g., \f5192.168.1.0/24\fR) and IP addresses
(e.g., \f5192.168.1.0\fR).
.TP 2m
\fBname\fR
The name of the access rule policy group. Must be 16 characters or less and
include only alphanumeric characters or '\fI'.
.TP 2m
\fBsquashMode\fR
Squash mode for the access rule.
.RE
.sp
\fBShorthand Example:\fR
.RS 2m
\-\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string \-\-access\-rules=ipAddressRanges=[string],name=string,squashMode=string
.RE
\fBJSON Example:\fR
.RS 2m
\-\-access\-rules='[{"ipAddressRanges": ["string"], "name": "string", "squashMode": "string"}]'
.RE
\fBFile Example:\fR
.RS 2m
\-\-access\-rules=path_to_file.(yaml|json)
.RE
.TP 2m
\fB\-\-default\-squash\-gid\fR=\fRDEFAULT_SQUASH_GID\fI
The user squash GID for the default access rule. This user squash GID applies to
all root users connecting from clients that are not matched by any of the access
rules. If not set, the default is 0 (no GID squash).
.TP 2m
\fB\-\-default\-squash\-uid\fR=\fRDEFAULT_SQUASH_UID\fI
The user squash UID for the default access rule. This user squash UID applies to
all root users connecting from clients that are not matched by any of the access
rules. If not set, the default is 0 (no UID squash).
\fR
.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 "API REFERENCE"
This command uses the \fBlustre/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/managed\-lustre/
.SH "NOTES"
This variant is also available:
.RS 2m
$ gcloud alpha lustre instances create
.RE