fortinet.fortios.fortios_system_vxlan – Configure VXLAN devices in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_system_vxlan
.
New in version 2.9: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
state
string /
required
|
|
Indicates whether to create or remove the object.
|
||
system_vxlan
dictionary
|
Configure VXLAN devices.
|
|||
dstport
integer
|
VXLAN destination port (1 - 65535).
|
|||
interface
string
|
Outgoing interface for VXLAN encapsulated traffic. Source system.interface.name.
|
|||
ip_version
string
|
|
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
|
||
multicast_ttl
integer
|
VXLAN multicast TTL (1-255).
|
|||
name
string /
required
|
VXLAN device or interface name. Must be a unique interface name.
|
|||
remote_ip
list /
elements=string
|
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN.
|
|||
ip
string /
required
|
IPv4 address.
|
|||
remote_ip6
list /
elements=string
|
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN.
|
|||
ip6
string /
required
|
IPv6 address.
|
|||
vni
integer
|
VXLAN network ID.
|
|||
vdom
string
|
Default:
"root"
|
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.
|
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 VXLAN devices. fortios_system_vxlan: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" system_vxlan: dstport: "3" interface: "<your_own_value> (source system.interface.name)" ip_version: "ipv4-unicast" multicast_ttl: "6" name: "default_name_7" remote_ip: - ip: "<your_own_value>" remote_ip6: - ip6: "<your_own_value>" vni: "12"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_vxlan_module.html