fortinet.fortimanager.fmgr_router_routemap module – Configure route maps.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_router_routemap.
New in fortinet.fortimanager 2.1.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Optional comments. |
|
Name. |
|
Rule. |
|
Action. Choices:
|
|
Rule ID. |
|
Match BGP AS path list. |
|
Match BGP community list. |
|
Enable/disable exact matching of communities. Choices:
|
|
Match BGP extended community list. |
|
Enable/disable exact matching of extended communities. Choices:
|
|
Match flags. |
|
Match interface configuration. |
|
Match IPv6 address permitted by access-list6 or prefix-list6. |
|
Match next hop IPv6 address passed by access-list6 or prefix-list6. |
|
Match IP address permitted by access-list or prefix-list. |
|
Match next hop IP address passed by access-list or prefix-list. |
|
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. |
|
(list) Prepend BGP AS path attribute. |
|
Specify preferred action of set-aspath. Choices:
|
|
Enable/disable BGP atomic aggregate attribute. Choices:
|
|
(list) BGP community attribute. |
|
Enable/disable adding set-community to existing community. Choices:
|
|
Delete communities matching community list. |
|
Maximum duration to suppress a route |
|
Reachability half-life time for the penalty |
|
Value to start reusing a route |
|
Value to start suppressing a route |
|
Unreachability Half-life time for the penalty |
|
(list) Route Target extended community. |
|
(list) Site-of-Origin extended community. |
|
Set flags. |
|
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. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure route maps.
fortinet.fortimanager.fmgr_router_routemap:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
router_routemap:
comments: <string>
name: <string>
rule:
-
action: <value in [permit, deny]>
id: <integer>
match_as_path: <string>
match_community: <string>
match_community_exact: <value in [disable, enable]>
match_flags: <integer>
match_interface: <string>
match_ip_address: <string>
match_ip_nexthop: <string>
match_ip6_address: <string>
match_ip6_nexthop: <string>
match_metric: <string>
match_origin: <value in [none, egp, igp, ...]>
match_route_type: <value in [1, 2, none, ...]>
match_tag: <string>
match_vrf: <integer>
set_aggregator_as: <integer>
set_aggregator_ip: <string>
set_aspath: <list or string>
set_aspath_action: <value in [prepend, replace]>
set_atomic_aggregate: <value in [disable, enable]>
set_community: <list or string>
set_community_additive: <value in [disable, enable]>
set_community_delete: <string>
set_dampening_max_suppress: <integer>
set_dampening_reachability_half_life: <integer>
set_dampening_reuse: <integer>
set_dampening_suppress: <integer>
set_dampening_unreachability_half_life: <integer>
set_extcommunity_rt: <list or string>
set_extcommunity_soo: <list or string>
set_flags: <integer>
set_ip_nexthop: <string>
set_ip6_nexthop: <string>
set_ip6_nexthop_local: <string>
set_local_preference: <string>
set_metric: <string>
set_metric_type: <value in [1, 2, none, ...]>
set_origin: <value in [none, egp, igp, ...]>
set_originator_id: <string>
set_priority: <integer>
set_route_tag: <string>
set_tag: <string>
set_weight: <string>
match_extcommunity: <string>
match_extcommunity_exact: <value in [disable, enable]>
set_ip_prefsrc: <string>
set_vpnv4_nexthop: <string>
set_vpnv6_nexthop: <string>
set_vpnv6_nexthop_local: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |