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

iosxe.BgpAddressFamilyL2vpn

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 BGP Address Family L2VPN 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.BgpAddressFamilyL2vpn("example", new()
        {
            AfName = "evpn",
            Asn = "65000",
        });
    
    });
    
    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.NewBgpAddressFamilyL2vpn(ctx, "example", &iosxe.BgpAddressFamilyL2vpnArgs{
    			AfName: pulumi.String("evpn"),
    			Asn:    pulumi.String("65000"),
    		})
    		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.BgpAddressFamilyL2vpn;
    import com.pulumi.iosxe.BgpAddressFamilyL2vpnArgs;
    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 BgpAddressFamilyL2vpn("example", BgpAddressFamilyL2vpnArgs.builder()        
                .afName("evpn")
                .asn("65000")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.BgpAddressFamilyL2vpn("example",
        af_name="evpn",
        asn="65000")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.BgpAddressFamilyL2vpn("example", {
        afName: "evpn",
        asn: "65000",
    });
    
    resources:
      example:
        type: iosxe:BgpAddressFamilyL2vpn
        properties:
          afName: evpn
          asn: '65000'
    

    Create BgpAddressFamilyL2vpn Resource

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

    Constructor syntax

    new BgpAddressFamilyL2vpn(name: string, args: BgpAddressFamilyL2vpnArgs, opts?: CustomResourceOptions);
    @overload
    def BgpAddressFamilyL2vpn(resource_name: str,
                              args: BgpAddressFamilyL2vpnArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpAddressFamilyL2vpn(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              af_name: Optional[str] = None,
                              asn: Optional[str] = None,
                              delete_mode: Optional[str] = None,
                              device: Optional[str] = None)
    func NewBgpAddressFamilyL2vpn(ctx *Context, name string, args BgpAddressFamilyL2vpnArgs, opts ...ResourceOption) (*BgpAddressFamilyL2vpn, error)
    public BgpAddressFamilyL2vpn(string name, BgpAddressFamilyL2vpnArgs args, CustomResourceOptions? opts = null)
    public BgpAddressFamilyL2vpn(String name, BgpAddressFamilyL2vpnArgs args)
    public BgpAddressFamilyL2vpn(String name, BgpAddressFamilyL2vpnArgs args, CustomResourceOptions options)
    
    type: iosxe:BgpAddressFamilyL2vpn
    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 BgpAddressFamilyL2vpnArgs
    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 BgpAddressFamilyL2vpnArgs
    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 BgpAddressFamilyL2vpnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpAddressFamilyL2vpnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpAddressFamilyL2vpnArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var bgpAddressFamilyL2vpnResource = new Iosxe.BgpAddressFamilyL2vpn("bgpAddressFamilyL2vpnResource", new()
    {
        AfName = "string",
        Asn = "string",
        DeleteMode = "string",
        Device = "string",
    });
    
    example, err := iosxe.NewBgpAddressFamilyL2vpn(ctx, "bgpAddressFamilyL2vpnResource", &iosxe.BgpAddressFamilyL2vpnArgs{
    	AfName:     pulumi.String("string"),
    	Asn:        pulumi.String("string"),
    	DeleteMode: pulumi.String("string"),
    	Device:     pulumi.String("string"),
    })
    
    var bgpAddressFamilyL2vpnResource = new BgpAddressFamilyL2vpn("bgpAddressFamilyL2vpnResource", BgpAddressFamilyL2vpnArgs.builder()        
        .afName("string")
        .asn("string")
        .deleteMode("string")
        .device("string")
        .build());
    
    bgp_address_family_l2vpn_resource = iosxe.BgpAddressFamilyL2vpn("bgpAddressFamilyL2vpnResource",
        af_name="string",
        asn="string",
        delete_mode="string",
        device="string")
    
    const bgpAddressFamilyL2vpnResource = new iosxe.BgpAddressFamilyL2vpn("bgpAddressFamilyL2vpnResource", {
        afName: "string",
        asn: "string",
        deleteMode: "string",
        device: "string",
    });
    
    type: iosxe:BgpAddressFamilyL2vpn
    properties:
        afName: string
        asn: string
        deleteMode: string
        device: string
    

    BgpAddressFamilyL2vpn Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BgpAddressFamilyL2vpn resource accepts the following input properties:

    AfName string
    • Choices: evpn, vpls
    Asn string
    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
    Device string
    A device name from the provider configuration.
    AfName string
    • Choices: evpn, vpls
    Asn string
    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
    Device string
    A device name from the provider configuration.
    afName String
    • Choices: evpn, vpls
    asn String
    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
    device String
    A device name from the provider configuration.
    afName string
    • Choices: evpn, vpls
    asn string
    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
    device string
    A device name from the provider configuration.
    af_name str
    • Choices: evpn, vpls
    asn str
    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
    device str
    A device name from the provider configuration.
    afName String
    • Choices: evpn, vpls
    asn String
    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
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing BgpAddressFamilyL2vpn 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?: BgpAddressFamilyL2vpnState, opts?: CustomResourceOptions): BgpAddressFamilyL2vpn
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            af_name: Optional[str] = None,
            asn: Optional[str] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None) -> BgpAddressFamilyL2vpn
    func GetBgpAddressFamilyL2vpn(ctx *Context, name string, id IDInput, state *BgpAddressFamilyL2vpnState, opts ...ResourceOption) (*BgpAddressFamilyL2vpn, error)
    public static BgpAddressFamilyL2vpn Get(string name, Input<string> id, BgpAddressFamilyL2vpnState? state, CustomResourceOptions? opts = null)
    public static BgpAddressFamilyL2vpn get(String name, Output<String> id, BgpAddressFamilyL2vpnState 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:
    AfName string
    • Choices: evpn, vpls
    Asn string
    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
    Device string
    A device name from the provider configuration.
    AfName string
    • Choices: evpn, vpls
    Asn string
    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
    Device string
    A device name from the provider configuration.
    afName String
    • Choices: evpn, vpls
    asn String
    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
    device String
    A device name from the provider configuration.
    afName string
    • Choices: evpn, vpls
    asn string
    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
    device string
    A device name from the provider configuration.
    af_name str
    • Choices: evpn, vpls
    asn str
    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
    device str
    A device name from the provider configuration.
    afName String
    • Choices: evpn, vpls
    asn String
    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
    device String
    A device name from the provider configuration.

    Import

     $ pulumi import iosxe:index/bgpAddressFamilyL2vpn:BgpAddressFamilyL2vpn example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/no-vrf/l2vpn=evpn"
    

    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