Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. FhrpGroup
Viewing docs for netbox 5.5.0
published on Friday, Jun 12, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

netbox.FhrpGroup

Viewing docs for netbox 5.5.0
published on Friday, Jun 12, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

    From the official documentation:

    Example Usage

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

const test = new netbox.FhrpGroup("test", {
    protocol: "vrrp",
    groupId: 1234,
    authType: "md5",
    authKey: "SuperSecretKey",
    name: "test-fhrp-group",
    description: "This is a test group",
});

    import pulumi
import pulumi_netbox as netbox

test = netbox.FhrpGroup("test",
    protocol="vrrp",
    group_id=1234,
    auth_type="md5",
    auth_key="SuperSecretKey",
    name="test-fhrp-group",
    description="This is a test group")

    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.NewFhrpGroup(ctx, "test", &netbox.FhrpGroupArgs{
			Protocol:    pulumi.String("vrrp"),
			GroupId:     pulumi.Float64(1234),
			AuthType:    pulumi.String("md5"),
			AuthKey:     pulumi.String("SuperSecretKey"),
			Name:        pulumi.String("test-fhrp-group"),
			Description: pulumi.String("This is a test group"),
		})
		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 = new Netbox.FhrpGroup("test", new()
    {
        Protocol = "vrrp",
        GroupId = 1234,
        AuthType = "md5",
        AuthKey = "SuperSecretKey",
        Name = "test-fhrp-group",
        Description = "This is a test group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.FhrpGroup;
import com.pulumi.netbox.FhrpGroupArgs;
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) {
        var test = new FhrpGroup("test", FhrpGroupArgs.builder()
            .protocol("vrrp")
            .groupId(1234.0)
            .authType("md5")
            .authKey("SuperSecretKey")
            .name("test-fhrp-group")
            .description("This is a test group")
            .build());

    }
}

    resources:
  test:
    type: netbox:FhrpGroup
    properties:
      protocol: vrrp
      groupId: 1234
      authType: md5
      authKey: SuperSecretKey
      name: test-fhrp-group
      description: This is a test group

    Example coming soon!

    Create FhrpGroup Resource

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

    Constructor syntax

    new FhrpGroup(name: string, args: FhrpGroupArgs, opts?: CustomResourceOptions);
    @overload
def FhrpGroup(resource_name: str,
              args: FhrpGroupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def FhrpGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              group_id: Optional[float] = None,
              protocol: Optional[str] = None,
              auth_key: Optional[str] = None,
              auth_type: Optional[str] = None,
              comments: Optional[str] = None,
              description: Optional[str] = None,
              fhrp_group_id: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[str]] = None)
    func NewFhrpGroup(ctx *Context, name string, args FhrpGroupArgs, opts ...ResourceOption) (*FhrpGroup, error)
    public FhrpGroup(string name, FhrpGroupArgs args, CustomResourceOptions? opts = null)
    public FhrpGroup(String name, FhrpGroupArgs args)
public FhrpGroup(String name, FhrpGroupArgs args, CustomResourceOptions options)

    type: netbox:FhrpGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "netbox_fhrpgroup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args FhrpGroupArgs
    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 FhrpGroupArgs
    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 FhrpGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FhrpGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FhrpGroupArgs
    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 fhrpGroupResource = new Netbox.FhrpGroup("fhrpGroupResource", new()
{
    GroupId = 0,
    Protocol = "string",
    AuthKey = "string",
    AuthType = "string",
    Comments = "string",
    Description = "string",
    FhrpGroupId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := netbox.NewFhrpGroup(ctx, "fhrpGroupResource", &netbox.FhrpGroupArgs{
	GroupId:     pulumi.Float64(0),
	Protocol:    pulumi.String("string"),
	AuthKey:     pulumi.String("string"),
	AuthType:    pulumi.String("string"),
	Comments:    pulumi.String("string"),
	Description: pulumi.String("string"),
	FhrpGroupId: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "netbox_fhrpgroup" "fhrpGroupResource" {
  group_id      = 0
  protocol      = "string"
  auth_key      = "string"
  auth_type     = "string"
  comments      = "string"
  description   = "string"
  fhrp_group_id = "string"
  name          = "string"
  tags          = ["string"]
}

    var fhrpGroupResource = new FhrpGroup("fhrpGroupResource", FhrpGroupArgs.builder()
    .groupId(0.0)
    .protocol("string")
    .authKey("string")
    .authType("string")
    .comments("string")
    .description("string")
    .fhrpGroupId("string")
    .name("string")
    .tags("string")
    .build());

    fhrp_group_resource = netbox.FhrpGroup("fhrpGroupResource",
    group_id=float(0),
    protocol="string",
    auth_key="string",
    auth_type="string",
    comments="string",
    description="string",
    fhrp_group_id="string",
    name="string",
    tags=["string"])

    const fhrpGroupResource = new netbox.FhrpGroup("fhrpGroupResource", {
    groupId: 0,
    protocol: "string",
    authKey: "string",
    authType: "string",
    comments: "string",
    description: "string",
    fhrpGroupId: "string",
    name: "string",
    tags: ["string"],
});

    type: netbox:FhrpGroup
properties:
    authKey: string
    authType: string
    comments: string
    description: string
    fhrpGroupId: string
    groupId: 0
    name: string
    protocol: string
    tags:
        - string

    FhrpGroup 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 FhrpGroup resource accepts the following input properties:

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls []string
    id string
    The provider-assigned unique ID for this managed resource.
    tags_alls list(string)
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAlls string[]
    id str
    The provider-assigned unique ID for this managed resource.
    tags_alls Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>

    Look up Existing FhrpGroup Resource

    Get an existing FhrpGroup 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?: FhrpGroupState, opts?: CustomResourceOptions): FhrpGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_key: Optional[str] = None,
        auth_type: Optional[str] = None,
        comments: Optional[str] = None,
        description: Optional[str] = None,
        fhrp_group_id: Optional[str] = None,
        group_id: Optional[float] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tags_alls: Optional[Sequence[str]] = None) -> FhrpGroup
    func GetFhrpGroup(ctx *Context, name string, id IDInput, state *FhrpGroupState, opts ...ResourceOption) (*FhrpGroup, error)
    public static FhrpGroup Get(string name, Input<string> id, FhrpGroupState? state, CustomResourceOptions? opts = null)
    public static FhrpGroup get(String name, Output<String> id, FhrpGroupState state, CustomResourceOptions options)
    resources:  _:    type: netbox:FhrpGroup    get:      id: ${id}
    import {
  to = netbox_fhrpgroup.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:
    AuthKey string
    Authentication key.
    AuthType string
    Auth type.
    Comments string
    Comments.
    Description string
    Description.
    FhrpGroupId string
    The ID of this resource.
    GroupId double
    Group ID.
    Name string
    Name.
    Protocol string
    Protocol.
    Tags List<string>
    TagsAlls List<string>
    AuthKey string
    Authentication key.
    AuthType string
    Auth type.
    Comments string
    Comments.
    Description string
    Description.
    FhrpGroupId string
    The ID of this resource.
    GroupId float64
    Group ID.
    Name string
    Name.
    Protocol string
    Protocol.
    Tags []string
    TagsAlls []string
    auth_key string
    Authentication key.
    auth_type string
    Auth type.
    comments string
    Comments.
    description string
    Description.
    fhrp_group_id string
    The ID of this resource.
    group_id number
    Group ID.
    name string
    Name.
    protocol string
    Protocol.
    tags list(string)
    tags_alls list(string)
    authKey String
    Authentication key.
    authType String
    Auth type.
    comments String
    Comments.
    description String
    Description.
    fhrpGroupId String
    The ID of this resource.
    groupId Double
    Group ID.
    name String
    Name.
    protocol String
    Protocol.
    tags List<String>
    tagsAlls List<String>
    authKey string
    Authentication key.
    authType string
    Auth type.
    comments string
    Comments.
    description string
    Description.
    fhrpGroupId string
    The ID of this resource.
    groupId number
    Group ID.
    name string
    Name.
    protocol string
    Protocol.
    tags string[]
    tagsAlls string[]
    auth_key str
    Authentication key.
    auth_type str
    Auth type.
    comments str
    Comments.
    description str
    Description.
    fhrp_group_id str
    The ID of this resource.
    group_id float
    Group ID.
    name str
    Name.
    protocol str
    Protocol.
    tags Sequence[str]
    tags_alls Sequence[str]
    authKey String
    Authentication key.
    authType String
    Auth type.
    comments String
    Comments.
    description String
    Description.
    fhrpGroupId String
    The ID of this resource.
    groupId Number
    Group ID.
    name String
    Name.
    protocol String
    Protocol.
    tags List<String>
    tagsAlls List<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
    Schema (JSON)
    e-breuninger/terraform-provider-netbox

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial