1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getFhrpGroup
Viewing docs for netbox 5.5.0
published on Friday, Jun 12, 2026 by e-breuninger
Viewing docs for netbox 5.5.0
published on Friday, Jun 12, 2026 by e-breuninger

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getFhrpGroup({
        protocol: "vrrp",
        groupId: 1234,
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_fhrp_group(protocol="vrrp",
        group_id=1234)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v5/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupFhrpGroup(ctx, &netbox.LookupFhrpGroupArgs{
    			Protocol: pulumi.StringRef("vrrp"),
    			GroupId:  1234,
    		}, 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 test = Netbox.GetFhrpGroup.Invoke(new()
        {
            Protocol = "vrrp",
            GroupId = 1234,
        });
    
    });
    
    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.GetFhrpGroupArgs;
    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 test = NetboxFunctions.getFhrpGroup(GetFhrpGroupArgs.builder()
                .protocol("vrrp")
                .groupId(1234)
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getFhrpGroup
          arguments:
            protocol: vrrp
            groupId: 1234
    
    Example coming soon!
    

    Using getFhrpGroup

    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 getFhrpGroup(args: GetFhrpGroupArgs, opts?: InvokeOptions): Promise<GetFhrpGroupResult>
    function getFhrpGroupOutput(args: GetFhrpGroupOutputArgs, opts?: InvokeOptions): Output<GetFhrpGroupResult>
    def get_fhrp_group(group_id: Optional[float] = None,
                       protocol: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFhrpGroupResult
    def get_fhrp_group_output(group_id: pulumi.Input[Optional[float]] = None,
                       protocol: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFhrpGroupResult]
    func LookupFhrpGroup(ctx *Context, args *LookupFhrpGroupArgs, opts ...InvokeOption) (*LookupFhrpGroupResult, error)
    func LookupFhrpGroupOutput(ctx *Context, args *LookupFhrpGroupOutputArgs, opts ...InvokeOption) LookupFhrpGroupResultOutput

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

    public static class GetFhrpGroup 
    {
        public static Task<GetFhrpGroupResult> InvokeAsync(GetFhrpGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetFhrpGroupResult> Invoke(GetFhrpGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFhrpGroupResult> getFhrpGroup(GetFhrpGroupArgs args, InvokeOptions options)
    public static Output<GetFhrpGroupResult> getFhrpGroup(GetFhrpGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getFhrpGroup:getFhrpGroup
      arguments:
        # arguments dictionary
    data "netbox_getfhrpgroup" "name" {
        # arguments
    }

    The following arguments are supported:

    GroupId double
    Protocol string
    GroupId float64
    Protocol string
    group_id number
    protocol string
    groupId Double
    protocol String
    groupId number
    protocol string
    groupId Number
    protocol String

    getFhrpGroup Result

    The following output properties are available:

    AuthKey string
    AuthType string
    Comments string
    Description string
    GroupId double
    Id double
    The ID of this resource.
    Name string
    Tags List<string>
    Protocol string
    AuthKey string
    AuthType string
    Comments string
    Description string
    GroupId float64
    Id float64
    The ID of this resource.
    Name string
    Tags []string
    Protocol string
    auth_key string
    auth_type string
    comments string
    description string
    group_id number
    id number
    The ID of this resource.
    name string
    tags list(string)
    protocol string
    authKey String
    authType String
    comments String
    description String
    groupId Double
    id Double
    The ID of this resource.
    name String
    tags List<String>
    protocol String
    authKey string
    authType string
    comments string
    description string
    groupId number
    id number
    The ID of this resource.
    name string
    tags string[]
    protocol string
    auth_key str
    auth_type str
    comments str
    description str
    group_id float
    id float
    The ID of this resource.
    name str
    tags Sequence[str]
    protocol str
    authKey String
    authType String
    comments String
    description String
    groupId Number
    id Number
    The ID of this resource.
    name String
    tags List<String>
    protocol String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    Viewing docs for netbox 5.5.0
    published on Friday, Jun 12, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial