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

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 static category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• 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 static routing tables.
    fortios_router_static:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      router_static:
        state: "present"
        bfd: "enable"
        blackhole: "enable"
        comment: "Optional comments."
        device: "<your_own_value> (source system.interface.name)"
        distance: "7"
        dst: "<your_own_value>"
        dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
        dynamic-gateway: "enable"
        gateway: "<your_own_value>"
        internet-service: "12 (source firewall.internet-service.id)"
        internet-service-custom: "<your_own_value> (source firewall.internet-service-custom.name)"
        link-monitor-exempt: "enable"
        priority: "15"
        seq-num: "16"
        src: "<your_own_value>"
        status: "enable"
        virtual-wan-link: "enable"
        vrf: "20"
        weight: "21"

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_static:
    default: null
    description:
    - Configure IPv4 static routing tables.
    suboptions:
      bfd:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Bidirectional Forwarding Detection (BFD).
      blackhole:
        choices:
        - enable
        - disable
        description:
        - Enable/disable black hole.
      comment:
        description:
        - Optional comments.
      device:
        description:
        - Gateway out interface or tunnel. Source system.interface.name.
      distance:
        description:
        - Administrative distance (1 - 255).
      dst:
        description:
        - Destination IP and mask for this route.
      dstaddr:
        description:
        - Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name.
      dynamic-gateway:
        choices:
        - enable
        - disable
        description:
        - Enable use of dynamic gateway retrieved from a DHCP or PPP server.
      gateway:
        description:
        - Gateway IP for this route.
      internet-service:
        description:
        - Application ID in the Internet service database. Source firewall.internet-service.id.
      internet-service-custom:
        description:
        - Application name in the Internet service custom database. Source firewall.internet-service-custom.name.
      link-monitor-exempt:
        choices:
        - enable
        - disable
        description:
        - Enable/disable withdrawing this route when link monitor or health check is down.
      priority:
        description:
        - Administrative priority (0 - 4294967295).
      seq-num:
        description:
        - Sequence number.
        required: true
      src:
        description:
        - Source prefix for this route.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this static route.
      virtual-wan-link:
        choices:
        - enable
        - disable
        description:
        - Enable/disable egress through the virtual-wan-link.
      vrf:
        description:
        - Virtual Routing Forwarding ID.
      weight:
        description:
        - Administrative weight (0 - 255).

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