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

Note

This module is part of the fortinet.fortios collection (version 2.3.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.fortios. You need further requirements to be able to use this module, see Requirements for details.

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

New in fortinet.fortios 2.0.0

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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

router_policy

dictionary

Configure IPv4 routing policies.

action

string

Action of the policy route.

Choices:

  • "deny"

  • "permit"

comments

string

Optional comments.

dst

list / elements=dictionary

Destination IP and mask (x.x.x.x/x).

subnet

string / required

IP and mask.

dst_negate

string

Enable/disable negating destination address match.

Choices:

  • "enable"

  • "disable"

dstaddr

list / elements=dictionary

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=dictionary

Incoming interface name.

name

string / required

Interface name. Source system.interface.name.

input_device_negate

string

Enable/disable negation of input device match.

Choices:

  • "enable"

  • "disable"

internet_service_custom

list / elements=dictionary

Custom Destination Internet Service name.

name

string / required

Custom Destination Internet Service name. Source firewall.internet-service-custom.name.

internet_service_id

list / elements=dictionary

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 / required

Sequence number(1-65535).

src

list / elements=dictionary

Source IP and mask (x.x.x.x/x).

subnet

string / required

IP and mask.

src_negate

string

Enable/disable negating source address match.

Choices:

  • "enable"

  • "disable"

srcaddr

list / elements=dictionary

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

Enable/disable this policy route.

Choices:

  • "enable"

  • "disable"

tos

string

Type of service bit pattern.

tos_mask

string

Type of service evaluated bits.

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

vdom

string

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.

Default: "root"

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: "65535"
        end_source_port: "65535"
        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: "0"
        seq_num: "0"
        src:
         -
            subnet: "<your_own_value>"
        src_negate: "enable"
        srcaddr:
         -
            name: "default_name_27 (source firewall.address.name firewall.addrgrp.name)"
        start_port: "0"
        start_source_port: "0"
        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

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

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)