fortios_system_geneve – Configure GENEVE devices in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and geneve 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_geneve v6.2.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_geneve - Configure GENEVE devices. type: dict more...
    • dstport - GENEVE destination port (1 - 65535). type: int more...
    • interface - Outgoing interface for GENEVE encapsulated traffic. Source system.interface.name. type: str more...
    • ip_version - IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. type: str choices: ipv4-unicast, ipv6-unicast more...
    • name - GENEVE device or interface name. Must be an unique interface name. type: str required: true more...
    • remote_ip - IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE. type: str more...
    • remote_ip6 - IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE. type: str more...
    • type - GENEVE type. type: str choices: ethernet, ppp more...
    • vni - GENEVE network ID. type: int more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure GENEVE devices.
  fortinet.fortios.fortios_system_geneve:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_geneve:
          dstport: "6081"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "ipv4-unicast"
          name: "default_name_6"
          remote_ip: "<your_own_value>"
          remote_ip6: "<your_own_value>"
          type: "ethernet"
          vni: "0"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.