ansible.builtin.fortios_system_gre_tunnel (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and gre_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

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"
   ssl_verify: "False"
  tasks:
  - name: Configure GRE tunnel.
    fortios_system_gre_tunnel:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_gre_tunnel:
        checksum_reception: "disable"
        checksum_transmission: "disable"
        dscp_copying: "disable"
        interface: "<your_own_value> (source system.interface.name)"
        ip_version: "4"
        keepalive_failtimes: "8"
        keepalive_interval: "9"
        key_inbound: "10"
        key_outbound: "11"
        local_gw: "<your_own_value>"
        local_gw6: "<your_own_value>"
        name: "default_name_14"
        remote_gw: "<your_own_value>"
        remote_gw6: "<your_own_value>"
        sequence_number_reception: "disable"
        sequence_number_transmission: "disable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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.
    type: str

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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_gre_tunnel:
    default: null
    description:
    - Configure GRE tunnel.
    suboptions:
      checksum_reception:
        choices:
        - disable
        - enable
        description:
        - Enable/disable validating checksums in received GRE packets.
        type: str
      checksum_transmission:
        choices:
        - disable
        - enable
        description:
        - Enable/disable including checksums in transmitted GRE packets.
        type: str
      dscp_copying:
        choices:
        - disable
        - enable
        description:
        - Enable/disable DSCP copying.
        type: str
      interface:
        description:
        - Interface name. Source system.interface.name.
        type: str
      ip_version:
        choices:
        - 4
        - 6
        description:
        - IP version to use for VPN interface.
        type: str
      keepalive_failtimes:
        description:
        - Number of consecutive unreturned keepalive messages before a GRE connection
          is considered down (1 - 255).
        type: int
      keepalive_interval:
        description:
        - Keepalive message interval (0 - 32767, 0 = disabled).
        type: int
      key_inbound:
        description:
        - Require received GRE packets contain this key (0 - 4294967295).
        type: int
      key_outbound:
        description:
        - Include this key in transmitted GRE packets (0 - 4294967295).
        type: int
      local_gw:
        description:
        - IP address of the local gateway.
        type: str
      local_gw6:
        description:
        - IPv6 address of the local gateway.
        type: str
      name:
        description:
        - Tunnel name.
        required: true
        type: str
      remote_gw:
        description:
        - IP address of the remote gateway.
        type: str
      remote_gw6:
        description:
        - IPv6 address of the remote gateway.
        type: str
      sequence_number_reception:
        choices:
        - disable
        - enable
        description:
        - Enable/disable validating sequence numbers in received GRE packets.
        type: str
      sequence_number_transmission:
        choices:
        - disable
        - enable
        description:
        - Enable/disable including of sequence numbers in transmitted GRE packets.
        type: str
    type: dict

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