fortios_user_security_exempt_list – Configure security exemption list in Fortinet’s FortiOS and FortiGate

From Get docs
Ansible/docs/2.9/modules/fortios user security exempt list module


fortios_user_security_exempt_list – Configure security exemption list in Fortinet’s FortiOS and FortiGate

New in version 2.9.


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.5

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

host

string

FortiOS or FortiGate IP address.

https

boolean

  • no
  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol.

password

string

Default:

""

FortiOS or FortiGate password.

ssl_verify

boolean

  • no
  • yes

Ensures FortiGate certificate must be verified by a proper CA.

state

string / required

  • present
  • absent

Indicates whether to create or remove the object.

user_security_exempt_list

dictionary

Default:

null

Configure security exemption list.

description

string

Description.

name

string / required

Name of the exempt list.

rule

list

Configure rules for exempting users from captive portal authentication.

devices

list

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

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

Destination services.

name

string / required

Service name. Source firewall.service.custom.name firewall.service.group.name.

srcaddr

list

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.



Notes

Note

  • Requires fortiosapi library developed by Fortinet
  • Run as a local_action in your playbook


Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure security exemption list.
    fortios_user_security_exempt_list:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      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)"

Return Values

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




Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_user_security_exempt_list_module.html