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.8).
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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure IPv4 routing policies. |
|
Action of the policy route. Choices:
|
|
Optional comments. |
|
Destination IP and mask (x.x.x.x/x). |
|
IP and mask. |
|
Enable/disable negating destination address match. Choices:
|
|
Destination address name. |
|
Address/group name. Source firewall.address.name firewall.addrgrp.name. |
|
End destination port number (0 - 65535). |
|
End source port number (0 - 65535). |
|
IP address of the gateway. |
|
Incoming interface name. |
|
Interface name. Source system.interface.name. |
|
Enable/disable negation of input device match. Choices:
|
|
Custom Destination Internet Service name. |
|
Custom Destination Internet Service name. Source firewall.internet-service-custom.name. |
|
Destination Internet Service ID. |
|
Destination Internet Service ID. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
Outgoing interface name. Source system.interface.name. |
|
Protocol number (0 - 255). |
|
Sequence number(1-65535). see <a href=’#notes’>Notes</a>. |
|
Source IP and mask (x.x.x.x/x). |
|
IP and mask. |
|
Enable/disable negating source address match. Choices:
|
|
Source address name. |
|
Address/group name. Source firewall.address.name firewall.addrgrp.name. |
|
Start destination port number (0 - 65535). |
|
Start source port number (0 - 65535). |
|
Enable/disable this policy route. Choices:
|
|
Type of service bit pattern. |
|
Type of service evaluated bits. |
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
We highly recommend using your own value as the seq_num instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure IPv4 routing policies.
fortinet.fortios.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: "<you_own_value>"
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 number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |