Skip to content

Latest commit

 

History

History
347 lines (306 loc) · 15.2 KB

fortios_system_vxlan.rst

File metadata and controls

347 lines (306 loc) · 15.2 KB
Raw
source:fortios_system_vxlan.py
orphan:

fortios_system_vxlan -- Configure VXLAN devices in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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 vxlan 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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_vxlan - Configure VXLAN devices. type: dict more...
    Supported Version Ranges
    system_vxlan v6.0.0 -> 7.4.3
    • dstport - VXLAN destination port (1 - 65535). type: int more...
      Supported Version Ranges
      dstport v6.0.0 -> 7.4.3
    • evpn_id - EVPN instance. Source system.evpn.id. type: int more...
      Supported Version Ranges
      evpn_id v7.4.0 -> 7.4.3
    • interface - Outgoing interface for VXLAN encapsulated traffic. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.0.0 -> 7.4.3
    • ip_version - IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. type: str choices: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast more...
      Supported Version Ranges
      ip_version v6.0.0 -> 7.4.3
      [ipv4-unicast] v6.0.0 -> 7.4.3
      [ipv6-unicast] v6.0.0 -> 7.4.3
      [ipv4-multicast] v6.0.0 -> 7.4.3
      [ipv6-multicast] v6.0.0 -> 7.4.3
    • learn_from_traffic - Enable/disable VXLAN MAC learning from traffic. type: str choices: enable, disable more...
      Supported Version Ranges
      learn_from_traffic v7.4.0 -> 7.4.3
      [enable] v7.4.0 -> 7.4.3
      [disable] v7.4.0 -> 7.4.3
    • multicast_ttl - VXLAN multicast TTL (1-255). type: int more...
      Supported Version Ranges
      multicast_ttl v6.0.0 -> 7.4.3
    • name - VXLAN device or interface name. Must be a unique interface name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> 7.4.3
    • remote_ip - IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. type: list member_path: remote_ip:ip more...
      Supported Version Ranges
      remote_ip v6.0.0 -> 7.4.3
      • ip - IPv4 address. type: str required: true more...
        Supported Version Ranges
        ip v6.0.0 -> 7.4.3
    • remote_ip6 - IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. type: list member_path: remote_ip6:ip6 more...
      Supported Version Ranges
      remote_ip6 v6.0.0 -> 7.4.3
      • ip6 - IPv6 address. type: str required: true more...
        Supported Version Ranges
        ip6 v6.0.0 -> 7.4.3
    • vni - VXLAN network ID. type: int more...
      Supported Version Ranges
      vni v6.0.0 -> 7.4.3

Notes

Note

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

Examples

- name: Configure VXLAN devices.
  fortinet.fortios.fortios_system_vxlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vxlan:
          dstport: "4789"
          evpn_id: "0"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "ipv4-unicast"
          learn_from_traffic: "enable"
          multicast_ttl: "0"
          name: "default_name_9"
          remote_ip:
              -
                  ip: "<your_own_value>"
          remote_ip6:
              -
                  ip6: "<your_own_value>"
          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.