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

iosxe.BgpIpv4UnicastVrfNeighbor

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 IPv4 Unicast VRF Neighbor configuration.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.BgpIpv4UnicastVrfNeighbor;
import com.pulumi.iosxe.BgpIpv4UnicastVrfNeighborArgs;
import com.pulumi.iosxe.inputs.BgpIpv4UnicastVrfNeighborRouteMapArgs;
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 BgpIpv4UnicastVrfNeighbor("example", BgpIpv4UnicastVrfNeighborArgs.builder()        
            .activate(true)
            .asn("65000")
            .clusterId("2.2.2.2")
            .description("BGP Neighbor Description")
            .fallOverBfdCheckControlPlaneFailure(true)
            .fallOverBfdSingleHop(true)
            .fallOverBfdStrictMode(true)
            .fallOverDefaultRouteMap("RMAP")
            .fallOverMaximumMetricRouteMap("ROUTEMAP")
            .ip("3.3.3.3")
            .logNeighborChangesDisable(true)
            .password("LINE")
            .passwordType(1)
            .remoteAs("65000")
            .routeMaps(BgpIpv4UnicastVrfNeighborRouteMapArgs.builder()
                .in_out("in")
                .route_map_name("RM1")
                .build())
            .routeReflectorClient(false)
            .sendCommunity("both")
            .shutdown(false)
            .timersHoldtime(40)
            .timersKeepaliveInterval(30)
            .timersMinimumNeighborHold(30)
            .updateSourceLoopback("100")
            .version(4)
            .vrf("VRF1")
            .build());

    }
}
Copy

Coming soon!

Coming soon!

resources:
  example:
    type: iosxe:BgpIpv4UnicastVrfNeighbor
    properties:
      activate: true
      asn: '65000'
      clusterId: 2.2.2.2
      description: BGP Neighbor Description
      fallOverBfdCheckControlPlaneFailure: true
      fallOverBfdSingleHop: true
      fallOverBfdStrictMode: true
      fallOverDefaultRouteMap: RMAP
      fallOverMaximumMetricRouteMap: ROUTEMAP
      ip: 3.3.3.3
      logNeighborChangesDisable: true
      password: LINE
      passwordType: 1
      remoteAs: '65000'
      routeMaps:
        - in_out: in
          route_map_name: RM1
      routeReflectorClient: false
      sendCommunity: both
      shutdown: false
      timersHoldtime: 40
      timersKeepaliveInterval: 30
      timersMinimumNeighborHold: 30
      updateSourceLoopback: '100'
      version: 4
      vrf: VRF1
Copy

Create BgpIpv4UnicastVrfNeighbor Resource

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

Constructor syntax

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

@overload
def BgpIpv4UnicastVrfNeighbor(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              ip: Optional[str] = None,
                              asn: Optional[str] = None,
                              vrf: Optional[str] = None,
                              local_as: Optional[str] = None,
                              log_neighbor_changes_disable: Optional[bool] = 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,
                              local_as_replace_as: Optional[bool] = None,
                              fall_over_bfd_strict_mode: Optional[bool] = None,
                              fall_over_default_route_map: Optional[str] = None,
                              fall_over_maximum_metric_route_map: Optional[str] = None,
                              delete_mode: Optional[str] = None,
                              activate: Optional[bool] = None,
                              description: Optional[str] = None,
                              local_as_dual_as: Optional[bool] = None,
                              fall_over_bfd_single_hop: Optional[bool] = None,
                              local_as_no_prepend: Optional[bool] = None,
                              password: Optional[str] = None,
                              password_type: Optional[int] = None,
                              remote_as: Optional[str] = None,
                              route_maps: Optional[Sequence[BgpIpv4UnicastVrfNeighborRouteMapArgs]] = None,
                              route_reflector_client: Optional[bool] = None,
                              send_community: 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,
                              cluster_id: Optional[str] = None)
func NewBgpIpv4UnicastVrfNeighbor(ctx *Context, name string, args BgpIpv4UnicastVrfNeighborArgs, opts ...ResourceOption) (*BgpIpv4UnicastVrfNeighbor, error)
public BgpIpv4UnicastVrfNeighbor(string name, BgpIpv4UnicastVrfNeighborArgs args, CustomResourceOptions? opts = null)
public BgpIpv4UnicastVrfNeighbor(String name, BgpIpv4UnicastVrfNeighborArgs args)
public BgpIpv4UnicastVrfNeighbor(String name, BgpIpv4UnicastVrfNeighborArgs args, CustomResourceOptions options)

type: iosxe:BgpIpv4UnicastVrfNeighbor
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. BgpIpv4UnicastVrfNeighborArgs
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. BgpIpv4UnicastVrfNeighborArgs
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. BgpIpv4UnicastVrfNeighborArgs
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. BgpIpv4UnicastVrfNeighborArgs
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. BgpIpv4UnicastVrfNeighborArgs
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 bgpIpv4UnicastVrfNeighborResource = new Iosxe.BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource", new()
{
    Ip = "string",
    Asn = "string",
    Vrf = "string",
    LocalAs = "string",
    LogNeighborChangesDisable = false,
    Device = "string",
    DisableConnectedCheck = false,
    EbgpMultihop = false,
    EbgpMultihopMaxHop = 0,
    FallOverBfdCheckControlPlaneFailure = false,
    FallOverBfdMultiHop = false,
    LocalAsReplaceAs = false,
    FallOverBfdStrictMode = false,
    FallOverDefaultRouteMap = "string",
    FallOverMaximumMetricRouteMap = "string",
    DeleteMode = "string",
    Activate = false,
    Description = "string",
    LocalAsDualAs = false,
    FallOverBfdSingleHop = false,
    LocalAsNoPrepend = false,
    Password = "string",
    PasswordType = 0,
    RemoteAs = "string",
    RouteMaps = new[]
    {
        new Iosxe.Inputs.BgpIpv4UnicastVrfNeighborRouteMapArgs
        {
            InOut = "string",
            RouteMapName = "string",
        },
    },
    RouteReflectorClient = false,
    SendCommunity = "string",
    Shutdown = false,
    TimersHoldtime = 0,
    TimersKeepaliveInterval = 0,
    TimersMinimumNeighborHold = 0,
    TtlSecurityHops = 0,
    UpdateSourceLoopback = "string",
    Version = 0,
    ClusterId = "string",
});
Copy
example, err := iosxe.NewBgpIpv4UnicastVrfNeighbor(ctx, "bgpIpv4UnicastVrfNeighborResource", &iosxe.BgpIpv4UnicastVrfNeighborArgs{
	Ip:                                  pulumi.String("string"),
	Asn:                                 pulumi.String("string"),
	Vrf:                                 pulumi.String("string"),
	LocalAs:                             pulumi.String("string"),
	LogNeighborChangesDisable:           pulumi.Bool(false),
	Device:                              pulumi.String("string"),
	DisableConnectedCheck:               pulumi.Bool(false),
	EbgpMultihop:                        pulumi.Bool(false),
	EbgpMultihopMaxHop:                  pulumi.Int(0),
	FallOverBfdCheckControlPlaneFailure: pulumi.Bool(false),
	FallOverBfdMultiHop:                 pulumi.Bool(false),
	LocalAsReplaceAs:                    pulumi.Bool(false),
	FallOverBfdStrictMode:               pulumi.Bool(false),
	FallOverDefaultRouteMap:             pulumi.String("string"),
	FallOverMaximumMetricRouteMap:       pulumi.String("string"),
	DeleteMode:                          pulumi.String("string"),
	Activate:                            pulumi.Bool(false),
	Description:                         pulumi.String("string"),
	LocalAsDualAs:                       pulumi.Bool(false),
	FallOverBfdSingleHop:                pulumi.Bool(false),
	LocalAsNoPrepend:                    pulumi.Bool(false),
	Password:                            pulumi.String("string"),
	PasswordType:                        pulumi.Int(0),
	RemoteAs:                            pulumi.String("string"),
	RouteMaps: iosxe.BgpIpv4UnicastVrfNeighborRouteMapArray{
		&iosxe.BgpIpv4UnicastVrfNeighborRouteMapArgs{
			InOut:        pulumi.String("string"),
			RouteMapName: pulumi.String("string"),
		},
	},
	RouteReflectorClient:      pulumi.Bool(false),
	SendCommunity:             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),
	ClusterId:                 pulumi.String("string"),
})
Copy
var bgpIpv4UnicastVrfNeighborResource = new BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource", BgpIpv4UnicastVrfNeighborArgs.builder()
    .ip("string")
    .asn("string")
    .vrf("string")
    .localAs("string")
    .logNeighborChangesDisable(false)
    .device("string")
    .disableConnectedCheck(false)
    .ebgpMultihop(false)
    .ebgpMultihopMaxHop(0)
    .fallOverBfdCheckControlPlaneFailure(false)
    .fallOverBfdMultiHop(false)
    .localAsReplaceAs(false)
    .fallOverBfdStrictMode(false)
    .fallOverDefaultRouteMap("string")
    .fallOverMaximumMetricRouteMap("string")
    .deleteMode("string")
    .activate(false)
    .description("string")
    .localAsDualAs(false)
    .fallOverBfdSingleHop(false)
    .localAsNoPrepend(false)
    .password("string")
    .passwordType(0)
    .remoteAs("string")
    .routeMaps(BgpIpv4UnicastVrfNeighborRouteMapArgs.builder()
        .inOut("string")
        .routeMapName("string")
        .build())
    .routeReflectorClient(false)
    .sendCommunity("string")
    .shutdown(false)
    .timersHoldtime(0)
    .timersKeepaliveInterval(0)
    .timersMinimumNeighborHold(0)
    .ttlSecurityHops(0)
    .updateSourceLoopback("string")
    .version(0)
    .clusterId("string")
    .build());
Copy
bgp_ipv4_unicast_vrf_neighbor_resource = iosxe.BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource",
    ip="string",
    asn="string",
    vrf="string",
    local_as="string",
    log_neighbor_changes_disable=False,
    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,
    local_as_replace_as=False,
    fall_over_bfd_strict_mode=False,
    fall_over_default_route_map="string",
    fall_over_maximum_metric_route_map="string",
    delete_mode="string",
    activate=False,
    description="string",
    local_as_dual_as=False,
    fall_over_bfd_single_hop=False,
    local_as_no_prepend=False,
    password="string",
    password_type=0,
    remote_as="string",
    route_maps=[{
        "in_out": "string",
        "route_map_name": "string",
    }],
    route_reflector_client=False,
    send_community="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,
    cluster_id="string")
Copy
const bgpIpv4UnicastVrfNeighborResource = new iosxe.BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource", {
    ip: "string",
    asn: "string",
    vrf: "string",
    localAs: "string",
    logNeighborChangesDisable: false,
    device: "string",
    disableConnectedCheck: false,
    ebgpMultihop: false,
    ebgpMultihopMaxHop: 0,
    fallOverBfdCheckControlPlaneFailure: false,
    fallOverBfdMultiHop: false,
    localAsReplaceAs: false,
    fallOverBfdStrictMode: false,
    fallOverDefaultRouteMap: "string",
    fallOverMaximumMetricRouteMap: "string",
    deleteMode: "string",
    activate: false,
    description: "string",
    localAsDualAs: false,
    fallOverBfdSingleHop: false,
    localAsNoPrepend: false,
    password: "string",
    passwordType: 0,
    remoteAs: "string",
    routeMaps: [{
        inOut: "string",
        routeMapName: "string",
    }],
    routeReflectorClient: false,
    sendCommunity: "string",
    shutdown: false,
    timersHoldtime: 0,
    timersKeepaliveInterval: 0,
    timersMinimumNeighborHold: 0,
    ttlSecurityHops: 0,
    updateSourceLoopback: "string",
    version: 0,
    clusterId: "string",
});
Copy
type: iosxe:BgpIpv4UnicastVrfNeighbor
properties:
    activate: false
    asn: string
    clusterId: string
    deleteMode: string
    description: string
    device: string
    disableConnectedCheck: false
    ebgpMultihop: false
    ebgpMultihopMaxHop: 0
    fallOverBfdCheckControlPlaneFailure: false
    fallOverBfdMultiHop: false
    fallOverBfdSingleHop: false
    fallOverBfdStrictMode: false
    fallOverDefaultRouteMap: string
    fallOverMaximumMetricRouteMap: string
    ip: string
    localAs: string
    localAsDualAs: false
    localAsNoPrepend: false
    localAsReplaceAs: false
    logNeighborChangesDisable: false
    password: string
    passwordType: 0
    remoteAs: string
    routeMaps:
        - inOut: string
          routeMapName: string
    routeReflectorClient: false
    sendCommunity: string
    shutdown: false
    timersHoldtime: 0
    timersKeepaliveInterval: 0
    timersMinimumNeighborHold: 0
    ttlSecurityHops: 0
    updateSourceLoopback: string
    version: 0
    vrf: string
Copy

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

Asn This property is required. string
Ip This property is required. string
Vrf This property is required. string
Activate bool
Enable the address family for this neighbor - Default value: true
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
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
LogNeighborChangesDisable bool
disable
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
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv4UnicastVrfNeighborRouteMap>
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
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
Vrf This property is required. string
Activate bool
Enable the address family for this neighbor - Default value: true
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
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
LogNeighborChangesDisable bool
disable
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
RouteMaps []BgpIpv4UnicastVrfNeighborRouteMapArgs
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
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
vrf This property is required. String
activate Boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable Boolean
disable
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
routeMaps List<BgpIpv4UnicastVrfNeighborRouteMap>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
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
vrf This property is required. string
activate boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable boolean
disable
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
routeMaps BgpIpv4UnicastVrfNeighborRouteMap[]
Apply route map to neighbor
routeReflectorClient boolean
Configure a neighbor as Route Reflector client
sendCommunity string
  • Choices: both, extended, standard
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
vrf This property is required. str
activate bool
Enable the address family for this neighbor - Default value: true
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_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_disable bool
disable
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
route_maps Sequence[BgpIpv4UnicastVrfNeighborRouteMapArgs]
Apply route map to neighbor
route_reflector_client bool
Configure a neighbor as Route Reflector client
send_community str
  • Choices: both, extended, standard
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
vrf This property is required. String
activate Boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable Boolean
disable
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
routeMaps List<Property Map>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
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 BgpIpv4UnicastVrfNeighbor 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 BgpIpv4UnicastVrfNeighbor Resource

Get an existing BgpIpv4UnicastVrfNeighbor 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?: BgpIpv4UnicastVrfNeighborState, opts?: CustomResourceOptions): BgpIpv4UnicastVrfNeighbor
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activate: Optional[bool] = 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_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_disable: Optional[bool] = None,
        password: Optional[str] = None,
        password_type: Optional[int] = None,
        remote_as: Optional[str] = None,
        route_maps: Optional[Sequence[BgpIpv4UnicastVrfNeighborRouteMapArgs]] = None,
        route_reflector_client: Optional[bool] = None,
        send_community: 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,
        vrf: Optional[str] = None) -> BgpIpv4UnicastVrfNeighbor
func GetBgpIpv4UnicastVrfNeighbor(ctx *Context, name string, id IDInput, state *BgpIpv4UnicastVrfNeighborState, opts ...ResourceOption) (*BgpIpv4UnicastVrfNeighbor, error)
public static BgpIpv4UnicastVrfNeighbor Get(string name, Input<string> id, BgpIpv4UnicastVrfNeighborState? state, CustomResourceOptions? opts = null)
public static BgpIpv4UnicastVrfNeighbor get(String name, Output<String> id, BgpIpv4UnicastVrfNeighborState state, CustomResourceOptions options)
resources:  _:    type: iosxe:BgpIpv4UnicastVrfNeighbor    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:
Activate bool
Enable the address family for this neighbor - Default value: true
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
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
LogNeighborChangesDisable bool
disable
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
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv4UnicastVrfNeighborRouteMap>
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
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
Vrf string
Activate bool
Enable the address family for this neighbor - Default value: true
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
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
LogNeighborChangesDisable bool
disable
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
RouteMaps []BgpIpv4UnicastVrfNeighborRouteMapArgs
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
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
Vrf string
activate Boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable Boolean
disable
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
routeMaps List<BgpIpv4UnicastVrfNeighborRouteMap>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
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
vrf String
activate boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable boolean
disable
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
routeMaps BgpIpv4UnicastVrfNeighborRouteMap[]
Apply route map to neighbor
routeReflectorClient boolean
Configure a neighbor as Route Reflector client
sendCommunity string
  • Choices: both, extended, standard
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
vrf string
activate bool
Enable the address family for this neighbor - Default value: true
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_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_disable bool
disable
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
route_maps Sequence[BgpIpv4UnicastVrfNeighborRouteMapArgs]
Apply route map to neighbor
route_reflector_client bool
Configure a neighbor as Route Reflector client
send_community str
  • Choices: both, extended, standard
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
vrf str
activate Boolean
Enable the address family for this neighbor - Default value: true
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
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
logNeighborChangesDisable Boolean
disable
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
routeMaps List<Property Map>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
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
vrf String

Supporting Types

BgpIpv4UnicastVrfNeighborRouteMap
, BgpIpv4UnicastVrfNeighborRouteMapArgs

InOut This property is required. string
RouteMapName This property is required. string
InOut This property is required. string
RouteMapName This property is required. string
inOut This property is required. String
routeMapName This property is required. String
inOut This property is required. string
routeMapName This property is required. string
in_out This property is required. str
route_map_name This property is required. str
inOut This property is required. String
routeMapName This property is required. String

Import

 $ pulumi import iosxe:index/bgpIpv4UnicastVrfNeighbor:BgpIpv4UnicastVrfNeighbor example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/with-vrf/ipv4=unicast/vrf=VRF1/ipv4-unicast/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