New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
||
switch_controller_global
-
|
Default: null
|
Configure FortiSwitch global settings.
|
||
allow-multiple-interfaces
-
|
|
Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate.
|
||
default-virtual-switch-vlan
-
|
Default VLAN for ports when added to the virtual-switch. Source system.interface.name.
|
|||
disable-discovery
-
|
Prevent this FortiSwitch from discovering.
|
|||
name
-
/ required
|
Managed device ID.
|
|||
https-image-push
-
|
|
Enable/disable image push to FortiSwitch using HTTPS.
|
||
log-mac-limit-violations
-
|
|
Enable/disable logs for Learning Limit Violations.
|
||
mac-aging-interval
-
|
Time after which an inactive MAC is aged out (10 - 1000000 sec, default = 300, 0 = disable).
|
|||
mac-retention-period
-
|
Time in hours after which an inactive MAC is removed from client DB.
|
|||
mac-violation-timer
-
|
Set timeout for Learning Limit Violations (0 = disabled).
|
|||
username
-
/ required
|
FortiOS or FortiGate username.
|
|||
vdom
-
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure FortiSwitch global settings.
fortios_switch_controller_global:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
switch_controller_global:
allow-multiple-interfaces: "enable"
default-virtual-switch-vlan: "<your_own_value> (source system.interface.name)"
disable-discovery:
-
name: "default_name_6"
https-image-push: "enable"
log-mac-limit-violations: "enable"
mac-aging-interval: "9"
mac-retention-period: "10"
mac-violation-timer: "11"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.