fmgr_router_routemap – Configure route maps.¶
New in version 2.1.6.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| False | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| False | False | False | False | False | False | False | False | False | False | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
| False | False | False | False | False | False | False | False | False | False | False | False |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
| False | False | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| True | True | True | |||||||||
7.4.0 |
|||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- router_routemap - Configure route maps. type: dict
- comments - Optional comments. type: str more...
- name - Name. type: str more...
- rule - No description for the parameter type: array
more...
- action - Action. type: str choices: [permit, deny] more...
- id - Rule ID. type: int more...
- match-as-path - Match BGP AS path list. type: str more...
- match-community - Match BGP community list. type: str more...
- match-community-exact - Enable/disable exact matching of communities. type: str choices: [disable, enable] more...
- match-flags - No description for the parameter type: int more...
- match-interface - Match interface configuration. type: str more...
- match-ip-address - Match IP address permitted by access-list or prefix-list. type: str more...
- match-ip-nexthop - Match next hop IP address passed by access-list or prefix-list. type: str more...
- match-ip6-address - Match IPv6 address permitted by access-list6 or prefix-list6. type: str more...
- match-ip6-nexthop - Match next hop IPv6 address passed by access-list6 or prefix-list6. type: str more...
- match-metric - Match metric for redistribute routes. type: str 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: str 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 - No description for the parameter type: str 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: [disable, enable] more...
- set-community - No description for the parameter type: str more...
- set-community-additive - Enable/disable adding set-community to existing community. type: str choices: [disable, enable] more...
- set-community-delete - Delete communities matching community list. 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 - No description for the parameter type: str more...
- set-extcommunity-soo - No description for the parameter type: str more...
- set-flags - No description for the parameter 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: str more...
- set-metric - Metric value. type: str 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-priority - Priority for routing table. type: int more...
- set-route-tag - Route tag for routing table. type: str more...
- set-tag - Tag value. type: str more...
- set-weight - BGP weight for routing table. type: str more...
- match-extcommunity - Match BGP extended community list. type: str more...
- match-extcommunity-exact - Enable/disable exact matching of extended communities. type: str choices: [disable, enable] more...
- set-ip-prefsrc - IP address of preferred source. type: str more...
Notes¶
Note
- 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure route maps.
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: <value in [present, absent]>
router_routemap:
comments: <value of string>
name: <value of string>
rule:
-
action: <value in [permit, deny]>
id: <value of integer>
match-as-path: <value of string>
match-community: <value of string>
match-community-exact: <value in [disable, enable]>
match-flags: <value of integer>
match-interface: <value of string>
match-ip-address: <value of string>
match-ip-nexthop: <value of string>
match-ip6-address: <value of string>
match-ip6-nexthop: <value of string>
match-metric: <value of string>
match-origin: <value in [none, egp, igp, ...]>
match-route-type: <value in [1, 2, none, ...]>
match-tag: <value of string>
match-vrf: <value of integer>
set-aggregator-as: <value of integer>
set-aggregator-ip: <value of string>
set-aspath: <value of string>
set-aspath-action: <value in [prepend, replace]>
set-atomic-aggregate: <value in [disable, enable]>
set-community: <value of string>
set-community-additive: <value in [disable, enable]>
set-community-delete: <value of string>
set-dampening-max-suppress: <value of integer>
set-dampening-reachability-half-life: <value of integer>
set-dampening-reuse: <value of integer>
set-dampening-suppress: <value of integer>
set-dampening-unreachability-half-life: <value of integer>
set-extcommunity-rt: <value of string>
set-extcommunity-soo: <value of string>
set-flags: <value of integer>
set-ip-nexthop: <value of string>
set-ip6-nexthop: <value of string>
set-ip6-nexthop-local: <value of string>
set-local-preference: <value of string>
set-metric: <value of string>
set-metric-type: <value in [1, 2, none, ...]>
set-origin: <value in [none, egp, igp, ...]>
set-originator-id: <value of string>
set-priority: <value of integer>
set-route-tag: <value of string>
set-tag: <value of string>
set-weight: <value of string>
match-extcommunity: <value of string>
match-extcommunity-exact: <value in [disable, enable]>
set-ip-prefsrc: <value of string>
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0