1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Network
  5. getHosts
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves all the host entries from a specific node.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const firstNodeHostEntries = proxmoxve.Network.getHosts({
        nodeName: "first-node",
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    first_node_host_entries = proxmoxve.Network.get_hosts(node_name="first-node")
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.GetHosts(ctx, &network.GetHostsArgs{
    			NodeName: "first-node",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var firstNodeHostEntries = ProxmoxVE.Network.GetHosts.Invoke(new()
        {
            NodeName = "first-node",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.Network.NetworkFunctions;
    import com.pulumi.proxmoxve.Network.inputs.GetHostsArgs;
    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 firstNodeHostEntries = NetworkFunctions.getHosts(GetHostsArgs.builder()
                .nodeName("first-node")
                .build());
    
        }
    }
    
    variables:
      firstNodeHostEntries:
        fn::invoke:
          function: proxmoxve:Network:getHosts
          arguments:
            nodeName: first-node
    

    Using getHosts

    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 getHosts(args: GetHostsArgs, opts?: InvokeOptions): Promise<GetHostsResult>
    function getHostsOutput(args: GetHostsOutputArgs, opts?: InvokeOptions): Output<GetHostsResult>
    def get_hosts(node_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetHostsResult
    def get_hosts_output(node_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetHostsResult]
    func GetHosts(ctx *Context, args *GetHostsArgs, opts ...InvokeOption) (*GetHostsResult, error)
    func GetHostsOutput(ctx *Context, args *GetHostsOutputArgs, opts ...InvokeOption) GetHostsResultOutput

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

    public static class GetHosts 
    {
        public static Task<GetHostsResult> InvokeAsync(GetHostsArgs args, InvokeOptions? opts = null)
        public static Output<GetHostsResult> Invoke(GetHostsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHostsResult> getHosts(GetHostsArgs args, InvokeOptions options)
    public static Output<GetHostsResult> getHosts(GetHostsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:Network/getHosts:getHosts
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NodeName string
    A node name.
    NodeName string
    A node name.
    nodeName String
    A node name.
    nodeName string
    A node name.
    node_name str
    A node name.
    nodeName String
    A node name.

    getHosts Result

    The following output properties are available:

    Addresses List<string>
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries List<Pulumi.ProxmoxVE.Network.Outputs.GetHostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    Hostnames List<ImmutableArray<string>>
    The hostnames associated with each of the IP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeName string
    Addresses []string
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries []GetHostsEntry
    The host entries (conversion of addresses and hostnames into objects).
    Hostnames [][]string
    The hostnames associated with each of the IP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeName string
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<GetHostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeName String
    addresses string[]
    The IP addresses.
    digest string
    The SHA1 digest.
    entries GetHostsEntry[]
    The host entries (conversion of addresses and hostnames into objects).
    hostnames string[][]
    The hostnames associated with each of the IP addresses.
    id string
    The provider-assigned unique ID for this managed resource.
    nodeName string
    addresses Sequence[str]
    The IP addresses.
    digest str
    The SHA1 digest.
    entries Sequence[GetHostsEntry]
    The host entries (conversion of addresses and hostnames into objects).
    hostnames Sequence[Sequence[str]]
    The hostnames associated with each of the IP addresses.
    id str
    The provider-assigned unique ID for this managed resource.
    node_name str
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<Property Map>
    The host entries (conversion of addresses and hostnames into objects).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeName String

    Supporting Types

    GetHostsEntry

    Address string
    The address
    Hostnames List<string>
    The hostnames associated with each of the IP addresses.
    Address string
    The address
    Hostnames []string
    The hostnames associated with each of the IP addresses.
    address String
    The address
    hostnames List<String>
    The hostnames associated with each of the IP addresses.
    address string
    The address
    hostnames string[]
    The hostnames associated with each of the IP addresses.
    address str
    The address
    hostnames Sequence[str]
    The hostnames associated with each of the IP addresses.
    address String
    The address
    hostnames List<String>
    The hostnames associated with each of the IP addresses.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
    published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.