fortinet.fortios.fortios_user_quarantine (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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)"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

user_quarantine:
    default: null
    description:
    - Configure quarantine support.
    suboptions:
      firewall_groups:
        description:
        - Firewall address group which includes all quarantine MAC address. Source firewall.addrgrp.name.
        type: str
      quarantine:
        choices:
        - enable
        - disable
        description:
        - Enable/disable quarantine.
        type: str
      targets:
        description:
        - Quarantine entry to hold multiple MACs.
        elements: dict
        suboptions:
          description:
            description:
            - Description for the quarantine entry.
            type: str
          entry:
            description:
            - Quarantine entry name.
            required: true
            type: str
          macs:
            description:
            - Quarantine MACs.
            elements: dict
            suboptions:
              description:
                description:
                - Description for the quarantine MAC.
                type: str
              drop:
                choices:
                - disable
                - enable
                description:
                - Enable/disable dropping of quarantined device traffic.
                type: str
              entry_id:
                description:
                - FSW entry id for the quarantine MAC.
                type: int
              mac:
                description:
                - Quarantine MAC.
                required: true
                type: str
              parent:
                description:
                - Parent entry name.
                type: str
            type: list
        type: list
      traffic_policy:
        description:
        - Traffic policy for quarantined MACs. Source switch-controller.traffic-policy.name.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str