Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. VpnTunnelGroup
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.VpnTunnelGroup

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

From the official documentation:

NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec. A tunnel may be terminated to two or more device or virtual machine interfaces. For convenient organization, tunnels may be assigned to user-defined groups.

Example Usage

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

const test = new netbox.VpnTunnelGroup("test", {description: "My description"});
Copy
import pulumi
import pulumi_netbox as netbox

test = netbox.VpnTunnelGroup("test", description="My description")
Copy
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.NewVpnTunnelGroup(ctx, "test", &netbox.VpnTunnelGroupArgs{
			Description: pulumi.String("My description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var test = new Netbox.VpnTunnelGroup("test", new()
    {
        Description = "My description",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.VpnTunnelGroup;
import com.pulumi.netbox.VpnTunnelGroupArgs;
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 VpnTunnelGroup("test", VpnTunnelGroupArgs.builder()
            .description("My description")
            .build());

    }
}
Copy
resources:
  test:
    type: netbox:VpnTunnelGroup
    properties:
      description: My description
Copy

Create VpnTunnelGroup Resource

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

Constructor syntax

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

@overload
def VpnTunnelGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   slug: Optional[str] = None,
                   vpn_tunnel_group_id: Optional[str] = None)
func NewVpnTunnelGroup(ctx *Context, name string, args *VpnTunnelGroupArgs, opts ...ResourceOption) (*VpnTunnelGroup, error)
public VpnTunnelGroup(string name, VpnTunnelGroupArgs? args = null, CustomResourceOptions? opts = null)
public VpnTunnelGroup(String name, VpnTunnelGroupArgs args)
public VpnTunnelGroup(String name, VpnTunnelGroupArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args VpnTunnelGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args VpnTunnelGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args VpnTunnelGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args VpnTunnelGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpnTunnelGroupArgs
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 vpnTunnelGroupResource = new Netbox.VpnTunnelGroup("vpnTunnelGroupResource", new()
{
    Description = "string",
    Name = "string",
    Slug = "string",
    VpnTunnelGroupId = "string",
});
Copy
example, err := netbox.NewVpnTunnelGroup(ctx, "vpnTunnelGroupResource", &netbox.VpnTunnelGroupArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Slug: pulumi.String("string"),
VpnTunnelGroupId: pulumi.String("string"),
})
Copy
var vpnTunnelGroupResource = new VpnTunnelGroup("vpnTunnelGroupResource", VpnTunnelGroupArgs.builder()
    .description("string")
    .name("string")
    .slug("string")
    .vpnTunnelGroupId("string")
    .build());
Copy
vpn_tunnel_group_resource = netbox.VpnTunnelGroup("vpnTunnelGroupResource",
    description="string",
    name="string",
    slug="string",
    vpn_tunnel_group_id="string")
Copy
const vpnTunnelGroupResource = new netbox.VpnTunnelGroup("vpnTunnelGroupResource", {
    description: "string",
    name: "string",
    slug: "string",
    vpnTunnelGroupId: "string",
});
Copy
type: netbox:VpnTunnelGroup
properties:
    description: string
    name: string
    slug: string
    vpnTunnelGroupId: string
Copy

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

Description string
Name string
Slug string
VpnTunnelGroupId string
The ID of this resource.
Description string
Name string
Slug string
VpnTunnelGroupId string
The ID of this resource.
description String
name String
slug String
vpnTunnelGroupId String
The ID of this resource.
description string
name string
slug string
vpnTunnelGroupId string
The ID of this resource.
description str
name str
slug str
vpn_tunnel_group_id str
The ID of this resource.
description String
name String
slug String
vpnTunnelGroupId String
The ID of this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpnTunnelGroup 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VpnTunnelGroup Resource

Get an existing VpnTunnelGroup 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?: VpnTunnelGroupState, opts?: CustomResourceOptions): VpnTunnelGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None,
        vpn_tunnel_group_id: Optional[str] = None) -> VpnTunnelGroup
func GetVpnTunnelGroup(ctx *Context, name string, id IDInput, state *VpnTunnelGroupState, opts ...ResourceOption) (*VpnTunnelGroup, error)
public static VpnTunnelGroup Get(string name, Input<string> id, VpnTunnelGroupState? state, CustomResourceOptions? opts = null)
public static VpnTunnelGroup get(String name, Output<String> id, VpnTunnelGroupState state, CustomResourceOptions options)
resources:  _:    type: netbox:VpnTunnelGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Name string
Slug string
VpnTunnelGroupId string
The ID of this resource.
Description string
Name string
Slug string
VpnTunnelGroupId string
The ID of this resource.
description String
name String
slug String
vpnTunnelGroupId String
The ID of this resource.
description string
name string
slug string
vpnTunnelGroupId string
The ID of this resource.
description str
name str
slug str
vpn_tunnel_group_id str
The ID of this resource.
description String
name String
slug String
vpnTunnelGroupId String
The ID of this resource.

Package Details

Repository
netbox e-breuninger/terraform-provider-netbox
License
Notes
This Pulumi package is based on the netbox Terraform Provider.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox