fortios_user_security_exempt_list – Configure security exemption list in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and security_exempt_list 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_security_exempt_list - Configure security exemption list. type: dict more...
- description - Description. type: str more...
- name - Name of the exempt list. type: str required: true more...
- rule - Configure rules for exempting users from captive portal authentication. type: list member_path: rule:id more...
- devices - Devices or device groups. type: list member_path: rule:id/devices:name more...
- name - Device or group name. Source user.device.alias user.device-group.name user.device-category.name. type: str required: true more...
- dstaddr - Destination addresses or address groups. type: list member_path: rule:id/dstaddr:name more...
- name - Address or group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- id - ID. see Notes. type: int required: true more...
- service - Destination services. type: list member_path: rule:id/service:name more...
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
- srcaddr - Source addresses or address groups. type: list member_path: rule:id/srcaddr:name more...
- name - Address or group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure security exemption list.
fortinet.fortios.fortios_user_security_exempt_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
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)"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.