get_instance_template_properties
Read-onlyIdempotent
Get instance properties of a Compute Engine instance template. This includes properties such as description, tags, machine type, network interfaces, disks, metadata, service accounts, scheduling options, labels, guest accelerators, reservation affinity, and shielded/confidential instance configurations. Requires project and instance template name as input.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Required. Identifier. Name of the instance template to return. | |
| project | Yes | Required. Project ID for this request. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 <https://www.ietf.org/rfc/rfc1035.txt>. | |
| disks | No | An array of disks that are associated with the instances that are created from these properties. | |
| labels | No | Labels to apply to instances that are created from these properties. | |
| metadata | No | The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata </compute/docs/metadata#project_and_instance_metadata> for more information. | |
| scheduling | No | Specifies the scheduling options for the instances that are created from these properties. | |
| description | No | An optional text description for the instances that are created from these properties. | |
| machineType | No | The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. | |
| canIpForward | No | Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding </vpc/docs/using-routes#canipforward> documentation for more information. | |
| minCpuPlatform | No | Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform </compute/docs/instances/specify-min-cpu-platform>. | |
| serviceAccounts | No | A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. | |
| resourcePolicies | No | Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. | |
| guestAccelerators | No | A list of guest accelerator cards' type and count to use for instances created from these properties. | |
| networkInterfaces | No | An array of network access configurations for this interface. | |
| reservationAffinity | No | Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet. | |
| resourceManagerTags | No | Input only. Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags <https://cloud.google.com/resource-manager/docs/tags/tags-overview>. Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when empty. | |
| localSsdEncryptionMode | No | Specifies which method should be used for encrypting the Local SSDs attached to the VM. | |
| shieldedInstanceConfig | No | Note that for MachineImage, this is not supported yet. | |
| workloadIdentityConfig | No | ||
| advancedMachineFeatures | No | Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet. | |
| keyRevocationActionType | No | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | |
| privateIpv6GoogleAccess | No | The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. | |
| networkPerformanceConfig | No | Note that for MachineImage, this is not supported yet. | |
| confidentialInstanceConfig | No | Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet. |