Note
This plugin is part of the fortinet.fortios collection.
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_user_security_exempt_list
.
New in version 2.9: of fortinet.fortios
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. | |||
user_security_exempt_list dictionary | Configure security exemption list. | ||||
description string | Description. | ||||
name string / required | Name of the exempt list. | ||||
rule list / elements=string | Configure rules for exempting users from captive portal authentication. | ||||
devices list / elements=string | Devices or device groups. | ||||
name string / required | Device or group name. Source user.device.alias user.device-group.name user.device-category.name. | ||||
dstaddr list / elements=string | Destination addresses or address groups. | ||||
name string / required | Address or group name. Source firewall.address.name firewall.addrgrp.name. | ||||
id integer / required | ID. | ||||
service list / elements=string | Destination services. | ||||
name string / required | Service name. Source firewall.service.custom.name firewall.service.group.name. | ||||
srcaddr list / elements=string | Source addresses or address groups. | ||||
name string / required | Address or group name. Source firewall.address.name firewall.addrgrp.name. | ||||
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: 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 security exemption list. fortios_user_security_exempt_list: vdom: "{{ vdom }}" state: "present" user_security_exempt_list: description: "<your_own_value>" name: "default_name_4" rule: - devices: - name: "default_name_7 (source user.device.alias user.device-group.name user.device-category.name)" dstaddr: - name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)" id: "10" service: - name: "default_name_12 (source firewall.service.custom.name firewall.service.group.name)" srcaddr: - name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
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 |
© 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_user_security_exempt_list_module.html