1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectRouterRoutemap
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.ObjectRouterRoutemap

Explore with Pulumi AI

Configure route maps.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • rule: fortimanager.ObjectRouterRoutemapRule

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  trname:
    type: fortimanager:ObjectRouterRoutemap
    properties:
      comment: This is a Terraform example
      rules:
        - action: deny
          id: 1
          matchCommunity: Priority_1
          matchExtcommunityExact: enable
Copy

Create ObjectRouterRoutemap Resource

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

Constructor syntax

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

@overload
def ObjectRouterRoutemap(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         adom: Optional[str] = None,
                         comments: Optional[str] = None,
                         dynamic_sort_subtable: Optional[str] = None,
                         name: Optional[str] = None,
                         object_router_routemap_id: Optional[str] = None,
                         rules: Optional[Sequence[ObjectRouterRoutemapRuleArgs]] = None,
                         scopetype: Optional[str] = None)
func NewObjectRouterRoutemap(ctx *Context, name string, args *ObjectRouterRoutemapArgs, opts ...ResourceOption) (*ObjectRouterRoutemap, error)
public ObjectRouterRoutemap(string name, ObjectRouterRoutemapArgs? args = null, CustomResourceOptions? opts = null)
public ObjectRouterRoutemap(String name, ObjectRouterRoutemapArgs args)
public ObjectRouterRoutemap(String name, ObjectRouterRoutemapArgs args, CustomResourceOptions options)
type: fortimanager:ObjectRouterRoutemap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ObjectRouterRoutemapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ObjectRouterRoutemapArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ObjectRouterRoutemapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ObjectRouterRoutemapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectRouterRoutemapArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var objectRouterRoutemapResource = new Fortimanager.ObjectRouterRoutemap("objectRouterRoutemapResource", new()
{
    Adom = "string",
    Comments = "string",
    DynamicSortSubtable = "string",
    Name = "string",
    ObjectRouterRoutemapId = "string",
    Rules = new[]
    {
        new Fortimanager.Inputs.ObjectRouterRoutemapRuleArgs
        {
            Action = "string",
            Id = 0,
            MatchAsPath = "string",
            MatchCommunity = "string",
            MatchCommunityExact = "string",
            MatchExtcommunity = "string",
            MatchExtcommunityExact = "string",
            MatchFlags = 0,
            MatchInterface = "string",
            MatchIp6Address = "string",
            MatchIp6Nexthop = "string",
            MatchIpAddress = "string",
            MatchIpNexthop = "string",
            MatchMetric = "string",
            MatchOrigin = "string",
            MatchRouteType = "string",
            MatchTag = "string",
            MatchVrf = 0,
            SetAggregatorAs = 0,
            SetAggregatorIp = "string",
            SetAspathAction = "string",
            SetAspaths = new[]
            {
                "string",
            },
            SetAtomicAggregate = "string",
            SetCommunities = new[]
            {
                "string",
            },
            SetCommunityAdditive = "string",
            SetCommunityDelete = "string",
            SetDampeningMaxSuppress = 0,
            SetDampeningReachabilityHalfLife = 0,
            SetDampeningReuse = 0,
            SetDampeningSuppress = 0,
            SetDampeningUnreachabilityHalfLife = 0,
            SetExtcommunityRts = new[]
            {
                "string",
            },
            SetExtcommunitySoos = new[]
            {
                "string",
            },
            SetFlags = 0,
            SetIp6Nexthop = "string",
            SetIp6NexthopLocal = "string",
            SetIpNexthop = "string",
            SetIpPrefsrc = "string",
            SetLocalPreference = "string",
            SetMetric = "string",
            SetMetricType = "string",
            SetOrigin = "string",
            SetOriginatorId = "string",
            SetPriority = 0,
            SetRouteTag = "string",
            SetTag = "string",
            SetVpnv4Nexthop = "string",
            SetVpnv6Nexthop = "string",
            SetVpnv6NexthopLocal = "string",
            SetWeight = "string",
        },
    },
    Scopetype = "string",
});
Copy
example, err := fortimanager.NewObjectRouterRoutemap(ctx, "objectRouterRoutemapResource", &fortimanager.ObjectRouterRoutemapArgs{
Adom: pulumi.String("string"),
Comments: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectRouterRoutemapId: pulumi.String("string"),
Rules: .ObjectRouterRoutemapRuleTypeArray{
&.ObjectRouterRoutemapRuleTypeArgs{
Action: pulumi.String("string"),
Id: pulumi.Float64(0),
MatchAsPath: pulumi.String("string"),
MatchCommunity: pulumi.String("string"),
MatchCommunityExact: pulumi.String("string"),
MatchExtcommunity: pulumi.String("string"),
MatchExtcommunityExact: pulumi.String("string"),
MatchFlags: pulumi.Float64(0),
MatchInterface: pulumi.String("string"),
MatchIp6Address: pulumi.String("string"),
MatchIp6Nexthop: pulumi.String("string"),
MatchIpAddress: pulumi.String("string"),
MatchIpNexthop: pulumi.String("string"),
MatchMetric: pulumi.String("string"),
MatchOrigin: pulumi.String("string"),
MatchRouteType: pulumi.String("string"),
MatchTag: pulumi.String("string"),
MatchVrf: pulumi.Float64(0),
SetAggregatorAs: pulumi.Float64(0),
SetAggregatorIp: pulumi.String("string"),
SetAspathAction: pulumi.String("string"),
SetAspaths: pulumi.StringArray{
pulumi.String("string"),
},
SetAtomicAggregate: pulumi.String("string"),
SetCommunities: pulumi.StringArray{
pulumi.String("string"),
},
SetCommunityAdditive: pulumi.String("string"),
SetCommunityDelete: pulumi.String("string"),
SetDampeningMaxSuppress: pulumi.Float64(0),
SetDampeningReachabilityHalfLife: pulumi.Float64(0),
SetDampeningReuse: pulumi.Float64(0),
SetDampeningSuppress: pulumi.Float64(0),
SetDampeningUnreachabilityHalfLife: pulumi.Float64(0),
SetExtcommunityRts: pulumi.StringArray{
pulumi.String("string"),
},
SetExtcommunitySoos: pulumi.StringArray{
pulumi.String("string"),
},
SetFlags: pulumi.Float64(0),
SetIp6Nexthop: pulumi.String("string"),
SetIp6NexthopLocal: pulumi.String("string"),
SetIpNexthop: pulumi.String("string"),
SetIpPrefsrc: pulumi.String("string"),
SetLocalPreference: pulumi.String("string"),
SetMetric: pulumi.String("string"),
SetMetricType: pulumi.String("string"),
SetOrigin: pulumi.String("string"),
SetOriginatorId: pulumi.String("string"),
SetPriority: pulumi.Float64(0),
SetRouteTag: pulumi.String("string"),
SetTag: pulumi.String("string"),
SetVpnv4Nexthop: pulumi.String("string"),
SetVpnv6Nexthop: pulumi.String("string"),
SetVpnv6NexthopLocal: pulumi.String("string"),
SetWeight: pulumi.String("string"),
},
},
Scopetype: pulumi.String("string"),
})
Copy
var objectRouterRoutemapResource = new ObjectRouterRoutemap("objectRouterRoutemapResource", ObjectRouterRoutemapArgs.builder()
    .adom("string")
    .comments("string")
    .dynamicSortSubtable("string")
    .name("string")
    .objectRouterRoutemapId("string")
    .rules(ObjectRouterRoutemapRuleArgs.builder()
        .action("string")
        .id(0)
        .matchAsPath("string")
        .matchCommunity("string")
        .matchCommunityExact("string")
        .matchExtcommunity("string")
        .matchExtcommunityExact("string")
        .matchFlags(0)
        .matchInterface("string")
        .matchIp6Address("string")
        .matchIp6Nexthop("string")
        .matchIpAddress("string")
        .matchIpNexthop("string")
        .matchMetric("string")
        .matchOrigin("string")
        .matchRouteType("string")
        .matchTag("string")
        .matchVrf(0)
        .setAggregatorAs(0)
        .setAggregatorIp("string")
        .setAspathAction("string")
        .setAspaths("string")
        .setAtomicAggregate("string")
        .setCommunities("string")
        .setCommunityAdditive("string")
        .setCommunityDelete("string")
        .setDampeningMaxSuppress(0)
        .setDampeningReachabilityHalfLife(0)
        .setDampeningReuse(0)
        .setDampeningSuppress(0)
        .setDampeningUnreachabilityHalfLife(0)
        .setExtcommunityRts("string")
        .setExtcommunitySoos("string")
        .setFlags(0)
        .setIp6Nexthop("string")
        .setIp6NexthopLocal("string")
        .setIpNexthop("string")
        .setIpPrefsrc("string")
        .setLocalPreference("string")
        .setMetric("string")
        .setMetricType("string")
        .setOrigin("string")
        .setOriginatorId("string")
        .setPriority(0)
        .setRouteTag("string")
        .setTag("string")
        .setVpnv4Nexthop("string")
        .setVpnv6Nexthop("string")
        .setVpnv6NexthopLocal("string")
        .setWeight("string")
        .build())
    .scopetype("string")
    .build());
Copy
object_router_routemap_resource = fortimanager.ObjectRouterRoutemap("objectRouterRoutemapResource",
    adom="string",
    comments="string",
    dynamic_sort_subtable="string",
    name="string",
    object_router_routemap_id="string",
    rules=[{
        "action": "string",
        "id": 0,
        "match_as_path": "string",
        "match_community": "string",
        "match_community_exact": "string",
        "match_extcommunity": "string",
        "match_extcommunity_exact": "string",
        "match_flags": 0,
        "match_interface": "string",
        "match_ip6_address": "string",
        "match_ip6_nexthop": "string",
        "match_ip_address": "string",
        "match_ip_nexthop": "string",
        "match_metric": "string",
        "match_origin": "string",
        "match_route_type": "string",
        "match_tag": "string",
        "match_vrf": 0,
        "set_aggregator_as": 0,
        "set_aggregator_ip": "string",
        "set_aspath_action": "string",
        "set_aspaths": ["string"],
        "set_atomic_aggregate": "string",
        "set_communities": ["string"],
        "set_community_additive": "string",
        "set_community_delete": "string",
        "set_dampening_max_suppress": 0,
        "set_dampening_reachability_half_life": 0,
        "set_dampening_reuse": 0,
        "set_dampening_suppress": 0,
        "set_dampening_unreachability_half_life": 0,
        "set_extcommunity_rts": ["string"],
        "set_extcommunity_soos": ["string"],
        "set_flags": 0,
        "set_ip6_nexthop": "string",
        "set_ip6_nexthop_local": "string",
        "set_ip_nexthop": "string",
        "set_ip_prefsrc": "string",
        "set_local_preference": "string",
        "set_metric": "string",
        "set_metric_type": "string",
        "set_origin": "string",
        "set_originator_id": "string",
        "set_priority": 0,
        "set_route_tag": "string",
        "set_tag": "string",
        "set_vpnv4_nexthop": "string",
        "set_vpnv6_nexthop": "string",
        "set_vpnv6_nexthop_local": "string",
        "set_weight": "string",
    }],
    scopetype="string")
