fortiswitch_switch_quarantine – Configure quarantine devices on the switch in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify switch feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_switch_quarantine | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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
- switch_quarantine - Configure quarantine devices on the switch. type: dict
- acl_id - Associated ingress acl for the quarantine MAC. type: int
- cos_queue - COS queue for the quarantine device traffic from range (0 - 7) or unset to disable. type: int
- description - Description for the quarantine MAC. type: str
- drop - Drop setting for the quarantine device traffic. type: str choices: disable, enable
- mac - Quarantine MAC. type: str required: true
- policer - ACL policer for the quarantine device traffic. type: int
Examples
- name: Configure quarantine devices on the switch.
fortinet.fortiswitch.fortiswitch_switch_quarantine:
state: "present"
switch_quarantine:
acl_id: "3 (source switch.acl.ingress.id)"
cos_queue: "4"
description: "<your_own_value>"
drop: "disable"
mac: "<your_own_value>"
policer: "8 (source switch.acl.policer.id)"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.