1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. FhrpGroupAssignment
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

    From the official documentation:

    Create FhrpGroupAssignment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FhrpGroupAssignment(name: string, args: FhrpGroupAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def FhrpGroupAssignment(resource_name: str,
                            args: FhrpGroupAssignmentArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def FhrpGroupAssignment(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            group_id: Optional[float] = None,
                            interface_id: Optional[float] = None,
                            interface_type: Optional[str] = None,
                            priority: Optional[float] = None,
                            fhrp_group_assignment_id: Optional[str] = None)
    func NewFhrpGroupAssignment(ctx *Context, name string, args FhrpGroupAssignmentArgs, opts ...ResourceOption) (*FhrpGroupAssignment, error)
    public FhrpGroupAssignment(string name, FhrpGroupAssignmentArgs args, CustomResourceOptions? opts = null)
    public FhrpGroupAssignment(String name, FhrpGroupAssignmentArgs args)
    public FhrpGroupAssignment(String name, FhrpGroupAssignmentArgs args, CustomResourceOptions options)
    
    type: netbox:FhrpGroupAssignment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "netbox_fhrpgroupassignment" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FhrpGroupAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FhrpGroupAssignmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FhrpGroupAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FhrpGroupAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FhrpGroupAssignmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fhrpGroupAssignmentResource = new Netbox.FhrpGroupAssignment("fhrpGroupAssignmentResource", new()
    {
        GroupId = 0,
        InterfaceId = 0,
        InterfaceType = "string",
        Priority = 0,
        FhrpGroupAssignmentId = "string",
    });
    
    example, err := netbox.NewFhrpGroupAssignment(ctx, "fhrpGroupAssignmentResource", &netbox.FhrpGroupAssignmentArgs{
    	GroupId:               pulumi.Float64(0),
    	InterfaceId:           pulumi.Float64(0),
    	InterfaceType:         pulumi.String("string"),
    	Priority:              pulumi.Float64(0),
    	FhrpGroupAssignmentId: pulumi.String("string"),
    })
    
    resource "netbox_fhrpgroupassignment" "fhrpGroupAssignmentResource" {
      group_id                 = 0
      interface_id             = 0
      interface_type           = "string"
      priority                 = 0
      fhrp_group_assignment_id = "string"
    }
    
    var fhrpGroupAssignmentResource = new FhrpGroupAssignment("fhrpGroupAssignmentResource", FhrpGroupAssignmentArgs.builder()
        .groupId(0.0)
        .interfaceId(0.0)
        .interfaceType("string")
        .priority(0.0)
        .fhrpGroupAssignmentId("string")
        .build());
    
    fhrp_group_assignment_resource = netbox.FhrpGroupAssignment("fhrpGroupAssignmentResource",
        group_id=float(0),
        interface_id=float(0),
        interface_type="string",
        priority=float(0),
        fhrp_group_assignment_id="string")
    
    const fhrpGroupAssignmentResource = new netbox.FhrpGroupAssignment("fhrpGroupAssignmentResource", {
        groupId: 0,
        interfaceId: 0,
        interfaceType: "string",
        priority: 0,
        fhrpGroupAssignmentId: "string",
    });
    
    type: netbox:FhrpGroupAssignment
    properties:
        fhrpGroupAssignmentId: string
        groupId: 0
        interfaceId: 0
        interfaceType: string
        priority: 0
    

    FhrpGroupAssignment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FhrpGroupAssignment resource accepts the following input properties:

    GroupId double
    Group ID.
    InterfaceId double
    Interface ID.
    InterfaceType string
    Interface type.
    Priority double
    Priority.
    FhrpGroupAssignmentId string
    The ID of this resource.
    GroupId float64
    Group ID.
    InterfaceId float64
    Interface ID.
    InterfaceType string
    Interface type.
    Priority float64
    Priority.
    FhrpGroupAssignmentId string
    The ID of this resource.
    group_id number
    Group ID.
    interface_id number
    Interface ID.
    interface_type string
    Interface type.
    priority number
    Priority.
    fhrp_group_assignment_id string
    The ID of this resource.
    groupId Double
    Group ID.
    interfaceId Double
    Interface ID.
    interfaceType String
    Interface type.
    priority Double
    Priority.
    fhrpGroupAssignmentId String
    The ID of this resource.
    groupId number
    Group ID.
    interfaceId number
    Interface ID.
    interfaceType string
    Interface type.
    priority number
    Priority.
    fhrpGroupAssignmentId string
    The ID of this resource.
    group_id float
    Group ID.
    interface_id float
    Interface ID.
    interface_type str
    Interface type.
    priority float
    Priority.
    fhrp_group_assignment_id str
    The ID of this resource.
    groupId Number
    Group ID.
    interfaceId Number
    Interface ID.
    interfaceType String
    Interface type.
    priority Number
    Priority.
    fhrpGroupAssignmentId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FhrpGroupAssignment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FhrpGroupAssignment Resource

    Get an existing FhrpGroupAssignment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FhrpGroupAssignmentState, opts?: CustomResourceOptions): FhrpGroupAssignment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fhrp_group_assignment_id: Optional[str] = None,
            group_id: Optional[float] = None,
            interface_id: Optional[float] = None,
            interface_type: Optional[str] = None,
            priority: Optional[float] = None) -> FhrpGroupAssignment
    func GetFhrpGroupAssignment(ctx *Context, name string, id IDInput, state *FhrpGroupAssignmentState, opts ...ResourceOption) (*FhrpGroupAssignment, error)
    public static FhrpGroupAssignment Get(string name, Input<string> id, FhrpGroupAssignmentState? state, CustomResourceOptions? opts = null)
    public static FhrpGroupAssignment get(String name, Output<String> id, FhrpGroupAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: netbox:FhrpGroupAssignment    get:      id: ${id}
    import {
      to = netbox_fhrpgroupassignment.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FhrpGroupAssignmentId string
    The ID of this resource.
    GroupId double
    Group ID.
    InterfaceId double
    Interface ID.
    InterfaceType string
    Interface type.
    Priority double
    Priority.
    FhrpGroupAssignmentId string
    The ID of this resource.
    GroupId float64
    Group ID.
    InterfaceId float64
    Interface ID.
    InterfaceType string
    Interface type.
    Priority float64
    Priority.
    fhrp_group_assignment_id string
    The ID of this resource.
    group_id number
    Group ID.
    interface_id number
    Interface ID.
    interface_type string
    Interface type.
    priority number
    Priority.
    fhrpGroupAssignmentId String
    The ID of this resource.
    groupId Double
    Group ID.
    interfaceId Double
    Interface ID.
    interfaceType String
    Interface type.
    priority Double
    Priority.
    fhrpGroupAssignmentId string
    The ID of this resource.
    groupId number
    Group ID.
    interfaceId number
    Interface ID.
    interfaceType string
    Interface type.
    priority number
    Priority.
    fhrp_group_assignment_id str
    The ID of this resource.
    group_id float
    Group ID.
    interface_id float
    Interface ID.
    interface_type str
    Interface type.
    priority float
    Priority.
    fhrpGroupAssignmentId String
    The ID of this resource.
    groupId Number
    Group ID.
    interfaceId Number
    Interface ID.
    interfaceType String
    Interface type.
    priority Number
    Priority.

    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