source: | fortios_system_vne_tunnel.py |
---|---|
orphan: |
fortios_system_vne_tunnel -- Configure virtual network enabler tunnel in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_system_vne_tunnel | v6.4.0 -> latest |
- 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
- system_vne_tunnel - Configure virtual network enabler tunnel. type: dict
more...
Supported Version Ranges system_vne_tunnel v6.4.0 -> latest
- auto_asic_offload - Enable/disable tunnel ASIC offloading. type: str choices: enable, disable
more...
Supported Version Ranges auto_asic_offload v6.4.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- bmr_hostname - BMR hostname. type: str
more...
Supported Version Ranges bmr_hostname v6.4.0 -> latest
- br - IPv6 address or FQDN of the border relay. type: str
more...
Supported Version Ranges br v6.4.0 -> latest
- http_password - HTTP authentication password. type: str
more...
Supported Version Ranges http_password v7.2.0 -> latest
- http_username - HTTP authentication user name. type: str
more...
Supported Version Ranges http_username v7.2.0 -> latest
- interface - Interface name. Source system.interface.name. type: str
more...
Supported Version Ranges interface v6.4.0 -> latest
- ipv4_address - Tunnel IPv4 address and netmask. type: str
more...
Supported Version Ranges ipv4_address v6.4.0 -> latest
- mode - VNE tunnel mode. type: str choices: map-e, fixed-ip, ds-lite
more...
Supported Version Ranges mode v6.4.0 -> latest
[map-e] v6.0.0 -> latest
[fixed-ip] v6.0.0 -> latest
[ds-lite] v7.2.0 -> latest
- ssl_certificate - Name of local certificate for SSL connections. Source certificate.local.name. type: str
more...
Supported Version Ranges ssl_certificate v6.4.0 -> latest
- status - Enable/disable VNE tunnel. type: str choices: enable, disable
more...
Supported Version Ranges status v6.4.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- update_url - URL of provisioning server. type: str
more...
Supported Version Ranges update_url v6.4.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure virtual network enabler tunnel.
fortinet.fortios.fortios_system_vne_tunnel:
vdom: "{{ vdom }}"
system_vne_tunnel:
auto_asic_offload: "enable"
bmr_hostname: "myhostname"
br: "<your_own_value>"
http_password: "<your_own_value>"
http_username: "<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>"
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
- This module is not guaranteed to have a backwards compatible interface.
- 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.