iosxe.InterfaceVlan
Explore with Pulumi AI
This resource can manage the Interface VLAN configuration.
Example Usage
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.InterfaceVlan;
import com.pulumi.iosxe.InterfaceVlanArgs;
import com.pulumi.iosxe.inputs.InterfaceVlanHelperAddressArgs;
import com.pulumi.iosxe.inputs.InterfaceVlanIpv6AddressArgs;
import com.pulumi.iosxe.inputs.InterfaceVlanIpv6LinkLocalAddressArgs;
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 example = new InterfaceVlan("example", InterfaceVlanArgs.builder()        
            .autostate(false)
            .bfdEnable(true)
            .bfdLocalAddress("1.2.3.4")
            .bfdTemplate("bfd_template1")
            .description("My Interface Description")
            .helperAddresses(InterfaceVlanHelperAddressArgs.builder()
                .address("10.10.10.10")
                .global(false)
                .vrf("VRF1")
                .build())
            .ipAccessGroupIn("1")
            .ipAccessGroupInEnable(true)
            .ipAccessGroupOut("1")
            .ipAccessGroupOutEnable(true)
            .ipDhcpRelaySourceInterface("Loopback100")
            .ipProxyArp(false)
            .ipRedirects(false)
            .ipUnreachables(false)
            .ipv4Address("10.1.1.1")
            .ipv4AddressMask("255.255.255.0")
            .ipv6AddressDhcp(true)
            .ipv6Addresses(InterfaceVlanIpv6AddressArgs.builder()
                .eui_64(true)
                .prefix("2006:DB8::/32")
                .build())
            .ipv6Enable(true)
            .ipv6LinkLocalAddresses(InterfaceVlanIpv6LinkLocalAddressArgs.builder()
                .address("fe80::9656:d028:8652:66bb")
                .link_local(true)
                .build())
            .ipv6Mtu(1300)
            .ipv6NdRaSuppressAll(true)
            .shutdown(false)
            .vrfForwarding("VRF1")
            .build());
    }
}
Coming soon!
Coming soon!
resources:
  example:
    type: iosxe:InterfaceVlan
    properties:
      autostate: false
      bfdEnable: true
      bfdLocalAddress: 1.2.3.4
      bfdTemplate: bfd_template1
      description: My Interface Description
      helperAddresses:
        - address: 10.10.10.10
          global: false
          vrf: VRF1
      ipAccessGroupIn: '1'
      ipAccessGroupInEnable: true
      ipAccessGroupOut: '1'
      ipAccessGroupOutEnable: true
      ipDhcpRelaySourceInterface: Loopback100
      ipProxyArp: false
      ipRedirects: false
      ipUnreachables: false
      ipv4Address: 10.1.1.1
      ipv4AddressMask: 255.255.255.0
      ipv6AddressDhcp: true
      ipv6Addresses:
        - eui_64: true
          prefix: 2006:DB8::/32
      ipv6Enable: true
      ipv6LinkLocalAddresses:
        - address: fe80::9656:d028:8652:66bb
          link_local: true
      ipv6Mtu: 1300
      ipv6NdRaSuppressAll: true
      shutdown: false
      vrfForwarding: VRF1
Create InterfaceVlan Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new InterfaceVlan(name: string, args?: InterfaceVlanArgs, opts?: CustomResourceOptions);@overload
def InterfaceVlan(resource_name: str,
                  args: Optional[InterfaceVlanArgs] = None,
                  opts: Optional[ResourceOptions] = None)
@overload
def InterfaceVlan(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  autostate: Optional[bool] = None,
                  bfd_echo: Optional[bool] = None,
                  bfd_enable: Optional[bool] = None,
                  bfd_interval: Optional[int] = None,
                  bfd_interval_min_rx: Optional[int] = None,
                  bfd_interval_multiplier: Optional[int] = None,
                  bfd_local_address: Optional[str] = None,
                  bfd_template: Optional[str] = None,
                  delete_mode: Optional[str] = None,
                  description: Optional[str] = None,
                  device: Optional[str] = None,
                  helper_addresses: Optional[Sequence[InterfaceVlanHelperAddressArgs]] = None,
                  ip_access_group_in: Optional[str] = None,
                  ip_access_group_in_enable: Optional[bool] = None,
                  ip_access_group_out: Optional[str] = None,
                  ip_access_group_out_enable: Optional[bool] = None,
                  ip_dhcp_relay_source_interface: Optional[str] = None,
                  ip_proxy_arp: Optional[bool] = None,
                  ip_redirects: Optional[bool] = None,
                  ip_unreachables: Optional[bool] = None,
                  ipv4_address: Optional[str] = None,
                  ipv4_address_mask: Optional[str] = None,
                  ipv6_address_autoconfig_default: Optional[bool] = None,
                  ipv6_address_dhcp: Optional[bool] = None,
                  ipv6_addresses: Optional[Sequence[InterfaceVlanIpv6AddressArgs]] = None,
                  ipv6_enable: Optional[bool] = None,
                  ipv6_link_local_addresses: Optional[Sequence[InterfaceVlanIpv6LinkLocalAddressArgs]] = None,
                  ipv6_mtu: Optional[int] = None,
                  ipv6_nd_ra_suppress_all: Optional[bool] = None,
                  name: Optional[int] = None,
                  shutdown: Optional[bool] = None,
                  unnumbered: Optional[str] = None,
                  vrf_forwarding: Optional[str] = None)func NewInterfaceVlan(ctx *Context, name string, args *InterfaceVlanArgs, opts ...ResourceOption) (*InterfaceVlan, error)public InterfaceVlan(string name, InterfaceVlanArgs? args = null, CustomResourceOptions? opts = null)
public InterfaceVlan(String name, InterfaceVlanArgs args)
public InterfaceVlan(String name, InterfaceVlanArgs args, CustomResourceOptions options)
type: iosxe:InterfaceVlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args InterfaceVlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InterfaceVlanArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InterfaceVlanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InterfaceVlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InterfaceVlanArgs
- 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 interfaceVlanResource = new Iosxe.InterfaceVlan("interfaceVlanResource", new()
{
    Autostate = false,
    BfdEcho = false,
    BfdEnable = false,
    BfdInterval = 0,
    BfdIntervalMinRx = 0,
    BfdIntervalMultiplier = 0,
    BfdLocalAddress = "string",
    BfdTemplate = "string",
    DeleteMode = "string",
    Description = "string",
    Device = "string",
    HelperAddresses = new[]
    {
        new Iosxe.Inputs.InterfaceVlanHelperAddressArgs
        {
            Address = "string",
            Global = false,
            Vrf = "string",
        },
    },
    IpAccessGroupIn = "string",
    IpAccessGroupInEnable = false,
    IpAccessGroupOut = "string",
    IpAccessGroupOutEnable = false,
    IpDhcpRelaySourceInterface = "string",
    IpProxyArp = false,
    IpRedirects = false,
    IpUnreachables = false,
    Ipv4Address = "string",
    Ipv4AddressMask = "string",
    Ipv6AddressAutoconfigDefault = false,
    Ipv6AddressDhcp = false,
    Ipv6Addresses = new[]
    {
        new Iosxe.Inputs.InterfaceVlanIpv6AddressArgs
        {
            Prefix = "string",
            Eui64 = false,
        },
    },
    Ipv6Enable = false,
    Ipv6LinkLocalAddresses = new[]
    {
        new Iosxe.Inputs.InterfaceVlanIpv6LinkLocalAddressArgs
        {
            Address = "string",
            LinkLocal = false,
        },
    },
    Ipv6Mtu = 0,
    Ipv6NdRaSuppressAll = false,
    Name = 0,
    Shutdown = false,
    Unnumbered = "string",
    VrfForwarding = "string",
});
example, err := iosxe.NewInterfaceVlan(ctx, "interfaceVlanResource", &iosxe.InterfaceVlanArgs{
	Autostate:             pulumi.Bool(false),
	BfdEcho:               pulumi.Bool(false),
	BfdEnable:             pulumi.Bool(false),
	BfdInterval:           pulumi.Int(0),
	BfdIntervalMinRx:      pulumi.Int(0),
	BfdIntervalMultiplier: pulumi.Int(0),
	BfdLocalAddress:       pulumi.String("string"),
	BfdTemplate:           pulumi.String("string"),
	DeleteMode:            pulumi.String("string"),
	Description:           pulumi.String("string"),
	Device:                pulumi.String("string"),
	HelperAddresses: iosxe.InterfaceVlanHelperAddressArray{
		&iosxe.InterfaceVlanHelperAddressArgs{
			Address: pulumi.String("string"),
			Global:  pulumi.Bool(false),
			Vrf:     pulumi.String("string"),
		},
	},
	IpAccessGroupIn:              pulumi.String("string"),
	IpAccessGroupInEnable:        pulumi.Bool(false),
	IpAccessGroupOut:             pulumi.String("string"),
	IpAccessGroupOutEnable:       pulumi.Bool(false),
	IpDhcpRelaySourceInterface:   pulumi.String("string"),
	IpProxyArp:                   pulumi.Bool(false),
	IpRedirects:                  pulumi.Bool(false),
	IpUnreachables:               pulumi.Bool(false),
	Ipv4Address:                  pulumi.String("string"),
	Ipv4AddressMask:              pulumi.String("string"),
	Ipv6AddressAutoconfigDefault: pulumi.Bool(false),
	Ipv6AddressDhcp:              pulumi.Bool(false),
	Ipv6Addresses: iosxe.InterfaceVlanIpv6AddressArray{
		&iosxe.InterfaceVlanIpv6AddressArgs{
			Prefix: pulumi.String("string"),
			Eui64:  pulumi.Bool(false),
		},
	},
	Ipv6Enable: pulumi.Bool(false),
	Ipv6LinkLocalAddresses: iosxe.InterfaceVlanIpv6LinkLocalAddressArray{
		&iosxe.InterfaceVlanIpv6LinkLocalAddressArgs{
			Address:   pulumi.String("string"),
			LinkLocal: pulumi.Bool(false),
		},
	},
	Ipv6Mtu:             pulumi.Int(0),
	Ipv6NdRaSuppressAll: pulumi.Bool(false),
	Name:                pulumi.Int(0),
	Shutdown:            pulumi.Bool(false),
	Unnumbered:          pulumi.String("string"),
	VrfForwarding:       pulumi.String("string"),
})
var interfaceVlanResource = new InterfaceVlan("interfaceVlanResource", InterfaceVlanArgs.builder()
    .autostate(false)
    .bfdEcho(false)
    .bfdEnable(false)
    .bfdInterval(0)
    .bfdIntervalMinRx(0)
    .bfdIntervalMultiplier(0)
    .bfdLocalAddress("string")
    .bfdTemplate("string")
    .deleteMode("string")
    .description("string")
    .device("string")
    .helperAddresses(InterfaceVlanHelperAddressArgs.builder()
        .address("string")
        .global(false)
        .vrf("string")
        .build())
    .ipAccessGroupIn("string")
    .ipAccessGroupInEnable(false)
    .ipAccessGroupOut("string")
    .ipAccessGroupOutEnable(false)
    .ipDhcpRelaySourceInterface("string")
    .ipProxyArp(false)
    .ipRedirects(false)
    .ipUnreachables(false)
    .ipv4Address("string")
    .ipv4AddressMask("string")
    .ipv6AddressAutoconfigDefault(false)
    .ipv6AddressDhcp(false)
    .ipv6Addresses(InterfaceVlanIpv6AddressArgs.builder()
        .prefix("string")
        .eui64(false)
        .build())
    .ipv6Enable(false)
    .ipv6LinkLocalAddresses(InterfaceVlanIpv6LinkLocalAddressArgs.builder()
        .address("string")
        .linkLocal(false)
        .build())
    .ipv6Mtu(0)
    .ipv6NdRaSuppressAll(false)
    .name(0)
    .shutdown(false)
    .unnumbered("string")
    .vrfForwarding("string")
    .build());
interface_vlan_resource = iosxe.InterfaceVlan("interfaceVlanResource",
    autostate=False,
    bfd_echo=False,
    bfd_enable=False,
    bfd_interval=0,
    bfd_interval_min_rx=0,
    bfd_interval_multiplier=0,
    bfd_local_address="string",
    bfd_template="string",
    delete_mode="string",
    description="string",
    device="string",
    helper_addresses=[{
        "address": "string",
        "global_": False,
        "vrf": "string",
    }],
    ip_access_group_in="string",
    ip_access_group_in_enable=False,
    ip_access_group_out="string",
    ip_access_group_out_enable=False,
    ip_dhcp_relay_source_interface="string",
    ip_proxy_arp=False,
    ip_redirects=False,
    ip_unreachables=False,
    ipv4_address="string",
    ipv4_address_mask="string",
    ipv6_address_autoconfig_default=False,
    ipv6_address_dhcp=False,
    ipv6_addresses=[{
        "prefix": "string",
        "eui64": False,
    }],
    ipv6_enable=False,
    ipv6_link_local_addresses=[{
        "address": "string",
        "link_local": False,
    }],
    ipv6_mtu=0,
    ipv6_nd_ra_suppress_all=False,
    name=0,
    shutdown=False,
    unnumbered="string",
    vrf_forwarding="string")
const interfaceVlanResource = new iosxe.InterfaceVlan("interfaceVlanResource", {
    autostate: false,
    bfdEcho: false,
    bfdEnable: false,
    bfdInterval: 0,
    bfdIntervalMinRx: 0,
    bfdIntervalMultiplier: 0,
    bfdLocalAddress: "string",
    bfdTemplate: "string",
    deleteMode: "string",
    description: "string",
    device: "string",
    helperAddresses: [{
        address: "string",
        global: false,
        vrf: "string",
    }],
    ipAccessGroupIn: "string",
    ipAccessGroupInEnable: false,
    ipAccessGroupOut: "string",
    ipAccessGroupOutEnable: false,
    ipDhcpRelaySourceInterface: "string",
    ipProxyArp: false,
    ipRedirects: false,
    ipUnreachables: false,
    ipv4Address: "string",
    ipv4AddressMask: "string",
    ipv6AddressAutoconfigDefault: false,
    ipv6AddressDhcp: false,
    ipv6Addresses: [{
        prefix: "string",
        eui64: false,
    }],
    ipv6Enable: false,
    ipv6LinkLocalAddresses: [{
        address: "string",
        linkLocal: false,
    }],
    ipv6Mtu: 0,
    ipv6NdRaSuppressAll: false,
    name: 0,
    shutdown: false,
    unnumbered: "string",
    vrfForwarding: "string",
});
type: iosxe:InterfaceVlan
properties:
    autostate: false
    bfdEcho: false
    bfdEnable: false
    bfdInterval: 0
    bfdIntervalMinRx: 0
    bfdIntervalMultiplier: 0
    bfdLocalAddress: string
    bfdTemplate: string
    deleteMode: string
    description: string
    device: string
    helperAddresses:
        - address: string
          global: false
          vrf: string
    ipAccessGroupIn: string
    ipAccessGroupInEnable: false
    ipAccessGroupOut: string
    ipAccessGroupOutEnable: false
    ipDhcpRelaySourceInterface: string
    ipProxyArp: false
    ipRedirects: false
    ipUnreachables: false
    ipv4Address: string
    ipv4AddressMask: string
    ipv6AddressAutoconfigDefault: false
    ipv6AddressDhcp: false
    ipv6Addresses:
        - eui64: false
          prefix: string
    ipv6Enable: false
    ipv6LinkLocalAddresses:
        - address: string
          linkLocal: false
    ipv6Mtu: 0
    ipv6NdRaSuppressAll: false
    name: 0
    shutdown: false
    unnumbered: string
    vrfForwarding: string
InterfaceVlan 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 InterfaceVlan resource accepts the following input properties:
- 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
- Range: 50-9999
 
- Range: 
- BfdInterval intMin Rx 
- Minimum receive interval capability - Range: 50-9999
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- DeleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- Description string
- Interface specific description
- Device string
- A device name from the provider configuration.
- HelperAddresses List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Interface Vlan Helper Address> 
- Specify a destination address for UDP broadcasts
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Interface Vlan Ipv6Address> 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal List<Lbrlabs.Addresses Pulumi Package. Iosxe. Inputs. Interface Vlan Ipv6Link Local Address> 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Range: 1-4094
 
- Range: 
- Shutdown bool
- Shutdown the selected interface
- Unnumbered string
- Enable IP processing without an explicit address
- VrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- BfdInterval intMin Rx 
- Minimum receive interval capability - Range: 50-9999
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- DeleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- Description string
- Interface specific description
- Device string
- A device name from the provider configuration.
- HelperAddresses []InterfaceVlan Helper Address Args 
- Specify a destination address for UDP broadcasts
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
[]InterfaceVlan Ipv6Address Args 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal []InterfaceAddresses Vlan Ipv6Link Local Address Args 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Range: 1-4094
 
