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

iosxe.VlanConfiguration

Explore with Pulumi AI

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

    This resource can manage the VLAN Configuration configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Lbrlabs.PulumiPackage.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Iosxe.VlanConfiguration("example", new()
        {
            EvpnInstance = 123,
            EvpnInstanceVni = 10123,
            VlanId = 123,
        });
    
    });
    
    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.NewVlanConfiguration(ctx, "example", &iosxe.VlanConfigurationArgs{
    			EvpnInstance:    pulumi.Int(123),
    			EvpnInstanceVni: pulumi.Int(10123),
    			VlanId:          pulumi.Int(123),
    		})
    		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.VlanConfiguration;
    import com.pulumi.iosxe.VlanConfigurationArgs;
    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 VlanConfiguration("example", VlanConfigurationArgs.builder()        
                .evpnInstance(123)
                .evpnInstanceVni(10123)
                .vlanId(123)
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.VlanConfiguration("example",
        evpn_instance=123,
        evpn_instance_vni=10123,
        vlan_id=123)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.VlanConfiguration("example", {
        evpnInstance: 123,
        evpnInstanceVni: 10123,
        vlanId: 123,
    });
    
    resources:
      example:
        type: iosxe:VlanConfiguration
        properties:
          evpnInstance: 123
          evpnInstanceVni: 10123
          vlanId: 123
    

    Create VlanConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VlanConfiguration(name: string, args: VlanConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def VlanConfiguration(resource_name: str,
                          args: VlanConfigurationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def VlanConfiguration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          vlan_id: Optional[int] = None,
                          access_vfi: Optional[str] = None,
                          device: Optional[str] = None,
                          evpn_instance: Optional[int] = None,
                          evpn_instance_vni: Optional[int] = None,
                          vni: Optional[int] = None)
    func NewVlanConfiguration(ctx *Context, name string, args VlanConfigurationArgs, opts ...ResourceOption) (*VlanConfiguration, error)
    public VlanConfiguration(string name, VlanConfigurationArgs args, CustomResourceOptions? opts = null)
    public VlanConfiguration(String name, VlanConfigurationArgs args)
    public VlanConfiguration(String name, VlanConfigurationArgs args, CustomResourceOptions options)
    
    type: iosxe:VlanConfiguration
    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 VlanConfigurationArgs
    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 VlanConfigurationArgs
    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 VlanConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VlanConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VlanConfigurationArgs
    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 vlanConfigurationResource = new Iosxe.VlanConfiguration("vlanConfigurationResource", new()
    {
        VlanId = 0,
        AccessVfi = "string",
        Device = "string",
        EvpnInstance = 0,
        EvpnInstanceVni = 0,
        Vni = 0,
    });
    
    example, err := iosxe.NewVlanConfiguration(ctx, "vlanConfigurationResource", &iosxe.VlanConfigurationArgs{
    	VlanId:          pulumi.Int(0),
    	AccessVfi:       pulumi.String("string"),
    	Device:          pulumi.String("string"),
    	EvpnInstance:    pulumi.Int(0),
    	EvpnInstanceVni: pulumi.Int(0),
    	Vni:             pulumi.Int(0),
    })
    
    var vlanConfigurationResource = new VlanConfiguration("vlanConfigurationResource", VlanConfigurationArgs.builder()
        .vlanId(0)
        .accessVfi("string")
        .device("string")
        .evpnInstance(0)
        .evpnInstanceVni(0)
        .vni(0)
        .build());
    
    vlan_configuration_resource = iosxe.VlanConfiguration("vlanConfigurationResource",
        vlan_id=0,
        access_vfi="string",
        device="string",
        evpn_instance=0,
        evpn_instance_vni=0,
        vni=0)
    
    const vlanConfigurationResource = new iosxe.VlanConfiguration("vlanConfigurationResource", {
        vlanId: 0,
        accessVfi: "string",
        device: "string",
        evpnInstance: 0,
        evpnInstanceVni: 0,
        vni: 0,
    });
    
    type: iosxe:VlanConfiguration
    properties:
        accessVfi: string
        device: string
        evpnInstance: 0
        evpnInstanceVni: 0
        vlanId: 0
        vni: 0
    

    VlanConfiguration 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 VlanConfiguration resource accepts the following input properties:

    VlanId int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    AccessVfi string
    Enter VFI name
    Device string
    A device name from the provider configuration.
    EvpnInstance int
    • Range: 1-65535
    EvpnInstanceVni int
    VxLAN VNI value - Range: 4096-16777215
    Vni int
    VxLAN VNI value - Range: 4096-16777215
    VlanId int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    AccessVfi string
    Enter VFI name
    Device string
    A device name from the provider configuration.
    EvpnInstance int
    • Range: 1-65535
    EvpnInstanceVni int
    VxLAN VNI value - Range: 4096-16777215
    Vni int
    VxLAN VNI value - Range: 4096-16777215
    vlanId Integer
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    accessVfi String
    Enter VFI name
    device String
    A device name from the provider configuration.
    evpnInstance Integer
    • Range: 1-65535
    evpnInstanceVni Integer
    VxLAN VNI value - Range: 4096-16777215
    vni Integer
    VxLAN VNI value - Range: 4096-16777215
    vlanId number
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    accessVfi string
    Enter VFI name
    device string
    A device name from the provider configuration.
    evpnInstance number
    • Range: 1-65535
    evpnInstanceVni number
    VxLAN VNI value - Range: 4096-16777215
    vni number
    VxLAN VNI value - Range: 4096-16777215
    vlan_id int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    access_vfi str
    Enter VFI name
    device str
    A device name from the provider configuration.
    evpn_instance int
    • Range: 1-65535
    evpn_instance_vni int
    VxLAN VNI value - Range: 4096-16777215
    vni int
    VxLAN VNI value - Range: 4096-16777215
    vlanId Number
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    accessVfi String
    Enter VFI name
    device String
    A device name from the provider configuration.
    evpnInstance Number
    • Range: 1-65535
    evpnInstanceVni Number
    VxLAN VNI value - Range: 4096-16777215
    vni Number
    VxLAN VNI value - Range: 4096-16777215

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VlanConfiguration 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 VlanConfiguration Resource

    Get an existing VlanConfiguration 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?: VlanConfigurationState, opts?: CustomResourceOptions): VlanConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_vfi: Optional[str] = None,
            device: Optional[str] = None,
            evpn_instance: Optional[int] = None,
            evpn_instance_vni: Optional[int] = None,
            vlan_id: Optional[int] = None,
            vni: Optional[int] = None) -> VlanConfiguration
    func GetVlanConfiguration(ctx *Context, name string, id IDInput, state *VlanConfigurationState, opts ...ResourceOption) (*VlanConfiguration, error)
    public static VlanConfiguration Get(string name, Input<string> id, VlanConfigurationState? state, CustomResourceOptions? opts = null)
    public static VlanConfiguration get(String name, Output<String> id, VlanConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AccessVfi string
    Enter VFI name
    Device string
    A device name from the provider configuration.
    EvpnInstance int
    • Range: 1-65535
    EvpnInstanceVni int
    VxLAN VNI value - Range: 4096-16777215
    VlanId int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    Vni int
    VxLAN VNI value - Range: 4096-16777215
    AccessVfi string
    Enter VFI name
    Device string
    A device name from the provider configuration.
    EvpnInstance int
    • Range: 1-65535
    EvpnInstanceVni int
    VxLAN VNI value - Range: 4096-16777215
    VlanId int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    Vni int
    VxLAN VNI value - Range: 4096-16777215
    accessVfi String
    Enter VFI name
    device String
    A device name from the provider configuration.
    evpnInstance Integer
    • Range: 1-65535
    evpnInstanceVni Integer
    VxLAN VNI value - Range: 4096-16777215
    vlanId Integer
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    vni Integer
    VxLAN VNI value - Range: 4096-16777215
    accessVfi string
    Enter VFI name
    device string
    A device name from the provider configuration.
    evpnInstance number
    • Range: 1-65535
    evpnInstanceVni number
    VxLAN VNI value - Range: 4096-16777215
    vlanId number
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    vni number
    VxLAN VNI value - Range: 4096-16777215
    access_vfi str
    Enter VFI name
    device str
    A device name from the provider configuration.
    evpn_instance int
    • Range: 1-65535
    evpn_instance_vni int
    VxLAN VNI value - Range: 4096-16777215
    vlan_id int
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    vni int
    VxLAN VNI value - Range: 4096-16777215
    accessVfi String
    Enter VFI name
    device String
    A device name from the provider configuration.
    evpnInstance Number
    • Range: 1-65535
    evpnInstanceVni Number
    VxLAN VNI value - Range: 4096-16777215
    vlanId Number
    VLAN ID List Eg. 1-10,15 - Range: 1-4094
    vni Number
    VxLAN VNI value - Range: 4096-16777215

    Import

     $ pulumi import iosxe:index/vlanConfiguration:VlanConfiguration example "Cisco-IOS-XE-native:native/vlan/Cisco-IOS-XE-vlan:configuration=123"
    

    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 iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs