1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getFhrpGroupAssignments
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    Lists fhrp_group_assignment objects matching the given filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getFhrpGroupAssignments({
        limit: 10,
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_fhrp_group_assignments(limit=10)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.GetFhrpGroupAssignments(ctx, &netbox.GetFhrpGroupAssignmentsArgs{
    			Limit: pulumi.Float64Ref(10),
    		}, 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.GetFhrpGroupAssignments.Invoke(new()
        {
            Limit = 10,
        });
    
    });
    
    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.GetFhrpGroupAssignmentsArgs;
    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.getFhrpGroupAssignments(GetFhrpGroupAssignmentsArgs.builder()
                .limit(10)
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getFhrpGroupAssignments
          arguments:
            limit: 10
    
    Example coming soon!
    

    Using getFhrpGroupAssignments

    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 getFhrpGroupAssignments(args: GetFhrpGroupAssignmentsArgs, opts?: InvokeOptions): Promise<GetFhrpGroupAssignmentsResult>
    function getFhrpGroupAssignmentsOutput(args: GetFhrpGroupAssignmentsOutputArgs, opts?: InvokeOutputOptions): Output<GetFhrpGroupAssignmentsResult>
    def get_fhrp_group_assignments(filters: Optional[Sequence[GetFhrpGroupAssignmentsFilter]] = None,
                                   limit: Optional[float] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetFhrpGroupAssignmentsResult
    def get_fhrp_group_assignments_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetFhrpGroupAssignmentsFilterArgs]]]] = None,
                                   limit: pulumi.Input[Optional[float]] = None,
                                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetFhrpGroupAssignmentsResult]
    func GetFhrpGroupAssignments(ctx *Context, args *GetFhrpGroupAssignmentsArgs, opts ...InvokeOption) (*GetFhrpGroupAssignmentsResult, error)
    func GetFhrpGroupAssignmentsOutput(ctx *Context, args *GetFhrpGroupAssignmentsOutputArgs, opts ...InvokeOption) GetFhrpGroupAssignmentsResultOutput

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

    public static class GetFhrpGroupAssignments 
    {
        public static Task<GetFhrpGroupAssignmentsResult> InvokeAsync(GetFhrpGroupAssignmentsArgs args, InvokeOptions? opts = null)
        public static Output<GetFhrpGroupAssignmentsResult> Invoke(GetFhrpGroupAssignmentsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetFhrpGroupAssignmentsResult> Invoke(GetFhrpGroupAssignmentsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetFhrpGroupAssignmentsResult> getFhrpGroupAssignments(GetFhrpGroupAssignmentsArgs args, InvokeOptions options)
    public static Output<GetFhrpGroupAssignmentsResult> getFhrpGroupAssignments(GetFhrpGroupAssignmentsArgs args, InvokeOptions options)
    public static Output<GetFhrpGroupAssignmentsResult> getFhrpGroupAssignments(GetFhrpGroupAssignmentsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getFhrpGroupAssignments:getFhrpGroupAssignments
      arguments:
        # arguments dictionary
    data "netbox_get_fhrp_group_assignments" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetFhrpGroupAssignmentsFilter>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    Filters []GetFhrpGroupAssignmentsFilter
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<GetFhrpGroupAssignmentsFilter>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters GetFhrpGroupAssignmentsFilter[]
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters Sequence[GetFhrpGroupAssignmentsFilter]
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    getFhrpGroupAssignments Result

    The following output properties are available:

    FhrpGroupAssignments List<GetFhrpGroupAssignmentsFhrpGroupAssignment>
    The matching fhrpgroupassignments.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetFhrpGroupAssignmentsFilter>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    FhrpGroupAssignments []GetFhrpGroupAssignmentsFhrpGroupAssignment
    The matching fhrpgroupassignments.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetFhrpGroupAssignmentsFilter
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    fhrp_group_assignments list(object)
    The matching fhrpgroupassignments.
    id string
    The provider-assigned unique ID for this managed resource.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    fhrpGroupAssignments List<GetFhrpGroupAssignmentsFhrpGroupAssignment>
    The matching fhrpgroupassignments.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetFhrpGroupAssignmentsFilter>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    fhrpGroupAssignments GetFhrpGroupAssignmentsFhrpGroupAssignment[]
    The matching fhrpgroupassignments.
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetFhrpGroupAssignmentsFilter[]
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    fhrp_group_assignments Sequence[GetFhrpGroupAssignmentsFhrpGroupAssignment]
    The matching fhrpgroupassignments.
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetFhrpGroupAssignmentsFilter]
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    fhrpGroupAssignments List<Property Map>
    The matching fhrpgroupassignments.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: groupid, groupidn, id, idempty, idgt, idgte, idlt, idlte, idn, interfaceid, interfaceidn, interfacetype, interfacetypen, priority, priorityempty, prioritygt, prioritygte, prioritylt, prioritylte, priority__n. Repeating a name sends that parameter once per value.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    Supporting Types

    GetFhrpGroupAssignmentsFhrpGroupAssignment

    Created string
    GroupId double
    Id of the FHRP group.
    Id double
    NetBox id.
    InterfaceId double
    Id of the interface named by interface_type.
    InterfaceType string
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    LastUpdated string
    Priority double
    Priority of this interface within the group (0-255). Must be a whole number.
    Url string
    Created string
    GroupId float64
    Id of the FHRP group.
    Id float64
    NetBox id.
    InterfaceId float64
    Id of the interface named by interface_type.
    InterfaceType string
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    LastUpdated string
    Priority float64
    Priority of this interface within the group (0-255). Must be a whole number.
    Url string
    created string
    group_id number
    Id of the FHRP group.
    id number
    NetBox id.
    interface_id number
    Id of the interface named by interface_type.
    interface_type string
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    last_updated string
    priority number
    Priority of this interface within the group (0-255). Must be a whole number.
    url string
    created String
    groupId Double
    Id of the FHRP group.
    id Double
    NetBox id.
    interfaceId Double
    Id of the interface named by interface_type.
    interfaceType String
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    lastUpdated String
    priority Double
    Priority of this interface within the group (0-255). Must be a whole number.
    url String
    created string
    groupId number
    Id of the FHRP group.
    id number
    NetBox id.
    interfaceId number
    Id of the interface named by interface_type.
    interfaceType string
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    lastUpdated string
    priority number
    Priority of this interface within the group (0-255). Must be a whole number.
    url string
    created str
    group_id float
    Id of the FHRP group.
    id float
    NetBox id.
    interface_id float
    Id of the interface named by interface_type.
    interface_type str
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    last_updated str
    priority float
    Priority of this interface within the group (0-255). Must be a whole number.
    url str
    created String
    groupId Number
    Id of the FHRP group.
    id Number
    NetBox id.
    interfaceId Number
    Id of the interface named by interface_type.
    interfaceType String
    Type of the interface the group is assigned to, e.g. dcim.interface or virtualization.vminterface.
    lastUpdated String
    priority Number
    Priority of this interface within the group (0-255). Must be a whole number.
    url String

    GetFhrpGroupAssignmentsFilter

    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name str
    Name of the query filter (the API list parameter).
    value str
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial