fortiswitch_router_route_map – Route map configuration in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch 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 v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_router_route_map | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- router_route_map - Route map configuration. type: dict
- comments - Description/comments. type: str
- name - Name. type: str required: true
- protocol - Route-map type. type: str choices: ospf, ospf6, rip, bgp, isis, zebra, ripng, isis6
- rule - Rule. type: list
- action - Action. type: str choices: permit, deny
- id - Rule id. type: int
- match_as_path - Match BGP AS path list. type: str
- match_community - Match BGP community list. type: str
- match_community_exact - Do exact matching of communities. type: str choices: enable, disable
- match_flags - Match-flags. type: int
- match_interface - Match interface configuration. type: str
- match_ip6_address - Match ipv6 address permitted by access-list6 or prefix-list6. type: str
- match_ip_address - Match ip address permitted by access-list or prefix-list. type: str
- match_ip_nexthop - Match next hop ip address passed by access-list or prefix-list. type: str
- match_metric - Match metric for redistribute routes. type: int
- match_origin - Match BGP origin code. type: str choices: none, egp, igp, incomplete
- match_route_type - Match route type. type: str choices: 1, 2
- match_tag - Match tag. type: int
- set_aggregator_as - Set BGP aggregator AS. type: int
- set_aggregator_ip - Set BGP aggregator IP. type: str
- set_aspath - Prepend BGP AS path attribute. type: list
- as - AS number, value range from 0 to 4294967295 type: str
- set_atomic_aggregate - BGP atomic aggregate attribute. type: str choices: enable, disable
- set_community - Set BGP community attribute. type: list
- community - AA|AA:NN|internet|local-AS|no-advertise|no-export. type: str
- set_community_additive - Add set-community to existing community. type: str choices: enable, disable
- set_community_delete - Delete communities matching community list. type: str
- set_extcommunity_rt - Set Route Target extended community. type: list
- community - AA:NN. type: str
- set_extcommunity_soo - Set Site-of-Origin extended community. type: list
- community - AA:NN. type: str
- set_flags - Set-flags. type: int
- set_ip6_nexthop - Set ipv6 global address of next hop. type: str
- set_ip6_nexthop_local - Set ipv6 local address of next hop. type: str
- set_ip_nexthop - Set ip address of next hop. type: str
- set_local_preference - Set BGP local preference path attribute. type: int
- set_metric - Set the metric value. type: int
- set_metric_type - Set the metric type. type: str choices: 1, 2
- set_origin - Set BGP origin code. type: str choices: none, egp, igp, incomplete
- set_originator_id - Set BGP originator ID attribute. type: str
- set_tag - Set the tag value. type: int
- set_weight - Set BGP weight for routing table. type: int
Examples
- name: Route map configuration.
fortinet.fortiswitch.fortiswitch_router_route_map:
state: "present"
router_route_map:
comments: "<your_own_value>"
name: "default_name_4"
protocol: "ospf"
rule:
-
action: "permit"
id: "8"
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: "12"
match_interface: "<your_own_value> (source system.interface.name)"
match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.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_metric: "17"
match_origin: "none"
match_route_type: "1"
match_tag: "20"
set_aggregator_as: "21"
set_aggregator_ip: "<your_own_value>"
set_aspath:
-
as: "<your_own_value>"
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_extcommunity_rt:
-
community: "<your_own_value>"
set_extcommunity_soo:
-
community: "<your_own_value>"
set_flags: "34"
set_ip6_nexthop: "<your_own_value>"
set_ip6_nexthop_local: "<your_own_value>"
set_ip_nexthop: "<your_own_value>"
set_local_preference: "38"
set_metric: "39"
set_metric_type: "1"
set_origin: "none"
set_originator_id: "<your_own_value>"
set_tag: "43"
set_weight: "44"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.