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

netbox.getVpnTunnel

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

    Using getVpnTunnel

    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 getVpnTunnel(args: GetVpnTunnelArgs, opts?: InvokeOptions): Promise<GetVpnTunnelResult>
function getVpnTunnelOutput(args: GetVpnTunnelOutputArgs, opts?: InvokeOptions): Output<GetVpnTunnelResult>
    def get_vpn_tunnel(encapsualation: Optional[str] = None,
                   name: Optional[str] = None,
                   status: Optional[str] = None,
                   tenant_id: Optional[str] = None,
                   tunnel_group_id: Optional[str] = None,
                   tunnel_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetVpnTunnelResult
def get_vpn_tunnel_output(encapsualation: pulumi.Input[Optional[str]] = None,
                   name: pulumi.Input[Optional[str]] = None,
                   status: pulumi.Input[Optional[str]] = None,
                   tenant_id: pulumi.Input[Optional[str]] = None,
                   tunnel_group_id: pulumi.Input[Optional[str]] = None,
                   tunnel_id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetVpnTunnelResult]
    func LookupVpnTunnel(ctx *Context, args *LookupVpnTunnelArgs, opts ...InvokeOption) (*LookupVpnTunnelResult, error)
func LookupVpnTunnelOutput(ctx *Context, args *LookupVpnTunnelOutputArgs, opts ...InvokeOption) LookupVpnTunnelResultOutput

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

    public static class GetVpnTunnel 
{
    public static Task<GetVpnTunnelResult> InvokeAsync(GetVpnTunnelArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnTunnelResult> Invoke(GetVpnTunnelInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnTunnelResult> getVpnTunnel(GetVpnTunnelArgs args, InvokeOptions options)
public static Output<GetVpnTunnelResult> getVpnTunnel(GetVpnTunnelArgs args, InvokeOptions options)

    fn::invoke:
  function: netbox:index/getVpnTunnel:getVpnTunnel
  arguments:
    # arguments dictionary
    data "netbox_getvpntunnel" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Encapsualation string
    Status string
    TenantId string
    TunnelGroupId string
    TunnelId string
    Name string
    Encapsualation string
    Status string
    TenantId string
    TunnelGroupId string
    TunnelId string
    name string
    encapsualation string
    status string
    tenant_id string
    tunnel_group_id string
    tunnel_id string
    name String
    encapsualation String
    status String
    tenantId String
    tunnelGroupId String
    tunnelId String
    name string
    encapsualation string
    status string
    tenantId string
    tunnelGroupId string
    tunnelId string
    name String
    encapsualation String
    status String
    tenantId String
    tunnelGroupId String
    tunnelId String

    getVpnTunnel Result

    The following output properties are available:

    Description string
    Encapsualation string
    Id double
    The ID of this resource.
    Name string
    Status string
    Tags List<string>
    TenantId string
    TunnelGroupId string
    TunnelId string
    Description string
    Encapsualation string
    Id float64
    The ID of this resource.
    Name string
    Status string
    Tags []string
    TenantId string
    TunnelGroupId string
    TunnelId string
    description string
    encapsualation string
    id number
    The ID of this resource.
    name string
    status string
    tags list(string)
    tenant_id string
    tunnel_group_id string
    tunnel_id string
    description String
    encapsualation String
    id Double
    The ID of this resource.
    name String
    status String
    tags List<String>
    tenantId String
    tunnelGroupId String
    tunnelId String
    description string
    encapsualation string
    id number
    The ID of this resource.
    name string
    status string
    tags string[]
    tenantId string
    tunnelGroupId string
    tunnelId string
    description str
    encapsualation str
    id float
    The ID of this resource.
    name str
    status str
    tags Sequence[str]
    tenant_id str
    tunnel_group_id str
    tunnel_id str
    description String
    encapsualation String
    id Number
    The ID of this resource.
    name String
    status String
    tags List<String>
    tenantId String
    tunnelGroupId String
    tunnelId 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.2
    published on Friday, Jun 19, 2026 by e-breuninger
    Schema (JSON)
    e-breuninger/terraform-provider-netbox

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial