- NAME
-
- gcloud compute instance-groups managed create-instance - create a new virtual machine instance in a managed instance group with a defined name and optionally its stateful configuration
- SYNOPSIS
-
-
gcloud compute instance-groups managed create-instanceNAME--instance=INSTANCE[--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE]] [--stateful-external-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]] [--stateful-internal-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]] [--stateful-metadata=KEY=VALUE,[KEY=VALUE,…]] [--region=REGION|--zone=ZONE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
gcloud compute instance-groups managed create-instancecreates a virtual machine instance with a defined name and optionally its stateful configuration: stateful disk, stateful metadata key-values, and stateful IP addresses. Stateful configuration is stored in the corresponding newly created per-instance config. An instance with a per-instance config will preserve its given name, specified disks, specified metadata key-values, and specified internal and external IPs during instance recreation, auto-healing, updates, and any other lifecycle transitions of the instance. - EXAMPLES
-
To create an instance
instance-1inmy-group(in region europe-west4) with metadatamy-key: my-value, a diskdisk-1attached to it as the devicedevice-1, stateful internal IP192.168.0.10on the default interface (nic0), and existing address reservationmy-addressfor stateful external IP on interfacenic1, run:gcloud compute instance-groups managed create-instance my-group --region=europe-west4 --instance=instance-1 --stateful-disk='device-name=foo,source=https://compute.googleapis.com/compute/alpha/projects/my-project/zones/europe-west4/disks/disk-1,mode=rw,auto-delete=on-permanent-instance-deletion' --stateful-metadata='my-key=my-value' --stateful-internal-ip=address=192.168.0.10,auto-delete=on-permanent-instance-deletion --stateful-external-ip=address=/projects/example-project/regions/europe-west4/addresses/my-address,interface-name=nic1 - POSITIONAL ARGUMENTS
-
NAME- Name of the managed instance group to create instance in.
- REQUIRED FLAGS
-
--instance=INSTANCE- Name of the new instance to create.
- OPTIONAL FLAGS
-
--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE]-
Disks considered stateful by the instance group. Managed instance groups
preserve and reattach stateful disks on VM autohealing, update, and recreate
events.
You can also attach and preserve disks, not defined in the group's instance template, to a given instance.
The same disk can be attached to more than one instance but only in read-only mode.
--stateful-external-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]-
Managed instance groups preserve stateful IPs on VM autohealing, update, and
recreate events.
Use this argument multiple times to update more IPs.
If a stateful external IP with the given interface name already exists in the current instance configuration, its properties are replaced by the newly provided ones. Otherwise, a new stateful external IP definition is added to the instance configuration.
interface-name-
(Optional) Network interface name. If omitted, the default network interface
named
nic0*address*::: Static IP address to assign to the instance in one of the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name+ Literal: For example:
130.211.181.55If the provided IP address is not yet reserved, the managed instance group automatically creates the corresponding IP address reservation. If the provided IP address is reserved, the group assigns the reservation to the instance.
auto-delete-
(Optional) Prescribes what should happen to an associated static Address
resource when a VM instance is permanently deleted. Regardless of the value of
the delete rule, stateful IP addresses are always preserved on instance
autohealing, update, and recreation operations. The following options are
available:
-
never -
on-permanent-instance-deletion
-
--stateful-internal-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]-
Managed instance groups preserve stateful IPs on VM autohealing, update, and
recreate events.
Use this argument multiple times to update more IPs.
If a stateful internal IP with the given interface name already exists in the current instance configuration, its properties are replaced by the newly provided ones. Otherwise, a new stateful internal IP definition is added to the instance configuration.
interface-name-
(Optional) Network interface name. If omitted, the default network interface
named
nic0*address*::: Static IP address to assign to the instance in one of the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name+ Literal: For example:
130.211.181.55If the provided IP address is not yet reserved, the managed instance group automatically creates the corresponding IP address reservation. If the provided IP address is reserved, the group assigns the reservation to the instance.
auto-delete-
(Optional) Prescribes what should happen to an associated static Address
resource when a VM instance is permanently deleted. Regardless of the value of
the delete rule, stateful IP addresses are always preserved on instance
autohealing, update, and recreation operations. The following options are
available:
-
never -
on-permanent-instance-deletion
-
--stateful-metadata=KEY=VALUE,[KEY=VALUE,…]-
Additional metadata to be made available to the guest operating system in
addition to the metadata defined in the instance template.
Stateful metadata may be used to define a key/value pair specific for the one given instance to differentiate it from the other instances in the managed instance group.
Stateful metadata key/value pairs are preserved on instance recreation, autohealing, updates, and any other lifecycle transitions of the instance.
Stateful metadata have priority over the metadata defined in the instance template. This means that stateful metadata that is defined for a key that already exists in the instance template overrides the instance template value.
Each metadata entry is a key/value pair separated by an equals sign. Metadata keys must be unique and less than 128 bytes in length. Multiple entries can be passed to this flag, e.g.,
--stateful-metadata key-1=value-1,key-2=value-2,key-3=value-3 -
At most one of these can be specified:
--region=REGION-
Region of the managed instance group to create instance in. If not specified,
you might be prompted to select a region (interactive mode only).
A list of regions can be fetched by running:
gcloud compute regions listOverrides the default
compute/regionproperty value for this command invocation. --zone=ZONE-
Zone of the managed instance group to create instance in. If not specified, you
might be prompted to select a zone (interactive mode only).
A list of zones can be fetched by running:
gcloud compute zones listOverrides the default
compute/zoneproperty value for this command invocation.
- 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 helpfor details. - NOTES
-
These variants are also available:
gcloud alpha compute instance-groups managed create-instancegcloud beta compute instance-groups managed create-instance
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-04 UTC.