nodes

Creates, updates, deletes, gets or lists a nodes resource.

Overview

Name	nodes
Type	Resource
Id	google.tpu.nodes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (int64)	Output only. The unique identifier for the TPU Node.
name	string	Output only. Immutable. The name of the TPU.
acceleratorConfig	object	The AccleratorConfig for the TPU Node. (id: AcceleratorConfig)
acceleratorType	string	Optional. The type of hardware accelerators associated with this node.
apiVersion	string	Output only. The API version that created this Node.
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.
createTime	string (google-datetime)	Output only. The time when the node was created.
dataDisks	array	The additional data disks for the Node.
description	string	The user-supplied description of the TPU. Maximum of 512 characters.
health	string	The health status of the TPU node.
healthDescription	string	Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
labels	object	Resource labels to represent user-provided metadata.
metadata	object	Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
multisliceNode	boolean	Output only. Whether the Node belongs to a Multislice group.
networkConfig	object	Network configurations 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. (id: NetworkConfig)
networkConfigs	array	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.
networkEndpoints	array	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.
queuedResource	string	Output only. The qualified name of the QueuedResource that requested this Node.
runtimeVersion	string	Required. The runtime version running in the Node.
schedulingConfig	object	The scheduling options for this node. (id: SchedulingConfig)
serviceAccount	object	The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used. (id: ServiceAccount)
shieldedInstanceConfig	object	Shielded Instance options. (id: ShieldedInstanceConfig)
state	string	Output only. The current state for the TPU Node.
symptoms	array	Output only. The Symptoms that have occurred to the TPU Node.
tags	array	Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
upcomingMaintenance	object	Output only. Upcoming maintenance on this TPU node. (id: UpcomingMaintenance)

list

Successful response

Name	Datatype	Description
id	string (int64)	Output only. The unique identifier for the TPU Node.
name	string	Output only. Immutable. The name of the TPU.
acceleratorConfig	object	The AccleratorConfig for the TPU Node. (id: AcceleratorConfig)
acceleratorType	string	Optional. The type of hardware accelerators associated with this node.
apiVersion	string	Output only. The API version that created this Node.
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.
createTime	string (google-datetime)	Output only. The time when the node was created.
dataDisks	array	The additional data disks for the Node.
description	string	The user-supplied description of the TPU. Maximum of 512 characters.
health	string	The health status of the TPU node.
healthDescription	string	Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
labels	object	Resource labels to represent user-provided metadata.
metadata	object	Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
multisliceNode	boolean	Output only. Whether the Node belongs to a Multislice group.
networkConfig	object	Network configurations 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. (id: NetworkConfig)
networkConfigs	array	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.
networkEndpoints	array	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.
queuedResource	string	Output only. The qualified name of the QueuedResource that requested this Node.
runtimeVersion	string	Required. The runtime version running in the Node.
schedulingConfig	object	The scheduling options for this node. (id: SchedulingConfig)
serviceAccount	object	The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used. (id: ServiceAccount)
shieldedInstanceConfig	object	Shielded Instance options. (id: ShieldedInstanceConfig)
state	string	Output only. The current state for the TPU Node.
symptoms	array	Output only. The Symptoms that have occurred to the TPU Node.
tags	array	Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
upcomingMaintenance	object	Output only. Upcoming maintenance on this TPU node. (id: UpcomingMaintenance)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, nodesId		Gets the details of a node.
list	select	projectsId, locationsId	pageSize, pageToken	Lists nodes.
create	insert	projectsId, locationsId	nodeId	Creates a node.
patch	update	projectsId, locationsId, nodesId	updateMask	Updates the configurations of a node.
delete	delete	projectsId, locationsId, nodesId		Deletes a node.
stop	exec	projectsId, locationsId, nodesId		Stops a node. This operation is only available with single TPU nodes.
start	exec	projectsId, locationsId, nodesId		Starts a node.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
nodesId	string
projectsId	string
nodeId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a node.

SELECT
id,
name,
acceleratorConfig,
acceleratorType,
apiVersion,
cidrBlock,
createTime,
dataDisks,
description,
health,
healthDescription,
labels,
metadata,
multisliceNode,
networkConfig,
networkConfigs,
networkEndpoints,
queuedResource,
runtimeVersion,
schedulingConfig,
serviceAccount,
shieldedInstanceConfig,
state,
symptoms,
tags,
upcomingMaintenance
FROM google.tpu.nodes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND nodesId = '{{ nodesId }}' -- required;

list

Lists nodes.

SELECT
id,
name,
acceleratorConfig,
acceleratorType,
apiVersion,
cidrBlock,
createTime,
dataDisks,
description,
health,
healthDescription,
labels,
metadata,
multisliceNode,
networkConfig,
networkConfigs,
networkEndpoints,
queuedResource,
runtimeVersion,
schedulingConfig,
serviceAccount,
shieldedInstanceConfig,
state,
symptoms,
tags,
upcomingMaintenance
FROM google.tpu.nodes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a node.

INSERT INTO google.tpu.nodes (
data__description,
data__acceleratorType,
data__runtimeVersion,
data__networkConfig,
data__networkConfigs,
data__cidrBlock,
data__serviceAccount,
data__schedulingConfig,
data__health,
data__labels,
data__metadata,
data__tags,
data__dataDisks,
data__shieldedInstanceConfig,
data__acceleratorConfig,
projectsId,
locationsId,
nodeId
)
SELECT 
'{{ description }}',
'{{ acceleratorType }}',
'{{ runtimeVersion }}',
'{{ networkConfig }}',
'{{ networkConfigs }}',
'{{ cidrBlock }}',
'{{ serviceAccount }}',
'{{ schedulingConfig }}',
'{{ health }}',
'{{ labels }}',
'{{ metadata }}',
'{{ tags }}',
'{{ dataDisks }}',
'{{ shieldedInstanceConfig }}',
'{{ acceleratorConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ nodeId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: nodes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the nodes resource.
    - name: locationsId
      value: string
      description: Required parameter for the nodes resource.
    - name: description
      value: string
      description: >
        The user-supplied description of the TPU. Maximum of 512 characters.
        
    - name: acceleratorType
      value: string
      description: >
        Optional. The type of hardware accelerators associated with this node.
        
    - name: runtimeVersion
      value: string
      description: >
        Required. The runtime version running in the Node.
        
    - name: networkConfig
      value: object
      description: >
        Network configurations 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.
        
    - name: networkConfigs
      value: array
      description: >
        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.
        
    - name: cidrBlock
      value: string
      description: >
        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.
        
    - name: serviceAccount
      value: object
      description: >
        The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
        
    - name: schedulingConfig
      value: object
      description: >
        The scheduling options for this node.
        
    - name: health
      value: string
      description: >
        The health status of the TPU node.
        
      valid_values: ['HEALTH_UNSPECIFIED', 'HEALTHY', 'TIMEOUT', 'UNHEALTHY_TENSORFLOW', 'UNHEALTHY_MAINTENANCE']
    - name: labels
      value: object
      description: >
        Resource labels to represent user-provided metadata.
        
    - name: metadata
      value: object
      description: >
        Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
        
    - name: tags
      value: array
      description: >
        Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
        
    - name: dataDisks
      value: array
      description: >
        The additional data disks for the Node.
        
    - name: shieldedInstanceConfig
      value: object
      description: >
        Shielded Instance options.
        
    - name: acceleratorConfig
      value: object
      description: >
        The AccleratorConfig for the TPU Node.
        
    - name: nodeId
      value: string

UPDATE examples

patch

Updates the configurations of a node.

UPDATE google.tpu.nodes
SET 
data__description = '{{ description }}',
data__acceleratorType = '{{ acceleratorType }}',
data__runtimeVersion = '{{ runtimeVersion }}',
data__networkConfig = '{{ networkConfig }}',
data__networkConfigs = '{{ networkConfigs }}',
data__cidrBlock = '{{ cidrBlock }}',
data__serviceAccount = '{{ serviceAccount }}',
data__schedulingConfig = '{{ schedulingConfig }}',
data__health = '{{ health }}',
data__labels = '{{ labels }}',
data__metadata = '{{ metadata }}',
data__tags = '{{ tags }}',
data__dataDisks = '{{ dataDisks }}',
data__shieldedInstanceConfig = '{{ shieldedInstanceConfig }}',
data__acceleratorConfig = '{{ acceleratorConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND nodesId = '{{ nodesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a node.

DELETE FROM google.tpu.nodes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND nodesId = '{{ nodesId }}' --required;

Lifecycle Methods

stop

Stops a node. This operation is only available with single TPU nodes.

EXEC google.tpu.nodes.stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@nodesId='{{ nodesId }}' --required;

start

Starts a node.

EXEC google.tpu.nodes.start 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@nodesId='{{ nodesId }}' --required;