user_vpn_sessions_deauth - User monitor
+++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
User monitor.
Use API "/monitor-api/v1/user/vpn/sessions/deauth".
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.17.0
Parameters
----------
.. raw:: html
- force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
- bypass_validation Bypass validation of the module.type: booldefault: False
- params The parameters of the module.[Required]type: dict
- usernames type: listelements: str
- session_ids type: listelements: str
Examples
-------------
.. code-block:: yaml
- name: Deauth user VPN sessions
hosts: fortisase
gather_facts: false
tasks:
- name: Deauth user VPN sessions
fortinet.fortisase.user_vpn_sessions_deauth:
params:
usernames:
- "employee@company.com"
- "user@company.com"
session_ids:
- "Ottawa - Canada-demo@demo.com-0"
- "San Jose - USA-demo@demo.com-1"
Return Values
-------------
.. raw:: html
- http_code type: intreturned: always
- response type: rawreturned: always
Authors
-------
- Xinwei Du (@dux-fortinet)