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

iosxe.BgpNeighbor

Explore with Pulumi AI

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

This resource can manage the BGP 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.BgpNeighbor("example", new()
    {
        Asn = "65000",
        ClusterId = "1234",
        Description = "BGP Neighbor Description",
        DisableConnectedCheck = false,
        FallOverBfdCheckControlPlaneFailure = true,
        FallOverBfdSingleHop = true,
        FallOverBfdStrictMode = true,
        FallOverDefaultEnable = false,
        FallOverDefaultRouteMap = "RMAP",
        FallOverMaximumMetricRouteMap = "RMAP",
        Ip = "3.3.3.3",
        LogNeighborChanges = true,
        Password = "test1234",
        PasswordType = 1,
        RemoteAs = "65000",
        Shutdown = false,
        TimersHoldtime = 866,
        TimersKeepaliveInterval = 655,
        TimersMinimumNeighborHold = 222,
        UpdateSourceLoopback = "100",
        Version = 4,
    });

});
Copy
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.NewBgpNeighbor(ctx, "example", &iosxe.BgpNeighborArgs{
			Asn:                                 pulumi.String("65000"),
			ClusterId:                           pulumi.String("1234"),
			Description:                         pulumi.String("BGP Neighbor Description"),
			DisableConnectedCheck:               pulumi.Bool(false),
			FallOverBfdCheckControlPlaneFailure: pulumi.Bool(true),
			FallOverBfdSingleHop:                pulumi.Bool(true),
			FallOverBfdStrictMode:               pulumi.Bool(true),
			FallOverDefaultEnable:               pulumi.Bool(false),
			FallOverDefaultRouteMap:             pulumi.String("RMAP"),
			FallOverMaximumMetricRouteMap:       pulumi.String("RMAP"),
			Ip:                                  pulumi.String("3.3.3.3"),
			LogNeighborChanges:                  pulumi.Bool(true),
			Password:                            pulumi.String("test1234"),
			PasswordType:                        pulumi.Int(1),
			RemoteAs:                            pulumi.String("65000"),
			Shutdown:                            pulumi.Bool(false),
			TimersHoldtime:                      pulumi.Int(866),
			TimersKeepaliveInterval:             pulumi.Int(655),
			TimersMinimumNeighborHold:           pulumi.Int(222),
			UpdateSourceLoopback:                pulumi.String("100"),
			Version:                             pulumi.Int(4),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.BgpNeighbor;
import com.pulumi.iosxe.BgpNeighborArgs;
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 BgpNeighbor("example", BgpNeighborArgs.builder()        
            .asn("65000")
            .clusterId("1234")
            .description("BGP Neighbor Description")
            .disableConnectedCheck(false)
            .fallOverBfdCheckControlPlaneFailure(true)
            .fallOverBfdSingleHop(true)
            .fallOverBfdStrictMode(true)
            .fallOverDefaultEnable(false)
            .fallOverDefaultRouteMap("RMAP")
            .fallOverMaximumMetricRouteMap("RMAP")
            .ip("3.3.3.3")
            .logNeighborChanges(true)
            .password("test1234")
            .passwordType(1)
            .remoteAs("65000")
            .shutdown(false)
            .timersHoldtime(866)
            .timersKeepaliveInterval(655)
            .timersMinimumNeighborHold(222)
            .updateSourceLoopback("100")
            .version(4)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@lbrlabs/pulumi-iosxe";

const example = new iosxe.BgpNeighbor("example", {
    asn: "65000",
    clusterId: "1234",
    description: "BGP Neighbor Description",
    disableConnectedCheck: false,
    fallOverBfdCheckControlPlaneFailure: true,
    fallOverBfdSingleHop: true,
    fallOverBfdStrictMode: true,
    fallOverDefaultEnable: false,
    fallOverDefaultRouteMap: "RMAP",
    fallOverMaximumMetricRouteMap: "RMAP",
    ip: "3.3.3.3",
    logNeighborChanges: true,
    password: "test1234",
    passwordType: 1,
    remoteAs: "65000",
    shutdown: false,
    timersHoldtime: 866,
    timersKeepaliveInterval: 655,
    timersMinimumNeighborHold: 222,
    updateSourceLoopback: "100",
    version: 4,
});
Copy
import pulumi
import lbrlabs_pulumi_iosxe as iosxe

example = iosxe.BgpNeighbor("example",
    asn="65000",
    cluster_id="1234",
    description="BGP Neighbor Description",
    disable_connected_check=False,
    fall_over_bfd_check_control_plane_failure=True,
    fall_over_bfd_single_hop=True,
    fall_over_bfd_strict_mode=True,
    fall_over_default_enable=False,
    fall_over_default_route_map="RMAP",
    fall_over_maximum_metric_route_map="RMAP",
    ip="3.3.3.3",
    log_neighbor_changes=True,
    password="test1234",
    password_type=1,
    remote_as="65000",
    shutdown=False,
    timers_holdtime=866,
    timers_keepalive_interval=655,
    timers_minimum_neighbor_hold=222,
    update_source_loopback="100",
    version=4)
Copy
resources:
  example:
    type: iosxe:BgpNeighbor
    properties:
      asn: '65000'
      clusterId: '1234'
      description: BGP Neighbor Description
      disableConnectedCheck: false
      fallOverBfdCheckControlPlaneFailure: true
      fallOverBfdSingleHop: true
      fallOverBfdStrictMode: true
      fallOverDefaultEnable: false
      fallOverDefaultRouteMap: RMAP
      fallOverMaximumMetricRouteMap: RMAP
      ip: 3.3.3.3
      logNeighborChanges: true
      password: test1234
      passwordType: 1
      remoteAs: '65000'
      shutdown: false
      timersHoldtime: 866
      timersKeepaliveInterval: 655
      timersMinimumNeighborHold: 222
      updateSourceLoopback: '100'
      version: 4
Copy

Create BgpNeighbor Resource

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

Constructor syntax

new BgpNeighbor(name: string, args: BgpNeighborArgs, opts?: CustomResourceOptions);
@overload
def BgpNeighbor(resource_name: str,
                args: BgpNeighborArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def BgpNeighbor(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                asn: Optional[str] = None,
                ip: Optional[str] = None,
                fall_over_maximum_metric_route_map: Optional[str] = None,
                password: Optional[str] = None,
                device: Optional[str] = None,
                disable_connected_check: Optional[bool] = None,
                ebgp_multihop: Optional[bool] = None,
                ebgp_multihop_max_hop: Optional[int] = None,
                fall_over_bfd_check_control_plane_failure: Optional[bool] = None,
                fall_over_bfd_multi_hop: Optional[bool] = None,
                fall_over_bfd_single_hop: Optional[bool] = None,
                fall_over_bfd_strict_mode: Optional[bool] = None,
                fall_over_default_enable: Optional[bool] = None,
                fall_over_default_route_map: Optional[str] = None,
                delete_mode: Optional[str] = None,
                cluster_id: Optional[str] = None,
                description: Optional[str] = None,
                local_as_no_prepend: Optional[bool] = None,
                local_as: Optional[str] = None,
                local_as_replace_as: Optional[bool] = None,
                log_neighbor_changes: Optional[bool] = None,
                local_as_dual_as: Optional[bool] = None,
                password_type: Optional[int] = None,
                remote_as: Optional[str] = None,
                shutdown: Optional[bool] = None,
                timers_holdtime: Optional[int] = None,
                timers_keepalive_interval: Optional[int] = None,
                timers_minimum_neighbor_hold: Optional[int] = None,
                ttl_security_hops: Optional[int] = None,
                update_source_loopback: Optional[str] = None,
                version: Optional[int] = None)
func NewBgpNeighbor(ctx *Context, name string, args BgpNeighborArgs, opts ...ResourceOption) (*BgpNeighbor, error)
public BgpNeighbor(string name, BgpNeighborArgs args, CustomResourceOptions? opts = null)
public BgpNeighbor(String name, BgpNeighborArgs args)
public BgpNeighbor(String name, BgpNeighborArgs args, CustomResourceOptions options)

type: iosxe:BgpNeighbor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BgpNeighborArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BgpNeighborArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BgpNeighborArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BgpNeighborArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BgpNeighborArgs
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 bgpNeighborResource = new Iosxe.BgpNeighbor("bgpNeighborResource", new()
{
    Asn = "string",
    Ip = "string",
    FallOverMaximumMetricRouteMap = "string",
    Password = "string",
    Device = "string",
    DisableConnectedCheck = false,
    EbgpMultihop = false,
    EbgpMultihopMaxHop = 0,
    FallOverBfdCheckControlPlaneFailure = false,
    FallOverBfdMultiHop = false,
    FallOverBfdSingleHop = false,
    FallOverBfdStrictMode = false,
    FallOverDefaultEnable = false,
    FallOverDefaultRouteMap = "string",
    DeleteMode = "string",
    ClusterId = "string",
    Description = "string",
    LocalAsNoPrepend = false,
    LocalAs = "string",
    LocalAsReplaceAs = false,
    LogNeighborChanges = false,
    LocalAsDualAs = false,
    PasswordType = 0,
    RemoteAs = "string",
    Shutdown = false,
    TimersHoldtime = 0,
    TimersKeepaliveInterval = 0,
    TimersMinimumNeighborHold = 0,
    TtlSecurityHops = 0,
    UpdateSourceLoopback = "string",
    Version = 0,
});
Copy
example, err := iosxe.NewBgpNeighbor(ctx, "bgpNeighborResource", &iosxe.BgpNeighborArgs{
	Asn:                                 pulumi.String("string"),
	Ip:                                  pulumi.String("string"),
	FallOverMaximumMetricRouteMap:       pulumi.String("string"),
	Password:                            pulumi.String("string"),
	Device:                              pulumi.String("string"),
	DisableConnectedCheck:               pulumi.Bool(false),
	EbgpMultihop:                        pulumi.Bool(false),
	EbgpMultihopMaxHop:                  pulumi.Int(0),
	FallOverBfdCheckControlPlaneFailure: pulumi.Bool(false),
	FallOverBfdMultiHop:                 pulumi.Bool(false),
	FallOverBfdSingleHop:                pulumi.Bool(false),
	FallOverBfdStrictMode:               pulumi.Bool(false),
	FallOverDefaultEnable:               pulumi.Bool(false),
	FallOverDefaultRouteMap:             pulumi.String("string"),
	DeleteMode:                          pulumi.String("string"),
	ClusterId:                           pulumi.String("string"),
	Description:                         pulumi.String("string"),
	LocalAsNoPrepend:                    pulumi.Bool(false),
	LocalAs:                             pulumi.String("string"),
	LocalAsReplaceAs:                    pulumi.Bool(false),
	LogNeighborChanges:                  pulumi.Bool(false),
	LocalAsDualAs:                       pulumi.Bool(false),
	PasswordType:                        pulumi.Int(0),
	RemoteAs:                            pulumi.String("string"),
	Shutdown:                            pulumi.Bool(false),
	TimersHoldtime:                      pulumi.Int(0),
	TimersKeepaliveInterval:             pulumi.Int(0),
	TimersMinimumNeighborHold:           pulumi.Int(0),
	TtlSecurityHops:                     pulumi.Int(0),
	UpdateSourceLoopback:                pulumi.String("string"),
	Version:                             pulumi.Int(0),
})
Copy
var bgpNeighborResource = new BgpNeighbor("bgpNeighborResource", BgpNeighborArgs.builder()
    .asn("string")
    .ip("string")
    .fallOverMaximumMetricRouteMap("string")
    .password("string")
    .device("string")
    .disableConnectedCheck(false)
    .ebgpMultihop(false)
    .ebgpMultihopMaxHop(0)
    .fallOverBfdCheckControlPlaneFailure(false)
    .fallOverBfdMultiHop(false)
    .fallOverBfdSingleHop(false)
    .fallOverBfdStrictMode(false)
    .fallOverDefaultEnable(false)
    .fallOverDefaultRouteMap("string")
    .deleteMode("string")
    .clusterId("string")
    .description("string")
    .localAsNoPrepend(false)
    .localAs("string")
    .localAsReplaceAs(false)
    .logNeighborChanges(false)
    .localAsDualAs(false)
    .passwordType(0)
    .remoteAs("string")
    .shutdown(false)
    .timersHoldtime(0)
    .timersKeepaliveInterval(0)
    .timersMinimumNeighborHold(0)
    .ttlSecurityHops(0)
    .updateSourceLoopback("string")
    .version(0)
    .build());
Copy
bgp_neighbor_resource = iosxe.BgpNeighbor("bgpNeighborResource",
    asn="string",
    ip="string",
    fall_over_maximum_metric_route_map="string",
    password="string",
    device="string",
    disable_connected_check=False,
    ebgp_multihop=False,
    ebgp_multihop_max_hop=0,
    fall_over_bfd_check_control_plane_failure=False,
    fall_over_bfd_multi_hop=False,
    fall_over_bfd_single_hop=False,
    fall_over_bfd_strict_mode=False,
    fall_over_default_enable=False,
    fall_over_default_route_map="string",
    delete_mode="string",
    cluster_id="string",
    description="string",
    local_as_no_prepend=False,
    local_as="string",
    local_as_replace_as=False,
    log_neighbor_changes=False,
    local_as_dual_as=False,
    password_type=0,
    remote_as="string",
    shutdown=False,
    timers_holdtime=0,
    timers_keepalive_interval=0,
    timers_minimum_neighbor_hold=0,
    ttl_security_hops=0,
    update_source_loopback="string",
    version=0)
Copy
const bgpNeighborResource = new iosxe.BgpNeighbor("bgpNeighborResource", {
    asn: "string",
    ip: "string",
    fallOverMaximumMetricRouteMap: "string",
    password: "string",
    device: "string",
    disableConnectedCheck: false,
    ebgpMultihop: false,
    ebgpMultihopMaxHop: 0,
    fallOverBfdCheckControlPlaneFailure: false,
    fallOverBfdMultiHop: false,
    fallOverBfdSingleHop: false,
    fallOverBfdStrictMode: false,
    fallOverDefaultEnable: false,
    fallOverDefaultRouteMap: "string",
    deleteMode: "string",
    clusterId: "string",
    description: "string",
    localAsNoPrepend: false,
    localAs: "string",
    localAsReplaceAs: false,
    logNeighborChanges: false,
    localAsDualAs: false,
    passwordType: 0,
    remoteAs: "string",
    shutdown: false,
    timersHoldtime: 0,
    timersKeepaliveInterval: 0,
    timersMinimumNeighborHold: 0,
    ttlSecurityHops: 0,
    updateSourceLoopback: "string",
    version: 0,
});
Copy
type: iosxe:BgpNeighbor
properties:
    asn: string
    clusterId: string
    deleteMode: string
    description: string
    device: string
    disableConnectedCheck: false
    ebgpMultihop: false
    ebgpMultihopMaxHop: 0
    fallOverBfdCheckControlPlaneFailure: false
    fallOverBfdMultiHop: false
    fallOverBfdSingleHop: false
    fallOverBfdStrictMode: false
    fallOverDefaultEnable: false
    fallOverDefaultRouteMap: string
    fallOverMaximumMetricRouteMap: string
    ip: string
    localAs: string
    localAsDualAs: false
    localAsNoPrepend: false
    localAsReplaceAs: false
    logNeighborChanges: false
    password: string
    passwordType: 0
    remoteAs: string
    shutdown: false
    timersHoldtime: 0
    timersKeepaliveInterval: 0
    timersMinimumNeighborHold: 0
    ttlSecurityHops: 0
    updateSourceLoopback: string
    version: 0
Copy

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

Asn This property is required. string
Ip This property is required. string
ClusterId 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
Description string
Neighbor specific description
Device string
A device name from the provider configuration.
DisableConnectedCheck bool
one-hop away EBGP peer using loopback address
EbgpMultihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
EbgpMultihopMaxHop int
  • Range: 2-255
FallOverBfdCheckControlPlaneFailure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
FallOverBfdMultiHop bool
Force BFD multi-hop to detect failure
FallOverBfdSingleHop bool
Force BFD single-hop to detect failure
FallOverBfdStrictMode bool
Enable BFD strict-mode
FallOverDefaultEnable bool
FallOverDefaultRouteMap string
FallOverMaximumMetricRouteMap string
LocalAs string
LocalAsDualAs bool
Accept either real AS or local AS from the ebgp peer
LocalAsNoPrepend bool
Do not prepend local-as to updates from ebgp peers
LocalAsReplaceAs bool
Replace real AS with local AS in the EBGP updates
LogNeighborChanges bool
Log neighbor up/down and reset reason
Password string
PasswordType int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
RemoteAs string
Specify a BGP peer-group remote-as
Shutdown bool
Administratively shut down this neighbor
TimersHoldtime int
  • Range: 0-65535
TimersKeepaliveInterval int
  • Range: 0-65535
TimersMinimumNeighborHold int
  • Range: 0-65535
TtlSecurityHops int
IP hops - Range: 1-254
UpdateSourceLoopback string
Loopback interface
Version int
Set the BGP version to match a neighbor - Range: 4-4
Asn This property is required. string
Ip This property is required. string
ClusterId 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
Description string
Neighbor specific description
Device string
A device name from the provider configuration.
DisableConnectedCheck bool
one-hop away EBGP peer using loopback address
EbgpMultihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
EbgpMultihopMaxHop int
  • Range: 2-255
FallOverBfdCheckControlPlaneFailure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
FallOverBfdMultiHop bool
Force BFD multi-hop to detect failure
FallOverBfdSingleHop bool
Force BFD single-hop to detect failure
FallOverBfdStrictMode bool
Enable BFD strict-mode
FallOverDefaultEnable bool
FallOverDefaultRouteMap string
FallOverMaximumMetricRouteMap string
LocalAs string
LocalAsDualAs bool
Accept either real AS or local AS from the ebgp peer
LocalAsNoPrepend bool
Do not prepend local-as to updates from ebgp peers
LocalAsReplaceAs bool
Replace real AS with local AS in the EBGP updates
LogNeighborChanges bool
Log neighbor up/down and reset reason
Password string
PasswordType int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
RemoteAs string
Specify a BGP peer-group remote-as
Shutdown bool
Administratively shut down this neighbor
TimersHoldtime int
  • Range: 0-65535
TimersKeepaliveInterval int
  • Range: 0-65535
TimersMinimumNeighborHold int
  • Range: 0-65535
TtlSecurityHops int
IP hops - Range: 1-254
UpdateSourceLoopback string
Loopback interface
Version int
Set the BGP version to match a neighbor - Range: 4-4
asn This property is required. String
ip This property is required. String
clusterId 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
description String
Neighbor specific description
device String
A device name from the provider configuration.
disableConnectedCheck Boolean
one-hop away EBGP peer using loopback address
ebgpMultihop Boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop Integer
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure Boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop Boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop Boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode Boolean
Enable BFD strict-mode
fallOverDefaultEnable Boolean
fallOverDefaultRouteMap String
fallOverMaximumMetricRouteMap String
localAs String
localAsDualAs Boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend Boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs Boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges Boolean
Log neighbor up/down and reset reason
password String
passwordType Integer
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs String
Specify a BGP peer-group remote-as
shutdown Boolean
Administratively shut down this neighbor
timersHoldtime Integer
  • Range: 0-65535
timersKeepaliveInterval Integer
  • Range: 0-65535
timersMinimumNeighborHold Integer
  • Range: 0-65535
ttlSecurityHops Integer
IP hops - Range: 1-254
updateSourceLoopback String
Loopback interface
version Integer
Set the BGP version to match a neighbor - Range: 4-4
asn This property is required. string
ip This property is required. string
clusterId 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
description string
Neighbor specific description
device string
A device name from the provider configuration.
disableConnectedCheck boolean
one-hop away EBGP peer using loopback address
ebgpMultihop boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop number
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode boolean
Enable BFD strict-mode
fallOverDefaultEnable boolean
fallOverDefaultRouteMap string
fallOverMaximumMetricRouteMap string
localAs string
localAsDualAs boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges boolean
Log neighbor up/down and reset reason
password string
passwordType number
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs string
Specify a BGP peer-group remote-as
shutdown boolean
Administratively shut down this neighbor
timersHoldtime number
  • Range: 0-65535
timersKeepaliveInterval number
  • Range: 0-65535
timersMinimumNeighborHold number
  • Range: 0-65535
ttlSecurityHops number
IP hops - Range: 1-254
updateSourceLoopback string
Loopback interface
version number
Set the BGP version to match a neighbor - Range: 4-4
asn This property is required. str
ip This property is required. str
cluster_id 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
description str
Neighbor specific description
device str
A device name from the provider configuration.
disable_connected_check bool
one-hop away EBGP peer using loopback address
ebgp_multihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgp_multihop_max_hop int
  • Range: 2-255
fall_over_bfd_check_control_plane_failure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fall_over_bfd_multi_hop bool
Force BFD multi-hop to detect failure
fall_over_bfd_single_hop bool
Force BFD single-hop to detect failure
fall_over_bfd_strict_mode bool
Enable BFD strict-mode
fall_over_default_enable bool
fall_over_default_route_map str
fall_over_maximum_metric_route_map str
local_as str
local_as_dual_as bool
Accept either real AS or local AS from the ebgp peer
local_as_no_prepend bool
Do not prepend local-as to updates from ebgp peers
local_as_replace_as bool
Replace real AS with local AS in the EBGP updates
log_neighbor_changes bool
Log neighbor up/down and reset reason
password str
password_type int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remote_as str
Specify a BGP peer-group remote-as
shutdown bool
Administratively shut down this neighbor
timers_holdtime int
  • Range: 0-65535
timers_keepalive_interval int
  • Range: 0-65535
timers_minimum_neighbor_hold int
  • Range: 0-65535
ttl_security_hops int
IP hops - Range: 1-254
update_source_loopback str
Loopback interface
version int
Set the BGP version to match a neighbor - Range: 4-4
asn This property is required. String
ip This property is required. String
clusterId 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
description String
Neighbor specific description
device String
A device name from the provider configuration.
disableConnectedCheck Boolean
one-hop away EBGP peer using loopback address
ebgpMultihop Boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop Number
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure Boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop Boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop Boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode Boolean
Enable BFD strict-mode
fallOverDefaultEnable Boolean
fallOverDefaultRouteMap String
fallOverMaximumMetricRouteMap String
localAs String
localAsDualAs Boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend Boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs Boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges Boolean
Log neighbor up/down and reset reason
password String
passwordType Number
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs String
Specify a BGP peer-group remote-as
shutdown Boolean
Administratively shut down this neighbor
timersHoldtime Number
  • Range: 0-65535
timersKeepaliveInterval Number
  • Range: 0-65535
timersMinimumNeighborHold Number
  • Range: 0-65535
ttlSecurityHops Number
IP hops - Range: 1-254
updateSourceLoopback String
Loopback interface
version Number
Set the BGP version to match a neighbor - Range: 4-4

Outputs

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

Get an existing BgpNeighbor 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?: BgpNeighborState, opts?: CustomResourceOptions): BgpNeighbor
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asn: Optional[str] = None,
        cluster_id: Optional[str] = None,
        delete_mode: Optional[str] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        disable_connected_check: Optional[bool] = None,
        ebgp_multihop: Optional[bool] = None,
        ebgp_multihop_max_hop: Optional[int] = None,
        fall_over_bfd_check_control_plane_failure: Optional[bool] = None,
        fall_over_bfd_multi_hop: Optional[bool] = None,
        fall_over_bfd_single_hop: Optional[bool] = None,
        fall_over_bfd_strict_mode: Optional[bool] = None,
        fall_over_default_enable: Optional[bool] = None,
        fall_over_default_route_map: Optional[str] = None,
        fall_over_maximum_metric_route_map: Optional[str] = None,
        ip: Optional[str] = None,
        local_as: Optional[str] = None,
        local_as_dual_as: Optional[bool] = None,
        local_as_no_prepend: Optional[bool] = None,
        local_as_replace_as: Optional[bool] = None,
        log_neighbor_changes: Optional[bool] = None,
        password: Optional[str] = None,
        password_type: Optional[int] = None,
        remote_as: Optional[str] = None,
        shutdown: Optional[bool] = None,
        timers_holdtime: Optional[int] = None,
        timers_keepalive_interval: Optional[int] = None,
        timers_minimum_neighbor_hold: Optional[int] = None,
        ttl_security_hops: Optional[int] = None,
        update_source_loopback: Optional[str] = None,
        version: Optional[int] = None) -> BgpNeighbor
func GetBgpNeighbor(ctx *Context, name string, id IDInput, state *BgpNeighborState, opts ...ResourceOption) (*BgpNeighbor, error)
public static BgpNeighbor Get(string name, Input<string> id, BgpNeighborState? state, CustomResourceOptions? opts = null)
public static BgpNeighbor get(String name, Output<String> id, BgpNeighborState state, CustomResourceOptions options)
resources:  _:    type: iosxe:BgpNeighbor    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Asn string
ClusterId 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
Description string
Neighbor specific description
Device string
A device name from the provider configuration.
DisableConnectedCheck bool
one-hop away EBGP peer using loopback address
EbgpMultihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
EbgpMultihopMaxHop int
  • Range: 2-255
FallOverBfdCheckControlPlaneFailure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
FallOverBfdMultiHop bool
Force BFD multi-hop to detect failure
FallOverBfdSingleHop bool
Force BFD single-hop to detect failure
FallOverBfdStrictMode bool
Enable BFD strict-mode
FallOverDefaultEnable bool
FallOverDefaultRouteMap string
FallOverMaximumMetricRouteMap string
Ip string
LocalAs string
LocalAsDualAs bool
Accept either real AS or local AS from the ebgp peer
LocalAsNoPrepend bool
Do not prepend local-as to updates from ebgp peers
LocalAsReplaceAs bool
Replace real AS with local AS in the EBGP updates
LogNeighborChanges bool
Log neighbor up/down and reset reason
Password string
PasswordType int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
RemoteAs string
Specify a BGP peer-group remote-as
Shutdown bool
Administratively shut down this neighbor
TimersHoldtime int
  • Range: 0-65535
TimersKeepaliveInterval int
  • Range: 0-65535
TimersMinimumNeighborHold int
  • Range: 0-65535
TtlSecurityHops int
IP hops - Range: 1-254
UpdateSourceLoopback string
Loopback interface
Version int
Set the BGP version to match a neighbor - Range: 4-4
Asn string
ClusterId 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
Description string
Neighbor specific description
Device string
A device name from the provider configuration.
DisableConnectedCheck bool
one-hop away EBGP peer using loopback address
EbgpMultihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
EbgpMultihopMaxHop int
  • Range: 2-255
FallOverBfdCheckControlPlaneFailure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
FallOverBfdMultiHop bool
Force BFD multi-hop to detect failure
FallOverBfdSingleHop bool
Force BFD single-hop to detect failure
FallOverBfdStrictMode bool
Enable BFD strict-mode
FallOverDefaultEnable bool
FallOverDefaultRouteMap string
FallOverMaximumMetricRouteMap string
Ip string
LocalAs string
LocalAsDualAs bool
Accept either real AS or local AS from the ebgp peer
LocalAsNoPrepend bool
Do not prepend local-as to updates from ebgp peers
LocalAsReplaceAs bool
Replace real AS with local AS in the EBGP updates
LogNeighborChanges bool
Log neighbor up/down and reset reason
Password string
PasswordType int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
RemoteAs string
Specify a BGP peer-group remote-as
Shutdown bool
Administratively shut down this neighbor
TimersHoldtime int
  • Range: 0-65535
TimersKeepaliveInterval int
  • Range: 0-65535
TimersMinimumNeighborHold int
  • Range: 0-65535
TtlSecurityHops int
IP hops - Range: 1-254
UpdateSourceLoopback string
Loopback interface
Version int
Set the BGP version to match a neighbor - Range: 4-4
asn String
clusterId 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
description String
Neighbor specific description
device String
A device name from the provider configuration.
disableConnectedCheck Boolean
one-hop away EBGP peer using loopback address
ebgpMultihop Boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop Integer
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure Boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop Boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop Boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode Boolean
Enable BFD strict-mode
fallOverDefaultEnable Boolean
fallOverDefaultRouteMap String
fallOverMaximumMetricRouteMap String
ip String
localAs String
localAsDualAs Boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend Boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs Boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges Boolean
Log neighbor up/down and reset reason
password String
passwordType Integer
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs String
Specify a BGP peer-group remote-as
shutdown Boolean
Administratively shut down this neighbor
timersHoldtime Integer
  • Range: 0-65535
timersKeepaliveInterval Integer
  • Range: 0-65535
timersMinimumNeighborHold Integer
  • Range: 0-65535
ttlSecurityHops Integer
IP hops - Range: 1-254
updateSourceLoopback String
Loopback interface
version Integer
Set the BGP version to match a neighbor - Range: 4-4
asn string
clusterId 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
description string
Neighbor specific description
device string
A device name from the provider configuration.
disableConnectedCheck boolean
one-hop away EBGP peer using loopback address
ebgpMultihop boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop number
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode boolean
Enable BFD strict-mode
fallOverDefaultEnable boolean
fallOverDefaultRouteMap string
fallOverMaximumMetricRouteMap string
ip string
localAs string
localAsDualAs boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges boolean
Log neighbor up/down and reset reason
password string
passwordType number
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs string
Specify a BGP peer-group remote-as
shutdown boolean
Administratively shut down this neighbor
timersHoldtime number
  • Range: 0-65535
timersKeepaliveInterval number
  • Range: 0-65535
timersMinimumNeighborHold number
  • Range: 0-65535
ttlSecurityHops number
IP hops - Range: 1-254
updateSourceLoopback string
Loopback interface
version number
Set the BGP version to match a neighbor - Range: 4-4
asn str
cluster_id 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
description str
Neighbor specific description
device str
A device name from the provider configuration.
disable_connected_check bool
one-hop away EBGP peer using loopback address
ebgp_multihop bool
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgp_multihop_max_hop int
  • Range: 2-255
fall_over_bfd_check_control_plane_failure bool
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fall_over_bfd_multi_hop bool
Force BFD multi-hop to detect failure
fall_over_bfd_single_hop bool
Force BFD single-hop to detect failure
fall_over_bfd_strict_mode bool
Enable BFD strict-mode
fall_over_default_enable bool
fall_over_default_route_map str
fall_over_maximum_metric_route_map str
ip str
local_as str
local_as_dual_as bool
Accept either real AS or local AS from the ebgp peer
local_as_no_prepend bool
Do not prepend local-as to updates from ebgp peers
local_as_replace_as bool
Replace real AS with local AS in the EBGP updates
log_neighbor_changes bool
Log neighbor up/down and reset reason
password str
password_type int
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remote_as str
Specify a BGP peer-group remote-as
shutdown bool
Administratively shut down this neighbor
timers_holdtime int
  • Range: 0-65535
timers_keepalive_interval int
  • Range: 0-65535
timers_minimum_neighbor_hold int
  • Range: 0-65535
ttl_security_hops int
IP hops - Range: 1-254
update_source_loopback str
Loopback interface
version int
Set the BGP version to match a neighbor - Range: 4-4
asn String
clusterId 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
description String
Neighbor specific description
device String
A device name from the provider configuration.
disableConnectedCheck Boolean
one-hop away EBGP peer using loopback address
ebgpMultihop Boolean
Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
ebgpMultihopMaxHop Number
  • Range: 2-255
fallOverBfdCheckControlPlaneFailure Boolean
Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
fallOverBfdMultiHop Boolean
Force BFD multi-hop to detect failure
fallOverBfdSingleHop Boolean
Force BFD single-hop to detect failure
fallOverBfdStrictMode Boolean
Enable BFD strict-mode
fallOverDefaultEnable Boolean
fallOverDefaultRouteMap String
fallOverMaximumMetricRouteMap String
ip String
localAs String
localAsDualAs Boolean
Accept either real AS or local AS from the ebgp peer
localAsNoPrepend Boolean
Do not prepend local-as to updates from ebgp peers
localAsReplaceAs Boolean
Replace real AS with local AS in the EBGP updates
logNeighborChanges Boolean
Log neighbor up/down and reset reason
password String
passwordType Number
Encryption type (0 to disable encryption, 7 for proprietary) - Range: 0-7
remoteAs String
Specify a BGP peer-group remote-as
shutdown Boolean
Administratively shut down this neighbor
timersHoldtime Number
  • Range: 0-65535
timersKeepaliveInterval Number
  • Range: 0-65535
timersMinimumNeighborHold Number
  • Range: 0-65535
ttlSecurityHops Number
IP hops - Range: 1-254
updateSourceLoopback String
Loopback interface
version Number
Set the BGP version to match a neighbor - Range: 4-4

Import

 $ pulumi import iosxe:index/bgpNeighbor:BgpNeighbor example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/neighbor=3.3.3.3"
Copy

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