1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getVpnTunnelGroup
Viewing docs for netbox 5.6.1
published on Tuesday, Jun 16, 2026 by e-breuninger
Viewing docs for netbox 5.6.1
published on Tuesday, Jun 16, 2026 by e-breuninger

    Using getVpnTunnelGroup

    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 getVpnTunnelGroup(args: GetVpnTunnelGroupArgs, opts?: InvokeOptions): Promise<GetVpnTunnelGroupResult>
    function getVpnTunnelGroupOutput(args: GetVpnTunnelGroupOutputArgs, opts?: InvokeOptions): Output<GetVpnTunnelGroupResult>
    def get_vpn_tunnel_group(description: Optional[str] = None,
                             name: Optional[str] = None,
                             slug: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVpnTunnelGroupResult
    def get_vpn_tunnel_group_output(description: pulumi.Input[Optional[str]] = None,
                             name: pulumi.Input[Optional[str]] = None,
                             slug: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVpnTunnelGroupResult]
    func LookupVpnTunnelGroup(ctx *Context, args *LookupVpnTunnelGroupArgs, opts ...InvokeOption) (*LookupVpnTunnelGroupResult, error)
    func LookupVpnTunnelGroupOutput(ctx *Context, args *LookupVpnTunnelGroupOutputArgs, opts ...InvokeOption) LookupVpnTunnelGroupResultOutput

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

    public static class GetVpnTunnelGroup 
    {
        public static Task<GetVpnTunnelGroupResult> InvokeAsync(GetVpnTunnelGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetVpnTunnelGroupResult> Invoke(GetVpnTunnelGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpnTunnelGroupResult> getVpnTunnelGroup(GetVpnTunnelGroupArgs args, InvokeOptions options)
    public static Output<GetVpnTunnelGroupResult> getVpnTunnelGroup(GetVpnTunnelGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getVpnTunnelGroup:getVpnTunnelGroup
      arguments:
        # arguments dictionary
    data "netbox_getvpntunnelgroup" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    Description string
    Slug string
    Name string
    Description string
    Slug string
    name string
    description string
    slug string
    name String
    description String
    slug String
    name string
    description string
    slug string
    name String
    description String
    slug String

    getVpnTunnelGroup Result

    The following output properties are available:

    Description string
    Id double
    The ID of this resource.
    Name string
    Slug string
    Tags List<string>
    Description string
    Id float64
    The ID of this resource.
    Name string
    Slug string
    Tags []string
    description string
    id number
    The ID of this resource.
    name string
    slug string
    tags list(string)
    description String
    id Double
    The ID of this resource.
    name String
    slug String
    tags List<String>
    description string
    id number
    The ID of this resource.
    name string
    slug string
    tags string[]
    description str
    id float
    The ID of this resource.
    name str
    slug str
    tags Sequence[str]
    description String
    id Number
    The ID of this resource.
    name String
    slug String
    tags 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.6.1
    published on Tuesday, Jun 16, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial