routeros 1.89.0, Oct 15 25

routeros 1.89.0 published on Wednesday, Oct 15, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.RoutingBgpInstance

routeros 1.89.0 published on Wednesday, Oct 15, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const test = new routeros.RoutingBgpInstance("test", {});

import pulumi
import pulumi_routeros as routeros

test = routeros.RoutingBgpInstance("test")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewRoutingBgpInstance(ctx, "test", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;

return await Deployment.RunAsync(() => 
{
    var test = new Routeros.RoutingBgpInstance("test");

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.RoutingBgpInstance;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new RoutingBgpInstance("test");

    }
}

resources:
  test:
    type: routeros:RoutingBgpInstance

Create RoutingBgpInstance Resource

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

Constructor syntax

new RoutingBgpInstance(name: string, args?: RoutingBgpInstanceArgs, opts?: CustomResourceOptions);

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

@overload
def RoutingBgpInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       ___id_: Optional[float] = None,
                       ___path_: Optional[str] = None,
                       as_: Optional[str] = None,
                       cluster_id: Optional[str] = None,
                       comment: Optional[str] = None,
                       disabled: Optional[bool] = None,
                       ignore_as_path_len: Optional[bool] = None,
                       name: Optional[str] = None,
                       router_id: Optional[str] = None,
                       routing_bgp_instance_id: Optional[str] = None,
                       routing_table: Optional[str] = None,
                       vrf: Optional[str] = None)

func NewRoutingBgpInstance(ctx *Context, name string, args *RoutingBgpInstanceArgs, opts ...ResourceOption) (*RoutingBgpInstance, error)

public RoutingBgpInstance(string name, RoutingBgpInstanceArgs? args = null, CustomResourceOptions? opts = null)

public RoutingBgpInstance(String name, RoutingBgpInstanceArgs args)
public RoutingBgpInstance(String name, RoutingBgpInstanceArgs args, CustomResourceOptions options)

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

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

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

RoutingBgpInstance 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 RoutingBgpInstance 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.
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
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
Name string: Instance name.
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.
RoutingBgpInstanceId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
Vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.
___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.
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
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
Name string: Instance name.
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.
RoutingBgpInstanceId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
Vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.
___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.
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.
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
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
name String: Instance name.
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.
routingBgpInstanceId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
vrf String: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignoreAsPathLen boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
name string: Instance name.
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.
routingBgpInstanceId string: The ID of this resource.
routingTable string: Name of the routing table, to install routes in.
vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignore_as_path_len bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
name str: Instance name.
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_instance_id str: The ID of this resource.
routing_table str: Name of the routing table, to install routes in.
vrf str: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
name String: Instance name.
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.
routingBgpInstanceId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
vrf String: Name of the VRF BGP connections operates on. By default always use the main routing table.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Inactive bool

Id string: The provider-assigned unique ID for this managed resource.
Inactive bool

id String: The provider-assigned unique ID for this managed resource.
inactive Boolean

id string: The provider-assigned unique ID for this managed resource.
inactive boolean

id str: The provider-assigned unique ID for this managed resource.
inactive bool

id String: The provider-assigned unique ID for this managed resource.
inactive Boolean

Look up Existing RoutingBgpInstance Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        as_: Optional[str] = None,
        cluster_id: Optional[str] = None,
        comment: Optional[str] = None,
        disabled: Optional[bool] = None,
        ignore_as_path_len: Optional[bool] = None,
        inactive: Optional[bool] = None,
        name: Optional[str] = None,
        router_id: Optional[str] = None,
        routing_bgp_instance_id: Optional[str] = None,
        routing_table: Optional[str] = None,
        vrf: Optional[str] = None) -> RoutingBgpInstance

func GetRoutingBgpInstance(ctx *Context, name string, id IDInput, state *RoutingBgpInstanceState, opts ...ResourceOption) (*RoutingBgpInstance, error)

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

public static RoutingBgpInstance get(String name, Output<String> id, RoutingBgpInstanceState state, CustomResourceOptions options)

resources:  _:    type: routeros:RoutingBgpInstance    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:

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.
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
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
Inactive bool
Name string: Instance name.
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.
RoutingBgpInstanceId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
Vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.
___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.
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
IgnoreAsPathLen bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
Inactive bool
Name string: Instance name.
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.
RoutingBgpInstanceId string: The ID of this resource.
RoutingTable string: Name of the routing table, to install routes in.
Vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.
___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.
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.
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
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
inactive Boolean
name String: Instance name.
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.
routingBgpInstanceId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
vrf String: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignoreAsPathLen boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
inactive boolean
name string: Instance name.
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.
routingBgpInstanceId string: The ID of this resource.
routingTable string: Name of the routing table, to install routes in.
vrf string: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignore_as_path_len bool: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
inactive bool
name str: Instance name.
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_instance_id str: The ID of this resource.
routing_table str: Name of the routing table, to install routes in.
vrf str: Name of the VRF BGP connections operates on. By default always use the main routing table.

___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.
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.
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
ignoreAsPathLen Boolean: Whether to ignore the AS_PATH attribute in the BGP route selection algorithm. Works on input.
inactive Boolean
name String: Instance name.
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.
routingBgpInstanceId String: The ID of this resource.
routingTable String: Name of the routing table, to install routes in.
vrf String: Name of the VRF BGP connections operates on. By default always use the main routing table.

Import

#The ID can be found via API or the terminal

#The command for the terminal is -> :put [/routing/bgp/instance get [print show-ids]]

$ pulumi import routeros:index/routingBgpInstance:RoutingBgpInstance test *3

#Or you can import a resource using one of its attributes

$ pulumi import routeros:index/routingBgpInstance:RoutingBgpInstance test "name=xxx"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

routeros 1.89.0 published on Wednesday, Oct 15, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.RoutingBgpInstance

On this page

On this page

Example Usage

Create RoutingBgpInstance Resource

Constructor syntax

Parameters

RoutingBgpInstance Resource Properties

Inputs

Outputs

Look up Existing RoutingBgpInstance Resource

Import

Package Details

On this page

On this page