getNode

Nomad v2.6.1, Apr 21 26

Viewing docs for Nomad v2.6.1
published on Tuesday, Apr 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-nomad

Viewing docs for Nomad v2.6.1
published on Tuesday, Apr 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-nomad

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nomad from "@pulumi/nomad";

const myNode = nomad.getNode({
    nodeId: "abc123",
});

import pulumi
import pulumi_nomad as nomad

my_node = nomad.get_node(node_id="abc123")

package main

import (
	"github.com/pulumi/pulumi-nomad/sdk/v2/go/nomad"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nomad.GetNode(ctx, &nomad.GetNodeArgs{
			NodeId: "abc123",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nomad = Pulumi.Nomad;

return await Deployment.RunAsync(() => 
{
    var myNode = Nomad.Index.GetNode.Invoke(new()
    {
        NodeId = "abc123",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nomad.NomadFunctions;
import com.pulumi.nomad.inputs.GetNodeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myNode = NomadFunctions.getNode(GetNodeArgs.builder()
            .nodeId("abc123")
            .build());

    }
}

variables:
  myNode:
    fn::invoke:
      function: nomad:getNode
      arguments:
        nodeId: abc123

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(node_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetNodeResult
def get_node_output(node_id: pulumi.Input[Optional[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetNodeResult]

func GetNode(ctx *Context, args *GetNodeArgs, opts ...InvokeOption) (*GetNodeResult, error)
func GetNodeOutput(ctx *Context, args *GetNodeOutputArgs, opts ...InvokeOption) GetNodeResultOutput

> Note: This function is named GetNode 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)
public static Output<GetNodeResult> getNode(GetNodeArgs args, InvokeOptions options)

fn::invoke:
  function: nomad:index/getNode:getNode
  arguments:
    # arguments dictionary

The following arguments are supported:

NodeId string: (string: <required>) - The ID of the node to look up.

NodeId string: (string: <required>) - The ID of the node to look up.

nodeId String: (string: <required>) - The ID of the node to look up.

nodeId string: (string: <required>) - The ID of the node to look up.

node_id str: (string: <required>) - The ID of the node to look up.

nodeId String: (string: <required>) - The ID of the node to look up.

getNode Result

The following output properties are available:

Attributes Dictionary<string, string>: (map of string) - Driver-specific attributes.
Datacenter string: (string) - The datacenter of the node.
Drain bool: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
Drivers List<GetNodeDriver>: (list) - A list of driver information for the node.
HostVolumes List<GetNodeHostVolume>: (list) - A list of host volumes on the node.
HttpAddr string: (string) - The HTTP address of the node.
Id string: The provider-assigned unique ID for this managed resource.
Meta Dictionary<string, string>: (map of string) - A map of metadata for the node.
Name string: (string) - The device name.
NodeClass string: (string) - The node class of the node.
NodeId string
NodePool string: (string) - The node pool of the node.
NodeResources List<GetNodeNodeResource>: (list) - Resources available on the node.
ReservedResources List<GetNodeReservedResource>: (list) - Resources reserved on the node.
SchedulingEligibility string: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
Status string: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
StatusDescription string: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

Attributes map[string]string: (map of string) - Driver-specific attributes.
Datacenter string: (string) - The datacenter of the node.
Drain bool: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
Drivers []GetNodeDriver: (list) - A list of driver information for the node.
HostVolumes []GetNodeHostVolume: (list) - A list of host volumes on the node.
HttpAddr string: (string) - The HTTP address of the node.
Id string: The provider-assigned unique ID for this managed resource.
Meta map[string]string: (map of string) - A map of metadata for the node.
Name string: (string) - The device name.
NodeClass string: (string) - The node class of the node.
NodeId string
NodePool string: (string) - The node pool of the node.
NodeResources []GetNodeNodeResource: (list) - Resources available on the node.
ReservedResources []GetNodeReservedResource: (list) - Resources reserved on the node.
SchedulingEligibility string: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
Status string: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
StatusDescription string: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

attributes Map<String,String>: (map of string) - Driver-specific attributes.
datacenter String: (string) - The datacenter of the node.
drain Boolean: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
drivers List<GetNodeDriver>: (list) - A list of driver information for the node.
hostVolumes List<GetNodeHostVolume>: (list) - A list of host volumes on the node.
httpAddr String: (string) - The HTTP address of the node.
id String: The provider-assigned unique ID for this managed resource.
meta Map<String,String>: (map of string) - A map of metadata for the node.
name String: (string) - The device name.
nodeClass String: (string) - The node class of the node.
nodeId String
nodePool String: (string) - The node pool of the node.
nodeResources List<GetNodeNodeResource>: (list) - Resources available on the node.
reservedResources List<GetNodeReservedResource>: (list) - Resources reserved on the node.
schedulingEligibility String: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
status String: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
statusDescription String: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

attributes {[key: string]: string}: (map of string) - Driver-specific attributes.
datacenter string: (string) - The datacenter of the node.
drain boolean: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
drivers GetNodeDriver[]: (list) - A list of driver information for the node.
hostVolumes GetNodeHostVolume[]: (list) - A list of host volumes on the node.
httpAddr string: (string) - The HTTP address of the node.
id string: The provider-assigned unique ID for this managed resource.
meta {[key: string]: string}: (map of string) - A map of metadata for the node.
name string: (string) - The device name.
nodeClass string: (string) - The node class of the node.
nodeId string
nodePool string: (string) - The node pool of the node.
nodeResources GetNodeNodeResource[]: (list) - Resources available on the node.
reservedResources GetNodeReservedResource[]: (list) - Resources reserved on the node.
schedulingEligibility string: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
status string: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
statusDescription string: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

attributes Mapping[str, str]: (map of string) - Driver-specific attributes.
datacenter str: (string) - The datacenter of the node.
drain bool: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
drivers Sequence[GetNodeDriver]: (list) - A list of driver information for the node.
host_volumes Sequence[GetNodeHostVolume]: (list) - A list of host volumes on the node.
http_addr str: (string) - The HTTP address of the node.
id str: The provider-assigned unique ID for this managed resource.
meta Mapping[str, str]: (map of string) - A map of metadata for the node.
name str: (string) - The device name.
node_class str: (string) - The node class of the node.
node_id str
node_pool str: (string) - The node pool of the node.
node_resources Sequence[GetNodeNodeResource]: (list) - Resources available on the node.
reserved_resources Sequence[GetNodeReservedResource]: (list) - Resources reserved on the node.
scheduling_eligibility str: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
status str: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
status_description str: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

attributes Map<String>: (map of string) - Driver-specific attributes.
datacenter String: (string) - The datacenter of the node.
drain Boolean: (bool) - Whether the node is in drain mode. This value is ephemeral and can change without an agent restart.
drivers List<Property Map>: (list) - A list of driver information for the node.
hostVolumes List<Property Map>: (list) - A list of host volumes on the node.
httpAddr String: (string) - The HTTP address of the node.
id String: The provider-assigned unique ID for this managed resource.
meta Map<String>: (map of string) - A map of metadata for the node.
name String: (string) - The device name.
nodeClass String: (string) - The node class of the node.
nodeId String
nodePool String: (string) - The node pool of the node.
nodeResources List<Property Map>: (list) - Resources available on the node.
reservedResources List<Property Map>: (list) - Resources reserved on the node.
schedulingEligibility String: (string) - The scheduling eligibility of the node. This value is ephemeral and can change without an agent restart.
status String: (string) - The status of the node. This value is ephemeral and can change without an agent restart.
statusDescription String: (string) - The status description of the node. This value is ephemeral and can change without an agent restart.

Supporting Types

GetNodeDriver

Attributes Dictionary<string, string>: (map of string) - Driver-specific attributes.
Detected bool: (bool) - Whether the driver is detected.
Healthy bool: (bool) - Whether the driver is healthy.
Name string: (string) - The device name.

Attributes map[string]string: (map of string) - Driver-specific attributes.
Detected bool: (bool) - Whether the driver is detected.
Healthy bool: (bool) - Whether the driver is healthy.
Name string: (string) - The device name.

attributes Map<String,String>: (map of string) - Driver-specific attributes.
detected Boolean: (bool) - Whether the driver is detected.
healthy Boolean: (bool) - Whether the driver is healthy.
name String: (string) - The device name.

attributes {[key: string]: string}: (map of string) - Driver-specific attributes.
detected boolean: (bool) - Whether the driver is detected.
healthy boolean: (bool) - Whether the driver is healthy.
name string: (string) - The device name.

attributes Mapping[str, str]: (map of string) - Driver-specific attributes.
detected bool: (bool) - Whether the driver is detected.
healthy bool: (bool) - Whether the driver is healthy.
name str: (string) - The device name.

attributes Map<String>: (map of string) - Driver-specific attributes.
detected Boolean: (bool) - Whether the driver is detected.
healthy Boolean: (bool) - Whether the driver is healthy.
name String: (string) - The device name.

GetNodeHostVolume

Id string: (string) - The ID of the host volume (set for dynamic host volumes only).
Name string: (string) - The device name.
Path string: (string) - The path of the host volume.
ReadOnly bool: (bool) - Whether the host volume is read-only.

Id string: (string) - The ID of the host volume (set for dynamic host volumes only).
Name string: (string) - The device name.
Path string: (string) - The path of the host volume.
ReadOnly bool: (bool) - Whether the host volume is read-only.

id String: (string) - The ID of the host volume (set for dynamic host volumes only).
name String: (string) - The device name.
path String: (string) - The path of the host volume.
readOnly Boolean: (bool) - Whether the host volume is read-only.

id string: (string) - The ID of the host volume (set for dynamic host volumes only).
name string: (string) - The device name.
path string: (string) - The path of the host volume.
readOnly boolean: (bool) - Whether the host volume is read-only.

id str: (string) - The ID of the host volume (set for dynamic host volumes only).
name str: (string) - The device name.
path str: (string) - The path of the host volume.
read_only bool: (bool) - Whether the host volume is read-only.

id String: (string) - The ID of the host volume (set for dynamic host volumes only).
name String: (string) - The device name.
path String: (string) - The path of the host volume.
readOnly Boolean: (bool) - Whether the host volume is read-only.

GetNodeNodeResource

Cpus List<GetNodeNodeResourceCpus>: (list) - Reserved CPU resources.
Devices List<GetNodeNodeResourceDevice>: (list) - Device resources on the node (GPUs, etc.).
Disks List<GetNodeNodeResourceDisk>: (list) - Reserved disk resources.
MaxDynamicPort int: (int) - Maximum dynamic port for this node.
Memories List<GetNodeNodeResourceMemory>: (list) - Reserved memory resources.
MinDynamicPort int: (int) - Minimum dynamic port for this node.
Networks List<GetNodeNodeResourceNetwork>: (map of string) - Reserved network resources.

Cpus []GetNodeNodeResourceCpus: (list) - Reserved CPU resources.
Devices []GetNodeNodeResourceDevice: (list) - Device resources on the node (GPUs, etc.).
Disks []GetNodeNodeResourceDisk: (list) - Reserved disk resources.
MaxDynamicPort int: (int) - Maximum dynamic port for this node.
Memories []GetNodeNodeResourceMemory: (list) - Reserved memory resources.
MinDynamicPort int: (int) - Minimum dynamic port for this node.
Networks []GetNodeNodeResourceNetwork: (map of string) - Reserved network resources.

cpus List<GetNodeNodeResourceCpus>: (list) - Reserved CPU resources.
devices List<GetNodeNodeResourceDevice>: (list) - Device resources on the node (GPUs, etc.).
disks List<GetNodeNodeResourceDisk>: (list) - Reserved disk resources.
maxDynamicPort Integer: (int) - Maximum dynamic port for this node.
memories List<GetNodeNodeResourceMemory>: (list) - Reserved memory resources.
minDynamicPort Integer: (int) - Minimum dynamic port for this node.
networks List<GetNodeNodeResourceNetwork>: (map of string) - Reserved network resources.

cpus GetNodeNodeResourceCpus[]: (list) - Reserved CPU resources.
devices GetNodeNodeResourceDevice[]: (list) - Device resources on the node (GPUs, etc.).
disks GetNodeNodeResourceDisk[]: (list) - Reserved disk resources.
maxDynamicPort number: (int) - Maximum dynamic port for this node.
memories GetNodeNodeResourceMemory[]: (list) - Reserved memory resources.
minDynamicPort number: (int) - Minimum dynamic port for this node.
networks GetNodeNodeResourceNetwork[]: (map of string) - Reserved network resources.

cpus Sequence[GetNodeNodeResourceCpus]: (list) - Reserved CPU resources.
devices Sequence[GetNodeNodeResourceDevice]: (list) - Device resources on the node (GPUs, etc.).
disks Sequence[GetNodeNodeResourceDisk]: (list) - Reserved disk resources.
max_dynamic_port int: (int) - Maximum dynamic port for this node.
memories Sequence[GetNodeNodeResourceMemory]: (list) - Reserved memory resources.
min_dynamic_port int: (int) - Minimum dynamic port for this node.
networks Sequence[GetNodeNodeResourceNetwork]: (map of string) - Reserved network resources.

cpus List<Property Map>: (list) - Reserved CPU resources.
devices List<Property Map>: (list) - Device resources on the node (GPUs, etc.).
disks List<Property Map>: (list) - Reserved disk resources.
maxDynamicPort Number: (int) - Maximum dynamic port for this node.
memories List<Property Map>: (list) - Reserved memory resources.
minDynamicPort Number: (int) - Minimum dynamic port for this node.
networks List<Property Map>: (map of string) - Reserved network resources.

GetNodeNodeResourceCpus

CpuShares int: (int) - Reserved CPU shares.
ReservableCpuCores List<int>: (list of int) - List of reservable CPU core IDs.
TotalCpuCores int: (int) - Total number of CPU cores.

CpuShares int: (int) - Reserved CPU shares.
ReservableCpuCores []int: (list of int) - List of reservable CPU core IDs.
TotalCpuCores int: (int) - Total number of CPU cores.

cpuShares Integer: (int) - Reserved CPU shares.
reservableCpuCores List<Integer>: (list of int) - List of reservable CPU core IDs.
totalCpuCores Integer: (int) - Total number of CPU cores.

cpuShares number: (int) - Reserved CPU shares.
reservableCpuCores number[]: (list of int) - List of reservable CPU core IDs.
totalCpuCores number: (int) - Total number of CPU cores.

cpu_shares int: (int) - Reserved CPU shares.
reservable_cpu_cores Sequence[int]: (list of int) - List of reservable CPU core IDs.
total_cpu_cores int: (int) - Total number of CPU cores.

cpuShares Number: (int) - Reserved CPU shares.
reservableCpuCores List<Number>: (list of int) - List of reservable CPU core IDs.
totalCpuCores Number: (int) - Total number of CPU cores.

GetNodeNodeResourceDevice

Count int: (int) - The number of device instances.
Name string: (string) - The device name.
Type string: (string) - The device type.
Vendor string: (string) - The device vendor.

Count int: (int) - The number of device instances.
Name string: (string) - The device name.
Type string: (string) - The device type.
Vendor string: (string) - The device vendor.

count Integer: (int) - The number of device instances.
name String: (string) - The device name.
type String: (string) - The device type.
vendor String: (string) - The device vendor.

count number: (int) - The number of device instances.
name string: (string) - The device name.
type string: (string) - The device type.
vendor string: (string) - The device vendor.

count int: (int) - The number of device instances.
name str: (string) - The device name.
type str: (string) - The device type.
vendor str: (string) - The device vendor.

count Number: (int) - The number of device instances.
name String: (string) - The device name.
type String: (string) - The device type.
vendor String: (string) - The device vendor.

GetNodeNodeResourceDisk

DiskMb int: (int) - Reserved disk space in MB.

DiskMb int: (int) - Reserved disk space in MB.

diskMb Integer: (int) - Reserved disk space in MB.

diskMb number: (int) - Reserved disk space in MB.

disk_mb int: (int) - Reserved disk space in MB.

diskMb Number: (int) - Reserved disk space in MB.

GetNodeNodeResourceMemory

MemoryMb int: (int) - Reserved memory in MB.

MemoryMb int: (int) - Reserved memory in MB.

memoryMb Integer: (int) - Reserved memory in MB.

memoryMb number: (int) - Reserved memory in MB.

memory_mb int: (int) - Reserved memory in MB.

memoryMb Number: (int) - Reserved memory in MB.

GetNodeNodeResourceNetwork

Cidr string: (string) - The CIDR of the network.
Device string: (string) - The network device.
Ip string: (string) - The IP address of the network.
Mode string: (string) - The network mode.

Cidr string: (string) - The CIDR of the network.
Device string: (string) - The network device.
Ip string: (string) - The IP address of the network.
Mode string: (string) - The network mode.

cidr String: (string) - The CIDR of the network.
device String: (string) - The network device.
ip String: (string) - The IP address of the network.
mode String: (string) - The network mode.

cidr string: (string) - The CIDR of the network.
device string: (string) - The network device.
ip string: (string) - The IP address of the network.
mode string: (string) - The network mode.

cidr str: (string) - The CIDR of the network.
device str: (string) - The network device.
ip str: (string) - The IP address of the network.
mode str: (string) - The network mode.

cidr String: (string) - The CIDR of the network.
device String: (string) - The network device.
ip String: (string) - The IP address of the network.
mode String: (string) - The network mode.

GetNodeReservedResource

Cpus List<GetNodeReservedResourceCpus>: (list) - Reserved CPU resources.
Disks List<GetNodeReservedResourceDisk>: (list) - Reserved disk resources.
Memories List<GetNodeReservedResourceMemory>: (list) - Reserved memory resources.
Networks Dictionary<string, string>: (map of string) - Reserved network resources.

Cpus []GetNodeReservedResourceCpus: (list) - Reserved CPU resources.
Disks []GetNodeReservedResourceDisk: (list) - Reserved disk resources.
Memories []GetNodeReservedResourceMemory: (list) - Reserved memory resources.
Networks map[string]string: (map of string) - Reserved network resources.

cpus List<GetNodeReservedResourceCpus>: (list) - Reserved CPU resources.
disks List<GetNodeReservedResourceDisk>: (list) - Reserved disk resources.
memories List<GetNodeReservedResourceMemory>: (list) - Reserved memory resources.
networks Map<String,String>: (map of string) - Reserved network resources.

cpus GetNodeReservedResourceCpus[]: (list) - Reserved CPU resources.
disks GetNodeReservedResourceDisk[]: (list) - Reserved disk resources.
memories GetNodeReservedResourceMemory[]: (list) - Reserved memory resources.
networks {[key: string]: string}: (map of string) - Reserved network resources.

cpus Sequence[GetNodeReservedResourceCpus]: (list) - Reserved CPU resources.
disks Sequence[GetNodeReservedResourceDisk]: (list) - Reserved disk resources.
memories Sequence[GetNodeReservedResourceMemory]: (list) - Reserved memory resources.
networks Mapping[str, str]: (map of string) - Reserved network resources.

cpus List<Property Map>: (list) - Reserved CPU resources.
disks List<Property Map>: (list) - Reserved disk resources.
memories List<Property Map>: (list) - Reserved memory resources.
networks Map<String>: (map of string) - Reserved network resources.

GetNodeReservedResourceCpus

CpuShares int: (int) - Reserved CPU shares.

CpuShares int: (int) - Reserved CPU shares.

cpuShares Integer: (int) - Reserved CPU shares.

cpuShares number: (int) - Reserved CPU shares.

cpu_shares int: (int) - Reserved CPU shares.

cpuShares Number: (int) - Reserved CPU shares.

GetNodeReservedResourceDisk

DiskMb int: (int) - Reserved disk space in MB.

DiskMb int: (int) - Reserved disk space in MB.

diskMb Integer: (int) - Reserved disk space in MB.

diskMb number: (int) - Reserved disk space in MB.

disk_mb int: (int) - Reserved disk space in MB.

diskMb Number: (int) - Reserved disk space in MB.

GetNodeReservedResourceMemory

MemoryMb int: (int) - Reserved memory in MB.

MemoryMb int: (int) - Reserved memory in MB.

memoryMb Integer: (int) - Reserved memory in MB.

memoryMb number: (int) - Reserved memory in MB.

memory_mb int: (int) - Reserved memory in MB.

memoryMb Number: (int) - Reserved memory in MB.

Package Details

Repository: HashiCorp Nomad pulumi/pulumi-nomad
License: Apache-2.0
Notes: This Pulumi package is based on the nomad Terraform Provider.

Viewing docs for Nomad v2.6.1
published on Tuesday, Apr 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-nomad

nomad.getNode

On this page

On this page

Example Usage

Using getNode

getNode Result

Supporting Types

GetNodeDriver

GetNodeHostVolume

GetNodeNodeResource

GetNodeNodeResourceCpus

GetNodeNodeResourceDevice

GetNodeNodeResourceDisk

GetNodeNodeResourceMemory

GetNodeNodeResourceNetwork

GetNodeReservedResource

GetNodeReservedResourceCpus

GetNodeReservedResourceDisk

GetNodeReservedResourceMemory

Package Details

On this page

On this page