fortios_system_vne_tunnel – Configure virtual network enabler tunnel in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vne_tunnel 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.0
FortiOS Version Compatibility¶
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_system_vne_tunnel | yes | yes | yes | 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
- system_vne_tunnel - Configure virtual network enabler tunnel. type: dict more...
- auto_asic_offload - Enable/disable tunnel ASIC offloading. type: str choices: enable, disable more...
- bmr_hostname - BMR hostname. type: str more...
- br - Border relay IPv6 address. type: str more...
- interface - Interface name. Source system.interface.name. type: str more...
- ipv4_address - Tunnel IPv4 address and netmask. type: str more...
- mode - VNE tunnel mode. type: str choices: map-e, fixed-ip more...
- ssl_certificate - Name of local certificate for SSL connections. Source certificate.local.name. type: str more...
- status - Enable/disable VNE tunnel. type: str choices: enable, disable more...
- update_url - URL of provisioning server. type: str more...
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 virtual network enabler tunnel.
fortios_system_vne_tunnel:
vdom: "{{ vdom }}"
system_vne_tunnel:
auto_asic_offload: "enable"
bmr_hostname: "<your_own_value>"
br: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
ipv4_address: "<your_own_value>"
mode: "map-e"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
status: "enable"
update_url: "<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