routeros 1.83.0, Apr 16 25

routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.RoutingBgpTemplate

Explore with Pulumi AI

routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

# routeros.RoutingBgpTemplate (Resource)

[!WARNING] Using this resource you may happen unexpected behavior, for example, some of the attributes may not be removable after adding them to the TF configuration. Please report this to GitHub and it may be possible to fix it. Use the resource at your own risk as it is!

Create RoutingBgpTemplate Resource

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

new RoutingBgpTemplate(name: string, args: RoutingBgpTemplateArgs, opts?: CustomResourceOptions);

@overload
def RoutingBgpTemplate(resource_name: str,
                       args: RoutingBgpTemplateArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def RoutingBgpTemplate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       as_: Optional[str] = None,
                       keepalive_time: Optional[str] = None,
                       cluster_id: Optional[str] = None,
                       address_families: Optional[str] = None,
                       ___path_: Optional[str] = None,
                       as_override: Optional[bool] = None,
                       cisco_vpls_nlri_len_fmt: Optional[str] = None,
                       ___id_: Optional[float] = None,
                       comment: Optional[str] = None,
                       disabled: Optional[bool] = None,
                       hold_time: Optional[str] = None,
                       add_path_out: Optional[str] = None,
                       input: Optional[RoutingBgpTemplateInputArgs] = None,
                       remove_private_as: Optional[bool] = None,
                       name: Optional[str] = None,
                       nexthop_choice: Optional[str] = None,
                       output: Optional[RoutingBgpTemplateOutputArgs] = None,
                       multihop: Optional[bool] = None,
                       router_id: Optional[str] = None,
                       routing_bgp_template_id: Optional[str] = None,
                       routing_table: Optional[str] = None,
                       save_to: Optional[str] = None,
                       templates: Optional[Sequence[str]] = None,
                       use_bfd: Optional[bool] = None,
                       vrf: Optional[str] = None)

func NewRoutingBgpTemplate(ctx *Context, name string, args RoutingBgpTemplateArgs, opts ...ResourceOption) (*RoutingBgpTemplate, error)

public RoutingBgpTemplate(string name, RoutingBgpTemplateArgs args, CustomResourceOptions? opts = null)

public RoutingBgpTemplate(String name, RoutingBgpTemplateArgs args)
public RoutingBgpTemplate(String name, RoutingBgpTemplateArgs args, CustomResourceOptions options)

type: routeros:RoutingBgpTemplate
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 RoutingBgpTemplateArgs: 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 RoutingBgpTemplateArgs: 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 RoutingBgpTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RoutingBgpTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RoutingBgpTemplateArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

As string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
AddPathOut string
AddressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
AsOverride bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
CiscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
ClusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
Comment string
Disabled bool
HoldTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
Input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
KeepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
Multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
Name string: Name of the BGP template.
NexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
Output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
RemovePrivateAs bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
RouterId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
RoutingBgpTemplateId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
SaveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
Templates List<string>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
UseBfd bool: Whether to use the BFD protocol for faster connection state detection.
Vrf string: The VRF table this resource operates on.
___id_ double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.

As string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
AddPathOut string
AddressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
AsOverride bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
CiscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
ClusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
Comment string
Disabled bool
HoldTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
Input RoutingBgpTemplateInputTypeArgs: A group of parameters associated with BGP input.
KeepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
Multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
Name string: Name of the BGP template.
NexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
Output RoutingBgpTemplateOutputTypeArgs: A group of parameters associated with BGP output.
RemovePrivateAs bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
RouterId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
RoutingBgpTemplateId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
SaveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
Templates []string: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
UseBfd bool: Whether to use the BFD protocol for faster connection state detection.
Vrf string: The VRF table this resource operates on.
___id_ float64: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.

as String: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
___id_ Double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut String
addressFamilies String: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
asOverride Boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt String: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId String: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment String
disabled Boolean
holdTime String: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
keepaliveTime String: How long to keep the BGP session open after the last received 'keepalive' message.
multihop Boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name String: Name of the BGP template.
nexthopChoice String: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
removePrivateAs Boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId String: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
saveTo String: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates List<String>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd Boolean: Whether to use the BFD protocol for faster connection state detection.
vrf String: The VRF table this resource operates on.

as string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
___id_ number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut string
addressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
asOverride boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment string
disabled boolean
holdTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
keepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
multihop boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name string: Name of the BGP template.
nexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
removePrivateAs boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId string: The ID of this resource.
routingTable string: Name of the routing table, to install routes in.
saveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates string[]: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd boolean: Whether to use the BFD protocol for faster connection state detection.
vrf string: The VRF table this resource operates on.

as_ str: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
___id_ float: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
add_path_out str
address_families str: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
as_override bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
cisco_vpls_nlri_len_fmt str: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
cluster_id str: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment str
disabled bool
hold_time str: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInputArgs: A group of parameters associated with BGP input.
keepalive_time str: How long to keep the BGP session open after the last received 'keepalive' message.
multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name str: Name of the BGP template.
nexthop_choice str: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutputArgs: A group of parameters associated with BGP output.
remove_private_as bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
router_id str: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routing_bgp_template_id str: The ID of this resource.
routing_table str: Name of the routing table, to install routes in.
save_to str: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates Sequence[str]: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
use_bfd bool: Whether to use the BFD protocol for faster connection state detection.
vrf str: The VRF table this resource operates on.

as String: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
___id_ Number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut String
addressFamilies String: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
asOverride Boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt String: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId String: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment String
disabled Boolean
holdTime String: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input Property Map: A group of parameters associated with BGP input.
keepaliveTime String: How long to keep the BGP session open after the last received 'keepalive' message.
multihop Boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name String: Name of the BGP template.
nexthopChoice String: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output Property Map: A group of parameters associated with BGP output.
removePrivateAs Boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId String: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
saveTo String: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates List<String>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd Boolean: Whether to use the BFD protocol for faster connection state detection.
vrf String: The VRF table this resource operates on.

Outputs

All input properties are implicitly available as output properties. Additionally, the RoutingBgpTemplate resource produces the following output properties:

Default bool: It's the default item.
Id string: The provider-assigned unique ID for this managed resource.

Default bool: It's the default item.
Id string: The provider-assigned unique ID for this managed resource.

default_ Boolean: It's the default item.
id String: The provider-assigned unique ID for this managed resource.

default boolean: It's the default item.
id string: The provider-assigned unique ID for this managed resource.

default bool: It's the default item.
id str: The provider-assigned unique ID for this managed resource.

default Boolean: It's the default item.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing RoutingBgpTemplate Resource

Get an existing RoutingBgpTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: RoutingBgpTemplateState, opts?: CustomResourceOptions): RoutingBgpTemplate

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        add_path_out: Optional[str] = None,
        address_families: Optional[str] = None,
        as_: Optional[str] = None,
        as_override: Optional[bool] = None,
        cisco_vpls_nlri_len_fmt: Optional[str] = None,
        cluster_id: Optional[str] = None,
        comment: Optional[str] = None,
        default: Optional[bool] = None,
        disabled: Optional[bool] = None,
        hold_time: Optional[str] = None,
        input: Optional[RoutingBgpTemplateInputArgs] = None,
        keepalive_time: Optional[str] = None,
        multihop: Optional[bool] = None,
        name: Optional[str] = None,
        nexthop_choice: Optional[str] = None,
        output: Optional[RoutingBgpTemplateOutputArgs] = None,
        remove_private_as: Optional[bool] = None,
        router_id: Optional[str] = None,
        routing_bgp_template_id: Optional[str] = None,
        routing_table: Optional[str] = None,
        save_to: Optional[str] = None,
        templates: Optional[Sequence[str]] = None,
        use_bfd: Optional[bool] = None,
        vrf: Optional[str] = None) -> RoutingBgpTemplate

func GetRoutingBgpTemplate(ctx *Context, name string, id IDInput, state *RoutingBgpTemplateState, opts ...ResourceOption) (*RoutingBgpTemplate, error)

public static RoutingBgpTemplate Get(string name, Input<string> id, RoutingBgpTemplateState? state, CustomResourceOptions? opts = null)

