fortios_router_route_map – Configure route maps in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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.9.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_router_route_map | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- router_route_map - Configure route maps. type: dict more...
- comments - Optional comments. type: str more...
- name - Name. type: str required: True more...
- rule - Rule. type: list more...
- action - Action. type: str choices: permit, deny more...
- id - Rule ID. type: int required: True more...
- match_as_path - Match BGP AS path list. Source router.aspath-list.name. type: str more...
- match_community - Match BGP community list. Source router.community-list.name. type: str more...
- match_community_exact - Enable/disable exact matching of communities. type: str choices: enable, disable more...
- match_flags - BGP flag value to match (0 - 65535) type: int more...
- match_interface - Match interface configuration. Source system.interface.name. type: str more...
- match_ip_address - Match IP address permitted by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. type: str more...
- match_ip_nexthop - Match next hop IP address passed by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. type: str more...
- match_ip6_address - Match IPv6 address permitted by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. type: str more...
- match_ip6_nexthop - Match next hop IPv6 address passed by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. type: str more...
- match_metric - Match metric for redistribute routes. type: int more...
- match_origin - Match BGP origin code. type: str choices: none, egp, igp, incomplete more...
- match_route_type - Match route type. type: str choices: 1, 2, none, external-type1, external-type2 more...
- match_tag - Match tag. type: int more...
- match_vrf - Match VRF ID. type: int more...
- set_aggregator_as - BGP aggregator AS. type: int more...
- set_aggregator_ip - BGP aggregator IP. type: str more...
- set_aspath - Prepend BGP AS path attribute. type: list more...
- as - AS number (0 - 42949672). NOTE: Use quotes for repeating numbers, e.g.: "1 1 2" type: str required: True more...
- set_aspath_action - Specify preferred action of set-aspath. type: str choices: prepend, replace more...
- set_atomic_aggregate - Enable/disable BGP atomic aggregate attribute. type: str choices: enable, disable more...
- set_community - BGP community attribute. type: list more...
- community - Attribute: AA|AA:NN|internet|local-AS|no-advertise|no-export. type: str required: True more...
- set_community_additive - Enable/disable adding set-community to existing community. type: str choices: enable, disable more...
- set_community_delete - Delete communities matching community list. Source router.community-list.name. type: str more...
- set_dampening_max_suppress - Maximum duration to suppress a route (1 - 255 min, 0 = unset). type: int more...
- set_dampening_reachability_half_life - Reachability half-life time for the penalty (1 - 45 min, 0 = unset). type: int more...
- set_dampening_reuse - Value to start reusing a route (1 - 20000, 0 = unset). type: int more...
- set_dampening_suppress - Value to start suppressing a route (1 - 20000, 0 = unset). type: int more...
- set_dampening_unreachability_half_life - Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset) type: int more...
- set_extcommunity_rt - Route Target extended community. type: list more...
- community - AA:NN. type: str required: True more...
- set_extcommunity_soo - Site-of-Origin extended community. type: list more...
- community - AA:NN type: str required: True more...
- set_flags - BGP flags value (0 - 65535) type: int more...
- set_ip_nexthop - IP address of next hop. type: str more...
- set_ip6_nexthop - IPv6 global address of next hop. type: str more...
- set_ip6_nexthop_local - IPv6 local address of next hop. type: str more...
- set_local_preference - BGP local preference path attribute. type: int more...
- set_metric - Metric value. type: int more...
- set_metric_type - Metric type. type: str choices: 1, 2, none, external-type1, external-type2 more...
- set_origin - BGP origin code. type: str choices: none, egp, igp, incomplete more...
- set_originator_id - BGP originator ID attribute. type: str more...
- set_route_tag - Route tag for routing table. type: int more...
- set_tag - Tag value. type: int more...
- set_weight - BGP weight for routing table. type: int more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure route maps.
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_flags: "11"
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: "17"
match_origin: "none"
match_route_type: "1"
match_tag: "20"
match_vrf: "21"
set_aggregator_as: "22"
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: "32"
set_dampening_reachability_half_life: "33"
set_dampening_reuse: "34"
set_dampening_suppress: "35"
set_dampening_unreachability_half_life: "36"
set_extcommunity_rt:
-
community: "<your_own_value>"
set_extcommunity_soo:
-
community: "<your_own_value>"
set_flags: "41"
set_ip_nexthop: "<your_own_value>"
set_ip6_nexthop: "<your_own_value>"
set_ip6_nexthop_local: "<your_own_value>"
set_local_preference: "45"
set_metric: "46"
set_metric_type: "1"
set_origin: "none"
set_originator_id: "<your_own_value>"
set_route_tag: "50"
set_tag: "51"
set_weight: "52"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3