1. Packages
  2. Google Cloud Native
  3. API Docs
  4. tpu
  5. tpu/v1
  6. getNode

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.tpu/v1.getNode

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Gets the details of a node.

    Using getNode

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNode(args: GetNodeArgs, opts?: InvokeOptions): Promise<GetNodeResult>
    function getNodeOutput(args: GetNodeOutputArgs, opts?: InvokeOptions): Output<GetNodeResult>
    def get_node(location: Optional[str] = None,
                 node_id: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNodeResult
    def get_node_output(location: Optional[pulumi.Input[str]] = None,
                 node_id: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNodeResult]
    func LookupNode(ctx *Context, args *LookupNodeArgs, opts ...InvokeOption) (*LookupNodeResult, error)
    func LookupNodeOutput(ctx *Context, args *LookupNodeOutputArgs, opts ...InvokeOption) LookupNodeResultOutput

    > Note: This function is named LookupNode in the Go SDK.

    public static class GetNode 
    {
        public static Task<GetNodeResult> InvokeAsync(GetNodeArgs args, InvokeOptions? opts = null)
        public static Output<GetNodeResult> Invoke(GetNodeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNodeResult> getNode(GetNodeArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:tpu/v1:getNode
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Location string
    NodeId string
    Project string
    Location string
    NodeId string
    Project string
    location String
    nodeId String
    project String
    location string
    nodeId string
    project string
    location String
    nodeId String
    project String

    getNode Result

    The following output properties are available:

    AcceleratorType string
    The type of hardware accelerators associated with this node.
    ApiVersion string
    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
    The time when the node was created.
    Description string
    The user-supplied description of the TPU. Maximum of 512 characters.
    Health string
    The health status of the TPU node.
    HealthDescription string
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    IpAddress string
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Labels Dictionary<string, string>
    Resource labels to represent user-provided metadata.
    Name string
    Immutable. The name of the TPU
    Network string
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    NetworkEndpoints List<Pulumi.GoogleNative.TPU.V1.Outputs.NetworkEndpointResponse>
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    Port string
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    SchedulingConfig Pulumi.GoogleNative.TPU.V1.Outputs.SchedulingConfigResponse
    The scheduling options for this node.
    ServiceAccount string
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    State string
    The current state for the TPU Node.
    Symptoms List<Pulumi.GoogleNative.TPU.V1.Outputs.SymptomResponse>
    The Symptoms that have occurred to the TPU Node.
    TensorflowVersion string
    The version of Tensorflow running in the Node.
    UseServiceNetworking bool
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    AcceleratorType string
    The type of hardware accelerators associated with this node.
    ApiVersion string
    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
    The time when the node was created.
    Description string
    The user-supplied description of the TPU. Maximum of 512 characters.
    Health string
    The health status of the TPU node.
    HealthDescription string
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    IpAddress string
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Labels map[string]string
    Resource labels to represent user-provided metadata.
    Name string
    Immutable. The name of the TPU
    Network string
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    NetworkEndpoints []NetworkEndpointResponse
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    Port string
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    SchedulingConfig SchedulingConfigResponse
    The scheduling options for this node.
    ServiceAccount string
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    State string
    The current state for the TPU Node.
    Symptoms []SymptomResponse
    The Symptoms that have occurred to the TPU Node.
    TensorflowVersion string
    The version of Tensorflow running in the Node.
    UseServiceNetworking bool
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    acceleratorType String
    The type of hardware accelerators associated with this node.
    apiVersion String
    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
    The time when the node was created.
    description String
    The user-supplied description of the TPU. Maximum of 512 characters.
    health String
    The health status of the TPU node.
    healthDescription String
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    ipAddress String
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    labels Map<String,String>
    Resource labels to represent user-provided metadata.
    name String
    Immutable. The name of the TPU
    network String
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    networkEndpoints List<NetworkEndpointResponse>
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    port String
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    schedulingConfig SchedulingConfigResponse
    The scheduling options for this node.
    serviceAccount String
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    state String
    The current state for the TPU Node.
    symptoms List<SymptomResponse>
    The Symptoms that have occurred to the TPU Node.
    tensorflowVersion String
    The version of Tensorflow running in the Node.
    useServiceNetworking Boolean
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    acceleratorType string
    The type of hardware accelerators associated with this node.
    apiVersion string
    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
    The time when the node was created.
    description string
    The user-supplied description of the TPU. Maximum of 512 characters.
    health string
    The health status of the TPU node.
    healthDescription string
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    ipAddress string
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    labels {[key: string]: string}
    Resource labels to represent user-provided metadata.
    name string
    Immutable. The name of the TPU
    network string
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    networkEndpoints NetworkEndpointResponse[]
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    port string
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    schedulingConfig SchedulingConfigResponse
    The scheduling options for this node.
    serviceAccount string
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    state string
    The current state for the TPU Node.
    symptoms SymptomResponse[]
    The Symptoms that have occurred to the TPU Node.
    tensorflowVersion string
    The version of Tensorflow running in the Node.
    useServiceNetworking boolean
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    accelerator_type str
    The type of hardware accelerators associated with this node.
    api_version str
    The API version that created this Node.
    cidr_block str
    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.
    create_time str
    The time when the node was created.
    description str
    The user-supplied description of the TPU. Maximum of 512 characters.
    health str
    The health status of the TPU node.
    health_description str
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    ip_address str
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    labels Mapping[str, str]
    Resource labels to represent user-provided metadata.
    name str
    Immutable. The name of the TPU
    network str
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    network_endpoints Sequence[NetworkEndpointResponse]
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    port str
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    scheduling_config SchedulingConfigResponse
    The scheduling options for this node.
    service_account str
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    state str
    The current state for the TPU Node.
    symptoms Sequence[SymptomResponse]
    The Symptoms that have occurred to the TPU Node.
    tensorflow_version str
    The version of Tensorflow running in the Node.
    use_service_networking bool
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    acceleratorType String
    The type of hardware accelerators associated with this node.
    apiVersion String
    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
    The time when the node was created.
    description String
    The user-supplied description of the TPU. Maximum of 512 characters.
    health String
    The health status of the TPU node.
    healthDescription String
    If this field is populated, it contains a description of why the TPU Node is unhealthy.
    ipAddress String
    DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

    labels Map<String>
    Resource labels to represent user-provided metadata.
    name String
    Immutable. The name of the TPU
    network String
    The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
    networkEndpoints List<Property Map>
    The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    port String
    DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    Deprecated: Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

    schedulingConfig Property Map
    The scheduling options for this node.
    serviceAccount String
    The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
    state String
    The current state for the TPU Node.
    symptoms List<Property Map>
    The Symptoms that have occurred to the TPU Node.
    tensorflowVersion String
    The version of Tensorflow running in the Node.
    useServiceNetworking Boolean
    Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.

    Supporting Types

    NetworkEndpointResponse

    IpAddress string
    The IP address of this network endpoint.
    Port int
    The port of this network endpoint.
    IpAddress string
    The IP address of this network endpoint.
    Port int
    The port of this network endpoint.
    ipAddress String
    The IP address of this network endpoint.
    port Integer
    The port of this network endpoint.
    ipAddress string
    The IP address of this network endpoint.
    port number
    The port of this network endpoint.
    ip_address str
    The IP address of this network endpoint.
    port int
    The port of this network endpoint.
    ipAddress String
    The IP address of this network endpoint.
    port Number
    The port of this network endpoint.

    SchedulingConfigResponse

    Preemptible bool
    Defines whether the node is preemptible.
    Reserved bool
    Whether the node is created under a reservation.
    Preemptible bool
    Defines whether the node is preemptible.
    Reserved bool
    Whether the node is created under a reservation.
    preemptible Boolean
    Defines whether the node is preemptible.
    reserved Boolean
    Whether the node is created under a reservation.
    preemptible boolean
    Defines whether the node is preemptible.
    reserved boolean
    Whether the node is created under a reservation.
    preemptible bool
    Defines whether the node is preemptible.
    reserved bool
    Whether the node is created under a reservation.
    preemptible Boolean
    Defines whether the node is preemptible.
    reserved Boolean
    Whether the node is created under a reservation.

    SymptomResponse

    CreateTime string
    Timestamp when the Symptom is created.
    Details string
    Detailed information of the current Symptom.
    SymptomType string
    Type of the Symptom.
    WorkerId string
    A string used to uniquely distinguish a worker within a TPU node.
    CreateTime string
    Timestamp when the Symptom is created.
    Details string
    Detailed information of the current Symptom.
    SymptomType string
    Type of the Symptom.
    WorkerId string
    A string used to uniquely distinguish a worker within a TPU node.
    createTime String
    Timestamp when the Symptom is created.
    details String
    Detailed information of the current Symptom.
    symptomType String
    Type of the Symptom.
    workerId String
    A string used to uniquely distinguish a worker within a TPU node.
    createTime string
    Timestamp when the Symptom is created.
    details string
    Detailed information of the current Symptom.
    symptomType string
    Type of the Symptom.
    workerId string
    A string used to uniquely distinguish a worker within a TPU node.
    create_time str
    Timestamp when the Symptom is created.
    details str
    Detailed information of the current Symptom.
    symptom_type str
    Type of the Symptom.
    worker_id str
    A string used to uniquely distinguish a worker within a TPU node.
    createTime String
    Timestamp when the Symptom is created.
    details String
    Detailed information of the current Symptom.
    symptomType String
    Type of the Symptom.
    workerId String
    A string used to uniquely distinguish a worker within a TPU node.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi