File: //snap/google-cloud-cli/396/help/man/man1/gcloud_compute_tpus_queued-resources_create.1
.TH "GCLOUD_COMPUTE_TPUS_QUEUED\-RESOURCES_CREATE" 1
.SH "NAME"
.HP
gcloud compute tpus queued\-resources create \- create a Queued Resource
.SH "SYNOPSIS"
.HP
\f5gcloud compute tpus queued\-resources create\fR (\fIQUEUED_RESOURCE\fR\ :\ \fB\-\-zone\fR=\fIZONE\fR) \fB\-\-runtime\-version\fR=\fIRUNTIME_VERSION\fR (\fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR\ |\ \fB\-\-topology\fR=\fITOPOLOGY\fR\ \fB\-\-type\fR=\fITYPE\fR) (\fB\-\-node\-id\fR=\fINODE_ID\fR\ |\ [\fB\-\-node\-count\fR=\fINODE_COUNT\fR\ :\ \fB\-\-node\-prefix\fR=\fINODE_PREFIX\fR]) [\fB\-\-async\fR] [\fB\-\-boot\-disk\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-data\-disk\fR=[\fImode\fR=\fIMODE\fR],[\fIsource\fR=\fISOURCE\fR]] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-guaranteed\fR] [\fB\-\-internal\-ips\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-metadata\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-metadata\-from\-file\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-network\fR=\fINETWORK\fR;\ default="default"] [\fB\-\-range\fR=\fIRANGE\fR] [\fB\-\-reserved\fR] [\fB\-\-scopes\fR=[\fISCOPES\fR,...]] [\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR] [\fB\-\-shielded\-secure\-boot\fR] [\fB\-\-spot\fR] [\fB\-\-subnetwork\fR=\fISUBNETWORK\fR] [\fB\-\-tags\fR=[\fITAGS\fR,...]] [\fB\-\-valid\-after\-duration\fR=\fIVALID_AFTER_DURATION\fR] [\fB\-\-valid\-after\-time\fR=\fIVALID_AFTER_TIME\fR] [\fB\-\-valid\-until\-duration\fR=\fIVALID_UNTIL_DURATION\fR] [\fB\-\-valid\-until\-time\fR=\fIVALID_UNTIL_TIME\fR] [\fB\-\-reservation\-host\-folder\fR=\fIRESERVATION_HOST_FOLDER\fR\ \fB\-\-reservation\-host\-organization\fR=\fIRESERVATION_HOST_ORGANIZATION\fR\ \fB\-\-reservation\-host\-project\fR=\fIRESERVATION_HOST_PROJECT\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Create a new Queued Resource with the specified attributes.
.SH "EXAMPLES"
To create a Queued Resource with ID \f5my\-queued\-resource\fR in zone
\f5us\-central2\-b\fR and project \f5my\-project\fR, run:
.RS 2m
$ gcloud compute tpus queued\-resources create my\-queued\-resource \e
\-\-accelerator\-type=v4\-8 \-\-runtime\-version=v2\-alpha\-tpuv4 \e
\-\-node\-id=my\-node\-001 \-\-zone=us\-central2\-b \-\-project=my\-project
.RE
To create a Queued Resource with multiple nodes, run:
.RS 2m
$ gcloud compute tpus queued\-resources create my\-queued\-resource \e
\-\-accelerator\-type=v4\-8 \-\-runtime\-version=v2\-alpha\-tpuv4 \e
\-\-node\-count=2 \-\-zone=us\-central2\-b \-\-project=my\-project
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Queued resource resource \- The Queued Resource you want 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 \f5queued_resource\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
\fIQUEUED_RESOURCE\fR
ID of the queued_resource or fully qualified identifier for the queued_resource.
To set the \f5queued_resource\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5queued_resource\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 compute/zone of the Cloud TPU.
If not specified, will use \f5default\fR compute/zone.
To set the \f5zone\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5queued_resource\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
set the property \f5compute/zone\fR.
.RE
.sp
.RE
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
\fB\-\-runtime\-version\fR=\fIRUNTIME_VERSION\fR
Runtime version for the TPU, such as \f5tpu\-ubuntu2204\-base\fR.
.TP 2m
Specify a chip\-based or core\-based TPU node.
Exactly one of these must be specified:
.RS 2m
.TP 2m
Core\-based TPU configuration
.RS 2m
.TP 2m
\fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR
Accelerator type for the TPU.
.RE
.sp
.TP 2m
Chip\-based TPU configuration
.RS 2m
.TP 2m
\fB\-\-topology\fR=\fITOPOLOGY\fR
Chip topology for TPU.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-type\fR=\fITYPE\fR
Type of TPU. \fITYPE\fR must be one of: \fBv2\fR, \fBv3\fR, \fBv4\fR.
This flag argument must be specified if any of the other arguments in this group
are specified.
.RE
.RE
.sp
.TP 2m
Specify TPU node(s) with either a single node id or a node count and an optional
node prefix
Exactly one of these must be specified:
.RS 2m
.TP 2m
Single node creation
.RS 2m
.TP 2m
\fB\-\-node\-id\fR=\fINODE_ID\fR
Unqualified node identifier used to identify the node in the project once
provisioned.
To request a resource with multiple nodes, in place of \f5\-\-node\-id\fR, use
\f5\-\-node\-count\fR to specify the number of nodes and optionally use
\f5\-\-node\-prefix\fR to specify the prefix for each node.
.RE
.sp
.TP 2m
Multinode creation
.RS 2m
.TP 2m
\fB\-\-node\-count\fR=\fINODE_COUNT\fR
The number of nodes in a multislice provision, also used to generate the
qualified name for nodes in the provision. Value must be greater than 1.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-node\-prefix\fR=\fINODE_PREFIX\fR
Node prefix used to generate the qualified name of each node the multislice node
provision. If not supplied, the queued resource id will be used as the prefix.
Must also specify \f5\-\-node\-count\fR.
.RE
.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\-\-boot\-disk\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Specifies the boot disk configuration.
.RS 2m
$ gcloud compute tpus queued\-resources create \e
\-\-boot\-disk kms\-key=<full_kms_key_name_here>
.RE
The following keys are allowed:
.RS 2m
.TP 2m
\fBkms\-key\fR
Specifies the fully qualified Cloud KMS cryptokey name which will be used to
protect the disk. KMS cryptokey name format:
projects/<kms\-project>/locations/<kms\-location>/keyRings/<kms\-keyring>/cryptoKeys/<key\-name>
.RE
.sp
.TP 2m
\fB\-\-data\-disk\fR=[\fImode\fR=\fIMODE\fR],[\fIsource\fR=\fISOURCE\fR]
Additional data disks for the TPU VM.
This flag must be repeated to provide multiple data disks. For example:
.RS 2m
$ gcloud compute tpus queued\-resources create \e
\-\-data\-disk \e
source=projects/my\-project/zones/us\-central1\-c/disks/my\-disk,\e
mode=read\-only
.RE
The following keys are allowed:
.RS 2m
.TP 2m
\fBsource\fR
Specifies the full path to an existing disk. Required. The disk must be in the
same zone.
.TP 2m
\fBmode\fR
Specifies the mode in which to attach this disk. Valid options are
\'read\-write', 'read\-only'. If not specified, the default is 'read\-write'.
.RE
.sp
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
Text description of the TPU.
.TP 2m
\fB\-\-guaranteed\fR
If provided, the Node requested here will only be scheduled at the 'guaranteed'
tier.
.TP 2m
\fB\-\-internal\-ips\fR
Indicates that the IP addresses for the node should be internal. The default is
that external IP addresses will be associated with the TPU workers.
.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Resource labels to represent user\-provided metadata. See
https://cloud.google.com/compute/docs/labeling\-resources for details.
.TP 2m
\fB\-\-metadata\fR=[\fIKEY\fR=\fIVALUE\fR,...]
List of comma\-separated metadata key\-value pairs for the Cloud TPU VM node.
Example: \f5\-\-metadata='key1=value1,key2=value2'\fR
.TP 2m
\fB\-\-metadata\-from\-file\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Same as \f5\-\-metadata\fR except the value for the entry will be read from a
local file. Example: \f5\-\-metadata\-from\-file='key1=value1.txt'\fR
.TP 2m
\fB\-\-network\fR=\fINETWORK\fR; default="default"
Network that this TPU will be a part of.
.TP 2m
\fB\-\-range\fR=\fIRANGE\fR
CIDR range for the TPU.
The IP range that the TPU will select an IP address from. Must be in CIDR
notation and a \f5/29\fR range, for example \f5192.168.0.0/29\fR. Errors will
occur if the CIDR range has already been used for a currently existing TPU, the
CIDR range conflicts with any networks in the user's provided network, or the
provided network is peered with another network that is using that CIDR range.
.TP 2m
\fB\-\-reserved\fR
Specifies the request should be scheduled on reserved capacity.
If \f5\-\-reservation\-host\-project\fR, \f5\-\-reservation\-host\-folder\fR, or
\f5\-\-reservation\-host\-organization\fR are present then this flag has no
effect.
.TP 2m
\fB\-\-scopes\fR=[\fISCOPES\fR,...]
List of comma\-separated scopes to be made available for the service account.
.TP 2m
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR
Email address of the service account. If empty, default Google Compute Engine
service account will be used.
.TP 2m
\fB\-\-shielded\-secure\-boot\fR
Specifies that the TPU instances are created with secure boot enabled. This
implicitly makes them Shielded VM instances.
.TP 2m
\fB\-\-spot\fR
If provided, the Node requested here will be created as Spot VMs.
.TP 2m
\fB\-\-subnetwork\fR=\fISUBNETWORK\fR
Subnetwork that this TPU will be a part of.
.TP 2m
\fB\-\-tags\fR=[\fITAGS\fR,...]
Tags to apply to the TPU Node. Tags are used to identify valid sources or
targets for network firewalls. See
https://cloud.google.com/vpc/docs/add\-remove\-network\-tags for more details.
.TP 2m
\fB\-\-valid\-after\-duration\fR=\fIVALID_AFTER_DURATION\fR
A duration before which the TPU must not be provisioned, relative to the current
time. See $ gcloud topic datetimes for information on duration formats.
.TP 2m
\fB\-\-valid\-after\-time\fR=\fIVALID_AFTER_TIME\fR
An absolute time before which the TPU must not be provisioned. See $ gcloud
topic datetimes for information on duration formats.
.TP 2m
\fB\-\-valid\-until\-duration\fR=\fIVALID_UNTIL_DURATION\fR
A duration after which the TPU must not be provisioned, relative to the current
time. See $ gcloud topic datetimes for information on duration formats.
.TP 2m
\fB\-\-valid\-until\-time\fR=\fIVALID_UNTIL_TIME\fR
An absolute time after which resources must not be created. See $ gcloud topic
datetimes for information on duration formats.
.TP 2m
\fB\-\-reservation\-host\-folder\fR=\fIRESERVATION_HOST_FOLDER\fR
The folder hosting the reservation that the TPU should use. Only one reservation
host entity may be specified.
.TP 2m
\fB\-\-reservation\-host\-organization\fR=\fIRESERVATION_HOST_ORGANIZATION\fR
The organization hosting the reservation that the TPU should use. Only one
reservation host entity may be specified.
.TP 2m
\fB\-\-reservation\-host\-project\fR=\fIRESERVATION_HOST_PROJECT\fR
The project hosting the reservation that the TPU should use. Only one
reservation host entity may be specified.
.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 \fBtpu/v2\fR API. The full documentation for this API can
be found at: https://cloud.google.com/tpu/
.SH "NOTES"
This variant is also available:
.RS 2m
$ gcloud alpha compute tpus queued\-resources create
.RE