Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. getCluster
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.getCluster

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    Example Usage

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

const vmwCluster01 = netbox.getCluster({
    name: "vmw-cluster-01",
});

    import pulumi
import pulumi_netbox as netbox

vmw_cluster01 = netbox.get_cluster(name="vmw-cluster-01")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.LookupCluster(ctx, &netbox.LookupClusterArgs{
			Name: pulumi.StringRef("vmw-cluster-01"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vmwCluster01 = Netbox.GetCluster.Invoke(new()
    {
        Name = "vmw-cluster-01",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetClusterArgs;
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 vmwCluster01 = NetboxFunctions.getCluster(GetClusterArgs.builder()
            .name("vmw-cluster-01")
            .build());

    }
}

    variables:
  vmwCluster01:
    fn::invoke:
      function: netbox:getCluster
      arguments:
        name: vmw-cluster-01

    Using getCluster

    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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(cluster_group_id: Optional[float] = None,
                id: Optional[str] = None,
                name: Optional[str] = None,
                site_id: Optional[float] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_group_id: Optional[pulumi.Input[float]] = None,
                id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                site_id: Optional[pulumi.Input[float]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: netbox:index/getCluster:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterGroupId double
    Id string
    At least one of name, site_id or id must be given.
    Name string
    At least one of name, site_id or id must be given.
    SiteId double
    At least one of name, site_id or id must be given.
    ClusterGroupId float64
    Id string
    At least one of name, site_id or id must be given.
    Name string
    At least one of name, site_id or id must be given.
    SiteId float64
    At least one of name, site_id or id must be given.
    clusterGroupId Double
    id String
    At least one of name, site_id or id must be given.
    name String
    At least one of name, site_id or id must be given.
    siteId Double
    At least one of name, site_id or id must be given.
    clusterGroupId number
    id string
    At least one of name, site_id or id must be given.
    name string
    At least one of name, site_id or id must be given.
    siteId number
    At least one of name, site_id or id must be given.
    cluster_group_id float
    id str
    At least one of name, site_id or id must be given.
    name str
    At least one of name, site_id or id must be given.
    site_id float
    At least one of name, site_id or id must be given.
    clusterGroupId Number
    id String
    At least one of name, site_id or id must be given.
    name String
    At least one of name, site_id or id must be given.
    siteId Number
    At least one of name, site_id or id must be given.

    getCluster Result

    The following output properties are available:

    ClusterGroupId double
    ClusterId double
    ClusterTypeId double
    Comments string
    CustomFields Dictionary<string, string>
    Description string
    Id string
    At least one of name, site_id or id must be given.
    SiteId double
    At least one of name, site_id or id must be given.
    Tags List<string>
    Name string
    At least one of name, site_id or id must be given.
    ClusterGroupId float64
    ClusterId float64
    ClusterTypeId float64
    Comments string
    CustomFields map[string]string
    Description string
    Id string
    At least one of name, site_id or id must be given.
    SiteId float64
    At least one of name, site_id or id must be given.
    Tags []string
    Name string
    At least one of name, site_id or id must be given.
    clusterGroupId Double
    clusterId Double
    clusterTypeId Double
    comments String
    customFields Map<String,String>
    description String
    id String
    At least one of name, site_id or id must be given.
    siteId Double
    At least one of name, site_id or id must be given.
    tags List<String>
    name String
    At least one of name, site_id or id must be given.
    clusterGroupId number
    clusterId number
    clusterTypeId number
    comments string
    customFields {[key: string]: string}
    description string
    id string
    At least one of name, site_id or id must be given.
    siteId number
    At least one of name, site_id or id must be given.
    tags string[]
    name string
    At least one of name, site_id or id must be given.
    cluster_group_id float
    cluster_id float
    cluster_type_id float
    comments str
    custom_fields Mapping[str, str]
    description str
    id str
    At least one of name, site_id or id must be given.
    site_id float
    At least one of name, site_id or id must be given.
    tags Sequence[str]
    name str
    At least one of name, site_id or id must be given.
    clusterGroupId Number
    clusterId Number
    clusterTypeId Number
    comments String
    customFields Map<String>
    description String
    id String
    At least one of name, site_id or id must be given.
    siteId Number
    At least one of name, site_id or id must be given.
    tags List<String>
    name String
    At least one of name, site_id or id must be given.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox