1. Packages
  2. Netbox Provider
  3. API Docs
  4. getClusterGroup
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getClusterGroup

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const dcWest = netbox.getClusterGroup({
        name: "dc-west",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    dc_west = netbox.get_cluster_group(name="dc-west")
    
    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.LookupClusterGroup(ctx, &netbox.LookupClusterGroupArgs{
    			Name: "dc-west",
    		}, 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 dcWest = Netbox.GetClusterGroup.Invoke(new()
        {
            Name = "dc-west",
        });
    
    });
    
    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.GetClusterGroupArgs;
    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 dcWest = NetboxFunctions.getClusterGroup(GetClusterGroupArgs.builder()
                .name("dc-west")
                .build());
    
        }
    }
    
    variables:
      dcWest:
        fn::invoke:
          function: netbox:getClusterGroup
          arguments:
            name: dc-west
    

    Using getClusterGroup

    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 getClusterGroup(args: GetClusterGroupArgs, opts?: InvokeOptions): Promise<GetClusterGroupResult>
    function getClusterGroupOutput(args: GetClusterGroupOutputArgs, opts?: InvokeOptions): Output<GetClusterGroupResult>
    def get_cluster_group(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetClusterGroupResult
    def get_cluster_group_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetClusterGroupResult]
    func LookupClusterGroup(ctx *Context, args *LookupClusterGroupArgs, opts ...InvokeOption) (*LookupClusterGroupResult, error)
    func LookupClusterGroupOutput(ctx *Context, args *LookupClusterGroupOutputArgs, opts ...InvokeOption) LookupClusterGroupResultOutput

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

    public static class GetClusterGroup 
    {
        public static Task<GetClusterGroupResult> InvokeAsync(GetClusterGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterGroupResult> Invoke(GetClusterGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterGroupResult> getClusterGroup(GetClusterGroupArgs args, InvokeOptions options)
    public static Output<GetClusterGroupResult> getClusterGroup(GetClusterGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getClusterGroup:getClusterGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    The ID of this resource.
    Name string
    Id string
    The ID of this resource.
    name String
    id String
    The ID of this resource.
    name string
    id string
    The ID of this resource.
    name str
    id str
    The ID of this resource.
    name String
    id String
    The ID of this resource.

    getClusterGroup Result

    The following output properties are available:

    ClusterGroupId double
    Id string
    The ID of this resource.
    Name string
    ClusterGroupId float64
    Id string
    The ID of this resource.
    Name string
    clusterGroupId Double
    id String
    The ID of this resource.
    name String
    clusterGroupId number
    id string
    The ID of this resource.
    name string
    cluster_group_id float
    id str
    The ID of this resource.
    name str
    clusterGroupId Number
    id String
    The ID of this resource.
    name String

    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