1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfaceTunnel
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getInterfaceTunnel

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

This data source can read the Interface Tunnel configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Pulumi.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetInterfaceTunnel.Invoke(new()
    {
        Name = 90,
    });

});
Copy
package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupInterfaceTunnel(ctx, &iosxe.LookupInterfaceTunnelArgs{
			Name: 90,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetInterfaceTunnelArgs;
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) {
        final var example = IosxeFunctions.getInterfaceTunnel(GetInterfaceTunnelArgs.builder()
            .name(90)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getInterfaceTunnel({
    name: 90,
});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_interface_tunnel(name=90)
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfaceTunnel
      Arguments:
        name: 90
Copy

Using getInterfaceTunnel

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 getInterfaceTunnel(args: GetInterfaceTunnelArgs, opts?: InvokeOptions): Promise<GetInterfaceTunnelResult>
function getInterfaceTunnelOutput(args: GetInterfaceTunnelOutputArgs, opts?: InvokeOptions): Output<GetInterfaceTunnelResult>
Copy
def get_interface_tunnel(device: Optional[str] = None,
                         name: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetInterfaceTunnelResult
def get_interface_tunnel_output(device: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceTunnelResult]
Copy
func LookupInterfaceTunnel(ctx *Context, args *LookupInterfaceTunnelArgs, opts ...InvokeOption) (*LookupInterfaceTunnelResult, error)
func LookupInterfaceTunnelOutput(ctx *Context, args *LookupInterfaceTunnelOutputArgs, opts ...InvokeOption) LookupInterfaceTunnelResultOutput
Copy

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

public static class GetInterfaceTunnel 
{
    public static Task<GetInterfaceTunnelResult> InvokeAsync(GetInterfaceTunnelArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfaceTunnelResult> Invoke(GetInterfaceTunnelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInterfaceTunnelResult> getInterfaceTunnel(GetInterfaceTunnelArgs args, InvokeOptions options)
public static Output<GetInterfaceTunnelResult> getInterfaceTunnel(GetInterfaceTunnelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getInterfaceTunnel:getInterfaceTunnel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. int
Device string
A device name from the provider configuration.
Name This property is required. int
Device string
A device name from the provider configuration.
name This property is required. Integer
device String
A device name from the provider configuration.
name This property is required. number
device string
A device name from the provider configuration.
name This property is required. int
device str
A device name from the provider configuration.
name This property is required. Number
device String
A device name from the provider configuration.

getInterfaceTunnel Result

The following output properties are available:

ArpTimeout int
Set ARP cache timeout
BfdEcho bool
Use echo adjunct as bfd detection mechanism
BfdEnable bool
Enable BFD under the interface
BfdInterval int
BfdIntervalMinRx int
Minimum receive interval capability
BfdIntervalMultiplier int
Multiplier value used to compute holddown
BfdLocalAddress string
The Source IP address to be used for BFD sessions over this interface.
BfdTemplate string
BFD template
CryptoIpsecDfBit string
Handling of encapsulated DF bit.
Description string
Interface specific description
HelperAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceTunnelHelperAddress>
Specify a destination address for UDP broadcasts
Id string
The path of the retrieved object.
IpAccessGroupIn string
IpAccessGroupInEnable bool
inbound packets
IpAccessGroupOut string
IpAccessGroupOutEnable bool
outbound packets
IpDhcpRelaySourceInterface string
Set source interface for relayed messages
IpProxyArp bool
Enable proxy ARP
IpRedirects bool
Enable sending ICMP Redirect messages
IpUnreachables bool
Enable sending ICMP Unreachable messages
Ipv4Address string
Ipv4AddressMask string
Ipv6AddressAutoconfigDefault bool
Insert default route
Ipv6AddressDhcp bool
Obtain IPv6 address from DHCP server
Ipv6Addresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceTunnelIpv6Address>
Ipv6Enable bool
Enable IPv6 on interface
Ipv6LinkLocalAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceTunnelIpv6LinkLocalAddress>
Ipv6Mtu int
Set IPv6 Maximum Transmission Unit
Ipv6NdRaSuppressAll bool
Suppress all IPv6 RA
Name int
Shutdown bool
Shutdown the selected interface
TunnelDestinationIpv4 string
ip address or host name
TunnelModeIpsecIpv4 bool
over IPv4
TunnelProtectionIpsecProfile string
Determine the ipsec policy profile to use.
TunnelSource string
source of tunnel packets
Unnumbered string
Enable IP processing without an explicit address
VrfForwarding string
Configure forwarding table
Device string
A device name from the provider configuration.
ArpTimeout int
Set ARP cache timeout
BfdEcho bool
Use echo adjunct as bfd detection mechanism
BfdEnable bool
Enable BFD under the interface
BfdInterval int
BfdIntervalMinRx int
Minimum receive interval capability
BfdIntervalMultiplier int
Multiplier value used to compute holddown
BfdLocalAddress string
The Source IP address to be used for BFD sessions over this interface.
BfdTemplate string
BFD template
CryptoIpsecDfBit string
Handling of encapsulated DF bit.
Description string
Interface specific description
HelperAddresses []GetInterfaceTunnelHelperAddress
Specify a destination address for UDP broadcasts
Id string
The path of the retrieved object.
IpAccessGroupIn string
IpAccessGroupInEnable bool
inbound packets
IpAccessGroupOut string
IpAccessGroupOutEnable bool
outbound packets
IpDhcpRelaySourceInterface string
Set source interface for relayed messages
IpProxyArp bool
Enable proxy ARP
IpRedirects bool
Enable sending ICMP Redirect messages
IpUnreachables bool
Enable sending ICMP Unreachable messages
Ipv4Address string
Ipv4AddressMask string
Ipv6AddressAutoconfigDefault bool
Insert default route
Ipv6AddressDhcp bool
Obtain IPv6 address from DHCP server
Ipv6Addresses []GetInterfaceTunnelIpv6Address
Ipv6Enable bool
Enable IPv6 on interface
Ipv6LinkLocalAddresses []GetInterfaceTunnelIpv6LinkLocalAddress
Ipv6Mtu int
Set IPv6 Maximum Transmission Unit
Ipv6NdRaSuppressAll bool
Suppress all IPv6 RA
Name int
Shutdown bool
Shutdown the selected interface
TunnelDestinationIpv4 string
ip address or host name
TunnelModeIpsecIpv4 bool
over IPv4
TunnelProtectionIpsecProfile string
Determine the ipsec policy profile to use.
TunnelSource string
source of tunnel packets
Unnumbered string
Enable IP processing without an explicit address
VrfForwarding string
Configure forwarding table
Device string
A device name from the provider configuration.
arpTimeout Integer
Set ARP cache timeout
bfdEcho Boolean
Use echo adjunct as bfd detection mechanism
bfdEnable Boolean
Enable BFD under the interface
bfdInterval Integer
bfdIntervalMinRx Integer
Minimum receive interval capability
bfdIntervalMultiplier Integer
Multiplier value used to compute holddown
bfdLocalAddress String
The Source IP address to be used for BFD sessions over this interface.
bfdTemplate String
BFD template
cryptoIpsecDfBit String
Handling of encapsulated DF bit.
description String
Interface specific description
helperAddresses List<GetInterfaceTunnelHelperAddress>
Specify a destination address for UDP broadcasts
id String
The path of the retrieved object.
ipAccessGroupIn String
ipAccessGroupInEnable Boolean
inbound packets
ipAccessGroupOut String
ipAccessGroupOutEnable Boolean
outbound packets
ipDhcpRelaySourceInterface String
Set source interface for relayed messages
ipProxyArp Boolean
Enable proxy ARP
ipRedirects Boolean
Enable sending ICMP Redirect messages
ipUnreachables Boolean
Enable sending ICMP Unreachable messages
ipv4Address String
ipv4AddressMask String
ipv6AddressAutoconfigDefault Boolean
Insert default route
ipv6AddressDhcp Boolean
Obtain IPv6 address from DHCP server
ipv6Addresses List<GetInterfaceTunnelIpv6Address>
ipv6Enable Boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses List<GetInterfaceTunnelIpv6LinkLocalAddress>
ipv6Mtu Integer
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll Boolean
Suppress all IPv6 RA
name Integer
shutdown Boolean
Shutdown the selected interface
tunnelDestinationIpv4 String
ip address or host name
tunnelModeIpsecIpv4 Boolean
over IPv4
tunnelProtectionIpsecProfile String
Determine the ipsec policy profile to use.
tunnelSource String
source of tunnel packets
unnumbered String
Enable IP processing without an explicit address
vrfForwarding String
Configure forwarding table
device String
A device name from the provider configuration.
arpTimeout number
Set ARP cache timeout
bfdEcho boolean
Use echo adjunct as bfd detection mechanism
bfdEnable boolean
Enable BFD under the interface
bfdInterval number
bfdIntervalMinRx number
Minimum receive interval capability
bfdIntervalMultiplier number
Multiplier value used to compute holddown
bfdLocalAddress string
The Source IP address to be used for BFD sessions over this interface.
bfdTemplate string
BFD template
cryptoIpsecDfBit string
Handling of encapsulated DF bit.
description string
Interface specific description
helperAddresses GetInterfaceTunnelHelperAddress[]
Specify a destination address for UDP broadcasts
id string
The path of the retrieved object.
ipAccessGroupIn string
ipAccessGroupInEnable boolean
inbound packets
ipAccessGroupOut string
ipAccessGroupOutEnable boolean
outbound packets
ipDhcpRelaySourceInterface string
Set source interface for relayed messages
ipProxyArp boolean
Enable proxy ARP
ipRedirects boolean
Enable sending ICMP Redirect messages
ipUnreachables boolean
Enable sending ICMP Unreachable messages
ipv4Address string
ipv4AddressMask string
ipv6AddressAutoconfigDefault boolean
Insert default route
ipv6AddressDhcp boolean
Obtain IPv6 address from DHCP server
ipv6Addresses GetInterfaceTunnelIpv6Address[]
ipv6Enable boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses GetInterfaceTunnelIpv6LinkLocalAddress[]
ipv6Mtu number
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll boolean
Suppress all IPv6 RA
name number
shutdown boolean
Shutdown the selected interface
tunnelDestinationIpv4 string
ip address or host name
tunnelModeIpsecIpv4 boolean
over IPv4
tunnelProtectionIpsecProfile string
Determine the ipsec policy profile to use.
tunnelSource string
source of tunnel packets
unnumbered string
Enable IP processing without an explicit address
vrfForwarding string
Configure forwarding table
device string
A device name from the provider configuration.
arp_timeout int
Set ARP cache timeout
bfd_echo bool
Use echo adjunct as bfd detection mechanism
bfd_enable bool
Enable BFD under the interface
bfd_interval int
bfd_interval_min_rx int
Minimum receive interval capability
bfd_interval_multiplier int
Multiplier value used to compute holddown
bfd_local_address str
The Source IP address to be used for BFD sessions over this interface.
bfd_template str
BFD template
crypto_ipsec_df_bit str
Handling of encapsulated DF bit.
description str
Interface specific description
helper_addresses Sequence[GetInterfaceTunnelHelperAddress]
Specify a destination address for UDP broadcasts
id str
The path of the retrieved object.
ip_access_group_in str
ip_access_group_in_enable bool
inbound packets
ip_access_group_out str
ip_access_group_out_enable bool
outbound packets
ip_dhcp_relay_source_interface str
Set source interface for relayed messages
ip_proxy_arp bool
Enable proxy ARP
ip_redirects bool
Enable sending ICMP Redirect messages
ip_unreachables bool
Enable sending ICMP Unreachable messages
ipv4_address str
ipv4_address_mask str
ipv6_address_autoconfig_default bool
Insert default route
ipv6_address_dhcp bool
Obtain IPv6 address from DHCP server
ipv6_addresses Sequence[GetInterfaceTunnelIpv6Address]
ipv6_enable bool
Enable IPv6 on interface
ipv6_link_local_addresses Sequence[GetInterfaceTunnelIpv6LinkLocalAddress]
ipv6_mtu int
Set IPv6 Maximum Transmission Unit
ipv6_nd_ra_suppress_all bool
Suppress all IPv6 RA
name int
shutdown bool
Shutdown the selected interface
tunnel_destination_ipv4 str
ip address or host name
tunnel_mode_ipsec_ipv4 bool
over IPv4
tunnel_protection_ipsec_profile str
Determine the ipsec policy profile to use.
tunnel_source str
source of tunnel packets
unnumbered str
Enable IP processing without an explicit address
vrf_forwarding str
Configure forwarding table
device str
A device name from the provider configuration.
arpTimeout Number
Set ARP cache timeout
bfdEcho Boolean
Use echo adjunct as bfd detection mechanism
bfdEnable Boolean
Enable BFD under the interface
bfdInterval Number
bfdIntervalMinRx Number
Minimum receive interval capability
bfdIntervalMultiplier Number
Multiplier value used to compute holddown
bfdLocalAddress String
The Source IP address to be used for BFD sessions over this interface.
bfdTemplate String
BFD template
cryptoIpsecDfBit String
Handling of encapsulated DF bit.
description String
Interface specific description
helperAddresses List<Property Map>
Specify a destination address for UDP broadcasts
id String
The path of the retrieved object.
ipAccessGroupIn String
ipAccessGroupInEnable Boolean
inbound packets
ipAccessGroupOut String
ipAccessGroupOutEnable Boolean
outbound packets
ipDhcpRelaySourceInterface String
Set source interface for relayed messages
ipProxyArp Boolean
Enable proxy ARP
ipRedirects Boolean
Enable sending ICMP Redirect messages
ipUnreachables Boolean
Enable sending ICMP Unreachable messages
ipv4Address String
ipv4AddressMask String
ipv6AddressAutoconfigDefault Boolean
Insert default route
ipv6AddressDhcp Boolean
Obtain IPv6 address from DHCP server
ipv6Addresses List<Property Map>
ipv6Enable Boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses List<Property Map>
ipv6Mtu Number
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll Boolean
Suppress all IPv6 RA
name Number
shutdown Boolean
Shutdown the selected interface
tunnelDestinationIpv4 String
ip address or host name
tunnelModeIpsecIpv4 Boolean
over IPv4
tunnelProtectionIpsecProfile String
Determine the ipsec policy profile to use.
tunnelSource String
source of tunnel packets
unnumbered String
Enable IP processing without an explicit address
vrfForwarding String
Configure forwarding table
device String
A device name from the provider configuration.

Supporting Types

GetInterfaceTunnelHelperAddress

Address This property is required. string
Global This property is required. bool
Helper-address is global
Vrf This property is required. string
VRF name for helper-address (if different from interface VRF)
Address This property is required. string
Global This property is required. bool
Helper-address is global
Vrf This property is required. string
VRF name for helper-address (if different from interface VRF)
address This property is required. String
global This property is required. Boolean
Helper-address is global
vrf This property is required. String
VRF name for helper-address (if different from interface VRF)
address This property is required. string
global This property is required. boolean
Helper-address is global
vrf This property is required. string
VRF name for helper-address (if different from interface VRF)
address This property is required. str
global_ This property is required. bool
Helper-address is global
vrf This property is required. str
VRF name for helper-address (if different from interface VRF)
address This property is required. String
global This property is required. Boolean
Helper-address is global
vrf This property is required. String
VRF name for helper-address (if different from interface VRF)

GetInterfaceTunnelIpv6Address

Eui64 This property is required. bool
Use eui-64 interface identifier
Prefix This property is required. string
Eui64 This property is required. bool
Use eui-64 interface identifier
Prefix This property is required. string
eui64 This property is required. Boolean
Use eui-64 interface identifier
prefix This property is required. String
eui64 This property is required. boolean
Use eui-64 interface identifier
prefix This property is required. string
eui64 This property is required. bool
Use eui-64 interface identifier
prefix This property is required. str
eui64 This property is required. Boolean
Use eui-64 interface identifier
prefix This property is required. String

GetInterfaceTunnelIpv6LinkLocalAddress

Address This property is required. string
LinkLocal This property is required. bool
Use link-local address
Address This property is required. string
LinkLocal This property is required. bool
Use link-local address
address This property is required. String
linkLocal This property is required. Boolean
Use link-local address
address This property is required. string
linkLocal This property is required. boolean
Use link-local address
address This property is required. str
link_local This property is required. bool
Use link-local address
address This property is required. String
linkLocal This property is required. Boolean
Use link-local address

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs