ansible.builtin.fortios_router_policy (v2.8.20) — module

Configure IPv4 routing policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS 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.2


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv4 routing policies.
    fortios_router_policy:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      router_policy:
        state: "present"
        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>"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - 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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

router_policy:
    default: null
    description:
    - Configure IPv4 routing policies.
    suboptions:
      action:
        choices:
        - deny
        - permit
        description:
        - Action of the policy route.
      comments:
        description:
        - Optional comments.
      dst:
        description:
        - Destination IP and mask (x.x.x.x/x).
        suboptions:
          subnet:
            description:
            - IP and mask.
            required: true
      dst-negate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable negating destination address match.
      dstaddr:
        description:
        - Destination address name.
        suboptions:
          name:
            description:
            - Address/group name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      end-port:
        description:
        - End destination port number (0 - 65535).
      end-source-port:
        description:
        - End source port number (0 - 65535).
      gateway:
        description:
        - IP address of the gateway.
      input-device:
        description:
        - Incoming interface name.
        suboptions:
          name:
            description:
            - Interface name. Source system.interface.name.
            required: true
      output-device:
        description:
        - Outgoing interface name. Source system.interface.name.
      protocol:
        description:
        - Protocol number (0 - 255).
      seq-num:
        description:
        - Sequence number.
        required: true
      src:
        description:
        - Source IP and mask (x.x.x.x/x).
        suboptions:
          subnet:
            description:
            - IP and mask.
            required: true
      src-negate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable negating source address match.
      srcaddr:
        description:
        - Source address name.
        suboptions:
          name:
            description:
            - Address/group name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      start-port:
        description:
        - Start destination port number (0 - 65535).
      start-source-port:
        description:
        - Start source port number (0 - 65535).
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy route.
      tos:
        description:
        - Type of service bit pattern.
      tos-mask:
        description:
        - Type of service evaluated bits.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str