Skip to content

Latest commit

 

History

History
2054 lines (2013 loc) · 90.1 KB

fortios_endpoint_control_profile.rst

File metadata and controls

2054 lines (2013 loc) · 90.1 KB
Raw
source

fortios_endpoint_control_profile.py

orphan

fortios_endpoint_control_profile -- Configure FortiClient endpoint control profiles in Fortinet's FortiOS and FortiGate.

2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and profile 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 -> v6.0.11

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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • endpoint_control_profile - Configure FortiClient endpoint control profiles. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>endpoint_control_profile</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">description</span> - Description. <span class="li-normal">type: str</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>description</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">device_groups</span> - Device groups. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: device_groups:name</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>device_groups</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Device group object from available options. Source user.device-group.name user.device-category.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_android_settings</span> - FortiClient settings for Android platform. <span class="li-normal">type: dict</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_android_settings</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">disable_wf_when_protected</span> - Enable/disable FortiClient web category filtering when protected by FortiGate. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>disable_wf_when_protected</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_advanced_vpn</span> - Enable/disable advanced FortiClient VPN configuration. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_advanced_vpn</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_advanced_vpn_buffer</span> - Advanced FortiClient VPN configuration. <span class="li-normal">type: str</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_advanced_vpn_buffer</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_vpn_provisioning</span> - Enable/disable FortiClient VPN provisioning. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vpn_provisioning</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_vpn_settings</span> - FortiClient VPN settings. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_android_settings/forticlient_vpn_settings:name</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vpn_settings</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth_method</span> - Authentication method. <span class="li-normal">type: str</span> <span class="li-normal">choices: psk, certificate</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auth_method</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[psk]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[certificate]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - VPN name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">preshared_key</span> - Pre-shared secret for PSK authentication. <span class="li-normal">type: str</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>preshared_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">remote_gw</span> - IP address or FQDN of the remote VPN gateway. <span class="li-normal">type: str</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>remote_gw</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sslvpn_access_port</span> - SSL VPN access port (1 - 65535). <span class="li-normal">type: int</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sslvpn_access_port</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sslvpn_require_certificate</span> - Enable/disable requiring SSL VPN client certificate. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sslvpn_require_certificate</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">type</span> - VPN type (IPsec or SSL VPN). <span class="li-normal">type: str</span> <span class="li-normal">choices: ipsec, ssl</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[ipsec]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[ssl]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_wf</span> - Enable/disable FortiClient web filtering. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_wf_profile</span> - The FortiClient web filter profile to apply. Source webfilter.profile.name. <span class="li-normal">type: str</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf_profile</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_ios_settings</span> - FortiClient settings for iOS platform. <span class="li-normal">type: dict</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_ios_settings</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">client_vpn_provisioning</span> - FortiClient VPN provisioning. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>client_vpn_provisioning</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">client_vpn_settings</span> - FortiClient VPN settings. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_ios_settings/client_vpn_settings:name</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>client_vpn_settings</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth_method</span> - Authentication method. <span class="li-normal">type: str</span> <span class="li-normal">choices: psk, certificate</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auth_method</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[psk]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[certificate]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - VPN name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">preshared_key</span> - Pre-shared secret for PSK authentication. <span class="li-normal">type: str</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>preshared_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">remote_gw</span> - IP address or FQDN of the remote VPN gateway. <span class="li-normal">type: str</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>remote_gw</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sslvpn_access_port</span> - SSL VPN access port (1 - 65535). <span class="li-normal">type: int</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sslvpn_access_port</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sslvpn_require_certificate</span> - Enable/disable requiring SSL VPN client certificate. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sslvpn_require_certificate</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">type</span> - VPN type (IPsec or SSL VPN). <span class="li-normal">type: str</span> <span class="li-normal">choices: ipsec, ssl</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[ipsec]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[ssl]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">vpn_configuration_content</span> - Content of VPN configuration. <span class="li-normal">type: str</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vpn_configuration_content</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">vpn_configuration_name</span> - Name of VPN configuration. <span class="li-normal">type: str</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vpn_configuration_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">configuration_content</span> - Content of configuration profile. <span class="li-normal">type: str</span> <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a> <div id="label63" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>configuration_content</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">configuration_name</span> - Name of configuration profile. <span class="li-normal">type: str</span> <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a> <div id="label65" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>configuration_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">disable_wf_when_protected</span> - Enable/disable FortiClient web category filtering when protected by FortiGate. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a> <div id="label67" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>disable_wf_when_protected</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">distribute_configuration_profile</span> - Enable/disable configuration profile (.mobileconfig file) distribution. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a> <div id="label69" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distribute_configuration_profile</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_wf</span> - Enable/disable FortiClient web filtering. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a> <div id="label71" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_wf_profile</span> - The FortiClient web filter profile to apply. Source webfilter.profile.name. <span class="li-normal">type: str</span> <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a> <div id="label73" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf_profile</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_winmac_settings</span> - FortiClient settings for Windows/Mac platform. <span class="li-normal">type: dict</span> <a id='label74' href="javascript:ContentClick('label75', 'label74');" onmouseover="ContentPreview('label75');" onmouseout="ContentUnpreview('label75');" title="click to collapse or expand..."> more... </a> <div id="label75" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_winmac_settings</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">av_realtime_protection</span> - Enable/disable FortiClient AntiVirus real-time protection. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label76' href="javascript:ContentClick('label77', 'label76');" onmouseover="ContentPreview('label77');" onmouseout="ContentUnpreview('label77');" title="click to collapse or expand..."> more... </a> <div id="label77" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>av_realtime_protection</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">av_signature_up_to_date</span> - Enable/disable FortiClient AV signature updates. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label78' href="javascript:ContentClick('label79', 'label78');" onmouseover="ContentPreview('label79');" onmouseout="ContentUnpreview('label79');" title="click to collapse or expand..."> more... </a> <div id="label79" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>av_signature_up_to_date</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_application_firewall</span> - Enable/disable the FortiClient application firewall. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label80' href="javascript:ContentClick('label81', 'label80');" onmouseover="ContentPreview('label81');" onmouseout="ContentUnpreview('label81');" title="click to collapse or expand..."> more... </a> <div id="label81" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_application_firewall</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_application_firewall_list</span> - FortiClient application firewall rule list. Source application.list.name. <span class="li-normal">type: str</span> <a id='label82' href="javascript:ContentClick('label83', 'label82');" onmouseover="ContentPreview('label83');" onmouseout="ContentUnpreview('label83');" title="click to collapse or expand..."> more... </a> <div id="label83" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_application_firewall_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_av</span> - Enable/disable FortiClient AntiVirus scanning. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label84' href="javascript:ContentClick('label85', 'label84');" onmouseover="ContentPreview('label85');" onmouseout="ContentUnpreview('label85');" title="click to collapse or expand..."> more... </a> <div id="label85" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_av</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_ems_compliance</span> - Enable/disable FortiClient Enterprise Management Server (EMS) compliance. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label86' href="javascript:ContentClick('label87', 'label86');" onmouseover="ContentPreview('label87');" onmouseout="ContentUnpreview('label87');" title="click to collapse or expand..."> more... </a> <div id="label87" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_ems_compliance</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_ems_compliance_action</span> - FortiClient EMS compliance action. <span class="li-normal">type: str</span> <span class="li-normal">choices: block, warning</span> <a id='label88' href="javascript:ContentClick('label89', 'label88');" onmouseover="ContentPreview('label89');" onmouseout="ContentUnpreview('label89');" title="click to collapse or expand..."> more... </a> <div id="label89" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_ems_compliance_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[warning]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_ems_entries</span> - FortiClient EMS entries. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_winmac_settings/forticlient_ems_entries:name</span> <a id='label90' href="javascript:ContentClick('label91', 'label90');" onmouseover="ContentPreview('label91');" onmouseout="ContentUnpreview('label91');" title="click to collapse or expand..."> more... </a> <div id="label91" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_ems_entries</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - FortiClient EMS name. Source endpoint-control.forticlient-ems.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label92' href="javascript:ContentClick('label93', 'label92');" onmouseover="ContentPreview('label93');" onmouseout="ContentUnpreview('label93');" title="click to collapse or expand..."> more... </a> <div id="label93" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_linux_ver</span> - Minimum FortiClient Linux version. <span class="li-normal">type: str</span> <a id='label94' href="javascript:ContentClick('label95', 'label94');" onmouseover="ContentPreview('label95');" onmouseout="ContentUnpreview('label95');" title="click to collapse or expand..."> more... </a> <div id="label95" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_linux_ver</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_log_upload</span> - Enable/disable uploading FortiClient logs. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label96' href="javascript:ContentClick('label97', 'label96');" onmouseover="ContentPreview('label97');" onmouseout="ContentUnpreview('label97');" title="click to collapse or expand..."> more... </a> <div id="label97" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_log_upload</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_log_upload_level</span> - Select the FortiClient logs to upload. <span class="li-normal">type: str</span> <span class="li-normal">choices: traffic, vulnerability, event</span> <a id='label98' href="javascript:ContentClick('label99', 'label98');" onmouseover="ContentPreview('label99');" onmouseout="ContentUnpreview('label99');" title="click to collapse or expand..."> more... </a> <div id="label99" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_log_upload_level</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[traffic]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[vulnerability]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[event]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_log_upload_server</span> - IP address or FQDN of the server to which to upload FortiClient logs. <span class="li-normal">type: str</span> <a id='label100' href="javascript:ContentClick('label101', 'label100');" onmouseover="ContentPreview('label101');" onmouseout="ContentUnpreview('label101');" title="click to collapse or expand..."> more... </a> <div id="label101" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_log_upload_server</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_mac_ver</span> - Minimum FortiClient Mac OS version. <span class="li-normal">type: str</span> <a id='label102' href="javascript:ContentClick('label103', 'label102');" onmouseover="ContentPreview('label103');" onmouseout="ContentUnpreview('label103');" title="click to collapse or expand..."> more... </a> <div id="label103" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_mac_ver</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_minimum_software_version</span> - Enable/disable requiring clients to run FortiClient with a minimum software version number. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label104' href="javascript:ContentClick('label105', 'label104');" onmouseover="ContentPreview('label105');" onmouseout="ContentUnpreview('label105');" title="click to collapse or expand..."> more... </a> <div id="label105" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_minimum_software_version</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_operating_system</span> - FortiClient operating system. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_winmac_settings/forticlient_operating_system:id</span> <a id='label106' href="javascript:ContentClick('label107', 'label106');" onmouseover="ContentPreview('label107');" onmouseout="ContentUnpreview('label107');" title="click to collapse or expand..."> more... </a> <div id="label107" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_operating_system</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Operating system entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label108' href="javascript:ContentClick('label109', 'label108');" onmouseover="ContentPreview('label109');" onmouseout="ContentUnpreview('label109');" title="click to collapse or expand..."> more... </a> <div id="label109" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">os_name</span> - Customize operating system name or Mac OS format:x.x.x <span class="li-normal">type: str</span> <a id='label110' href="javascript:ContentClick('label111', 'label110');" onmouseover="ContentPreview('label111');" onmouseout="ContentUnpreview('label111');" title="click to collapse or expand..."> more... </a> <div id="label111" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>os_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">os_type</span> - Operating system type. <span class="li-normal">type: str</span> <span class="li-normal">choices: custom, mac-os, win-7, win-80, win-81, win-10, win-2000, win-home-svr, win-svr-10, win-svr-2003, win-svr-2003-r2, win-svr-2008, win-svr-2008-r2, win-svr-2012, win-svr-2012-r2, win-sto-svr-2003, win-vista, win-xp, ubuntu-linux, centos-linux, redhat-linux, fedora-linux</span> <a id='label112' href="javascript:ContentClick('label113', 'label112');" onmouseover="ContentPreview('label113');" onmouseout="ContentUnpreview('label113');" title="click to collapse or expand..."> more... </a> <div id="label113" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>os_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[custom]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[mac-os]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-7]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-80]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-81]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-10]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-2000]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-home-svr]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-10]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2003]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2003-r2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2008]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2008-r2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2012]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-svr-2012-r2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-sto-svr-2003]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-vista]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[win-xp]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[ubuntu-linux]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[centos-linux]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[redhat-linux]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[fedora-linux]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_own_file</span> - Checking the path and filename of the FortiClient application. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_winmac_settings/forticlient_own_file:id</span> <a id='label114' href="javascript:ContentClick('label115', 'label114');" onmouseover="ContentPreview('label115');" onmouseout="ContentUnpreview('label115');" title="click to collapse or expand..."> more... </a> <div id="label115" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_own_file</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">file</span> - File path and name. <span class="li-normal">type: str</span> <a id='label116' href="javascript:ContentClick('label117', 'label116');" onmouseover="ContentPreview('label117');" onmouseout="ContentUnpreview('label117');" title="click to collapse or expand..."> more... </a> <div id="label117" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>file</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - File ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label118' href="javascript:ContentClick('label119', 'label118');" onmouseover="ContentPreview('label119');" onmouseout="ContentUnpreview('label119');" title="click to collapse or expand..."> more... </a> <div id="label119" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_registration_compliance_action</span> - FortiClient registration compliance action. <span class="li-normal">type: str</span> <span class="li-normal">choices: block, warning</span> <a id='label120' href="javascript:ContentClick('label121', 'label120');" onmouseover="ContentPreview('label121');" onmouseout="ContentUnpreview('label121');" title="click to collapse or expand..."> more... </a> <div id="label121" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_registration_compliance_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[warning]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_registry_entry</span> - FortiClient registry entry. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_winmac_settings/forticlient_registry_entry:id</span> <a id='label122' href="javascript:ContentClick('label123', 'label122');" onmouseover="ContentPreview('label123');" onmouseout="ContentUnpreview('label123');" title="click to collapse or expand..."> more... </a> <div id="label123" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_registry_entry</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Registry entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label124' href="javascript:ContentClick('label125', 'label124');" onmouseover="ContentPreview('label125');" onmouseout="ContentUnpreview('label125');" title="click to collapse or expand..."> more... </a> <div id="label125" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">registry_entry</span> - Registry entry. <span class="li-normal">type: str</span> <a id='label126' href="javascript:ContentClick('label127', 'label126');" onmouseover="ContentPreview('label127');" onmouseout="ContentUnpreview('label127');" title="click to collapse or expand..."> more... </a> <div id="label127" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>registry_entry</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_running_app</span> - Use FortiClient to verify if the listed applications are running on the client. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_winmac_settings/forticlient_running_app:id</span> <a id='label128' href="javascript:ContentClick('label129', 'label128');" onmouseover="ContentPreview('label129');" onmouseout="ContentUnpreview('label129');" title="click to collapse or expand..."> more... </a> <div id="label129" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_running_app</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">app_name</span> - Application name. <span class="li-normal">type: str</span> <a id='label130' href="javascript:ContentClick('label131', 'label130');" onmouseover="ContentPreview('label131');" onmouseout="ContentUnpreview('label131');" title="click to collapse or expand..."> more... </a> <div id="label131" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">app_sha256_signature</span> - App"s SHA256 signature. <span class="li-normal">type: str</span> <a id='label132' href="javascript:ContentClick('label133', 'label132');" onmouseover="ContentPreview('label133');" onmouseout="ContentUnpreview('label133');" title="click to collapse or expand..."> more... </a> <div id="label133" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_sha256_signature</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">app_sha256_signature2</span> - App"s SHA256 Signature. <span class="li-normal">type: str</span> <a id='label134' href="javascript:ContentClick('label135', 'label134');" onmouseover="ContentPreview('label135');" onmouseout="ContentUnpreview('label135');" title="click to collapse or expand..."> more... </a> <div id="label135" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_sha256_signature2</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">app_sha256_signature3</span> - App"s SHA256 Signature. <span class="li-normal">type: str</span> <a id='label136' href="javascript:ContentClick('label137', 'label136');" onmouseover="ContentPreview('label137');" onmouseout="ContentUnpreview('label137');" title="click to collapse or expand..."> more... </a> <div id="label137" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_sha256_signature3</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">app_sha256_signature4</span> - App"s SHA256 Signature. <span class="li-normal">type: str</span> <a id='label138' href="javascript:ContentClick('label139', 'label138');" onmouseover="ContentPreview('label139');" onmouseout="ContentUnpreview('label139');" title="click to collapse or expand..."> more... </a> <div id="label139" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_sha256_signature4</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">application_check_rule</span> - Application check rule. <span class="li-normal">type: str</span> <span class="li-normal">choices: present, absent</span> <a id='label140' href="javascript:ContentClick('label141', 'label140');" onmouseover="ContentPreview('label141');" onmouseout="ContentUnpreview('label141');" title="click to collapse or expand..."> more... </a> <div id="label141" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>application_check_rule</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[present]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[absent]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">id</span> - Application ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label142' href="javascript:ContentClick('label143', 'label142');" onmouseover="ContentPreview('label143');" onmouseout="ContentUnpreview('label143');" title="click to collapse or expand..."> more... </a> <div id="label143" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">process_name</span> - Process name. <span class="li-normal">type: str</span> <a id='label144' href="javascript:ContentClick('label145', 'label144');" onmouseover="ContentPreview('label145');" onmouseout="ContentUnpreview('label145');" title="click to collapse or expand..."> more... </a> <div id="label145" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>process_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">process_name2</span> - Process name. <span class="li-normal">type: str</span> <a id='label146' href="javascript:ContentClick('label147', 'label146');" onmouseover="ContentPreview('label147');" onmouseout="ContentUnpreview('label147');" title="click to collapse or expand..."> more... </a> <div id="label147" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>process_name2</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">process_name3</span> - Process name. <span class="li-normal">type: str</span> <a id='label148' href="javascript:ContentClick('label149', 'label148');" onmouseover="ContentPreview('label149');" onmouseout="ContentUnpreview('label149');" title="click to collapse or expand..."> more... </a> <div id="label149" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>process_name3</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">process_name4</span> - Process name. <span class="li-normal">type: str</span> <a id='label150' href="javascript:ContentClick('label151', 'label150');" onmouseover="ContentPreview('label151');" onmouseout="ContentUnpreview('label151');" title="click to collapse or expand..."> more... </a> <div id="label151" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>process_name4</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">forticlient_security_posture</span> - Enable/disable FortiClient security posture check options. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label152' href="javascript:ContentClick('label153', 'label152');" onmouseover="ContentPreview('label153');" onmouseout="ContentUnpreview('label153');" title="click to collapse or expand..."> more... </a> <div id="label153" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_security_posture</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_security_posture_compliance_action</span> - FortiClient security posture compliance action. <span class="li-normal">type: str</span> <span class="li-normal">choices: block, warning</span> <a id='label154' href="javascript:ContentClick('label155', 'label154');" onmouseover="ContentPreview('label155');" onmouseout="ContentUnpreview('label155');" title="click to collapse or expand..."> more... </a> <div id="label155" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_security_posture_compliance_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[warning]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_system_compliance</span> - Enable/disable enforcement of FortiClient system compliance. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label156' href="javascript:ContentClick('label157', 'label156');" onmouseover="ContentPreview('label157');" onmouseout="ContentUnpreview('label157');" title="click to collapse or expand..."> more... </a> <div id="label157" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_system_compliance</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_system_compliance_action</span> - Block or warn clients not compliant with FortiClient requirements. <span class="li-normal">type: str</span> <span class="li-normal">choices: block, warning</span> <a id='label158' href="javascript:ContentClick('label159', 'label158');" onmouseover="ContentPreview('label159');" onmouseout="ContentUnpreview('label159');" title="click to collapse or expand..."> more... </a> <div id="label159" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_system_compliance_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[warning]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_vuln_scan</span> - Enable/disable FortiClient vulnerability scanning. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label160' href="javascript:ContentClick('label161', 'label160');" onmouseover="ContentPreview('label161');" onmouseout="ContentUnpreview('label161');" title="click to collapse or expand..."> more... </a> <div id="label161" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vuln_scan</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_vuln_scan_compliance_action</span> - FortiClient vulnerability compliance action. <span class="li-normal">type: str</span> <span class="li-normal">choices: block, warning</span> <a id='label162' href="javascript:ContentClick('label163', 'label162');" onmouseover="ContentPreview('label163');" onmouseout="ContentUnpreview('label163');" title="click to collapse or expand..."> more... </a> <div id="label163" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vuln_scan_compliance_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[warning]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_vuln_scan_enforce</span> - Configure the level of the vulnerability found that causes a FortiClient vulnerability compliance action. <span class="li-normal">type: str</span> <span class="li-normal">choices: critical, high, medium, low, info</span> <a id='label164' href="javascript:ContentClick('label165', 'label164');" onmouseover="ContentPreview('label165');" onmouseout="ContentUnpreview('label165');" title="click to collapse or expand..."> more... </a> <div id="label165" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vuln_scan_enforce</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[critical]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[high]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[medium]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[low]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[info]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_vuln_scan_enforce_grace</span> - FortiClient vulnerability scan enforcement grace period (0 - 30 days). <span class="li-normal">type: int</span> <a id='label166' href="javascript:ContentClick('label167', 'label166');" onmouseover="ContentPreview('label167');" onmouseout="ContentUnpreview('label167');" title="click to collapse or expand..."> more... </a> <div id="label167" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vuln_scan_enforce_grace</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_vuln_scan_exempt</span> - Enable/disable compliance exemption for vulnerabilities that cannot be patched automatically. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label168' href="javascript:ContentClick('label169', 'label168');" onmouseover="ContentPreview('label169');" onmouseout="ContentUnpreview('label169');" title="click to collapse or expand..."> more... </a> <div id="label169" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_vuln_scan_exempt</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_wf</span> - Enable/disable FortiClient web filtering. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label170' href="javascript:ContentClick('label171', 'label170');" onmouseover="ContentPreview('label171');" onmouseout="ContentUnpreview('label171');" title="click to collapse or expand..."> more... </a> <div id="label171" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">forticlient_wf_profile</span> - The FortiClient web filter profile to apply. Source webfilter.profile.name. <span class="li-normal">type: str</span> <a id='label172' href="javascript:ContentClick('label173', 'label172');" onmouseover="ContentPreview('label173');" onmouseout="ContentUnpreview('label173');" title="click to collapse or expand..."> more... </a> <div id="label173" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_wf_profile</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_win_ver</span> - Minimum FortiClient Windows version. <span class="li-normal">type: str</span> <a id='label174' href="javascript:ContentClick('label175', 'label174');" onmouseover="ContentPreview('label175');" onmouseout="ContentUnpreview('label175');" title="click to collapse or expand..."> more... </a> <div id="label175" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_win_ver</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">os_av_software_installed</span> - Enable/disable checking for OS recognized AntiVirus software. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label176' href="javascript:ContentClick('label177', 'label176');" onmouseover="ContentPreview('label177');" onmouseout="ContentUnpreview('label177');" title="click to collapse or expand..."> more... </a> <div id="label177" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>os_av_software_installed</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">sandbox_address</span> - FortiSandbox address. <span class="li-normal">type: str</span> <a id='label178' href="javascript:ContentClick('label179', 'label178');" onmouseover="ContentPreview('label179');" onmouseout="ContentUnpreview('label179');" title="click to collapse or expand..."> more... </a> <div id="label179" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sandbox_address</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sandbox_analysis</span> - Enable/disable sending files to FortiSandbox for analysis. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label180' href="javascript:ContentClick('label181', 'label180');" onmouseover="ContentPreview('label181');" onmouseout="ContentUnpreview('label181');" title="click to collapse or expand..."> more... </a> <div id="label181" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sandbox_analysis</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> </ul> <li> <span class="li-head">on_net_addr</span> - Addresses for on-net detection. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: on_net_addr:name</span> <a id='label182' href="javascript:ContentClick('label183', 'label182');" onmouseover="ContentPreview('label183');" onmouseout="ContentUnpreview('label183');" title="click to collapse or expand..."> more... </a> <div id="label183" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>on_net_addr</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Address object from available options. Source firewall.address.name firewall.addrgrp.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label184' href="javascript:ContentClick('label185', 'label184');" onmouseover="ContentPreview('label185');" onmouseout="ContentUnpreview('label185');" title="click to collapse or expand..."> more... </a> <div id="label185" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">profile_name</span> - Profile name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label186' href="javascript:ContentClick('label187', 'label186');" onmouseover="ContentPreview('label187');" onmouseout="ContentUnpreview('label187');" title="click to collapse or expand..."> more... </a> <div id="label187" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>profile_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">replacemsg_override_group</span> - Select an endpoint control replacement message override group from available options. Source system.replacemsg-group.name. <span class="li-normal">type: str</span> <a id='label188' href="javascript:ContentClick('label189', 'label188');" onmouseover="ContentPreview('label189');" onmouseout="ContentUnpreview('label189');" title="click to collapse or expand..."> more... </a> <div id="label189" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>replacemsg_override_group</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">src_addr</span> - Source addresses. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: src_addr:name</span> <a id='label190' href="javascript:ContentClick('label191', 'label190');" onmouseover="ContentPreview('label191');" onmouseout="ContentUnpreview('label191');" title="click to collapse or expand..."> more... </a> <div id="label191" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>src_addr</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Address object from available options. Source firewall.address.name firewall.addrgrp.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label192' href="javascript:ContentClick('label193', 'label192');" onmouseover="ContentPreview('label193');" onmouseout="ContentUnpreview('label193');" title="click to collapse or expand..."> more... </a> <div id="label193" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">user_groups</span> - User groups. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: user_groups:name</span> <a id='label194' href="javascript:ContentClick('label195', 'label194');" onmouseover="ContentPreview('label195');" onmouseout="ContentUnpreview('label195');" title="click to collapse or expand..."> more... </a> <div id="label195" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>user_groups</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - User group name. Source user.group.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label196' href="javascript:ContentClick('label197', 'label196');" onmouseover="ContentPreview('label197');" onmouseout="ContentUnpreview('label197');" title="click to collapse or expand..."> more... </a> <div id="label197" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">users</span> - Users. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: users:name</span> <a id='label198' href="javascript:ContentClick('label199', 'label198');" onmouseover="ContentPreview('label199');" onmouseout="ContentUnpreview('label199');" title="click to collapse or expand..."> more... </a> <div id="label199" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>users</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - User name. Source user.local.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label200' href="javascript:ContentClick('label201', 'label200');" onmouseover="ContentPreview('label201');" onmouseout="ContentUnpreview('label201');" title="click to collapse or expand..."> more... </a> <div id="label201" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> </ul> </ul> </ul>

    Notes

    Note

    • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

    Examples

    - name: Configure FortiClient endpoint control profiles.
  fortinet.fortios.fortios_endpoint_control_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      endpoint_control_profile:
          description: "<your_own_value>"
          device_groups:
              -
                  name: "default_name_5 (source user.device-group.name user.device-category.name)"
          forticlient_android_settings:
              disable_wf_when_protected: "enable"
              forticlient_advanced_vpn: "enable"
              forticlient_advanced_vpn_buffer: "<your_own_value>"
              forticlient_vpn_provisioning: "enable"
              forticlient_vpn_settings:
                  -
                      auth_method: "psk"
                      name: "default_name_13"
                      preshared_key: "<your_own_value>"
                      remote_gw: "<your_own_value>"
                      sslvpn_access_port: "32767"
                      sslvpn_require_certificate: "enable"
                      type: "ipsec"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
          forticlient_ios_settings:
              client_vpn_provisioning: "enable"
              client_vpn_settings:
                  -
                      auth_method: "psk"
                      name: "default_name_25"
                      preshared_key: "<your_own_value>"
                      remote_gw: "<your_own_value>"
                      sslvpn_access_port: "32767"
                      sslvpn_require_certificate: "enable"
                      type: "ipsec"
                      vpn_configuration_content: "<your_own_value>"
                      vpn_configuration_name: "<your_own_value>"
              configuration_content: "<your_own_value>"
              configuration_name: "<your_own_value>"
              disable_wf_when_protected: "enable"
              distribute_configuration_profile: "enable"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
          forticlient_winmac_settings:
              av_realtime_protection: "enable"
              av_signature_up_to_date: "enable"
              forticlient_application_firewall: "enable"
              forticlient_application_firewall_list: "<your_own_value> (source application.list.name)"
              forticlient_av: "enable"
              forticlient_ems_compliance: "enable"
              forticlient_ems_compliance_action: "block"
              forticlient_ems_entries:
                  -
                      name: "default_name_48 (source endpoint-control.forticlient-ems.name)"
              forticlient_linux_ver: "<your_own_value>"
              forticlient_log_upload: "enable"
              forticlient_log_upload_level: "traffic"
              forticlient_log_upload_server: "<your_own_value>"
              forticlient_mac_ver: "<your_own_value>"
              forticlient_minimum_software_version: "enable"
              forticlient_operating_system:
                  -
                      id: "56"
                      os_name: "<your_own_value>"
                      os_type: "custom"
              forticlient_own_file:
                  -
                      file: "<your_own_value>"
                      id: "61"
              forticlient_registration_compliance_action: "block"
              forticlient_registry_entry:
                  -
                      id: "64"
                      registry_entry: "<your_own_value>"
              forticlient_running_app:
                  -
                      app_name: "<your_own_value>"
                      app_sha256_signature: "<your_own_value>"
                      app_sha256_signature2: "<your_own_value>"
                      app_sha256_signature3: "<your_own_value>"
                      app_sha256_signature4: "<your_own_value>"
                      application_check_rule: "present"
                      id: "73"
                      process_name: "<your_own_value>"
                      process_name2: "<your_own_value>"
                      process_name3: "<your_own_value>"
                      process_name4: "<your_own_value>"
              forticlient_security_posture: "enable"
              forticlient_security_posture_compliance_action: "block"
              forticlient_system_compliance: "enable"
              forticlient_system_compliance_action: "block"
              forticlient_vuln_scan: "enable"
              forticlient_vuln_scan_compliance_action: "block"
              forticlient_vuln_scan_enforce: "critical"
              forticlient_vuln_scan_enforce_grace: "15"
              forticlient_vuln_scan_exempt: "enable"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
              forticlient_win_ver: "<your_own_value>"
              os_av_software_installed: "enable"
              sandbox_address: "<your_own_value>"
              sandbox_analysis: "enable"
          on_net_addr:
              -
                  name: "default_name_94 (source firewall.address.name firewall.addrgrp.name)"
          profile_name: "<your_own_value>"
          replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
          src_addr:
              -
                  name: "default_name_98 (source firewall.address.name firewall.addrgrp.name)"
          user_groups:
              -
                  name: "default_name_100 (source user.group.name)"
          users:
              -
                  name: "default_name_102 (source user.local.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.

    Authors

    • Link Zheng (@chillancezen)
    • Jie Xue (@JieX19)
    • Hongbin Lu (@fgtdev-hblu)
    • Frank Shen (@frankshen01)
    • Miguel Angel Munoz (@mamunozgonzalez)
    • Nicolas Thomas (@thomnico)

    Hint

    If you notice any issues in this documentation, you can create a pull request to improve it.