Copy
const objectRouterRoutemapResource = new fortimanager.ObjectRouterRoutemap("objectRouterRoutemapResource", {
    adom: "string",
    comments: "string",
    dynamicSortSubtable: "string",
    name: "string",
    objectRouterRoutemapId: "string",
    rules: [{
        action: "string",
        id: 0,
        matchAsPath: "string",
        matchCommunity: "string",
        matchCommunityExact: "string",
        matchExtcommunity: "string",
        matchExtcommunityExact: "string",
        matchFlags: 0,
        matchInterface: "string",
        matchIp6Address: "string",
        matchIp6Nexthop: "string",
        matchIpAddress: "string",
        matchIpNexthop: "string",
        matchMetric: "string",
        matchOrigin: "string",
        matchRouteType: "string",
        matchTag: "string",
        matchVrf: 0,
        setAggregatorAs: 0,
        setAggregatorIp: "string",
        setAspathAction: "string",
        setAspaths: ["string"],
        setAtomicAggregate: "string",
        setCommunities: ["string"],
        setCommunityAdditive: "string",
        setCommunityDelete: "string",
        setDampeningMaxSuppress: 0,
        setDampeningReachabilityHalfLife: 0,
        setDampeningReuse: 0,
        setDampeningSuppress: 0,
        setDampeningUnreachabilityHalfLife: 0,
        setExtcommunityRts: ["string"],
        setExtcommunitySoos: ["string"],
        setFlags: 0,
        setIp6Nexthop: "string",
        setIp6NexthopLocal: "string",
        setIpNexthop: "string",
        setIpPrefsrc: "string",
        setLocalPreference: "string",
        setMetric: "string",
        setMetricType: "string",
        setOrigin: "string",
        setOriginatorId: "string",
        setPriority: 0,
        setRouteTag: "string",
        setTag: "string",
        setVpnv4Nexthop: "string",
        setVpnv6Nexthop: "string",
        setVpnv6NexthopLocal: "string",
        setWeight: "string",
    }],
    scopetype: "string",
});
Copy
type: fortimanager:ObjectRouterRoutemap
properties:
    adom: string
    comments: string
    dynamicSortSubtable: string
    name: string
    objectRouterRoutemapId: string
    rules:
        - action: string
          id: 0
          matchAsPath: string
          matchCommunity: string
          matchCommunityExact: string
          matchExtcommunity: string
          matchExtcommunityExact: string
          matchFlags: 0
          matchInterface: string
          matchIp6Address: string
          matchIp6Nexthop: string
          matchIpAddress: string
          matchIpNexthop: string
          matchMetric: string
          matchOrigin: string
          matchRouteType: string
          matchTag: string
          matchVrf: 0
          setAggregatorAs: 0
          setAggregatorIp: string
          setAspathAction: string
          setAspaths:
            - string
          setAtomicAggregate: string
          setCommunities:
            - string
          setCommunityAdditive: string
          setCommunityDelete: string
          setDampeningMaxSuppress: 0
          setDampeningReachabilityHalfLife: 0
          setDampeningReuse: 0
          setDampeningSuppress: 0
          setDampeningUnreachabilityHalfLife: 0
          setExtcommunityRts:
            - string
          setExtcommunitySoos:
            - string
          setFlags: 0
          setIp6Nexthop: string
          setIp6NexthopLocal: string
          setIpNexthop: string
          setIpPrefsrc: string
          setLocalPreference: string
          setMetric: string
          setMetricType: string
          setOrigin: string
          setOriginatorId: string
          setPriority: 0
          setRouteTag: string
          setTag: string
          setVpnv4Nexthop: string
          setVpnv6Nexthop: string
          setVpnv6NexthopLocal: string
          setWeight: string
    scopetype: string
Copy

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

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comments string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Name string
Name.
ObjectRouterRoutemapId string
an identifier for the resource with format {{name}}.
Rules List<ObjectRouterRoutemapRule>
Rule. The structure of rule block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comments string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Name string
Name.
ObjectRouterRoutemapId string
an identifier for the resource with format {{name}}.
Rules []ObjectRouterRoutemapRuleTypeArgs
Rule. The structure of rule block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name String
Name.
objectRouterRoutemapId String
an identifier for the resource with format {{name}}.
rules List<ObjectRouterRoutemapRule>
Rule. The structure of rule block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments string
Optional comments.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name string
Name.
objectRouterRoutemapId string
an identifier for the resource with format {{name}}.
rules ObjectRouterRoutemapRule[]
Rule. The structure of rule block is documented below.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments str
Optional comments.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name str
Name.
object_router_routemap_id str
an identifier for the resource with format {{name}}.
rules Sequence[ObjectRouterRoutemapRuleArgs]
Rule. The structure of rule block is documented below.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name String
Name.
objectRouterRoutemapId String
an identifier for the resource with format {{name}}.
rules List<Property Map>
Rule. The structure of rule block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ObjectRouterRoutemap Resource

Get an existing ObjectRouterRoutemap 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?: ObjectRouterRoutemapState, opts?: CustomResourceOptions): ObjectRouterRoutemap
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        comments: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        name: Optional[str] = None,
        object_router_routemap_id: Optional[str] = None,
        rules: Optional[Sequence[ObjectRouterRoutemapRuleArgs]] = None,
        scopetype: Optional[str] = None) -> ObjectRouterRoutemap
func GetObjectRouterRoutemap(ctx *Context, name string, id IDInput, state *ObjectRouterRoutemapState, opts ...ResourceOption) (*ObjectRouterRoutemap, error)
public static ObjectRouterRoutemap Get(string name, Input<string> id, ObjectRouterRoutemapState? state, CustomResourceOptions? opts = null)
public static ObjectRouterRoutemap get(String name, Output<String> id, ObjectRouterRoutemapState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectRouterRoutemap    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comments string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Name string
Name.
ObjectRouterRoutemapId string
an identifier for the resource with format {{name}}.
Rules List<ObjectRouterRoutemapRule>
Rule. The structure of rule block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comments string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Name string
Name.
ObjectRouterRoutemapId string
an identifier for the resource with format {{name}}.
Rules []ObjectRouterRoutemapRuleTypeArgs
Rule. The structure of rule block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name String
Name.
objectRouterRoutemapId String
an identifier for the resource with format {{name}}.
rules List<ObjectRouterRoutemapRule>
Rule. The structure of rule block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments string
Optional comments.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name string
Name.
objectRouterRoutemapId string
an identifier for the resource with format {{name}}.
rules ObjectRouterRoutemapRule[]
Rule. The structure of rule block is documented below.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments str
Optional comments.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name str
Name.
object_router_routemap_id str
an identifier for the resource with format {{name}}.
rules Sequence[ObjectRouterRoutemapRuleArgs]
Rule. The structure of rule block is documented below.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comments String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
name String
Name.
objectRouterRoutemapId String
an identifier for the resource with format {{name}}.
rules List<Property Map>
Rule. The structure of rule block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

Supporting Types

ObjectRouterRoutemapRule
, ObjectRouterRoutemapRuleArgs

Action string
Action. Valid values: permit, deny.
Id double
Rule ID.
MatchAsPath string
Match BGP AS path list.
MatchCommunity string
Match BGP community list.
MatchCommunityExact string
Enable/disable exact matching of communities. Valid values: disable, enable.
MatchExtcommunity string
Match BGP extended community list.
MatchExtcommunityExact string
Enable/disable exact matching of extended communities. Valid values: disable, enable.
MatchFlags double
Match-Flags.
MatchInterface string
Match interface configuration.
MatchIp6Address string
Match IPv6 address permitted by access-list6 or prefix-list6.
MatchIp6Nexthop string
Match next hop IPv6 address passed by access-list6 or prefix-list6.
MatchIpAddress string
Match IP address permitted by access-list or prefix-list.
MatchIpNexthop string
Match next hop IP address passed by access-list or prefix-list.
MatchMetric string
Match metric for redistribute routes.
MatchOrigin string
Match BGP origin code. Valid values: none, egp, igp, incomplete.
MatchRouteType string
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
MatchTag string
Match tag.
MatchVrf double
Match VRF ID.
SetAggregatorAs double
BGP aggregator AS.
SetAggregatorIp string
BGP aggregator IP.
SetAspathAction string
Specify preferred action of set-aspath. Valid values: prepend, replace.
SetAspaths List<string>
Prepend BGP AS path attribute.
SetAtomicAggregate string
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
SetCommunities List<string>
BGP community attribute.
SetCommunityAdditive string
Enable/disable adding set-community to existing community. Valid values: disable, enable.
SetCommunityDelete string
Delete communities matching community list.
SetDampeningMaxSuppress double
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
SetDampeningReachabilityHalfLife double
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
SetDampeningReuse double
Value to start reusing a route (1 - 20000, 0 = unset).
SetDampeningSuppress double
Value to start suppressing a route (1 - 20000, 0 = unset).
SetDampeningUnreachabilityHalfLife double
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
SetExtcommunityRts List<string>
Route Target extended community.
SetExtcommunitySoos List<string>
Site-of-Origin extended community.
SetFlags double
Set-Flags.
SetIp6Nexthop string
IPv6 global address of next hop.
SetIp6NexthopLocal string
IPv6 local address of next hop.
SetIpNexthop string
IP address of next hop.
SetIpPrefsrc string
IP address of preferred source.
SetLocalPreference string
BGP local preference path attribute.
SetMetric string
Metric value.
SetMetricType string
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
SetOrigin string
BGP origin code. Valid values: none, egp, igp, incomplete.
SetOriginatorId string
BGP originator ID attribute.
SetPriority double
Priority for routing table.
SetRouteTag string
Route tag for routing table.
SetTag string
Tag value.
SetVpnv4Nexthop string
IP address of VPNv4 next-hop.
SetVpnv6Nexthop string
IPv6 global address of VPNv6 next-hop.
SetVpnv6NexthopLocal string
IPv6 link-local address of VPNv6 next-hop.
SetWeight string
BGP weight for routing table.
Action string
Action. Valid values: permit, deny.
Id float64
Rule ID.
MatchAsPath string
Match BGP AS path list.
MatchCommunity string
Match BGP community list.
MatchCommunityExact string
Enable/disable exact matching of communities. Valid values: disable, enable.
MatchExtcommunity string
Match BGP extended community list.
MatchExtcommunityExact string
Enable/disable exact matching of extended communities. Valid values: disable, enable.
MatchFlags float64
Match-Flags.
MatchInterface string
Match interface configuration.
MatchIp6Address string
Match IPv6 address permitted by access-list6 or prefix-list6.
MatchIp6Nexthop string
Match next hop IPv6 address passed by access-list6 or prefix-list6.
MatchIpAddress string
Match IP address permitted by access-list or prefix-list.
MatchIpNexthop string
Match next hop IP address passed by access-list or prefix-list.
MatchMetric string
Match metric for redistribute routes.
MatchOrigin string
Match BGP origin code. Valid values: none, egp, igp, incomplete.
MatchRouteType string
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
MatchTag string
Match tag.
MatchVrf float64
Match VRF ID.
SetAggregatorAs float64
BGP aggregator AS.
SetAggregatorIp string
BGP aggregator IP.
SetAspathAction string
Specify preferred action of set-aspath. Valid values: prepend, replace.
SetAspaths []string
Prepend BGP AS path attribute.
SetAtomicAggregate string
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
SetCommunities []string
BGP community attribute.
SetCommunityAdditive string
Enable/disable adding set-community to existing community. Valid values: disable, enable.
SetCommunityDelete string
Delete communities matching community list.
SetDampeningMaxSuppress float64
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
SetDampeningReachabilityHalfLife float64
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
SetDampeningReuse float64
Value to start reusing a route (1 - 20000, 0 = unset).
SetDampeningSuppress float64
Value to start suppressing a route (1 - 20000, 0 = unset).
SetDampeningUnreachabilityHalfLife float64
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
SetExtcommunityRts []string
Route Target extended community.
SetExtcommunitySoos []string
Site-of-Origin extended community.
SetFlags float64
Set-Flags.
SetIp6Nexthop string
IPv6 global address of next hop.
SetIp6NexthopLocal string
IPv6 local address of next hop.
SetIpNexthop string
IP address of next hop.
SetIpPrefsrc string
IP address of preferred source.
SetLocalPreference string
BGP local preference path attribute.
SetMetric string
Metric value.
SetMetricType string
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
SetOrigin string
BGP origin code. Valid values: none, egp, igp, incomplete.
SetOriginatorId string
BGP originator ID attribute.
SetPriority float64
Priority for routing table.
SetRouteTag string
Route tag for routing table.
SetTag string
Tag value.
SetVpnv4Nexthop string
IP address of VPNv4 next-hop.
SetVpnv6Nexthop string
IPv6 global address of VPNv6 next-hop.
SetVpnv6NexthopLocal string
IPv6 link-local address of VPNv6 next-hop.
SetWeight string
BGP weight for routing table.
action String
Action. Valid values: permit, deny.
id Double
Rule ID.
matchAsPath String
Match BGP AS path list.
matchCommunity String
Match BGP community list.
matchCommunityExact String
Enable/disable exact matching of communities. Valid values: disable, enable.
matchExtcommunity String
Match BGP extended community list.
matchExtcommunityExact String
Enable/disable exact matching of extended communities. Valid values: disable, enable.
matchFlags Double
Match-Flags.
matchInterface String
Match interface configuration.
matchIp6Address String
Match IPv6 address permitted by access-list6 or prefix-list6.
matchIp6Nexthop String
Match next hop IPv6 address passed by access-list6 or prefix-list6.
matchIpAddress String
Match IP address permitted by access-list or prefix-list.
matchIpNexthop String
Match next hop IP address passed by access-list or prefix-list.
matchMetric String
Match metric for redistribute routes.
matchOrigin String
Match BGP origin code. Valid values: none, egp, igp, incomplete.
matchRouteType String
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
matchTag String
Match tag.
matchVrf Double
Match VRF ID.
setAggregatorAs Double
BGP aggregator AS.
setAggregatorIp String
BGP aggregator IP.
setAspathAction String
Specify preferred action of set-aspath. Valid values: prepend, replace.
setAspaths List<String>
Prepend BGP AS path attribute.
setAtomicAggregate String
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
setCommunities List<String>
BGP community attribute.
setCommunityAdditive String
Enable/disable adding set-community to existing community. Valid values: disable, enable.
setCommunityDelete String
Delete communities matching community list.
setDampeningMaxSuppress Double
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
setDampeningReachabilityHalfLife Double
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
setDampeningReuse Double
Value to start reusing a route (1 - 20000, 0 = unset).
setDampeningSuppress Double
Value to start suppressing a route (1 - 20000, 0 = unset).
setDampeningUnreachabilityHalfLife Double
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
setExtcommunityRts List<String>
Route Target extended community.
setExtcommunitySoos List<String>
Site-of-Origin extended community.
setFlags Double
Set-Flags.
setIp6Nexthop String
IPv6 global address of next hop.
setIp6NexthopLocal String
IPv6 local address of next hop.
setIpNexthop String
IP address of next hop.
setIpPrefsrc String
IP address of preferred source.
setLocalPreference String
BGP local preference path attribute.
setMetric String
Metric value.
setMetricType String
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
setOrigin String
BGP origin code. Valid values: none, egp, igp, incomplete.
setOriginatorId String
BGP originator ID attribute.
setPriority Double
Priority for routing table.
setRouteTag String
Route tag for routing table.
setTag String
Tag value.
setVpnv4Nexthop String
IP address of VPNv4 next-hop.
setVpnv6Nexthop String
IPv6 global address of VPNv6 next-hop.
setVpnv6NexthopLocal String
IPv6 link-local address of VPNv6 next-hop.
setWeight String
BGP weight for routing table.
action string
Action. Valid values: permit, deny.
id number
Rule ID.
matchAsPath string
Match BGP AS path list.
matchCommunity string
Match BGP community list.
matchCommunityExact string
Enable/disable exact matching of communities. Valid values: disable, enable.
matchExtcommunity string
Match BGP extended community list.
matchExtcommunityExact string
Enable/disable exact matching of extended communities. Valid values: disable, enable.
matchFlags number
Match-Flags.
matchInterface string
Match interface configuration.
matchIp6Address string
Match IPv6 address permitted by access-list6 or prefix-list6.
matchIp6Nexthop string
Match next hop IPv6 address passed by access-list6 or prefix-list6.
matchIpAddress string
Match IP address permitted by access-list or prefix-list.
matchIpNexthop string
Match next hop IP address passed by access-list or prefix-list.
matchMetric string
Match metric for redistribute routes.
matchOrigin string
Match BGP origin code. Valid values: none, egp, igp, incomplete.
matchRouteType string
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
matchTag string
Match tag.
matchVrf number
Match VRF ID.
setAggregatorAs number
BGP aggregator AS.
setAggregatorIp string
BGP aggregator IP.
setAspathAction string
Specify preferred action of set-aspath. Valid values: prepend, replace.
setAspaths string[]
Prepend BGP AS path attribute.
setAtomicAggregate string
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
setCommunities string[]
BGP community attribute.
setCommunityAdditive string
Enable/disable adding set-community to existing community. Valid values: disable, enable.
setCommunityDelete string
Delete communities matching community list.
setDampeningMaxSuppress number
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
setDampeningReachabilityHalfLife number
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
setDampeningReuse number
Value to start reusing a route (1 - 20000, 0 = unset).
setDampeningSuppress number
Value to start suppressing a route (1 - 20000, 0 = unset).
setDampeningUnreachabilityHalfLife number
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
setExtcommunityRts string[]
Route Target extended community.
setExtcommunitySoos string[]
Site-of-Origin extended community.
setFlags number
Set-Flags.
setIp6Nexthop string
IPv6 global address of next hop.
setIp6NexthopLocal string
IPv6 local address of next hop.
setIpNexthop string
IP address of next hop.
setIpPrefsrc string
IP address of preferred source.
setLocalPreference string
BGP local preference path attribute.
setMetric string
Metric value.
setMetricType string
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
setOrigin string
BGP origin code. Valid values: none, egp, igp, incomplete.
setOriginatorId string
BGP originator ID attribute.
setPriority number
Priority for routing table.
setRouteTag string
Route tag for routing table.
setTag string
Tag value.
setVpnv4Nexthop string
IP address of VPNv4 next-hop.
setVpnv6Nexthop string
IPv6 global address of VPNv6 next-hop.
setVpnv6NexthopLocal string
IPv6 link-local address of VPNv6 next-hop.
setWeight string
BGP weight for routing table.
action str
Action. Valid values: permit, deny.
id float
Rule ID.
match_as_path str
Match BGP AS path list.
match_community str
Match BGP community list.
match_community_exact str
Enable/disable exact matching of communities. Valid values: disable, enable.
match_extcommunity str
Match BGP extended community list.
match_extcommunity_exact str
Enable/disable exact matching of extended communities. Valid values: disable, enable.
match_flags float
Match-Flags.
match_interface str
Match interface configuration.
match_ip6_address str
Match IPv6 address permitted by access-list6 or prefix-list6.
match_ip6_nexthop str
Match next hop IPv6 address passed by access-list6 or prefix-list6.
match_ip_address str
Match IP address permitted by access-list or prefix-list.
match_ip_nexthop str
Match next hop IP address passed by access-list or prefix-list.
match_metric str
Match metric for redistribute routes.
match_origin str
Match BGP origin code. Valid values: none, egp, igp, incomplete.
match_route_type str
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
match_tag str
Match tag.
match_vrf float
Match VRF ID.
set_aggregator_as float
BGP aggregator AS.
set_aggregator_ip str
BGP aggregator IP.
set_aspath_action str
Specify preferred action of set-aspath. Valid values: prepend, replace.
set_aspaths Sequence[str]
Prepend BGP AS path attribute.
set_atomic_aggregate str
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
set_communities Sequence[str]
BGP community attribute.
set_community_additive str
Enable/disable adding set-community to existing community. Valid values: disable, enable.
set_community_delete str
Delete communities matching community list.
set_dampening_max_suppress float
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
set_dampening_reachability_half_life float
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
set_dampening_reuse float
Value to start reusing a route (1 - 20000, 0 = unset).
set_dampening_suppress float
Value to start suppressing a route (1 - 20000, 0 = unset).
set_dampening_unreachability_half_life float
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
set_extcommunity_rts Sequence[str]
Route Target extended community.
set_extcommunity_soos Sequence[str]
Site-of-Origin extended community.
set_flags float
Set-Flags.
set_ip6_nexthop str
IPv6 global address of next hop.
set_ip6_nexthop_local str
IPv6 local address of next hop.
set_ip_nexthop str
IP address of next hop.
set_ip_prefsrc str
IP address of preferred source.
set_local_preference str
BGP local preference path attribute.
set_metric str
Metric value.
set_metric_type str
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
set_origin str
BGP origin code. Valid values: none, egp, igp, incomplete.
set_originator_id str
BGP originator ID attribute.
set_priority float
Priority for routing table.
set_route_tag str
Route tag for routing table.
set_tag str
Tag value.
set_vpnv4_nexthop str
IP address of VPNv4 next-hop.
set_vpnv6_nexthop str
IPv6 global address of VPNv6 next-hop.
set_vpnv6_nexthop_local str
IPv6 link-local address of VPNv6 next-hop.
set_weight str
BGP weight for routing table.
action String
Action. Valid values: permit, deny.
id Number
Rule ID.
matchAsPath String
Match BGP AS path list.
matchCommunity String
Match BGP community list.
matchCommunityExact String
Enable/disable exact matching of communities. Valid values: disable, enable.
matchExtcommunity String
Match BGP extended community list.
matchExtcommunityExact String
Enable/disable exact matching of extended communities. Valid values: disable, enable.
matchFlags Number
Match-Flags.
matchInterface String
Match interface configuration.
matchIp6Address String
Match IPv6 address permitted by access-list6 or prefix-list6.
matchIp6Nexthop String
Match next hop IPv6 address passed by access-list6 or prefix-list6.
matchIpAddress String
Match IP address permitted by access-list or prefix-list.
matchIpNexthop String
Match next hop IP address passed by access-list or prefix-list.
matchMetric String
Match metric for redistribute routes.
matchOrigin String
Match BGP origin code. Valid values: none, egp, igp, incomplete.
matchRouteType String
Match route type. Valid values: 1, 2, none, external-type1, external-type2.
matchTag String
Match tag.
matchVrf Number
Match VRF ID.
setAggregatorAs Number
BGP aggregator AS.
setAggregatorIp String
BGP aggregator IP.
setAspathAction String
Specify preferred action of set-aspath. Valid values: prepend, replace.
setAspaths List<String>
Prepend BGP AS path attribute.
setAtomicAggregate String
Enable/disable BGP atomic aggregate attribute. Valid values: disable, enable.
setCommunities List<String>
BGP community attribute.
setCommunityAdditive String
Enable/disable adding set-community to existing community. Valid values: disable, enable.
setCommunityDelete String
Delete communities matching community list.
setDampeningMaxSuppress Number
Maximum duration to suppress a route (1 - 255 min, 0 = unset).
setDampeningReachabilityHalfLife Number
Reachability half-life time for the penalty (1 - 45 min, 0 = unset).
setDampeningReuse Number
Value to start reusing a route (1 - 20000, 0 = unset).
setDampeningSuppress Number
Value to start suppressing a route (1 - 20000, 0 = unset).
setDampeningUnreachabilityHalfLife Number
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset)
setExtcommunityRts List<String>
Route Target extended community.
setExtcommunitySoos List<String>
Site-of-Origin extended community.
setFlags Number
Set-Flags.
setIp6Nexthop String
IPv6 global address of next hop.
setIp6NexthopLocal String
IPv6 local address of next hop.
setIpNexthop String
IP address of next hop.
setIpPrefsrc String
IP address of preferred source.
setLocalPreference String
BGP local preference path attribute.
setMetric String
Metric value.
setMetricType String
Metric type. Valid values: 1, 2, none, external-type1, external-type2.
setOrigin String
BGP origin code. Valid values: none, egp, igp, incomplete.
setOriginatorId String
BGP originator ID attribute.
setPriority Number
Priority for routing table.
setRouteTag String
Route tag for routing table.
setTag String
Tag value.
setVpnv4Nexthop String
IP address of VPNv4 next-hop.
setVpnv6Nexthop String
IPv6 global address of VPNv6 next-hop.
setVpnv6NexthopLocal String
IPv6 link-local address of VPNv6 next-hop.
setWeight String
BGP weight for routing table.

Import

ObjectRouter RouteMap can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectRouterRoutemap:ObjectRouterRoutemap labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

Package Details

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