fortios_user_quarantine – Configure quarantine support 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 quarantine 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
- user_quarantine - Configure quarantine support. type: dict more...
- firewall_groups - Firewall address group which includes all quarantine MAC address. Source firewall.addrgrp.name. type: str more...
- quarantine - Enable/disable quarantine. type: str choices: enable, disable more...
- targets - Quarantine entry to hold multiple MACs. type: list member_path: targets:entry more...
- description - Description for the quarantine entry. type: str more...
- entry - Quarantine entry name. type: str required: true more...
- macs - Quarantine MACs. type: list member_path: targets:entry/macs:mac more...
- description - Description for the quarantine MAC. type: str more...
- drop - Enable/disable dropping of quarantined device traffic. type: str choices: disable, enable more...
- entry_id - FSW entry id for the quarantine MAC. type: int more...
- mac - Quarantine MAC. type: str required: true more...
- parent - Parent entry name. type: str more...
- traffic_policy - Traffic policy for quarantined MACs. Source switch-controller.traffic-policy.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure quarantine support.
fortinet.fortios.fortios_user_quarantine:
vdom: "{{ vdom }}"
user_quarantine:
firewall_groups: "<your_own_value> (source firewall.addrgrp.name)"
quarantine: "enable"
targets:
-
description: "<your_own_value>"
entry: "<your_own_value>"
macs:
-
description: "<your_own_value>"
drop: "disable"
entry_id: "2147483647"
mac: "<your_own_value>"
parent: "<your_own_value>"
traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.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.