public static RoutingBgpTemplate get(String name, Output<String> id, RoutingBgpTemplateState state, CustomResourceOptions options)

resources:  _:    type: routeros:RoutingBgpTemplate    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddPathOut string
AddressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
As string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
AsOverride bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
CiscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
ClusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
Comment string
Default bool: It's the default item.
Disabled bool
HoldTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
Input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
KeepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
Multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
Name string: Name of the BGP template.
NexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
Output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
RemovePrivateAs bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
RouterId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
RoutingBgpTemplateId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
SaveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
Templates List<string>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
UseBfd bool: Whether to use the BFD protocol for faster connection state detection.
Vrf string: The VRF table this resource operates on.
___id_ double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.

AddPathOut string
AddressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
As string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
AsOverride bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
CiscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
ClusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
Comment string
Default bool: It's the default item.
Disabled bool
HoldTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
Input RoutingBgpTemplateInputTypeArgs: A group of parameters associated with BGP input.
KeepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
Multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
Name string: Name of the BGP template.
NexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
Output RoutingBgpTemplateOutputTypeArgs: A group of parameters associated with BGP output.
RemovePrivateAs bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
RouterId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
RoutingBgpTemplateId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
SaveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
Templates []string: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
UseBfd bool: Whether to use the BFD protocol for faster connection state detection.
Vrf string: The VRF table this resource operates on.
___id_ float64: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.

___id_ Double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut String
addressFamilies String: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
as String: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
asOverride Boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt String: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId String: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment String
default_ Boolean: It's the default item.
disabled Boolean
holdTime String: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
keepaliveTime String: How long to keep the BGP session open after the last received 'keepalive' message.
multihop Boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name String: Name of the BGP template.
nexthopChoice String: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
removePrivateAs Boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId String: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
saveTo String: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates List<String>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd Boolean: Whether to use the BFD protocol for faster connection state detection.
vrf String: The VRF table this resource operates on.

___id_ number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut string
addressFamilies string: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
as string: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
asOverride boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt string: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId string: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment string
default boolean: It's the default item.
disabled boolean
holdTime string: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInput: A group of parameters associated with BGP input.
keepaliveTime string: How long to keep the BGP session open after the last received 'keepalive' message.
multihop boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name string: Name of the BGP template.
nexthopChoice string: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutput: A group of parameters associated with BGP output.
removePrivateAs boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId string: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId string: The ID of this resource.
routingTable string: Name of the routing table, to install routes in.
saveTo string: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates string[]: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd boolean: Whether to use the BFD protocol for faster connection state detection.
vrf string: The VRF table this resource operates on.

___id_ float: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
add_path_out str
address_families str: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
as_ str: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
as_override bool: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
cisco_vpls_nlri_len_fmt str: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
cluster_id str: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment str
default bool: It's the default item.
disabled bool
hold_time str: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input RoutingBgpTemplateInputArgs: A group of parameters associated with BGP input.
keepalive_time str: How long to keep the BGP session open after the last received 'keepalive' message.
multihop bool: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name str: Name of the BGP template.
nexthop_choice str: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output RoutingBgpTemplateOutputArgs: A group of parameters associated with BGP output.
remove_private_as bool: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
router_id str: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routing_bgp_template_id str: The ID of this resource.
routing_table str: Name of the routing table, to install routes in.
save_to str: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates Sequence[str]: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
use_bfd bool: Whether to use the BFD protocol for faster connection state detection.
vrf str: The VRF table this resource operates on.

___id_ Number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
addPathOut String
addressFamilies String: List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
as String: 32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats. The parameter is also used to set up the BGP confederation, in the following format: confederation_as/as . For example, if your AS is 34 and your confederation AS is 43, then as configuration should be as =43/34.
asOverride Boolean: If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepending.
ciscoVplsNlriLenFmt String: VPLS NLRI length format type. Used for compatibility with Cisco VPLS.
clusterId String: In case this instance is a route reflector: the cluster ID of the router reflector cluster to this instance belongs. This attribute helps to recognize routing updates that come from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; in this case, 'cluster-id' does not need to be configured and BGP router ID is used instead.
comment String
default Boolean: It's the default item.
disabled Boolean
holdTime String: Specifies the BGP Hold Time value to use when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other value) infinity - never expire the connection and never send keepalive messages.
input Property Map: A group of parameters associated with BGP input.
keepaliveTime String: How long to keep the BGP session open after the last received 'keepalive' message.
multihop Boolean: Specifies whether the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for EBGP only, excluding EBGP peers local to the confederation). It also affects: whether to accept connections from peers that are not in the same network (the remote address of the connection is used for this check); whether to accept incoming routes with NEXT_HOP attribute that is not in the same network as the address used to establish the connection; the target-scope of the routes installed from this peer; routes from multi-hop or IBGP peers resolve their next-hops through IGP routes by default.
name String: Name of the BGP template.
nexthopChoice String: Affects the outgoing NEXTHOP attribute selection. Note that next-hops set in filters always take precedence. Also note that the next-hop is not changed on route reflection, except when it's set in the filter. default - select the next-hop as described in RFC 4271 force-self - always use a local address of the interface that is used to connect to the peer as the next-hop; propagate - try to propagate further the next-hop received; i.e. if the route has BGP NEXTHOP attribute, then use it as the next-hop, otherwise, fall back to the default case.
output Property Map: A group of parameters associated with BGP output.
removePrivateAs Boolean: If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
routerId String: BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
routingBgpTemplateId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
saveTo String: Filename to be used to save BGP protocol-specific packet content (Exported PDU) into pcap file. This method allows much simpler peer-specific packet capturing for debugging purposes. Pcap files in this format can also be loaded to create virtual BGP peers to recreate conditions that happened at the time when packet capture was running.
templates List<String>: List of template names from which to inherit parameters. Useful feature, to easily configure groups with overlapping configuration options.
useBfd Boolean: Whether to use the BFD protocol for faster connection state detection.
vrf String: The VRF table this resource operates on.

Supporting Types

RoutingBgpTemplateInput
, RoutingBgpTemplateInputArgs

AcceptComunities string: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptExtCommunities string: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptLargeComunities string: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptNlri string: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
AcceptUnknown string: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
Affinity string: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
AllowAs double: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
Filter string: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
LimitProcessRoutesIpv4 double: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
LimitProcessRoutesIpv6 double: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

AcceptComunities string: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptExtCommunities string: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptLargeComunities string: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
AcceptNlri string: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
AcceptUnknown string: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
Affinity string: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
AllowAs float64: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
Filter string: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
LimitProcessRoutesIpv4 float64: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
LimitProcessRoutesIpv6 float64: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

acceptComunities String: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptExtCommunities String: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptLargeComunities String: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptNlri String: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
acceptUnknown String: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
affinity String: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
allowAs Double: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
filter String: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
limitProcessRoutesIpv4 Double: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
limitProcessRoutesIpv6 Double: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

acceptComunities string: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptExtCommunities string: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptLargeComunities string: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptNlri string: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
acceptUnknown string: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
affinity string: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
allowAs number: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
filter string: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
ignoreAsPathLen boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
limitProcessRoutesIpv4 number: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
limitProcessRoutesIpv6 number: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

accept_comunities str: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
accept_ext_communities str: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
accept_large_comunities str: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
accept_nlri str: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
accept_unknown str: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
affinity str: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
allow_as float: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
filter str: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
ignore_as_path_len bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
limit_process_routes_ipv4 float: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
limit_process_routes_ipv6 float: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

acceptComunities String: A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptExtCommunities String: A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptLargeComunities String: A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
acceptNlri String: Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session restart.
acceptUnknown String: A quick way to filter incoming updates with specific 'unknown' attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as 'not active, filtered'. Changes to be applied required session refresh.
affinity String: Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
allowAs Number: Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
filter String: Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm
limitProcessRoutesIpv4 Number: Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.
limitProcessRoutesIpv6 Number: Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session 'clear' command must be used to reset the flag if the limit is reached.

RoutingBgpTemplateOutput
, RoutingBgpTemplateOutputArgs

Affinity string: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
DefaultOriginate string: Specifies default route (0.0.0.0/0) distribution method.
DefaultPrepend double: The count of AS prepended to the AS path.
FilterChain string: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
FilterSelect string: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
KeepSentAttributes bool: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
Network string: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
NoClientToClientReflection bool: Disable client-to-client route reflection in Route Reflector setups.
NoEarlyCut bool: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
Redistribute string: Enable redistribution of specified route types.

Affinity string: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
DefaultOriginate string: Specifies default route (0.0.0.0/0) distribution method.
DefaultPrepend float64: The count of AS prepended to the AS path.
FilterChain string: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
FilterSelect string: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
KeepSentAttributes bool: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
Network string: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
NoClientToClientReflection bool: Disable client-to-client route reflection in Route Reflector setups.
NoEarlyCut bool: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
Redistribute string: Enable redistribution of specified route types.

affinity String: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
defaultOriginate String: Specifies default route (0.0.0.0/0) distribution method.
defaultPrepend Double: The count of AS prepended to the AS path.
filterChain String: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
filterSelect String: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
keepSentAttributes Boolean: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
network String: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
noClientToClientReflection Boolean: Disable client-to-client route reflection in Route Reflector setups.
noEarlyCut Boolean: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
redistribute String: Enable redistribution of specified route types.

affinity string: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
defaultOriginate string: Specifies default route (0.0.0.0/0) distribution method.
defaultPrepend number: The count of AS prepended to the AS path.
filterChain string: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
filterSelect string: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
keepSentAttributes boolean: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
network string: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
noClientToClientReflection boolean: Disable client-to-client route reflection in Route Reflector setups.
noEarlyCut boolean: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
redistribute string: Enable redistribution of specified route types.

affinity str: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
default_originate str: Specifies default route (0.0.0.0/0) distribution method.
default_prepend float: The count of AS prepended to the AS path.
filter_chain str: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
filter_select str: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
keep_sent_attributes bool: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
network str: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
no_client_to_client_reflection bool: Disable client-to-client route reflection in Route Reflector setups.
no_early_cut bool: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
redistribute str: Enable redistribution of specified route types.

affinity String: Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity).
defaultOriginate String: Specifies default route (0.0.0.0/0) distribution method.
defaultPrepend Number: The count of AS prepended to the AS path.
filterChain String: Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
filterSelect String: Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
keepSentAttributes Boolean: Store in memory sent prefix attributes, required for ' dump-saved-advertisements ' command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
network String: Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table.
noClientToClientReflection Boolean: Disable client-to-client route reflection in Route Reflector setups.
noEarlyCut Boolean: The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then then this option should be used to disable the early cut feature.
redistribute String: Enable redistribution of specified route types.

Package Details

Repository: routeros terraform-routeros/terraform-provider-routeros
License
Notes: This Pulumi package is based on the routeros Terraform Provider.

routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.RoutingBgpTemplate

On this page

On this page

# routeros.RoutingBgpTemplate (Resource)

Create RoutingBgpTemplate Resource

Constructor syntax

Parameters

RoutingBgpTemplate Resource Properties

Inputs

Outputs

Look up Existing RoutingBgpTemplate Resource

Supporting Types

RoutingBgpTemplateInput
, RoutingBgpTemplateInputArgs

RoutingBgpTemplateOutput
, RoutingBgpTemplateOutputArgs

Package Details

On this page

On this page

routeros.RoutingBgpTemplate

On this page

On this page

# routeros.RoutingBgpTemplate (Resource)

Create RoutingBgpTemplate Resource

Constructor syntax

Parameters

RoutingBgpTemplate Resource Properties

Inputs

Outputs

Look up Existing RoutingBgpTemplate Resource

Supporting Types

RoutingBgpTemplateInput, RoutingBgpTemplateInputArgs

RoutingBgpTemplateOutput, RoutingBgpTemplateOutputArgs

Package Details

On this page

On this page

RoutingBgpTemplateInput
, RoutingBgpTemplateInputArgs

RoutingBgpTemplateOutput
, RoutingBgpTemplateOutputArgs