fortinet.fortimanager.fmgr_router_routemap_rule module – Rule.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.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_rule.

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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
route-map string	Deprecated, please use “route_map”
route_map string	The parameter (route-map) in requested url.
router_routemap_rule dictionary	The top level parameters set.
action string	Action. Choices: "permit" "deny"
id integer / required	Rule ID.
match-as-path string	Deprecated, please rename it to match_as_path. Match BGP AS path list.
match-community string	Deprecated, please rename it to match_community. Match BGP community list.
match-community-exact string	Deprecated, please rename it to match_community_exact. Enable/disable exact matching of communities. Choices: "disable" "enable"
match-extcommunity string	Deprecated, please rename it to match_extcommunity. Match BGP extended community list.
match-extcommunity-exact string	Deprecated, please rename it to match_extcommunity_exact. Enable/disable exact matching of extended communities. Choices: "disable" "enable"
match-flags integer	Deprecated, please rename it to match_flags. Match flags.
match-interface string	Deprecated, please rename it to match_interface. Match interface configuration.
match-ip-address string	Deprecated, please rename it to match_ip_address. Match IP address permitted by access-list or prefix-list.
match-ip-nexthop string	Deprecated, please rename it to match_ip_nexthop. Match next hop IP address passed by access-list or prefix-list.
match-ip6-address string	Deprecated, please rename it to match_ip6_address. Match IPv6 address permitted by access-list6 or prefix-list6.
match-ip6-nexthop string	Deprecated, please rename it to match_ip6_nexthop. Match next hop IPv6 address passed by access-list6 or prefix-list6.
match-metric string	Deprecated, please rename it to match_metric. Match metric for redistribute routes.
match-origin string	Deprecated, please rename it to match_origin. Match BGP origin code. Choices: "none" "egp" "igp" "incomplete"
match-route-type string	Deprecated, please rename it to match_route_type. Match route type. Choices: "1" "2" "none" "external-type1" "external-type2"
match-tag string	Deprecated, please rename it to match_tag. Match tag.
match-vrf integer	Deprecated, please rename it to match_vrf. Match VRF ID.
set-aggregator-as integer	Deprecated, please rename it to set_aggregator_as. BGP aggregator AS.
set-aggregator-ip string	Deprecated, please rename it to set_aggregator_ip. BGP aggregator IP.
set-aspath any	(list) Deprecated, please rename it to set_aspath. Prepend BGP AS path attribute.
set-aspath-action string	Deprecated, please rename it to set_aspath_action. Specify preferred action of set-aspath. Choices: "prepend" "replace"
set-atomic-aggregate string	Deprecated, please rename it to set_atomic_aggregate. Enable/disable BGP atomic aggregate attribute. Choices: "disable" "enable"
set-community any	(list) Deprecated, please rename it to set_community. BGP community attribute.
set-community-additive string	Deprecated, please rename it to set_community_additive. Enable/disable adding set-community to existing community. Choices: "disable" "enable"
set-community-delete string	Deprecated, please rename it to set_community_delete. Delete communities matching community list.
set-dampening-max-suppress integer	Deprecated, please rename it to set_dampening_max_suppress. Maximum duration to suppress a route
set-dampening-reachability-half-life integer	Deprecated, please rename it to set_dampening_reachability_half_life. Reachability half-life time for the penalty
set-dampening-reuse integer	Deprecated, please rename it to set_dampening_reuse. Value to start reusing a route
set-dampening-suppress integer	Deprecated, please rename it to set_dampening_suppress. Value to start suppressing a route
set-dampening-unreachability-half-life integer	Deprecated, please rename it to set_dampening_unreachability_half_life. Unreachability Half-life time for the penalty
set-extcommunity-rt any	(list) Deprecated, please rename it to set_extcommunity_rt. Route Target extended community.
set-extcommunity-soo any	(list) Deprecated, please rename it to set_extcommunity_soo. Site-of-Origin extended community.
set-flags integer	Deprecated, please rename it to set_flags. Set flags.
set-ip-nexthop string	Deprecated, please rename it to set_ip_nexthop. IP address of next hop.
set-ip-prefsrc string	Deprecated, please rename it to set_ip_prefsrc. IP address of preferred source.
set-ip6-nexthop string	Deprecated, please rename it to set_ip6_nexthop. IPv6 global address of next hop.
set-ip6-nexthop-local string	Deprecated, please rename it to set_ip6_nexthop_local. IPv6 local address of next hop.
set-local-preference string	Deprecated, please rename it to set_local_preference. BGP local preference path attribute.
set-metric string	Deprecated, please rename it to set_metric. Metric value.
set-metric-type string	Deprecated, please rename it to set_metric_type. Metric type. Choices: "1" "2" "none" "external-type1" "external-type2"
set-origin string	Deprecated, please rename it to set_origin. BGP origin code. Choices: "none" "egp" "igp" "incomplete"
set-originator-id string	Deprecated, please rename it to set_originator_id. BGP originator ID attribute.
set-priority integer	Deprecated, please rename it to set_priority. Priority for routing table.
set-route-tag string	Deprecated, please rename it to set_route_tag. Route tag for routing table.
set-tag string	Deprecated, please rename it to set_tag. Tag value.
set-vpnv4-nexthop string	Deprecated, please rename it to set_vpnv4_nexthop. IP address of VPNv4 next-hop.
set-vpnv6-nexthop string	Deprecated, please rename it to set_vpnv6_nexthop. IPv6 global address of VPNv6 next-hop.
set-vpnv6-nexthop-local string	Deprecated, please rename it to set_vpnv6_nexthop_local. IPv6 link-local address of VPNv6 next-hop.
set-weight string	Deprecated, please rename it to set_weight. BGP weight for routing table.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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: Rule.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        router_routemap_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
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)