- Range: 
- Shutdown bool
- Shutdown the selected interface
- Unnumbered string
- Enable IP processing without an explicit address
- VrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval IntegerMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval IntegerMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- deleteMode String
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description String
- Interface specific description
- device String
- A device name from the provider configuration.
- helperAddresses List<InterfaceVlan Helper Address> 
- Specify a destination address for UDP broadcasts
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
List<InterfaceVlan Ipv6Address> 
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<InterfaceAddresses Vlan Ipv6Link Local Address> 
- ipv6Mtu Integer
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Integer
- Range: 1-4094
 
- Range: 
- shutdown Boolean
- Shutdown the selected interface
- unnumbered String
- Enable IP processing without an explicit address
- vrfForwarding String
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval numberMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval numberMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate string
- BFD template
- deleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description string
- Interface specific description
- device string
- A device name from the provider configuration.
- helperAddresses InterfaceVlan Helper Address[] 
- Specify a destination address for UDP broadcasts
- ipAccess stringGroup In 
- ipAccess booleanGroup In Enable 
- inbound packets
- ipAccess stringGroup Out 
- ipAccess booleanGroup Out Enable 
- outbound packets
- ipDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy booleanArp 
- Enable proxy ARP
- ipRedirects boolean
- Enable sending ICMP Redirect messages
- ipUnreachables boolean
- Enable sending ICMP Unreachable messages
- ipv4Address string
- ipv4AddressMask string
- ipv6AddressAutoconfig booleanDefault 
- Insert default route
- ipv6AddressDhcp boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
InterfaceVlan Ipv6Address[] 
- ipv6Enable boolean
- Enable IPv6 on interface
- ipv6LinkLocal InterfaceAddresses Vlan Ipv6Link Local Address[] 
- ipv6Mtu number
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa booleanSuppress All 
- Suppress all IPv6 RA
- name number
- Range: 1-4094
 
- Range: 
- shutdown boolean
- Shutdown the selected interface
- unnumbered string
- Enable IP processing without an explicit address
- vrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfd_interval_ intmin_ rx 
- Minimum receive interval capability - Range: 50-9999
- bfd_interval_ intmultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfd_local_ straddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfd_template str
- BFD template
- delete_mode str
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description str
- Interface specific description
- device str
- A device name from the provider configuration.
- helper_addresses Sequence[InterfaceVlan Helper Address Args] 
- Specify a destination address for UDP broadcasts
- ip_access_ strgroup_ in 
- ip_access_ boolgroup_ in_ enable 
- inbound packets
- ip_access_ strgroup_ out 
- ip_access_ boolgroup_ out_ enable 
- outbound packets
- ip_dhcp_ strrelay_ source_ interface 
- Set source interface for relayed messages
- ip_proxy_ boolarp 
- Enable proxy ARP
- ip_redirects bool
- Enable sending ICMP Redirect messages
- ip_unreachables bool
- Enable sending ICMP Unreachable messages
- ipv4_address str
- ipv4_address_ strmask 
- ipv6_address_ boolautoconfig_ default 
- Insert default route
- ipv6_address_ booldhcp 
- Obtain IPv6 address from DHCP server
- ipv6_addresses Sequence[InterfaceVlan Ipv6Address Args] 
- ipv6_enable bool
- Enable IPv6 on interface
- ipv6_link_ Sequence[Interfacelocal_ addresses Vlan Ipv6Link Local Address Args] 
- ipv6_mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6_nd_ boolra_ suppress_ all 
- Suppress all IPv6 RA
- name int
- Range: 1-4094
 
- Range: 
- shutdown bool
- Shutdown the selected interface
- unnumbered str
- Enable IP processing without an explicit address
- vrf_forwarding str
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval NumberMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval NumberMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- deleteMode String
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description String
- Interface specific description
- device String
- A device name from the provider configuration.
- helperAddresses List<Property Map>
- Specify a destination address for UDP broadcasts
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses List<Property Map>
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<Property Map>Addresses 
- ipv6Mtu Number
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Number
- Range: 1-4094
 
- Range: 
- shutdown Boolean
- Shutdown the selected interface
- unnumbered String
- Enable IP processing without an explicit address
- vrfForwarding String
- Configure forwarding table
Outputs
All input properties are implicitly available as output properties. Additionally, the InterfaceVlan 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 InterfaceVlan Resource
Get an existing InterfaceVlan 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?: InterfaceVlanState, opts?: CustomResourceOptions): InterfaceVlan@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autostate: Optional[bool] = None,
        bfd_echo: Optional[bool] = None,
        bfd_enable: Optional[bool] = None,
        bfd_interval: Optional[int] = None,
        bfd_interval_min_rx: Optional[int] = None,
        bfd_interval_multiplier: Optional[int] = None,
        bfd_local_address: Optional[str] = None,
        bfd_template: Optional[str] = None,
        delete_mode: Optional[str] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        helper_addresses: Optional[Sequence[InterfaceVlanHelperAddressArgs]] = None,
        ip_access_group_in: Optional[str] = None,
        ip_access_group_in_enable: Optional[bool] = None,
        ip_access_group_out: Optional[str] = None,
        ip_access_group_out_enable: Optional[bool] = None,
        ip_dhcp_relay_source_interface: Optional[str] = None,
        ip_proxy_arp: Optional[bool] = None,
        ip_redirects: Optional[bool] = None,
        ip_unreachables: Optional[bool] = None,
        ipv4_address: Optional[str] = None,
        ipv4_address_mask: Optional[str] = None,
        ipv6_address_autoconfig_default: Optional[bool] = None,
        ipv6_address_dhcp: Optional[bool] = None,
        ipv6_addresses: Optional[Sequence[InterfaceVlanIpv6AddressArgs]] = None,
        ipv6_enable: Optional[bool] = None,
        ipv6_link_local_addresses: Optional[Sequence[InterfaceVlanIpv6LinkLocalAddressArgs]] = None,
        ipv6_mtu: Optional[int] = None,
        ipv6_nd_ra_suppress_all: Optional[bool] = None,
        name: Optional[int] = None,
        shutdown: Optional[bool] = None,
        unnumbered: Optional[str] = None,
        vrf_forwarding: Optional[str] = None) -> InterfaceVlanfunc GetInterfaceVlan(ctx *Context, name string, id IDInput, state *InterfaceVlanState, opts ...ResourceOption) (*InterfaceVlan, error)public static InterfaceVlan Get(string name, Input<string> id, InterfaceVlanState? state, CustomResourceOptions? opts = null)public static InterfaceVlan get(String name, Output<String> id, InterfaceVlanState state, CustomResourceOptions options)resources:  _:    type: iosxe:InterfaceVlan    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- 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
- Range: 50-9999
 
- Range: 
- BfdInterval intMin Rx 
- Minimum receive interval capability - Range: 50-9999
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- DeleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- Description string
- Interface specific description
- Device string
- A device name from the provider configuration.
- HelperAddresses List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Interface Vlan Helper Address> 
- Specify a destination address for UDP broadcasts
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Interface Vlan Ipv6Address> 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal List<Lbrlabs.Addresses Pulumi Package. Iosxe. Inputs. Interface Vlan Ipv6Link Local Address> 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Range: 1-4094
 
- Range: 
- Shutdown bool
- Shutdown the selected interface
- Unnumbered string
- Enable IP processing without an explicit address
- VrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- BfdInterval intMin Rx 
- Minimum receive interval capability - Range: 50-9999
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- DeleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- Description string
- Interface specific description
- Device string
- A device name from the provider configuration.
- HelperAddresses []InterfaceVlan Helper Address Args 
- Specify a destination address for UDP broadcasts
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
[]InterfaceVlan Ipv6Address Args 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal []InterfaceAddresses Vlan Ipv6Link Local Address Args 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Range: 1-4094
 
- Range: 
- Shutdown bool
- Shutdown the selected interface
- Unnumbered string
- Enable IP processing without an explicit address
- VrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval IntegerMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval IntegerMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- deleteMode String
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description String
- Interface specific description
- device String
- A device name from the provider configuration.
- helperAddresses List<InterfaceVlan Helper Address> 
- Specify a destination address for UDP broadcasts
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
List<InterfaceVlan Ipv6Address> 
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<InterfaceAddresses Vlan Ipv6Link Local Address> 
- ipv6Mtu Integer
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Integer
- Range: 1-4094
 
- Range: 
- shutdown Boolean
- Shutdown the selected interface
- unnumbered String
- Enable IP processing without an explicit address
- vrfForwarding String
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval numberMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval numberMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate string
- BFD template
- deleteMode string
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description string
- Interface specific description
- device string
- A device name from the provider configuration.
- helperAddresses InterfaceVlan Helper Address[] 
- Specify a destination address for UDP broadcasts
- ipAccess stringGroup In 
- ipAccess booleanGroup In Enable 
- inbound packets
- ipAccess stringGroup Out 
- ipAccess booleanGroup Out Enable 
- outbound packets
- ipDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy booleanArp 
- Enable proxy ARP
- ipRedirects boolean
- Enable sending ICMP Redirect messages
- ipUnreachables boolean
- Enable sending ICMP Unreachable messages
- ipv4Address string
- ipv4AddressMask string
- ipv6AddressAutoconfig booleanDefault 
- Insert default route
- ipv6AddressDhcp boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
InterfaceVlan Ipv6Address[] 
- ipv6Enable boolean
- Enable IPv6 on interface
- ipv6LinkLocal InterfaceAddresses Vlan Ipv6Link Local Address[] 
- ipv6Mtu number
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa booleanSuppress All 
- Suppress all IPv6 RA
- name number
- Range: 1-4094
 
- Range: 
- shutdown boolean
- Shutdown the selected interface
- unnumbered string
- Enable IP processing without an explicit address
- vrfForwarding string
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfd_interval_ intmin_ rx 
- Minimum receive interval capability - Range: 50-9999
- bfd_interval_ intmultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfd_local_ straddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfd_template str
- BFD template
- delete_mode str
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description str
- Interface specific description
- device str
- A device name from the provider configuration.
- helper_addresses Sequence[InterfaceVlan Helper Address Args] 
- Specify a destination address for UDP broadcasts
- ip_access_ strgroup_ in 
- ip_access_ boolgroup_ in_ enable 
- inbound packets
- ip_access_ strgroup_ out 
- ip_access_ boolgroup_ out_ enable 
- outbound packets
- ip_dhcp_ strrelay_ source_ interface 
- Set source interface for relayed messages
- ip_proxy_ boolarp 
- Enable proxy ARP
- ip_redirects bool
- Enable sending ICMP Redirect messages
- ip_unreachables bool
- Enable sending ICMP Unreachable messages
- ipv4_address str
- ipv4_address_ strmask 
- ipv6_address_ boolautoconfig_ default 
- Insert default route
- ipv6_address_ booldhcp 
- Obtain IPv6 address from DHCP server
- ipv6_addresses Sequence[InterfaceVlan Ipv6Address Args] 
- ipv6_enable bool
- Enable IPv6 on interface
- ipv6_link_ Sequence[Interfacelocal_ addresses Vlan Ipv6Link Local Address Args] 
- ipv6_mtu int
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6_nd_ boolra_ suppress_ all 
- Suppress all IPv6 RA
- name int
- Range: 1-4094
 
- Range: 
- shutdown bool
- Shutdown the selected interface
- unnumbered str
- Enable IP processing without an explicit address
- vrf_forwarding str
- Configure forwarding table
- 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
- Range: 50-9999
 
- Range: 
- bfdInterval NumberMin Rx 
- Minimum receive interval capability - Range: 50-9999
- bfdInterval NumberMultiplier 
- Multiplier value used to compute holddown - Range: 3-50
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- deleteMode String
- Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being
managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is.
Default value is all. - Choices:all,attributes
- description String
- Interface specific description
- device String
- A device name from the provider configuration.
- helperAddresses List<Property Map>
- Specify a destination address for UDP broadcasts
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses List<Property Map>
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<Property Map>Addresses 
- ipv6Mtu Number
- Set IPv6 Maximum Transmission Unit - Range: 1280-9976
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Number
- Range: 1-4094
 
- Range: 
- shutdown Boolean
- Shutdown the selected interface
- unnumbered String
- Enable IP processing without an explicit address
- vrfForwarding String
- Configure forwarding table
Supporting Types
InterfaceVlanHelperAddress, InterfaceVlanHelperAddressArgs        
InterfaceVlanIpv6Address, InterfaceVlanIpv6AddressArgs      
InterfaceVlanIpv6LinkLocalAddress, InterfaceVlanIpv6LinkLocalAddressArgs          
- address str
- link_local bool
Import
 $ pulumi import iosxe:index/interfaceVlan:InterfaceVlan example "Cisco-IOS-XE-native:native/interface/Vlan=10"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- iosxe lbrlabs/pulumi-iosxe
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the iosxeTerraform Provider.