Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_router_policy_module.html

fortinet.fortios.fortios_router_policy – Configure IPv4 routing policies in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_router_policy.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
router_policy
dictionary
Configure IPv4 routing policies.
action
string
    Choices:
  • deny
  • permit
Action of the policy route.
comments
string
Optional comments.
dst
list / elements=string
Destination IP and mask (x.x.x.x/x).
subnet
string / required
IP and mask.
dst_negate
string
    Choices:
  • enable
  • disable
Enable/disable negating destination address match.
dstaddr
list / elements=string
Destination address name.
name
string / required
Address/group name. Source firewall.address.name firewall.addrgrp.name.
end_port
integer
End destination port number (0 - 65535).
end_source_port
integer
End source port number (0 - 65535).
gateway
string
IP address of the gateway.
input_device
list / elements=string
Incoming interface name.
name
string / required
Interface name. Source system.interface.name.
input_device_negate
string
    Choices:
  • enable
  • disable
Enable/disable negation of input device match.
internet_service_custom
list / elements=string
Custom Destination Internet Service name.
name
string / required
Custom Destination Internet Service name. Source firewall.internet-service-custom.name.
internet_service_id
list / elements=string
Destination Internet Service ID.
id
integer / required
Destination Internet Service ID. Source firewall.internet-service.id.
output_device
string
Outgoing interface name. Source system.interface.name.
protocol
integer
Protocol number (0 - 255).
seq_num
integer
Sequence number.
src
list / elements=string
Source IP and mask (x.x.x.x/x).
subnet
string / required
IP and mask.
src_negate
string
    Choices:
  • enable
  • disable
Enable/disable negating source address match.
srcaddr
list / elements=string
Source address name.
name
string / required
Address/group name. Source firewall.address.name firewall.addrgrp.name.
start_port
integer
Start destination port number (0 - 65535).
start_source_port
integer
Start source port number (0 - 65535).
status
string
    Choices:
  • enable
  • disable
Enable/disable this policy route.
tos
string
Type of service bit pattern.
tos_mask
string
Type of service evaluated bits.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv4 routing policies.
    fortios_router_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_policy:
        action: "deny"
        comments: "<your_own_value>"
        dst:
         -
            subnet: "<your_own_value>"
        dst_negate: "enable"
        dstaddr:
         -
            name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
        end_port: "10"
        end_source_port: "11"
        gateway: "<your_own_value>"
        input_device:
         -
            name: "default_name_14 (source system.interface.name)"
        input_device_negate: "enable"
        internet_service_custom:
         -
            name: "default_name_17 (source firewall.internet-service-custom.name)"
        internet_service_id:
         -
            id:  "19 (source firewall.internet-service.id)"
        output_device: "<your_own_value> (source system.interface.name)"
        protocol: "21"
        seq_num: "22"
        src:
         -
            subnet: "<your_own_value>"
        src_negate: "enable"
        srcaddr:
         -
            name: "default_name_27 (source firewall.address.name firewall.addrgrp.name)"
        start_port: "28"
        start_source_port: "29"
        status: "enable"
        tos: "<your_own_value>"
        tos_mask: "<your_own_value>"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_router_policy_module.html