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

iosxe.BgpL2vpnEvpnNeighbor

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 L2VPN EVPN Neighbor 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.BgpL2vpnEvpnNeighbor("example", new()
        {
            Activate = true,
            Asn = "65000",
            Ip = "3.3.3.3",
            RouteReflectorClient = false,
            SendCommunity = "both",
        });
    
    });
    
    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.NewBgpL2vpnEvpnNeighbor(ctx, "example", &iosxe.BgpL2vpnEvpnNeighborArgs{
    			Activate:             pulumi.Bool(true),
    			Asn:                  pulumi.String("65000"),
    			Ip:                   pulumi.String("3.3.3.3"),
    			RouteReflectorClient: pulumi.Bool(false),
    			SendCommunity:        pulumi.String("both"),
    		})
    		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.BgpL2vpnEvpnNeighbor;
    import com.pulumi.iosxe.BgpL2vpnEvpnNeighborArgs;
    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 BgpL2vpnEvpnNeighbor("example", BgpL2vpnEvpnNeighborArgs.builder()        
                .activate(true)
                .asn("65000")
                .ip("3.3.3.3")
                .routeReflectorClient(false)
                .sendCommunity("both")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.BgpL2vpnEvpnNeighbor("example",
        activate=True,
        asn="65000",
        ip="3.3.3.3",
        route_reflector_client=False,
        send_community="both")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.BgpL2vpnEvpnNeighbor("example", {
        activate: true,
        asn: "65000",
        ip: "3.3.3.3",
        routeReflectorClient: false,
        sendCommunity: "both",
    });
    
    resources:
      example:
        type: iosxe:BgpL2vpnEvpnNeighbor
        properties:
          activate: true
          asn: '65000'
          ip: 3.3.3.3
          routeReflectorClient: false
          sendCommunity: both
    

    Create BgpL2vpnEvpnNeighbor Resource

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

    Constructor syntax

    new BgpL2vpnEvpnNeighbor(name: string, args: BgpL2vpnEvpnNeighborArgs, opts?: CustomResourceOptions);
    @overload
    def BgpL2vpnEvpnNeighbor(resource_name: str,
                             args: BgpL2vpnEvpnNeighborArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpL2vpnEvpnNeighbor(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             asn: Optional[str] = None,
                             ip: Optional[str] = None,
                             activate: Optional[bool] = None,
                             delete_mode: Optional[str] = None,
                             device: Optional[str] = None,
                             route_reflector_client: Optional[bool] = None,
                             send_community: Optional[str] = None)
    func NewBgpL2vpnEvpnNeighbor(ctx *Context, name string, args BgpL2vpnEvpnNeighborArgs, opts ...ResourceOption) (*BgpL2vpnEvpnNeighbor, error)
    public BgpL2vpnEvpnNeighbor(string name, BgpL2vpnEvpnNeighborArgs args, CustomResourceOptions? opts = null)
    public BgpL2vpnEvpnNeighbor(String name, BgpL2vpnEvpnNeighborArgs args)
    public BgpL2vpnEvpnNeighbor(String name, BgpL2vpnEvpnNeighborArgs args, CustomResourceOptions options)
    
    type: iosxe:BgpL2vpnEvpnNeighbor
    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 BgpL2vpnEvpnNeighborArgs
    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 BgpL2vpnEvpnNeighborArgs
    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 BgpL2vpnEvpnNeighborArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpL2vpnEvpnNeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpL2vpnEvpnNeighborArgs
    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 bgpL2vpnEvpnNeighborResource = new Iosxe.BgpL2vpnEvpnNeighbor("bgpL2vpnEvpnNeighborResource", new()
    {
        Asn = "string",
        Ip = "string",
        Activate = false,
        DeleteMode = "string",
        Device = "string",
        RouteReflectorClient = false,
        SendCommunity = "string",
    });
    
    example, err := iosxe.NewBgpL2vpnEvpnNeighbor(ctx, "bgpL2vpnEvpnNeighborResource", &iosxe.BgpL2vpnEvpnNeighborArgs{
    	Asn:                  pulumi.String("string"),
    	Ip:                   pulumi.String("string"),
    	Activate:             pulumi.Bool(false),
    	DeleteMode:           pulumi.String("string"),
    	Device:               pulumi.String("string"),
    	RouteReflectorClient: pulumi.Bool(false),
    	SendCommunity:        pulumi.String("string"),
    })
    
    var bgpL2vpnEvpnNeighborResource = new BgpL2vpnEvpnNeighbor("bgpL2vpnEvpnNeighborResource", BgpL2vpnEvpnNeighborArgs.builder()        
        .asn("string")
        .ip("string")
        .activate(false)
        .deleteMode("string")
        .device("string")
        .routeReflectorClient(false)
        .sendCommunity("string")
        .build());
    
    bgp_l2vpn_evpn_neighbor_resource = iosxe.BgpL2vpnEvpnNeighbor("bgpL2vpnEvpnNeighborResource",
        asn="string",
        ip="string",
        activate=False,
        delete_mode="string",
        device="string",
        route_reflector_client=False,
        send_community="string")
    
    const bgpL2vpnEvpnNeighborResource = new iosxe.BgpL2vpnEvpnNeighbor("bgpL2vpnEvpnNeighborResource", {
        asn: "string",
        ip: "string",
        activate: false,
        deleteMode: "string",
        device: "string",
        routeReflectorClient: false,
        sendCommunity: "string",
    });
    
    type: iosxe:BgpL2vpnEvpnNeighbor
    properties:
        activate: false
        asn: string
        deleteMode: string
        device: string
        ip: string
        routeReflectorClient: false
        sendCommunity: string
    

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

    Asn string
    Ip string
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    Asn string
    Ip string
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    asn String
    ip String
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard
    asn string
    ip string
    activate boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeReflectorClient boolean
    Configure a neighbor as Route Reflector client
    sendCommunity string
    • Choices: both, extended, standard
    asn str
    ip str
    activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    route_reflector_client bool
    Configure a neighbor as Route Reflector client
    send_community str
    • Choices: both, extended, standard
    asn String
    ip String
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard

    Outputs

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

    Get an existing BgpL2vpnEvpnNeighbor 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?: BgpL2vpnEvpnNeighborState, opts?: CustomResourceOptions): BgpL2vpnEvpnNeighbor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activate: Optional[bool] = None,
            asn: Optional[str] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            ip: Optional[str] = None,
            route_reflector_client: Optional[bool] = None,
            send_community: Optional[str] = None) -> BgpL2vpnEvpnNeighbor
    func GetBgpL2vpnEvpnNeighbor(ctx *Context, name string, id IDInput, state *BgpL2vpnEvpnNeighborState, opts ...ResourceOption) (*BgpL2vpnEvpnNeighbor, error)
    public static BgpL2vpnEvpnNeighbor Get(string name, Input<string> id, BgpL2vpnEvpnNeighborState? state, CustomResourceOptions? opts = null)
    public static BgpL2vpnEvpnNeighbor get(String name, Output<String> id, BgpL2vpnEvpnNeighborState 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:
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    Ip string
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    Ip string
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip String
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard
    activate boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip string
    routeReflectorClient boolean
    Configure a neighbor as Route Reflector client
    sendCommunity string
    • Choices: both, extended, standard
    activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    ip str
    route_reflector_client bool
    Configure a neighbor as Route Reflector client
    send_community str
    • Choices: both, extended, standard
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip String
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard

    Import

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

    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