iosxe.BgpIpv4UnicastVrfNeighbor
Explore with Pulumi AI
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());
}
}
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
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,
update_source_loopback: 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,
local_as_replace_as: 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,
delete_mode: Optional[str] = None,
activate: Optional[bool] = None,
cluster_id: Optional[str] = None,
description: Optional[str] = None,
fall_over_bfd_check_control_plane_failure: 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,
local_as_no_prepend: Optional[bool] = None,
version: Optional[int] = None,
local_as_dual_as: Optional[bool] = 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 string
- The unique name of the resource.
- args BgpIpv4UnicastVrfNeighborArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args BgpIpv4UnicastVrfNeighborArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BgpIpv4UnicastVrfNeighborArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
UpdateSourceLoopback = "string",
Device = "string",
DisableConnectedCheck = false,
EbgpMultihop = false,
EbgpMultihopMaxHop = 0,
LocalAsReplaceAs = false,
FallOverBfdMultiHop = false,
FallOverBfdSingleHop = false,
FallOverBfdStrictMode = false,
FallOverDefaultRouteMap = "string",
FallOverMaximumMetricRouteMap = "string",
DeleteMode = "string",
Activate = false,
ClusterId = "string",
Description = "string",
FallOverBfdCheckControlPlaneFailure = false,
LogNeighborChangesDisable = 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,
LocalAsNoPrepend = false,
Version = 0,
LocalAsDualAs = false,
});
example, err := iosxe.NewBgpIpv4UnicastVrfNeighbor(ctx, "bgpIpv4UnicastVrfNeighborResource", &iosxe.BgpIpv4UnicastVrfNeighborArgs{
Ip: pulumi.String("string"),
Asn: pulumi.String("string"),
Vrf: pulumi.String("string"),
LocalAs: pulumi.String("string"),
UpdateSourceLoopback: pulumi.String("string"),
Device: pulumi.String("string"),
DisableConnectedCheck: pulumi.Bool(false),
EbgpMultihop: pulumi.Bool(false),
EbgpMultihopMaxHop: pulumi.Int(0),
LocalAsReplaceAs: pulumi.Bool(false),
FallOverBfdMultiHop: pulumi.Bool(false),
FallOverBfdSingleHop: pulumi.Bool(false),
FallOverBfdStrictMode: pulumi.Bool(false),
FallOverDefaultRouteMap: pulumi.String("string"),
FallOverMaximumMetricRouteMap: pulumi.String("string"),
DeleteMode: pulumi.String("string"),
Activate: pulumi.Bool(false),
ClusterId: pulumi.String("string"),
Description: pulumi.String("string"),
FallOverBfdCheckControlPlaneFailure: pulumi.Bool(false),
LogNeighborChangesDisable: 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),
LocalAsNoPrepend: pulumi.Bool(false),
Version: pulumi.Int(0),
LocalAsDualAs: pulumi.Bool(false),
})
var bgpIpv4UnicastVrfNeighborResource = new BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource", BgpIpv4UnicastVrfNeighborArgs.builder()
.ip("string")
.asn("string")
.vrf("string")
.localAs("string")
.updateSourceLoopback("string")
.device("string")
.disableConnectedCheck(false)
.ebgpMultihop(false)
.ebgpMultihopMaxHop(0)
.localAsReplaceAs(false)
.fallOverBfdMultiHop(false)
.fallOverBfdSingleHop(false)
.fallOverBfdStrictMode(false)
.fallOverDefaultRouteMap("string")
.fallOverMaximumMetricRouteMap("string")
.deleteMode("string")
.activate(false)
.clusterId("string")
.description("string")
.fallOverBfdCheckControlPlaneFailure(false)
.logNeighborChangesDisable(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)
.localAsNoPrepend(false)
.version(0)
.localAsDualAs(false)
.build());
bgp_ipv4_unicast_vrf_neighbor_resource = iosxe.BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource",
ip="string",
asn="string",
vrf="string",
local_as="string",
update_source_loopback="string",
device="string",
disable_connected_check=False,
ebgp_multihop=False,
ebgp_multihop_max_hop=0,
local_as_replace_as=False,
fall_over_bfd_multi_hop=False,
fall_over_bfd_single_hop=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,
cluster_id="string",
description="string",
fall_over_bfd_check_control_plane_failure=False,
log_neighbor_changes_disable=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,
local_as_no_prepend=False,
version=0,
local_as_dual_as=False)
const bgpIpv4UnicastVrfNeighborResource = new iosxe.BgpIpv4UnicastVrfNeighbor("bgpIpv4UnicastVrfNeighborResource", {
ip: "string",
asn: "string",
vrf: "string",
localAs: "string",
updateSourceLoopback: "string",
device: "string",
disableConnectedCheck: false,
ebgpMultihop: false,
ebgpMultihopMaxHop: 0,
localAsReplaceAs: false,
fallOverBfdMultiHop: false,
fallOverBfdSingleHop: false,
fallOverBfdStrictMode: false,
fallOverDefaultRouteMap: "string",
fallOverMaximumMetricRouteMap: "string",
deleteMode: "string",
activate: false,
clusterId: "string",
description: "string",
fallOverBfdCheckControlPlaneFailure: 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,
localAsNoPrepend: false,
version: 0,
localAsDualAs: false,
});
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
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 string
- Ip string
- Vrf string
- Activate bool
- Enable the address family for this neighbor - Default value:
true
- Cluster
Id string - Delete
Mode 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.
- Disable
Connected boolCheck - 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 intMax Hop - Range:
2
-255
- Range:
- Fall
Over boolBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- Fall
Over boolBfd Multi Hop - Force BFD multi-hop to detect failure
- Fall
Over boolBfd Single Hop - Force BFD single-hop to detect failure
- Fall
Over boolBfd Strict Mode - Enable BFD strict-mode
- Fall
Over stringDefault Route Map - Fall
Over stringMaximum Metric Route Map - Local
As string - Local
As boolDual As - Accept either real AS or local AS from the ebgp peer
- Local
As boolNo Prepend - Do not prepend local-as to updates from ebgp peers
- Local
As boolReplace As - Replace real AS with local AS in the EBGP updates
- Log
Neighbor boolChanges Disable - disable
- Password string
- Password
Type int - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- Remote
As string - Specify a BGP peer-group remote-as
- Route
Maps List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Bgp Ipv4Unicast Vrf Neighbor Route Map> - Apply route map to neighbor
- Route
Reflector boolClient - Configure a neighbor as Route Reflector client
- Send
Community string - Choices:
both
,extended
,standard
- Choices:
- Shutdown bool
- Administratively shut down this neighbor
- Timers
Holdtime int - Range:
0
-65535
- Range:
- Timers
Keepalive intInterval - Range:
0
-65535
- Range:
- Timers
Minimum intNeighbor Hold - Range:
0
-65535
- Range:
- Ttl
Security intHops - IP hops - Range:
1
-254
- Update
Source stringLoopback - Loopback interface
- Version int
- Set the BGP version to match a neighbor - Range:
4
-4
- Asn string
- Ip string
- Vrf string
- Activate bool
- Enable the address family for this neighbor - Default value:
true
- Cluster
Id string - Delete
Mode 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.
- Disable
Connected boolCheck - 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 intMax Hop - Range:
2
-255
- Range:
- Fall
Over boolBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- Fall
Over boolBfd Multi Hop - Force BFD multi-hop to detect failure
- Fall
Over boolBfd Single Hop - Force BFD single-hop to detect failure
- Fall
Over boolBfd Strict Mode - Enable BFD strict-mode
- Fall
Over stringDefault Route Map - Fall
Over stringMaximum Metric Route Map - Local
As string - Local
As boolDual As - Accept either real AS or local AS from the ebgp peer
- Local
As boolNo Prepend - Do not prepend local-as to updates from ebgp peers
- Local
As boolReplace As - Replace real AS with local AS in the EBGP updates
- Log
Neighbor boolChanges Disable - disable
- Password string
- Password
Type int - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- Remote
As string - Specify a BGP peer-group remote-as
- Route
Maps []BgpIpv4Unicast Vrf Neighbor Route Map Args - Apply route map to neighbor
- Route
Reflector boolClient - Configure a neighbor as Route Reflector client
- Send
Community string - Choices:
both
,extended
,standard
- Choices:
- Shutdown bool
- Administratively shut down this neighbor
- Timers
Holdtime int - Range:
0
-65535
- Range:
- Timers
Keepalive intInterval - Range:
0
-65535
- Range:
- Timers
Minimum intNeighbor Hold - Range:
0
-65535
- Range:
- Ttl
Security intHops - IP hops - Range:
1
-254
- Update
Source stringLoopback - Loopback interface
- Version int
- Set the BGP version to match a neighbor - Range:
4
-4
- asn String
- ip String
- vrf String
- activate Boolean
- Enable the address family for this neighbor - Default value:
true
- cluster
Id String - delete
Mode 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.
- disable
Connected BooleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop Boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop IntegerMax Hop - Range:
2
-255
- Range:
- fall
Over BooleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over BooleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over BooleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over BooleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over StringDefault Route Map - fall
Over StringMaximum Metric Route Map - local
As String - local
As BooleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As BooleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As BooleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor BooleanChanges Disable - disable
- password String
- password
Type Integer - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As String - Specify a BGP peer-group remote-as
- route
Maps List<BgpIpv4Unicast Vrf Neighbor Route Map> - Apply route map to neighbor
- route
Reflector BooleanClient - Configure a neighbor as Route Reflector client
- send
Community String - Choices:
both
,extended
,standard
- Choices:
- shutdown Boolean
- Administratively shut down this neighbor
- timers
Holdtime Integer - Range:
0
-65535
- Range:
- timers
Keepalive IntegerInterval - Range:
0
-65535
- Range:
- timers
Minimum IntegerNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security IntegerHops - IP hops - Range:
1
-254
- update
Source StringLoopback - Loopback interface
- version Integer
- Set the BGP version to match a neighbor - Range:
4
-4
- asn string
- ip string
- vrf string
- activate boolean
- Enable the address family for this neighbor - Default value:
true
- cluster
Id string - delete
Mode 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.
- disable
Connected booleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop numberMax Hop - Range:
2
-255
- Range:
- fall
Over booleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over booleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over booleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over booleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over stringDefault Route Map - fall
Over stringMaximum Metric Route Map - local
As string - local
As booleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As booleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As booleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor booleanChanges Disable - disable
- password string
- password
Type number - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As string - Specify a BGP peer-group remote-as
- route
Maps BgpIpv4Unicast Vrf Neighbor Route Map[] - Apply route map to neighbor
- route
Reflector booleanClient - Configure a neighbor as Route Reflector client
- send
Community string - Choices:
both
,extended
,standard
- Choices:
- shutdown boolean
- Administratively shut down this neighbor
- timers
Holdtime number - Range:
0
-65535
- Range:
- timers
Keepalive numberInterval - Range:
0
-65535
- Range:
- timers
Minimum numberNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security numberHops - IP hops - Range:
1
-254
- update
Source stringLoopback - Loopback interface
- version number
- Set the BGP version to match a neighbor - Range:
4
-4
- asn str
- ip str
- vrf 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_ boolcheck - 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_ intmax_ hop - Range:
2
-255
- Range:
- fall_
over_ boolbfd_ check_ control_ plane_ failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall_
over_ boolbfd_ multi_ hop - Force BFD multi-hop to detect failure
- fall_
over_ boolbfd_ single_ hop - Force BFD single-hop to detect failure
- fall_
over_ boolbfd_ strict_ mode - Enable BFD strict-mode
- fall_
over_ strdefault_ route_ map - fall_
over_ strmaximum_ metric_ route_ map - local_
as str - local_
as_ booldual_ as - Accept either real AS or local AS from the ebgp peer
- local_
as_ boolno_ prepend - Do not prepend local-as to updates from ebgp peers
- local_
as_ boolreplace_ as - Replace real AS with local AS in the EBGP updates
- log_
neighbor_ boolchanges_ disable - 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[BgpIpv4Unicast Vrf Neighbor Route Map Args] - Apply route map to neighbor
- route_
reflector_ boolclient - Configure a neighbor as Route Reflector client
- send_
community str - Choices:
both
,extended
,standard
- Choices:
- shutdown bool
- Administratively shut down this neighbor
- timers_
holdtime int - Range:
0
-65535
- Range:
- timers_
keepalive_ intinterval - Range:
0
-65535
- Range:
- timers_
minimum_ intneighbor_ hold - Range:
0
-65535
- Range:
- ttl_
security_ inthops - IP hops - Range:
1
-254
- update_
source_ strloopback - Loopback interface
- version int
- Set the BGP version to match a neighbor - Range:
4
-4
- asn String
- ip String
- vrf String
- activate Boolean
- Enable the address family for this neighbor - Default value:
true
- cluster
Id String - delete
Mode 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.
- disable
Connected BooleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop Boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop NumberMax Hop - Range:
2
-255
- Range:
- fall
Over BooleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over BooleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over BooleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over BooleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over StringDefault Route Map - fall
Over StringMaximum Metric Route Map - local
As String - local
As BooleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As BooleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As BooleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor BooleanChanges Disable - disable
- password String
- password
Type Number - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As String - Specify a BGP peer-group remote-as
- route
Maps List<Property Map> - Apply route map to neighbor
- route
Reflector BooleanClient - Configure a neighbor as Route Reflector client
- send
Community String - Choices:
both
,extended
,standard
- Choices:
- shutdown Boolean
- Administratively shut down this neighbor
- timers
Holdtime Number - Range:
0
-65535
- Range:
- timers
Keepalive NumberInterval - Range:
0
-65535
- Range:
- timers
Minimum NumberNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security NumberHops - IP hops - Range:
1
-254
- update
Source StringLoopback - 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Activate bool
- Enable the address family for this neighbor - Default value:
true
- Asn string
- Cluster
Id string - Delete
Mode 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.
- Disable
Connected boolCheck - 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 intMax Hop - Range:
2
-255
- Range:
- Fall
Over boolBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- Fall
Over boolBfd Multi Hop - Force BFD multi-hop to detect failure
- Fall
Over boolBfd Single Hop - Force BFD single-hop to detect failure
- Fall
Over boolBfd Strict Mode - Enable BFD strict-mode
- Fall
Over stringDefault Route Map - Fall
Over stringMaximum Metric Route Map - Ip string
- Local
As string - Local
As boolDual As - Accept either real AS or local AS from the ebgp peer
- Local
As boolNo Prepend - Do not prepend local-as to updates from ebgp peers
- Local
As boolReplace As - Replace real AS with local AS in the EBGP updates
- Log
Neighbor boolChanges Disable - disable
- Password string
- Password
Type int - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- Remote
As string - Specify a BGP peer-group remote-as
- Route
Maps List<Lbrlabs.Pulumi Package. Iosxe. Inputs. Bgp Ipv4Unicast Vrf Neighbor Route Map> - Apply route map to neighbor
- Route
Reflector boolClient - Configure a neighbor as Route Reflector client
- Send
Community string - Choices:
both
,extended
,standard
- Choices:
- Shutdown bool
- Administratively shut down this neighbor
- Timers
Holdtime int - Range:
0
-65535
- Range:
- Timers
Keepalive intInterval - Range:
0
-65535
- Range:
- Timers
Minimum intNeighbor Hold - Range:
0
-65535
- Range:
- Ttl
Security intHops - IP hops - Range:
1
-254
- Update
Source stringLoopback - 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
- Cluster
Id string - Delete
Mode 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.
- Disable
Connected boolCheck - 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 intMax Hop - Range:
2
-255
- Range:
- Fall
Over boolBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- Fall
Over boolBfd Multi Hop - Force BFD multi-hop to detect failure
- Fall
Over boolBfd Single Hop - Force BFD single-hop to detect failure
- Fall
Over boolBfd Strict Mode - Enable BFD strict-mode
- Fall
Over stringDefault Route Map - Fall
Over stringMaximum Metric Route Map - Ip string
- Local
As string - Local
As boolDual As - Accept either real AS or local AS from the ebgp peer
- Local
As boolNo Prepend - Do not prepend local-as to updates from ebgp peers
- Local
As boolReplace As - Replace real AS with local AS in the EBGP updates
- Log
Neighbor boolChanges Disable - disable
- Password string
- Password
Type int - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- Remote
As string - Specify a BGP peer-group remote-as
- Route
Maps []BgpIpv4Unicast Vrf Neighbor Route Map Args - Apply route map to neighbor
- Route
Reflector boolClient - Configure a neighbor as Route Reflector client
- Send
Community string - Choices:
both
,extended
,standard
- Choices:
- Shutdown bool
- Administratively shut down this neighbor
- Timers
Holdtime int - Range:
0
-65535
- Range:
- Timers
Keepalive intInterval - Range:
0
-65535
- Range:
- Timers
Minimum intNeighbor Hold - Range:
0
-65535
- Range:
- Ttl
Security intHops - IP hops - Range:
1
-254
- Update
Source stringLoopback - 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
- cluster
Id String - delete
Mode 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.
- disable
Connected BooleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop Boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop IntegerMax Hop - Range:
2
-255
- Range:
- fall
Over BooleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over BooleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over BooleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over BooleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over StringDefault Route Map - fall
Over StringMaximum Metric Route Map - ip String
- local
As String - local
As BooleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As BooleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As BooleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor BooleanChanges Disable - disable
- password String
- password
Type Integer - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As String - Specify a BGP peer-group remote-as
- route
Maps List<BgpIpv4Unicast Vrf Neighbor Route Map> - Apply route map to neighbor
- route
Reflector BooleanClient - Configure a neighbor as Route Reflector client
- send
Community String - Choices:
both
,extended
,standard
- Choices:
- shutdown Boolean
- Administratively shut down this neighbor
- timers
Holdtime Integer - Range:
0
-65535
- Range:
- timers
Keepalive IntegerInterval - Range:
0
-65535
- Range:
- timers
Minimum IntegerNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security IntegerHops - IP hops - Range:
1
-254
- update
Source StringLoopback - 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
- cluster
Id string - delete
Mode 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.
- disable
Connected booleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop numberMax Hop - Range:
2
-255
- Range:
- fall
Over booleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over booleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over booleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over booleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over stringDefault Route Map - fall
Over stringMaximum Metric Route Map - ip string
- local
As string - local
As booleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As booleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As booleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor booleanChanges Disable - disable
- password string
- password
Type number - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As string - Specify a BGP peer-group remote-as
- route
Maps BgpIpv4Unicast Vrf Neighbor Route Map[] - Apply route map to neighbor
- route
Reflector booleanClient - Configure a neighbor as Route Reflector client
- send
Community string - Choices:
both
,extended
,standard
- Choices:
- shutdown boolean
- Administratively shut down this neighbor
- timers
Holdtime number - Range:
0
-65535
- Range:
- timers
Keepalive numberInterval - Range:
0
-65535
- Range:
- timers
Minimum numberNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security numberHops - IP hops - Range:
1
-254
- update
Source stringLoopback - 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_ boolcheck - 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_ intmax_ hop - Range:
2
-255
- Range:
- fall_
over_ boolbfd_ check_ control_ plane_ failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall_
over_ boolbfd_ multi_ hop - Force BFD multi-hop to detect failure
- fall_
over_ boolbfd_ single_ hop - Force BFD single-hop to detect failure
- fall_
over_ boolbfd_ strict_ mode - Enable BFD strict-mode
- fall_
over_ strdefault_ route_ map - fall_
over_ strmaximum_ metric_ route_ map - ip str
- local_
as str - local_
as_ booldual_ as - Accept either real AS or local AS from the ebgp peer
- local_
as_ boolno_ prepend - Do not prepend local-as to updates from ebgp peers
- local_
as_ boolreplace_ as - Replace real AS with local AS in the EBGP updates
- log_
neighbor_ boolchanges_ disable - 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[BgpIpv4Unicast Vrf Neighbor Route Map Args] - Apply route map to neighbor
- route_
reflector_ boolclient - Configure a neighbor as Route Reflector client
- send_
community str - Choices:
both
,extended
,standard
- Choices:
- shutdown bool
- Administratively shut down this neighbor
- timers_
holdtime int - Range:
0
-65535
- Range:
- timers_
keepalive_ intinterval - Range:
0
-65535
- Range:
- timers_
minimum_ intneighbor_ hold - Range:
0
-65535
- Range:
- ttl_
security_ inthops - IP hops - Range:
1
-254
- update_
source_ strloopback - 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
- cluster
Id String - delete
Mode 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.
- disable
Connected BooleanCheck - one-hop away EBGP peer using loopback address
- ebgp
Multihop Boolean - Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
- ebgp
Multihop NumberMax Hop - Range:
2
-255
- Range:
- fall
Over BooleanBfd Check Control Plane Failure - Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
- fall
Over BooleanBfd Multi Hop - Force BFD multi-hop to detect failure
- fall
Over BooleanBfd Single Hop - Force BFD single-hop to detect failure
- fall
Over BooleanBfd Strict Mode - Enable BFD strict-mode
- fall
Over StringDefault Route Map - fall
Over StringMaximum Metric Route Map - ip String
- local
As String - local
As BooleanDual As - Accept either real AS or local AS from the ebgp peer
- local
As BooleanNo Prepend - Do not prepend local-as to updates from ebgp peers
- local
As BooleanReplace As - Replace real AS with local AS in the EBGP updates
- log
Neighbor BooleanChanges Disable - disable
- password String
- password
Type Number - Encryption type (0 to disable encryption, 7 for proprietary) - Range:
0
-7
- remote
As String - Specify a BGP peer-group remote-as
- route
Maps List<Property Map> - Apply route map to neighbor
- route
Reflector BooleanClient - Configure a neighbor as Route Reflector client
- send
Community String - Choices:
both
,extended
,standard
- Choices:
- shutdown Boolean
- Administratively shut down this neighbor
- timers
Holdtime Number - Range:
0
-65535
- Range:
- timers
Keepalive NumberInterval - Range:
0
-65535
- Range:
- timers
Minimum NumberNeighbor Hold - Range:
0
-65535
- Range:
- ttl
Security NumberHops - IP hops - Range:
1
-254
- update
Source StringLoopback - Loopback interface
- version Number
- Set the BGP version to match a neighbor - Range:
4
-4
- vrf String
Supporting Types
BgpIpv4UnicastVrfNeighborRouteMap, BgpIpv4UnicastVrfNeighborRouteMapArgs
- In
Out string - Route
Map stringName
- In
Out string - Route
Map stringName
- in
Out String - route
Map StringName
- in
Out string - route
Map stringName
- in_
out str - route_
map_ strname
- in
Out String - route
Map StringName
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"
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.