fortios_switch_controller_global – Configure FortiSwitch global settings in Fortinet’s FortiOS and FortiGate
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| host
string
|
FortiOS or FortiGate IP address.
|
|||
| https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol.
|
||
| password
string
|
Default:
""
|
FortiOS or FortiGate password.
|
||
| ssl_verify
boolean
added in 2.9
|
|
Ensures FortiGate certificate must be verified by a proper CA.
|
||
| switch_controller_global
dictionary
|
Default:
null
|
Configure FortiSwitch global settings.
|
||
| allow_multiple_interfaces
string
|
|
Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate.
|
||
| default_virtual_switch_vlan
string
|
Default VLAN for ports when added to the virtual-switch. Source system.interface.name.
|
|||
| disable_discovery
list
|
Prevent this FortiSwitch from discovering.
|
|||
| name
string / required
|
Managed device ID.
|
|||
| https_image_push
string
|
|
Enable/disable image push to FortiSwitch using HTTPS.
|
||
| log_mac_limit_violations
string
|
|
Enable/disable logs for Learning Limit Violations.
|
||
| mac_aging_interval
integer
|
Time after which an inactive MAC is aged out (10 - 1000000 sec).
|
|||
| mac_retention_period
integer
|
Time in hours after which an inactive MAC is removed from client DB.
|
|||
| mac_violation_timer
integer
|
Set timeout for Learning Limit Violations (0 = disabled).
|
|||
| username
string
|
FortiOS or FortiGate username.
|
|||
| 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
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
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"
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_switch_controller_global_module.html