fmgr_router_routemap_rule – Rule.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`7.2.0`
router_routemap_rule	yes

Parameters ¶

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
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
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
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
adom - The parameter in requested url type: str required: true
route-map - The parameter in requested url type: str required: true
router_routemap_rule - no description type: dict

action - Action. type: str choices: [permit, deny] more...

7.2.0

action True
id - Rule ID. type: int more...

7.2.0

id True
match-as-path - Match BGP AS path list. type: str more...

7.2.0

match-as-path True
match-community - Match BGP community list. type: str more...

7.2.0

match-community True
match-community-exact - Enable/disable exact matching of communities. type: str choices: [disable, enable] more...

7.2.0

match-community-exact True
match-flags - No description for the parameter type: int more...

7.2.0

match-flags True
match-interface - Match interface configuration. type: str more...

7.2.0

match-interface True
match-ip-address - Match IP address permitted by access-list or prefix-list. type: str more...

7.2.0

match-ip-address True
match-ip-nexthop - Match next hop IP address passed by access-list or prefix-list. type: str more...

7.2.0

match-ip-nexthop True
match-ip6-address - Match IPv6 address permitted by access-list6 or prefix-list6. type: str more...

7.2.0

match-ip6-address True
match-ip6-nexthop - Match next hop IPv6 address passed by access-list6 or prefix-list6. type: str more...

7.2.0

match-ip6-nexthop True
match-metric - Match metric for redistribute routes. type: str more...

7.2.0

match-metric True
match-origin - Match BGP origin code. type: str choices: [none, egp, igp, incomplete] more...

7.2.0

match-origin True
match-route-type - Match route type. type: str choices: [1, 2, none, external-type1, external-type2] more...

7.2.0

match-route-type True
match-tag - Match tag. type: str more...

7.2.0

match-tag True
match-vrf - Match VRF ID. type: int more...

7.2.0

match-vrf True
set-aggregator-as - BGP aggregator AS. type: int more...

7.2.0

set-aggregator-as True
set-aggregator-ip - BGP aggregator IP. type: str more...

7.2.0

set-aggregator-ip True
set-aspath - No description for the parameter type: str more...

7.2.0

set-aspath True
set-aspath-action - Specify preferred action of set-aspath. type: str choices: [prepend, replace] more...

7.2.0

set-aspath-action True
set-atomic-aggregate - Enable/disable BGP atomic aggregate attribute. type: str choices: [disable, enable] more...

7.2.0

set-atomic-aggregate True
set-community - No description for the parameter type: str more...

7.2.0

set-community True
set-community-additive - Enable/disable adding set-community to existing community. type: str choices: [disable, enable] more...

7.2.0

set-community-additive True
set-community-delete - Delete communities matching community list. type: str more...

7.2.0

set-community-delete True
set-dampening-max-suppress - Maximum duration to suppress a route (1 - 255 min, 0 = unset). type: int more...

7.2.0

set-dampening-max-suppress True
set-dampening-reachability-half-life - Reachability half-life time for the penalty (1 - 45 min, 0 = unset). type: int more...

7.2.0

set-dampening-reachability-half-life True
set-dampening-reuse - Value to start reusing a route (1 - 20000, 0 = unset). type: int more...

7.2.0

set-dampening-reuse True
set-dampening-suppress - Value to start suppressing a route (1 - 20000, 0 = unset). type: int more...

7.2.0

set-dampening-suppress True
set-dampening-unreachability-half-life - Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset). type: int more...

7.2.0

set-dampening-unreachability-half-life True
set-extcommunity-rt - No description for the parameter type: str more...

7.2.0

set-extcommunity-rt True
set-extcommunity-soo - No description for the parameter type: str more...

7.2.0

set-extcommunity-soo True
set-flags - No description for the parameter type: int more...

7.2.0

set-flags True
set-ip-nexthop - IP address of next hop. type: str more...

7.2.0

set-ip-nexthop True
set-ip6-nexthop - IPv6 global address of next hop. type: str more...

7.2.0

set-ip6-nexthop True
set-ip6-nexthop-local - IPv6 local address of next hop. type: str more...

7.2.0

set-ip6-nexthop-local True
set-local-preference - BGP local preference path attribute. type: str more...

7.2.0

set-local-preference True
set-metric - Metric value. type: str more...

7.2.0

set-metric True
set-metric-type - Metric type. type: str choices: [1, 2, none, external-type1, external-type2] more...

7.2.0

set-metric-type True
set-origin - BGP origin code. type: str choices: [none, egp, igp, incomplete] more...

7.2.0

set-origin True
set-originator-id - BGP originator ID attribute. type: str more...

7.2.0

set-originator-id True
set-priority - Priority for routing table. type: int more...

7.2.0

set-priority True
set-route-tag - Route tag for routing table. type: str more...

7.2.0

set-route-tag True
set-tag - Tag value. type: str more...

7.2.0

set-tag True
set-weight - BGP weight for routing table. type: str more...

7.2.0

set-weight True

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: no description
     fmgr_router_routemap_rule:
        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>
        route-map: <your own value>
        state: <value in [present, absent]>
        router_routemap_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>

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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.