---
title: "PATCH /v2/{+name}"
method: PATCH
path: "/v2/{+name}"
tags: ["projects"]
---

# PATCH /v2/{+name}

`PATCH /v2/{+name}`

Updates the configurations of a node.

## Path parameters

- `name` string, required

## Query parameters

- `updateMask` string

## Request body

- Node — A TPU instance.
  - `queuedResource` string — Output only. The qualified name of the QueuedResource that requested this Node.
  - `apiVersion` 'API_VERSION_UNSPECIFIED' | 'V1_ALPHA1' | 'V1' | 'V2_ALPHA1' | 'V2' — Output only. The API version that created this Node.
  - `healthDescription` string — Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
  - `serviceAccount` ServiceAccount — A service account.
    - `email` string — Email address of the service account. If empty, default Compute service account will be used.
    - `scope` string[] — The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed.
  - `networkConfigs` NetworkConfig[] — Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
    - `subnetwork` string — The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
    - `canIpForward` boolean — Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
    - `queueCount` integer — Optional. Specifies networking queue count for TPU VM instance's network interface.
    - `network` string — The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
    - `enableExternalIps` boolean — Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
  - `schedulingConfig` SchedulingConfig — Sets the scheduling options for this node.
    - `preemptible` boolean — Defines whether the node is preemptible.
    - `spot` boolean — Optional. Defines whether the node is Spot VM.
    - `reserved` boolean — Whether the node is created under a reservation.
  - `description` string — The user-supplied description of the TPU. Maximum of 512 characters.
  - `acceleratorType` string — Optional. The type of hardware accelerators associated with this node.
  - `health` 'HEALTH_UNSPECIFIED' | 'HEALTHY' | 'TIMEOUT' | 'UNHEALTHY_TENSORFLOW' | 'UNHEALTHY_MAINTENANCE' — The health status of the TPU node.
  - `metadata` object — Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
  - `dataDisks` AttachedDisk[] — The additional data disks for the Node.
    - `sourceDisk` string — Specifies the full path to an existing disk. For example: "projects/my-project/zones/us-central1-c/disks/my-disk".
    - `mode` 'DISK_MODE_UNSPECIFIED' | 'READ_WRITE' | 'READ_ONLY' — The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks.
  - `symptoms` Symptom[] — Output only. The Symptoms that have occurred to the TPU Node.
    - `symptomType` 'SYMPTOM_TYPE_UNSPECIFIED' | 'LOW_MEMORY' | 'OUT_OF_MEMORY' | 'EXECUTE_TIMED_OUT' | 'MESH_BUILD_FAIL' | 'HBM_OUT_OF_MEMORY' | 'PROJECT_ABUSE' — Type of the Symptom.
    - `details` string — Detailed information of the current Symptom.
    - `workerId` string — A string used to uniquely distinguish a worker within a TPU node.
    - `createTime` string, google-datetime — Timestamp when the Symptom is created.
  - `networkConfig` NetworkConfig — Network related configurations.
    - `subnetwork` string — The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
    - `canIpForward` boolean — Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
    - `queueCount` integer — Optional. Specifies networking queue count for TPU VM instance's network interface.
    - `network` string — The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
    - `enableExternalIps` boolean — Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
  - `id` string, int64 — Output only. The unique identifier for the TPU Node.
  - `upcomingMaintenance` UpcomingMaintenance — Upcoming Maintenance notification information.
    - `type` 'UNKNOWN_TYPE' | 'SCHEDULED' | 'UNSCHEDULED' — Defines the type of maintenance.
    - `windowStartTime` string — The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
    - `windowEndTime` string — The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
    - `canReschedule` boolean — Indicates if the maintenance can be customer triggered.
    - `latestWindowStartTime` string — The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
    - `maintenanceStatus` 'UNKNOWN' | 'PENDING' | 'ONGOING' — The status of the maintenance.
  - `shieldedInstanceConfig` ShieldedInstanceConfig — A set of Shielded Instance options.
    - `enableSecureBoot` boolean — Defines whether the instance has Secure Boot enabled.
  - `multisliceNode` boolean — Output only. Whether the Node belongs to a Multislice group.
  - `runtimeVersion` string — Required. The runtime version running in the Node.
  - `name` string — Output only. Immutable. The name of the TPU.
  - `cidrBlock` string — The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
  - `bootDiskConfig` BootDiskConfig — Sets the boot disk configuration for the TPU node.
    - `customerEncryptionKey` CustomerEncryptionKey — Defines the customer encryption key for disk encryption.
      - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1
  - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'RESTARTING' | 'REIMAGING' | 'DELETING' | 'REPAIRING' | 'STOPPED' | 'STOPPING' | 'STARTING' | 'PREEMPTED' | 'TERMINATED' | 'HIDING' | 'HIDDEN' | 'UNHIDING' | 'UNKNOWN' — Output only. The current state for the TPU Node.
  - `networkEndpoints` NetworkEndpoint[] — Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
    - `ipAddress` string — The internal IP address of this network endpoint.
    - `accessConfig` AccessConfig — An access config attached to the TPU worker.
      - `externalIp` string — Output only. An external IP address associated with the TPU worker.
    - `port` integer — The port of this network endpoint.
  - `createTime` string, google-datetime — Output only. The time when the node was created.
  - `tags` string[] — Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
  - `labels` object — Resource labels to represent user-provided metadata.
  - `acceleratorConfig` AcceleratorConfig — A TPU accelerator configuration.
    - `type` 'TYPE_UNSPECIFIED' | 'V2' | 'V3' | 'V4' | 'V5LITE_POD' | 'V5P' | 'V6E' — Required. Type of TPU.
    - `topology` string — Required. Topology of TPU in chips.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/tpu.md) · [All operations](https://skmtc.dev/google/apis/tpu/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/tpu/revisions/69103b5673a3/schema)