Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfaceVlan
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.getInterfaceVlan

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

    This data source can read the Interface VLAN configuration.

    Example Usage

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

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

});

    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.LookupInterfaceVlan(ctx, &iosxe.LookupInterfaceVlanArgs{
			Name: 10,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    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.GetInterfaceVlanArgs;
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.getInterfaceVlan(GetInterfaceVlanArgs.builder()
            .name(10)
            .build());

    }
}

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_interface_vlan(name=10)

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

const example = iosxe.getInterfaceVlan({
    name: 10,
});

    variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfaceVlan
      Arguments:
        name: 10

    Using getInterfaceVlan

    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 getInterfaceVlan(args: GetInterfaceVlanArgs, opts?: InvokeOptions): Promise<GetInterfaceVlanResult>
function getInterfaceVlanOutput(args: GetInterfaceVlanOutputArgs, opts?: InvokeOptions): Output<GetInterfaceVlanResult>
    def get_interface_vlan(device: Optional[str] = None,
                       name: Optional[int] = None,
                       opts: Optional[InvokeOptions] = None) -> GetInterfaceVlanResult
def get_interface_vlan_output(device: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[int]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceVlanResult]
    func LookupInterfaceVlan(ctx *Context, args *LookupInterfaceVlanArgs, opts ...InvokeOption) (*LookupInterfaceVlanResult, error)
func LookupInterfaceVlanOutput(ctx *Context, args *LookupInterfaceVlanOutputArgs, opts ...InvokeOption) LookupInterfaceVlanResultOutput

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

    public static class GetInterfaceVlan 
{
    public static Task<GetInterfaceVlanResult> InvokeAsync(GetInterfaceVlanArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfaceVlanResult> Invoke(GetInterfaceVlanInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInterfaceVlanResult> getInterfaceVlan(GetInterfaceVlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: iosxe:index/getInterfaceVlan:getInterfaceVlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getInterfaceVlan Result

    The following output properties are available:

    Autostate bool
    Enable auto-state determination for VLAN
    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
    Description string
    Interface specific description
    HelperAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceVlanHelperAddress>
    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.GetInterfaceVlanIpv6Address>
    Ipv6Enable bool
    Enable IPv6 on interface
    Ipv6LinkLocalAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceVlanIpv6LinkLocalAddress>
    Ipv6Mtu int
    Set IPv6 Maximum Transmission Unit
    Ipv6NdRaSuppressAll bool
    Suppress all IPv6 RA
    Name int
    Shutdown bool
    Shutdown the selected interface
    Unnumbered string
    Enable IP processing without an explicit address
    VrfForwarding string
    Configure forwarding table
    Device string
    A device name from the provider configuration.
    Autostate bool
    Enable auto-state determination for VLAN
    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
    Description string
    Interface specific description
    HelperAddresses []GetInterfaceVlanHelperAddress
    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 []GetInterfaceVlanIpv6Address
    Ipv6Enable bool
    Enable IPv6 on interface
    Ipv6LinkLocalAddresses []GetInterfaceVlanIpv6LinkLocalAddress
    Ipv6Mtu int
    Set IPv6 Maximum Transmission Unit
    Ipv6NdRaSuppressAll bool
    Suppress all IPv6 RA
    Name int
    Shutdown bool
    Shutdown the selected interface
    Unnumbered string
    Enable IP processing without an explicit address
    VrfForwarding string
    Configure forwarding table
    Device string
    A device name from the provider configuration.
    autostate Boolean
    Enable auto-state determination for VLAN
    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
    description String
    Interface specific description
    helperAddresses List<GetInterfaceVlanHelperAddress>
    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<GetInterfaceVlanIpv6Address>
    ipv6Enable Boolean
    Enable IPv6 on interface
    ipv6LinkLocalAddresses List<GetInterfaceVlanIpv6LinkLocalAddress>
    ipv6Mtu Integer
    Set IPv6 Maximum Transmission Unit
    ipv6NdRaSuppressAll Boolean
    Suppress all IPv6 RA
    name Integer
    shutdown Boolean
    Shutdown the selected interface
    unnumbered String
    Enable IP processing without an explicit address
    vrfForwarding String
    Configure forwarding table
    device String
    A device name from the provider configuration.
    autostate boolean
    Enable auto-state determination for VLAN
    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
    description string
    Interface specific description
    helperAddresses GetInterfaceVlanHelperAddress[]
    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 GetInterfaceVlanIpv6Address[]
    ipv6Enable boolean
    Enable IPv6 on interface
    ipv6LinkLocalAddresses GetInterfaceVlanIpv6LinkLocalAddress[]
    ipv6Mtu number
    Set IPv6 Maximum Transmission Unit
    ipv6NdRaSuppressAll boolean
    Suppress all IPv6 RA
    name number
    shutdown boolean
    Shutdown the selected interface
    unnumbered string
    Enable IP processing without an explicit address
    vrfForwarding string
    Configure forwarding table
    device string
    A device name from the provider configuration.
    autostate bool
    Enable auto-state determination for VLAN
    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
    description str
    Interface specific description
    helper_addresses Sequence[GetInterfaceVlanHelperAddress]
    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[GetInterfaceVlanIpv6Address]
    ipv6_enable bool
    Enable IPv6 on interface
    ipv6_link_local_addresses Sequence[GetInterfaceVlanIpv6LinkLocalAddress]
    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
    unnumbered str
    Enable IP processing without an explicit address
    vrf_forwarding str
    Configure forwarding table
    device str
    A device name from the provider configuration.
    autostate Boolean
    Enable auto-state determination for VLAN
    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
    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
    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

    GetInterfaceVlanHelperAddress

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

    GetInterfaceVlanIpv6Address

    Eui64 bool
    Use eui-64 interface identifier
    Prefix string
    Eui64 bool
    Use eui-64 interface identifier
    Prefix string
    eui64 Boolean
    Use eui-64 interface identifier
    prefix String
    eui64 boolean
    Use eui-64 interface identifier
    prefix string
    eui64 bool
    Use eui-64 interface identifier
    prefix str
    eui64 Boolean
    Use eui-64 interface identifier
    prefix String

    GetInterfaceVlanIpv6LinkLocalAddress

    Address string
    LinkLocal bool
    Use link-local address
    Address string
    LinkLocal bool
    Use link-local address
    address String
    linkLocal Boolean
    Use link-local address
    address string
    linkLocal boolean
    Use link-local address
    address str
    link_local bool
    Use link-local address
    address String
    linkLocal 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.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
    lbrlabs/pulumi-iosxe