New in version 2.9.
The below requirements are needed on the host that executes this module.
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 |
| Ensures FortiGate certificate must be verified by a proper CA. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
switch_controller_vlan dictionary | Default: null | Configure VLANs for switch controller. | ||
auth string |
| Authentication. | ||
color integer | Color of icon on the GUI. | |||
comments string | Comment. | |||
name string / required | Switch VLAN name. | |||
portal_message_override_group string | Specify captive portal replacement message override group. | |||
portal_message_overrides dictionary | Individual message overrides. | |||
auth_disclaimer_page string | Override auth-disclaimer-page message with message from portal-message-overrides group. | |||
auth_login_failed_page string | Override auth-login-failed-page message with message from portal-message-overrides group. | |||
auth_login_page string | Override auth-login-page message with message from portal-message-overrides group. | |||
auth_reject_page string | Override auth-reject-page message with message from portal-message-overrides group. | |||
radius_server string | Authentication radius server. Source user.radius.name. | |||
security string |
| Security. | ||
selected_usergroups list | Selected user group. | |||
name string / required | User group name. Source user.group.name. | |||
usergroup string | Authentication usergroup. Source user.group.name. | |||
vdom string | Virtual domain, | |||
vlanid integer | VLAN ID. | |||
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. |
Note
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure VLANs for switch controller. fortios_switch_controller_vlan: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" switch_controller_vlan: auth: "radius" color: "4" comments: "<your_own_value>" name: "default_name_6" portal_message_override_group: "<your_own_value>" portal_message_overrides: auth_disclaimer_page: "<your_own_value>" auth_login_failed_page: "<your_own_value>" auth_login_page: "<your_own_value>" auth_reject_page: "<your_own_value>" radius_server: "<your_own_value> (source user.radius.name)" security: "open" selected_usergroups: - name: "default_name_16 (source user.group.name)" usergroup: "<your_own_value> (source user.group.name)" vdom: "<your_own_value>" vlanid: "19"
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.
© 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_vlan_module.html