Skip to content

Latest commit

 

History

History
310 lines (265 loc) · 12 KB

fortios_system_evpn.rst

File metadata and controls

310 lines (265 loc) · 12 KB
Raw
source:fortios_system_evpn.py
orphan:

fortios_system_evpn -- Configure EVPN instance 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 evpn 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.9

Tips

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

FortiOS Version Compatibility


v7.4.0
fortios_system_evpn yes

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_evpn - Configure EVPN instance. type: dict more...
    v7.4.0
    system_evpn yes
    • arp_suppression - Enable/disable ARP suppression. type: str choices: enable, disable more...
      v7.4.0
      arp_suppression yes
      [enable] yes
      [disable] yes
    • export_rt - List of export route targets. type: list member_path: export_rt:route_target more...
      v7.4.0
      export_rt yes
      • route_target - Route target: AA|AA:NN. type: str required: true more...
        v7.4.0
        route_target yes
    • id - ID. type: int required: true more...
      v7.4.0
      id yes
    • import_rt - List of import route targets. type: list member_path: import_rt:route_target more...
      v7.4.0
      import_rt yes
      • route_target - Route target: AA|AA:NN. type: str required: true more...
        v7.4.0
        route_target yes
    • ip_local_learning - Enable/disable IP address local learning. type: str choices: enable, disable more...
      v7.4.0
      ip_local_learning yes
      [enable] yes
      [disable] yes
    • rd - Route Distinguisher: AA|AA:NN|A.B.C.D:NN. type: str more...
      v7.4.0
      rd yes

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure EVPN instance.
    fortios_system_evpn:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_evpn:
        arp_suppression: "enable"
        export_rt:
         -
            route_target: "<your_own_value>"
        id:  "6"
        import_rt:
         -
            route_target: "<your_own_value>"
        ip_local_learning: "enable"
        rd: "<your_own_value>"

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.