fortios_router_policy – Configure IPv4 routing policies in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_router_policy – Configure IPv4 routing policies in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
router_policy dictionary | Default: null | Configure IPv4 routing policies.
| action string | Choices: deny permit | Action of the policy route.
| comments string |  | Optional comments.
| dst list |  | 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 |  | 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 |  | Incoming interface name.
|  | name string / required |  | Interface name. Source system.interface.name.
| output_device string |  | Outgoing interface name. Source system.interface.name.
| protocol integer |  | Protocol number (0 - 255).
| seq_num integer |  | Sequence number.
| src list |  | 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 |  | 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).
| state string | Choices: present absent | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
| 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.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9 | Choices: present absent | Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
username string |  | FortiOS or FortiGate username.
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

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure IPv4 routing policies.
        fortios_router_policy:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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)"
            output_device: "<your_own_value> (source system.interface.name)"
            protocol: "16"
            seq_num: "17"
            src:
             -
                subnet: "<your_own_value>"
            src_negate: "enable"
            srcaddr:
             -
                name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
            start_port: "23"
            start_source_port: "24"
            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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.