fortinet.fortios.fortios_router_route_map module – Configure route maps in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_router_route_map.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and route_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure route maps. |
|
Optional comments. |
|
Name. |
|
Rule. |
|
Action. Choices:
|
|
Rule ID. see <a href=’#notes’>Notes</a>. |
|
Match BGP AS path list. Source router.aspath-list.name. |
|
Match BGP community list. Source router.community-list.name. |
|
Enable/disable exact matching of communities. Choices:
|
|
Match BGP extended community list. Source router.extcommunity-list.name. |
|
Enable/disable exact matching of extended communities. Choices:
|
|
BGP flag value to match (0 - 65535) |
|
Match interface configuration. Source system.interface.name. |
|
Match IPv6 address permitted by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. |
|
Match next hop IPv6 address passed by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. |
|
Match IP address permitted by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. |
|
Match next hop IP address passed by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. |
|
Match metric for redistribute routes. |
|
Match BGP origin code. Choices:
|
|
Match route type. Choices:
|
|
Match tag. |
|
Match VRF ID. |
|
BGP aggregator AS. |
|
BGP aggregator IP. |
|
Prepend BGP AS path attribute. |
|
AS number (0 - 4294967295). Use quotes for repeating numbers, For example, “1 1 2”. |
|
Specify preferred action of set-aspath. Choices:
|
|
Enable/disable BGP atomic aggregate attribute. Choices:
|
|
BGP community attribute. |
|
Attribute: AA|AA:NN|internet|local-AS|no-advertise|no-export (exact match required for well known communities). |
|
Enable/disable adding set-community to existing community. Choices:
|
|
Delete communities matching community list. Source router.community-list.name. |
|
Maximum duration to suppress a route (1 - 255 min, 0 = unset). |
|
Reachability half-life time for the penalty (1 - 45 min, 0 = unset). |
|
Value to start reusing a route (1 - 20000, 0 = unset). |
|
Value to start suppressing a route (1 - 20000, 0 = unset). |
|
Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset). |
|
Route Target extended community. |
|
AA:NN. |
|
Site-of-Origin extended community. |
|
Community (format = AA:NN). |
|
BGP flags value (0 - 65535) |
|
IPv6 global address of next hop. |
|
IPv6 local address of next hop. |
|
IP address of next hop. |
|
IP address of preferred source. |
|
BGP local preference path attribute. |
|
Metric value. |
|
Metric type. Choices:
|
|
BGP origin code. Choices:
|
|
BGP originator ID attribute. |
|
Priority for routing table. |
|
Route tag for routing table. |
|
Tag value. |
|
IP address of VPNv4 next-hop. |
|
IPv6 global address of VPNv6 next-hop. |
|
IPv6 link-local address of VPNv6 next-hop. |
|
BGP weight for routing table. |
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure route maps.
fortinet.fortios.fortios_router_route_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_route_map:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
id: "7"
match_as_path: "<your_own_value> (source router.aspath-list.name)"
match_community: "<your_own_value> (source router.community-list.name)"
match_community_exact: "enable"
match_extcommunity: "<your_own_value> (source router.extcommunity-list.name)"
match_extcommunity_exact: "enable"
match_flags: "32767"
match_interface: "<your_own_value> (source system.interface.name)"
match_ip_address: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
match_ip_nexthop: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
match_ip6_nexthop: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
match_metric: ""
match_origin: "none"
match_route_type: "external-type1"
match_tag: ""
match_vrf: ""
set_aggregator_as: "0"
set_aggregator_ip: "<your_own_value>"
set_aspath:
-
as: "<your_own_value>"
set_aspath_action: "prepend"
set_atomic_aggregate: "enable"
set_community:
-
community: "<your_own_value>"
set_community_additive: "enable"
set_community_delete: "<your_own_value> (source router.community-list.name)"
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_rt:
-
community: "<your_own_value>"
set_extcommunity_soo:
-
community: "<your_own_value>"
set_flags: "32767"
set_ip_nexthop: "<your_own_value>"
set_ip_prefsrc: "<your_own_value>"
set_ip6_nexthop: "<your_own_value>"
set_ip6_nexthop_local: "<your_own_value>"
set_local_preference: ""
set_metric: ""
set_metric_type: "external-type1"
set_origin: "none"
set_originator_id: "<your_own_value>"
set_priority: ""
set_route_tag: ""
set_tag: ""
set_vpnv4_nexthop: "<your_own_value>"
set_vpnv6_nexthop: "<your_own_value>"
set_vpnv6_nexthop_local: "<your_own_value>"
set_weight: ""
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |