code
stringlengths 2.5k
150k
| kind
stringclasses 1
value |
|---|---|
ansible fortinet.fortios.fortios_videofilter_profile – Configure VideoFilter profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_videofilter\_profile – Configure VideoFilter profile in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_videofilter_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify videofilter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **videofilter\_profile** dictionary | | Configure VideoFilter profile. |
| | **comment** string | | Comment. |
| | **dailymotion** string | **Choices:*** enable
* disable
| Enable/disable Dailymotion video source. |
| | **fortiguard\_category** dictionary | | Configure FortiGuard categories. |
| | | **filters** list / elements=string | | Configure VideoFilter FortiGuard category. |
| | | | **action** string | **Choices:*** bypass
* monitor
* block
| VideoFilter action. |
| | | | **category\_id** integer | | Category ID. |
| | | | **id** integer / required | | ID. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | **name** string / required | | Name. |
| | **vimeo** string | **Choices:*** enable
* disable
| Enable/disable Vimeo video source. |
| | **vimeo\_restrict** string | | Set Vimeo-restrict ("7" = don"t show mature content, "134" = don"t show unrated and mature content). A value of cookie "content\_rating". |
| | **youtube** string | **Choices:*** enable
* disable
| Enable/disable YouTube video source. |
| | **youtube\_channel\_filter** integer | | Set YouTube channel filter. Source videofilter.youtube-channel-filter.id. |
| | **youtube\_restrict** string | **Choices:*** none
* strict
* moderate
| Set YouTube-restrict mode. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VideoFilter profile.
fortios_videofilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
videofilter_profile:
comment: "Comment."
dailymotion: "enable"
fortiguard_category:
filters:
-
action: "bypass"
category_id: "8"
id: "9"
log: "enable"
name: "default_name_11"
vimeo: "enable"
vimeo_restrict: "<your_own_value>"
youtube: "enable"
youtube_channel_filter: "15 (source videofilter.youtube-channel-filter.id)"
youtube_restrict: "none"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_report_chart – Report chart widget configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_chart – Report chart widget configuration in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_report_chart`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and chart 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **report\_chart** dictionary | | Report chart widget configuration. |
| | **background** string | | Chart background. |
| | **category** string | **Choices:*** misc
* traffic
* event
* virus
* webfilter
* attack
* spam
* dlp
* app-ctrl
* vulnerability
| Category. |
| | **category\_series** dictionary | | Category series of pie chart. |
| | | **databind** string | | Category series value expression. |
| | | **font\_size** integer | | Font size of category-series title. |
| | **color\_palette** string | | Color palette (system will pick color automatically by default). |
| | **column** list / elements=string | | Table column definition. |
| | | **detail\_unit** string | | Detail unit of column. |
| | | **detail\_value** string | | Detail value of column. |
| | | **footer\_unit** string | | Footer unit of column. |
| | | **footer\_value** string | | Footer value of column. |
| | | **header\_value** string | | Display name of table header. |
| | | **id** integer / required | | ID. |
| | | **mapping** list / elements=string | | Show detail in certain display value for certain condition. |
| | | | **displayname** string | | Display name. |
| | | | **id** integer / required | | id |
| | | | **op** string | **Choices:*** none
* greater
* greater-equal
* less
* less-equal
* equal
* between
| Comparision operater. |
| | | | **value1** string | | Value 1. |
| | | | **value2** string | | Value 2. |
| | | | **value\_type** string | **Choices:*** integer
* string
| Value type. |
| | **comments** string | | Comment. |
| | **dataset** string | | Bind dataset to chart. |
| | **dimension** string | **Choices:*** 2D
* 3D
| Dimension. |
| | **drill\_down\_charts** list / elements=string | | Drill down charts. |
| | | **chart\_name** string | | Drill down chart name. |
| | | **id** integer / required | | Drill down chart ID. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this drill down chart. |
| | **favorite** string | **Choices:*** False
* True
| Favorite. |
| | **graph\_type** string | **Choices:*** none
* bar
* pie
* line
* flow
| Graph type. |
| | **legend** string | **Choices:*** enable
* disable
| Enable/Disable Legend area. |
| | **legend\_font\_size** integer | | Font size of legend area. |
| | **name** string / required | | Chart Widget Name |
| | **period** string | **Choices:*** last24h
* last7d
| Time period. |
| | **policy** integer | | Used by monitor policy. |
| | **style** string | **Choices:*** auto
* manual
| Style. |
| | **title** string | | Chart title. |
| | **title\_font\_size** integer | | Font size of chart title. |
| | **type** string | **Choices:*** graph
* table
| Chart type. |
| | **value\_series** dictionary | | Value series of pie chart. |
| | | **databind** string | | Value series value expression. |
| | **x\_series** dictionary | | X-series of chart. |
| | | **caption** string | | X-series caption. |
| | | **caption\_font\_size** integer | | X-series caption font size. |
| | | **databind** string | | X-series value expression. |
| | | **font\_size** integer | | X-series label font size. |
| | | **is\_category** string | **Choices:*** True
* False
| X-series represent category or not. |
| | | **label\_angle** string | **Choices:*** 45-degree
* vertical
* horizontal
| X-series label angle. |
| | | **scale\_direction** string | **Choices:*** decrease
* increase
| Scale increase or decrease. |
| | | **scale\_format** string | **Choices:*** YYYY-MM-DD-HH-MM
* YYYY-MM-DD HH
* YYYY-MM-DD
* YYYY-MM
* YYYY
* HH-MM
* MM-DD
| Date/time format. |
| | | **scale\_step** integer | | Scale step. |
| | | **scale\_unit** string | **Choices:*** minute
* hour
* day
* month
* year
| Scale unit. |
| | | **unit** string | | X-series unit. |
| | **y\_series** dictionary | | Y-series of chart. |
| | | **caption** string | | Y-series caption. |
| | | **caption\_font\_size** integer | | Y-series caption font size. |
| | | **databind** string | | Y-series value expression. |
| | | **extra\_databind** string | | Extra Y-series value. |
| | | **extra\_y** string | **Choices:*** enable
* disable
| Allow another Y-series value |
| | | **extra\_y\_legend** string | | Extra Y-series legend type/name. |
| | | **font\_size** integer | | Y-series label font size. |
| | | **group** string | | Y-series group option. |
| | | **label\_angle** string | **Choices:*** 45-degree
* vertical
* horizontal
| Y-series label angle. |
| | | **unit** string | | Y-series unit. |
| | | **y\_legend** string | | First Y-series legend type/name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Report chart widget configuration.
fortios_report_chart:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_chart:
background: "<your_own_value>"
category: "misc"
category_series:
databind: "<your_own_value>"
font_size: "7"
color_palette: "<your_own_value>"
column:
-
detail_unit: "<your_own_value>"
detail_value: "<your_own_value>"
footer_unit: "<your_own_value>"
footer_value: "<your_own_value>"
header_value: "<your_own_value>"
id: "15"
mapping:
-
displayname: "<your_own_value>"
id: "18"
op: "none"
value_type: "integer"
value1: "<your_own_value>"
value2: "<your_own_value>"
comments: "<your_own_value>"
dataset: "<your_own_value>"
dimension: "2D"
drill_down_charts:
-
chart_name: "<your_own_value>"
id: "28"
status: "enable"
favorite: "no"
graph_type: "none"
legend: "enable"
legend_font_size: "33"
name: "default_name_34"
period: "last24h"
policy: "36"
style: "auto"
title: "<your_own_value>"
title_font_size: "39"
type: "graph"
value_series:
databind: "<your_own_value>"
x_series:
caption: "<your_own_value>"
caption_font_size: "45"
databind: "<your_own_value>"
font_size: "47"
is_category: "yes"
label_angle: "45-degree"
scale_direction: "decrease"
scale_format: "YYYY-MM-DD-HH-MM"
scale_step: "52"
scale_unit: "minute"
unit: "<your_own_value>"
y_series:
caption: "<your_own_value>"
caption_font_size: "57"
databind: "<your_own_value>"
extra_databind: "<your_own_value>"
extra_y: "enable"
extra_y_legend: "<your_own_value>"
font_size: "62"
group: "<your_own_value>"
label_angle: "45-degree"
unit: "<your_own_value>"
y_legend: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_endpoint_control_profile – Configure FortiClient endpoint control profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_profile – Configure FortiClient endpoint control profiles in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_endpoint_control_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **endpoint\_control\_profile** dictionary | | Configure FortiClient endpoint control profiles. |
| | **description** string | | Description. |
| | **device\_groups** list / elements=string | | Device groups. |
| | | **name** string / required | | Device group object from available options. Source user.device-group.name user.device-category.name. |
| | **forticlient\_android\_settings** dictionary | | FortiClient settings for Android platform. |
| | | **disable\_wf\_when\_protected** string | **Choices:*** enable
* disable
| Enable/disable FortiClient web category filtering when protected by FortiGate. |
| | | **forticlient\_advanced\_vpn** string | **Choices:*** enable
* disable
| Enable/disable advanced FortiClient VPN configuration. |
| | | **forticlient\_advanced\_vpn\_buffer** string | | Advanced FortiClient VPN configuration. |
| | | **forticlient\_vpn\_provisioning** string | **Choices:*** enable
* disable
| Enable/disable FortiClient VPN provisioning. |
| | | **forticlient\_vpn\_settings** list / elements=string | | FortiClient VPN settings. |
| | | | **auth\_method** string | **Choices:*** psk
* certificate
| Authentication method. |
| | | | **name** string / required | | VPN name. |
| | | | **preshared\_key** string | | Pre-shared secret for PSK authentication. |
| | | | **remote\_gw** string | | IP address or FQDN of the remote VPN gateway. |
| | | | **sslvpn\_access\_port** integer | | SSL VPN access port (1 - 65535). |
| | | | **sslvpn\_require\_certificate** string | **Choices:*** enable
* disable
| Enable/disable requiring SSL VPN client certificate. |
| | | | **type** string | **Choices:*** ipsec
* ssl
| VPN type (IPsec or SSL VPN). |
| | | **forticlient\_wf** string | **Choices:*** enable
* disable
| Enable/disable FortiClient web filtering. |
| | | **forticlient\_wf\_profile** string | | The FortiClient web filter profile to apply. Source webfilter.profile.name. |
| | **forticlient\_ios\_settings** dictionary | | FortiClient settings for iOS platform. |
| | | **client\_vpn\_provisioning** string | **Choices:*** enable
* disable
| FortiClient VPN provisioning. |
| | | **client\_vpn\_settings** list / elements=string | | FortiClient VPN settings. |
| | | | **auth\_method** string | **Choices:*** psk
* certificate
| Authentication method. |
| | | | **name** string / required | | VPN name. |
| | | | **preshared\_key** string | | Pre-shared secret for PSK authentication. |
| | | | **remote\_gw** string | | IP address or FQDN of the remote VPN gateway. |
| | | | **sslvpn\_access\_port** integer | | SSL VPN access port (1 - 65535). |
| | | | **sslvpn\_require\_certificate** string | **Choices:*** enable
* disable
| Enable/disable requiring SSL VPN client certificate. |
| | | | **type** string | **Choices:*** ipsec
* ssl
| VPN type (IPsec or SSL VPN). |
| | | | **vpn\_configuration\_content** string | | Content of VPN configuration. |
| | | | **vpn\_configuration\_name** string | | Name of VPN configuration. |
| | | **configuration\_content** string | | Content of configuration profile. |
| | | **configuration\_name** string | | Name of configuration profile. |
| | | **disable\_wf\_when\_protected** string | **Choices:*** enable
* disable
| Enable/disable FortiClient web category filtering when protected by FortiGate. |
| | | **distribute\_configuration\_profile** string | **Choices:*** enable
* disable
| Enable/disable configuration profile (.mobileconfig file) distribution. |
| | | **forticlient\_wf** string | **Choices:*** enable
* disable
| Enable/disable FortiClient web filtering. |
| | | **forticlient\_wf\_profile** string | | The FortiClient web filter profile to apply. Source webfilter.profile.name. |
| | **forticlient\_winmac\_settings** dictionary | | FortiClient settings for Windows/Mac platform. |
| | | **av\_realtime\_protection** string | **Choices:*** enable
* disable
| Enable/disable FortiClient AntiVirus real-time protection. |
| | | **av\_signature\_up\_to\_date** string | **Choices:*** enable
* disable
| Enable/disable FortiClient AV signature updates. |
| | | **forticlient\_application\_firewall** string | **Choices:*** enable
* disable
| Enable/disable the FortiClient application firewall. |
| | | **forticlient\_application\_firewall\_list** string | | FortiClient application firewall rule list. Source application.list.name. |
| | | **forticlient\_av** string | **Choices:*** enable
* disable
| Enable/disable FortiClient AntiVirus scanning. |
| | | **forticlient\_ems\_compliance** string | **Choices:*** enable
* disable
| Enable/disable FortiClient Enterprise Management Server (EMS) compliance. |
| | | **forticlient\_ems\_compliance\_action** string | **Choices:*** block
* warning
| FortiClient EMS compliance action. |
| | | **forticlient\_ems\_entries** list / elements=string | | FortiClient EMS entries. |
| | | | **name** string / required | | FortiClient EMS name. Source endpoint-control.forticlient-ems.name. |
| | | **forticlient\_linux\_ver** string | | Minimum FortiClient Linux version. |
| | | **forticlient\_log\_upload** string | **Choices:*** enable
* disable
| Enable/disable uploading FortiClient logs. |
| | | **forticlient\_log\_upload\_level** string | **Choices:*** traffic
* vulnerability
* event
| Select the FortiClient logs to upload. |
| | | **forticlient\_log\_upload\_server** string | | IP address or FQDN of the server to which to upload FortiClient logs. |
| | | **forticlient\_mac\_ver** string | | Minimum FortiClient Mac OS version. |
| | | **forticlient\_minimum\_software\_version** string | **Choices:*** enable
* disable
| Enable/disable requiring clients to run FortiClient with a minimum software version number. |
| | | **forticlient\_operating\_system** list / elements=string | | FortiClient operating system. |
| | | | **id** integer / required | | Operating system entry ID. |
| | | | **os\_name** string | | Customize operating system name or Mac OS format:x.x.x |
| | | | **os\_type** string | **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
| Operating system type. |
| | | **forticlient\_own\_file** list / elements=string | | Checking the path and filename of the FortiClient application. |
| | | | **file** string | | File path and name. |
| | | | **id** integer / required | | File ID. |
| | | **forticlient\_registration\_compliance\_action** string | **Choices:*** block
* warning
| FortiClient registration compliance action. |
| | | **forticlient\_registry\_entry** list / elements=string | | FortiClient registry entry. |
| | | | **id** integer / required | | Registry entry ID. |
| | | | **registry\_entry** string | | Registry entry. |
| | | **forticlient\_running\_app** list / elements=string | | Use FortiClient to verify if the listed applications are running on the client. |
| | | | **app\_name** string | | Application name. |
| | | | **app\_sha256\_signature** string | | App"s SHA256 signature. |
| | | | **app\_sha256\_signature2** string | | App"s SHA256 Signature. |
| | | | **app\_sha256\_signature3** string | | App"s SHA256 Signature. |
| | | | **app\_sha256\_signature4** string | | App"s SHA256 Signature. |
| | | | **application\_check\_rule** string | **Choices:*** present
* absent
| Application check rule. |
| | | | **id** integer / required | | Application ID. |
| | | | **process\_name** string | | Process name. |
| | | | **process\_name2** string | | Process name. |
| | | | **process\_name3** string | | Process name. |
| | | | **process\_name4** string | | Process name. |
| | | **forticlient\_security\_posture** string | **Choices:*** enable
* disable
| Enable/disable FortiClient security posture check options. |
| | | **forticlient\_security\_posture\_compliance\_action** string | **Choices:*** block
* warning
| FortiClient security posture compliance action. |
| | | **forticlient\_system\_compliance** string | **Choices:*** enable
* disable
| Enable/disable enforcement of FortiClient system compliance. |
| | | **forticlient\_system\_compliance\_action** string | **Choices:*** block
* warning
| Block or warn clients not compliant with FortiClient requirements. |
| | | **forticlient\_vuln\_scan** string | **Choices:*** enable
* disable
| Enable/disable FortiClient vulnerability scanning. |
| | | **forticlient\_vuln\_scan\_compliance\_action** string | **Choices:*** block
* warning
| FortiClient vulnerability compliance action. |
| | | **forticlient\_vuln\_scan\_enforce** string | **Choices:*** critical
* high
* medium
* low
* info
| Configure the level of the vulnerability found that causes a FortiClient vulnerability compliance action. |
| | | **forticlient\_vuln\_scan\_enforce\_grace** integer | | FortiClient vulnerability scan enforcement grace period (0 - 30 days). |
| | | **forticlient\_vuln\_scan\_exempt** string | **Choices:*** enable
* disable
| Enable/disable compliance exemption for vulnerabilities that cannot be patched automatically. |
| | | **forticlient\_wf** string | **Choices:*** enable
* disable
| Enable/disable FortiClient web filtering. |
| | | **forticlient\_wf\_profile** string | | The FortiClient web filter profile to apply. Source webfilter.profile.name. |
| | | **forticlient\_win\_ver** string | | Minimum FortiClient Windows version. |
| | | **os\_av\_software\_installed** string | **Choices:*** enable
* disable
| Enable/disable checking for OS recognized AntiVirus software. |
| | | **sandbox\_address** string | | FortiSandbox address. |
| | | **sandbox\_analysis** string | **Choices:*** enable
* disable
| Enable/disable sending files to FortiSandbox for analysis. |
| | **on\_net\_addr** list / elements=string | | Addresses for on-net detection. |
| | | **name** string / required | | Address object from available options. Source firewall.address.name firewall.addrgrp.name. |
| | **profile\_name** string | | Profile name. |
| | **replacemsg\_override\_group** string | | Select an endpoint control replacement message override group from available options. Source system.replacemsg-group.name. |
| | **src\_addr** list / elements=string | | Source addresses. |
| | | **name** string / required | | Address object from available options. Source firewall.address.name firewall.addrgrp.name. |
| | **user\_groups** list / elements=string | | User groups. |
| | | **name** string / required | | User group name. Source user.group.name. |
| | **users** list / elements=string | | Users. |
| | | **name** string / required | | User name. Source user.local.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiClient endpoint control profiles.
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: "16"
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: "28"
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: "85"
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 [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_gi_gk – Configure Gi Firewall Gatekeeper in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_gi\_gk – Configure Gi Firewall Gatekeeper in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_gi_gk`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and gi\_gk 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_gi\_gk** dictionary | | Configure Gi Firewall Gatekeeper. |
| | **context** integer | | Context ID |
| | **port** integer | | UDP port to listen, range 0-65535. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Gi Firewall Gatekeeper.
fortios_system_gi_gk:
vdom: "{{ vdom }}"
system_gi_gk:
context: "3"
port: "4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_auto_config_policy – Policy definitions which can define the behavior on auto configured interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_auto\_config\_policy – Policy definitions which can define the behavior on auto configured interfaces in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_auto_config_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_auto\_config feature and policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_auto\_config\_policy** dictionary | | Policy definitions which can define the behavior on auto configured interfaces. |
| | **igmp\_flood\_report** string | **Choices:*** enable
* disable
| Enable/disable IGMP flood report. |
| | **igmp\_flood\_traffic** string | **Choices:*** enable
* disable
| Enable/disable IGMP flood traffic. |
| | **name** string / required | | Auto-Config policy name |
| | **poe\_status** string | **Choices:*** enable
* disable
| Enable/disable PoE status. |
| | **qos\_policy** string | | Auto-Config QoS policy. Source switch-controller.qos.qos-policy.name. |
| | **storm\_control\_policy** string | | Auto-Config storm control policy. Source switch-controller.storm-control-policy.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Policy definitions which can define the behavior on auto configured interfaces.
fortios_switch_controller_auto_config_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_auto_config_policy:
igmp_flood_report: "enable"
igmp_flood_traffic: "enable"
name: "default_name_5"
poe_status: "enable"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
storm_control_policy: "<your_own_value> (source switch-controller.storm-control-policy.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_spamfilter_dnsbl – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_dnsbl – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_spamfilter_dnsbl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and dnsbl 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **spamfilter\_dnsbl** dictionary | | Configure AntiSpam DNSBL/ORBL. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter DNSBL and ORBL server. |
| | | **action** string | **Choices:*** reject
* spam
| Reject connection or mark as spam email. |
| | | **id** integer / required | | DNSBL/ORBL entry ID. |
| | | **server** string | | DNSBL or ORBL server name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam DNSBL/ORBL.
fortios_spamfilter_dnsbl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_dnsbl:
comment: "Optional comments."
entries:
-
action: "reject"
id: "6"
server: "192.168.100.40"
status: "enable"
id: "9"
name: "default_name_10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_access_list6 – Configure IPv6 access lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_access\_list6 – Configure IPv6 access lists in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_access_list6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and access\_list6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_access\_list6** dictionary | | Configure IPv6 access lists. |
| | **comments** string | | Comment. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | Rule. |
| | | **action** string | **Choices:*** permit
* deny
| Permit or deny this IP address and netmask prefix. |
| | | **exact\_match** string | **Choices:*** enable
* disable
| Enable/disable exact prefix match. |
| | | **flags** integer | | Flags. |
| | | **id** integer / required | | Rule ID. |
| | | **prefix6** string | | IPv6 prefix to define regular filter criteria, such as "any" or subnets. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 access lists.
fortios_router_access_list6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_access_list6:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
exact_match: "enable"
flags: "8"
id: "9"
prefix6: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_antivirus_mms_checksum – Configure MMS content checksum list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_mms\_checksum – Configure MMS content checksum list in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_antivirus_mms_checksum`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and mms\_checksum 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **antivirus\_mms\_checksum** dictionary | | Configure MMS content checksum list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | modify this MMS content checksum list |
| | | **checksum** string | | MMS attachment checksum value (CRC32) |
| | | **name** string / required | | entry name, for administrator reference |
| | | **status** string | **Choices:*** enable
* disable
| apply this entry during attachment inspection |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure MMS content checksum list.
fortios_antivirus_mms_checksum:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
antivirus_mms_checksum:
comment: "Optional comments."
entries:
-
checksum: "<your_own_value>"
name: "default_name_6"
status: "enable"
id: "8"
name: "default_name_9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_radius – Configure RADIUS server entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_radius – Configure RADIUS server entries in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_radius`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and radius 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_radius** dictionary | | Configure RADIUS server entries. |
| | **accounting\_server** list / elements=string | | Additional accounting servers. |
| | | **id** integer / required | | ID (0 - 4294967295). |
| | | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | | **port** integer | | RADIUS accounting port number. |
| | | **secret** string | | Secret key. |
| | | **server** string | | {<name\_str|ip\_str>} Server CN domain name or IP. |
| | | **source\_ip** string | | Source IP address for communications to the RADIUS server. |
| | | **status** string | **Choices:*** enable
* disable
| Status. |
| | **acct\_all\_servers** string | **Choices:*** enable
* disable
| Enable/disable sending of accounting messages to all configured servers . |
| | **acct\_interim\_interval** integer | | Time in seconds between each accounting interim update message. |
| | **all\_usergroup** string | **Choices:*** disable
* enable
| Enable/disable automatically including this RADIUS server in all user groups. |
| | **auth\_type** string | **Choices:*** auto
* ms\_chap\_v2
* ms\_chap
* chap
* pap
| Authentication methods/protocols permitted for this RADIUS server. |
| | **class** list / elements=string | | Class attribute name(s). |
| | | **name** string / required | | Class name. |
| | **group\_override\_attr\_type** string | **Choices:*** filter-Id
* class
| RADIUS attribute type to override user group information. |
| | **h3c\_compatibility** string | **Choices:*** enable
* disable
| Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **name** string / required | | RADIUS server entry name. |
| | **nas\_ip** string | | IP address used to communicate with the RADIUS server and used as NAS-IP-Address and Called-Station-ID attributes. |
| | **password\_encoding** string | **Choices:*** auto
* ISO-8859-1
| Password encoding. |
| | **password\_renewal** string | **Choices:*** enable
* disable
| Enable/disable password renewal. |
| | **radius\_coa** string | **Choices:*** enable
* disable
| Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated. |
| | **radius\_port** integer | | RADIUS service port number. |
| | **rsso** string | **Choices:*** enable
* disable
| Enable/disable RADIUS based single sign on feature. |
| | **rsso\_context\_timeout** integer | | Time in seconds before the logged out user is removed from the "user context list" of logged on users. |
| | **rsso\_endpoint\_attribute** string | **Choices:*** User-Name
* NAS-IP-Address
* Framed-IP-Address
* Framed-IP-Netmask
* Filter-Id
* Login-IP-Host
* Reply-Message
* Callback-Number
* Callback-Id
* Framed-Route
* Framed-IPX-Network
* Class
* Called-Station-Id
* Calling-Station-Id
* NAS-Identifier
* Proxy-State
* Login-LAT-Service
* Login-LAT-Node
* Login-LAT-Group
* Framed-AppleTalk-Zone
* Acct-Session-Id
* Acct-Multi-Session-Id
| RADIUS attributes used to extract the user end point identifer from the RADIUS Start record. |
| | **rsso\_endpoint\_block\_attribute** string | **Choices:*** User-Name
* NAS-IP-Address
* Framed-IP-Address
* Framed-IP-Netmask
* Filter-Id
* Login-IP-Host
* Reply-Message
* Callback-Number
* Callback-Id
* Framed-Route
* Framed-IPX-Network
* Class
* Called-Station-Id
* Calling-Station-Id
* NAS-Identifier
* Proxy-State
* Login-LAT-Service
* Login-LAT-Node
* Login-LAT-Group
* Framed-AppleTalk-Zone
* Acct-Session-Id
* Acct-Multi-Session-Id
| RADIUS attributes used to block a user. |
| | **rsso\_ep\_one\_ip\_only** string | **Choices:*** enable
* disable
| Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages. |
| | **rsso\_flush\_ip\_session** string | **Choices:*** enable
* disable
| Enable/disable flushing user IP sessions on RADIUS accounting Stop messages. |
| | **rsso\_log\_flags** list / elements=string | **Choices:*** protocol-error
* profile-missing
* accounting-stop-missed
* accounting-event
* endpoint-block
* radiusd-other
* none
| Events to log. |
| | **rsso\_log\_period** integer | | Time interval in seconds that group event log messages will be generated for dynamic profile events. |
| | **rsso\_radius\_response** string | **Choices:*** enable
* disable
| Enable/disable sending RADIUS response packets after receiving Start and Stop records. |
| | **rsso\_radius\_server\_port** integer | | UDP port to listen on for RADIUS Start and Stop records. |
| | **rsso\_secret** string | | RADIUS secret used by the RADIUS accounting server. |
| | **rsso\_validate\_request\_secret** string | **Choices:*** enable
* disable
| Enable/disable validating the RADIUS request shared secret in the Start or End record. |
| | **secondary\_secret** string | | Secret key to access the secondary server. |
| | **secondary\_server** string | | {<name\_str|ip\_str>} secondary RADIUS CN domain name or IP. |
| | **secret** string | | Pre-shared secret key used to access the primary RADIUS server. |
| | **server** string | | Primary RADIUS server CN domain name or IP address. |
| | **source\_ip** string | | Source IP address for communications to the RADIUS server. |
| | **sso\_attribute** string | **Choices:*** User-Name
* NAS-IP-Address
* Framed-IP-Address
* Framed-IP-Netmask
* Filter-Id
* Login-IP-Host
* Reply-Message
* Callback-Number
* Callback-Id
* Framed-Route
* Framed-IPX-Network
* Class
* Called-Station-Id
* Calling-Station-Id
* NAS-Identifier
* Proxy-State
* Login-LAT-Service
* Login-LAT-Node
* Login-LAT-Group
* Framed-AppleTalk-Zone
* Acct-Session-Id
* Acct-Multi-Session-Id
| RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record. |
| | **sso\_attribute\_key** string | | Key prefix for SSO group value in the SSO attribute. |
| | **sso\_attribute\_value\_override** string | **Choices:*** enable
* disable
| Enable/disable override old attribute value with new value for the same endpoint. |
| | **switch\_controller\_acct\_fast\_framedip\_detect** integer | | Switch controller accounting message Framed-IP detection from DHCP snooping (seconds). |
| | **switch\_controller\_service\_type** list / elements=string | **Choices:*** login
* framed
* callback-login
* callback-framed
* outbound
* administrative
* nas-prompt
* authenticate-only
* callback-nas-prompt
* call-check
* callback-administrative
| RADIUS service type. |
| | **tertiary\_secret** string | | Secret key to access the tertiary server. |
| | **tertiary\_server** string | | {<name\_str|ip\_str>} tertiary RADIUS CN domain name or IP. |
| | **timeout** integer | | Time in seconds between re-sending authentication requests. |
| | **use\_management\_vdom** string | **Choices:*** enable
* disable
| Enable/disable using management VDOM to send requests. |
| | **username\_case\_sensitive** string | **Choices:*** enable
* disable
| Enable/disable case sensitive user names. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure RADIUS server entries.
fortios_user_radius:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_radius:
accounting_server:
-
id: "4"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
port: "7"
secret: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
acct_all_servers: "enable"
acct_interim_interval: "13"
all_usergroup: "disable"
auth_type: "auto"
class:
-
name: "default_name_17"
group_override_attr_type: "filter-Id"
h3c_compatibility: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
name: "default_name_22"
nas_ip: "<your_own_value>"
password_encoding: "auto"
password_renewal: "enable"
radius_coa: "enable"
radius_port: "27"
rsso: "enable"
rsso_context_timeout: "29"
rsso_endpoint_attribute: "User-Name"
rsso_endpoint_block_attribute: "User-Name"
rsso_ep_one_ip_only: "enable"
rsso_flush_ip_session: "enable"
rsso_log_flags: "protocol-error"
rsso_log_period: "35"
rsso_radius_response: "enable"
rsso_radius_server_port: "37"
rsso_secret: "<your_own_value>"
rsso_validate_request_secret: "enable"
secondary_secret: "<your_own_value>"
secondary_server: "<your_own_value>"
secret: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
sso_attribute: "User-Name"
sso_attribute_key: "<your_own_value>"
sso_attribute_value_override: "enable"
switch_controller_acct_fast_framedip_detect: "48"
switch_controller_service_type: "login"
tertiary_secret: "<your_own_value>"
tertiary_server: "<your_own_value>"
timeout: "52"
use_management_vdom: "enable"
username_case_sensitive: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_stp_settings – Configure FortiSwitch spanning tree protocol (STP) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_stp\_settings – Configure FortiSwitch spanning tree protocol (STP) in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_stp_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and stp\_settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_stp\_settings** dictionary | | Configure FortiSwitch spanning tree protocol (STP). |
| | **forward\_time** integer | | Period of time a port is in listening and learning state (4 - 30 sec). |
| | **hello\_time** integer | | Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec). |
| | **max\_age** integer | | Maximum time before a bridge port saves its configuration BPDU information (6 - 40 sec). |
| | **max\_hops** integer | | Maximum number of hops between the root bridge and the furthest bridge (1- 40). |
| | **name** string | | Name of global STP settings configuration. |
| | **pending\_timer** integer | | Pending time (1 - 15 sec). |
| | **revision** integer | | STP revision number (0 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable STP. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch spanning tree protocol (STP).
fortios_switch_controller_stp_settings:
vdom: "{{ vdom }}"
switch_controller_stp_settings:
forward_time: "3"
hello_time: "4"
max_age: "5"
max_hops: "6"
name: "default_name_7"
pending_timer: "8"
revision: "9"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_isf_queue_profile – Create a queue profile of switch in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_isf\_queue\_profile – Create a queue profile of switch in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_isf_queue_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and isf\_queue\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_isf\_queue\_profile** dictionary | | Create a queue profile of switch. |
| | **bandwidth\_unit** string | **Choices:*** kbps
* pps
| Unit of measurement for guaranteed and maximum bandwidth. |
| | **burst\_control** string | **Choices:*** disable
* enable
| Burst control. |
| | **guaranteed\_bandwidth** integer | | Guaranteed bandwidth. |
| | **maximum\_bandwidth** integer | | Upper bandwidth limit enforced. |
| | **name** string / required | | Profile name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Create a queue profile of switch.
fortios_system_isf_queue_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_isf_queue_profile:
bandwidth_unit: "kbps"
burst_control: "disable"
guaranteed_bandwidth: "5"
maximum_bandwidth: "6"
name: "default_name_7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_syslogd3_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd3\_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd3_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd3 feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd3\_filter** dictionary | | Filters for remote system server. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | Syslog 3 filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for remote system server.
fortios_log_syslogd3_filter:
vdom: "{{ vdom }}"
log_syslogd3_filter:
anomaly: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_gtp_tunnel_limit – GTP tunnel limiter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_tunnel\_limit – GTP tunnel limiter in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_gtp_tunnel_limit`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and tunnel\_limit 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **gtp\_tunnel\_limit** dictionary | | GTP tunnel limiter. |
| | **name** string / required | | Tunnel limiter name. |
| | **tunnel\_limit** integer | | Tunnel limit [1, 16000000]. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: GTP tunnel limiter.
fortios_gtp_tunnel_limit:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_tunnel_limit:
name: "default_name_3"
tunnel_limit: "4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_syslogd4_override_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd4\_override\_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd4_override_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd4 feature and override\_setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd4\_override\_setting** dictionary | | Override settings for remote syslog server. |
| | **certificate** string | | Certificate used to communicate with Syslog server. Source certificate.local.name. |
| | **custom\_field\_name** list / elements=string | | Custom field name for CEF format logging. |
| | | **custom** string | | Field custom name. |
| | | **id** integer / required | | Entry ID. |
| | | **name** string | | Field name. |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
* disable
| Enable/disable reliable syslogging with TLS encryption. |
| | **facility** string | **Choices:*** kernel
* user
* mail
* daemon
* auth
* syslog
* lpr
* news
* uucp
* cron
* authpriv
* ftp
* ntp
* audit
* alert
* clock
* local0
* local1
* local2
* local3
* local4
* local5
* local6
* local7
| Remote syslog facility. |
| | **format** string | **Choices:*** default
* csv
* cef
* rfc5424
| Log format. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **max\_log\_rate** integer | | Syslog maximum log rate in MBps (0 = unlimited). |
| | **mode** string | **Choices:*** udp
* legacy-reliable
* reliable
| Remote syslog logging over UDP/Reliable TCP. |
| | **override** string | **Choices:*** enable
* disable
| Enable/disable override syslog settings. |
| | **port** integer | | Server listen port. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **server** string | | Address of remote syslog server. |
| | **source\_ip** string | | Source IP address of syslog. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable remote syslog logging. |
| | **syslog\_type** integer | | Hidden setting index of Syslog. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override settings for remote syslog server.
fortios_log_syslogd4_override_setting:
vdom: "{{ vdom }}"
log_syslogd4_override_setting:
certificate: "<your_own_value> (source certificate.local.name)"
custom_field_name:
-
custom: "<your_own_value>"
id: "6"
name: "default_name_7"
enc_algorithm: "high-medium"
facility: "kernel"
format: "default"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "13"
mode: "udp"
override: "enable"
port: "16"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "22"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_nsxt_setting – Configure NSX-T setting in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_nsxt\_setting – Configure NSX-T setting in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_nsxt_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify nsxt feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **nsxt\_setting** dictionary | | Configure NSX-T setting. |
| | **liveness** string | **Choices:*** enable
* disable
| Enable/disable liveness detection packet forwarding. |
| | **service** string | | Service name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NSX-T setting.
fortios_nsxt_setting:
vdom: "{{ vdom }}"
nsxt_setting:
liveness: "enable"
service: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_router_multicast_flow – Configure multicast-flow in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_multicast\_flow – Configure multicast-flow in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_multicast_flow`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast\_flow 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_multicast\_flow** dictionary | | Configure multicast-flow. |
| | **comments** string | | Comment. |
| | **flows** list / elements=string | | Multicast-flow entries. |
| | | **group\_addr** string | | Multicast group IP address. |
| | | **id** integer / required | | Flow ID. |
| | | **source\_addr** string | | Multicast source IP address. |
| | **name** string / required | | Name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure multicast-flow.
fortios_router_multicast_flow:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_multicast_flow:
comments: "<your_own_value>"
flows:
-
group_addr: "<your_own_value>"
id: "6"
source_addr: "<your_own_value>"
name: "default_name_8"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_icap_profile – Configure ICAP profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_icap\_profile – Configure ICAP profiles in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_icap_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify icap 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **icap\_profile** dictionary | | Configure ICAP profiles. |
| | **icap\_headers** list / elements=string | | Configure ICAP forwarded request headers. |
| | | **base64\_encoding** string | **Choices:*** disable
* enable
| Enable/disable use of base64 encoding of HTTP content. |
| | | **content** string | | HTTP header content. |
| | | **id** integer / required | | HTTP forwarded header ID. |
| | | **name** string | | HTTP forwarded header name. |
| | **methods** list / elements=string | **Choices:*** delete
* get
* head
* options
* post
* put
* trace
* other
| The allowed HTTP methods that will be sent to ICAP server for further processing. |
| | **name** string / required | | ICAP profile name. |
| | **preview** string | **Choices:*** disable
* enable
| Enable/disable preview of data to ICAP server. |
| | **preview\_data\_length** integer | | Preview data length to be sent to ICAP server. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **request** string | **Choices:*** disable
* enable
| Enable/disable whether an HTTP request is passed to an ICAP server. |
| | **request\_failure** string | **Choices:*** error
* bypass
| Action to take if the ICAP server cannot be contacted when processing an HTTP request. |
| | **request\_path** string | | Path component of the ICAP URI that identifies the HTTP request processing service. |
| | **request\_server** string | | ICAP server to use for an HTTP request. Source icap.server.name. |
| | **respmod\_default\_action** string | **Choices:*** forward
* bypass
| Default action to ICAP response modification (respmod) processing. |
| | **respmod\_forward\_rules** list / elements=string | | ICAP response mode forward rules. |
| | | **action** string | **Choices:*** forward
* bypass
| Action to be taken for ICAP server. |
| | | **header\_group** list / elements=string | | HTTP header group. |
| | | | **case\_sensitivity** string | **Choices:*** disable
* enable
| Enable/disable case sensitivity when matching header. |
| | | | **header** string | | HTTP header regular expression. |
| | | | **header\_name** string | | HTTP header. |
| | | | **id** integer / required | | ID. |
| | | **host** string | | Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. |
| | | **http\_resp\_status\_code** integer | | HTTP response status code. |
| | | | **code** integer / required | | HTTP response status code. |
| | | **name** string / required | | Address name. |
| | **response** string | **Choices:*** disable
* enable
| Enable/disable whether an HTTP response is passed to an ICAP server. |
| | **response\_failure** string | **Choices:*** error
* bypass
| Action to take if the ICAP server cannot be contacted when processing an HTTP response. |
| | **response\_path** string | | Path component of the ICAP URI that identifies the HTTP response processing service. |
| | **response\_req\_hdr** string | **Choices:*** disable
* enable
| Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. |
| | **response\_server** string | | ICAP server to use for an HTTP response. Source icap.server.name. |
| | **streaming\_content\_bypass** string | **Choices:*** disable
* enable
| Enable/disable bypassing of ICAP server for streaming content. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure ICAP profiles.
fortios_icap_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_profile:
icap_headers:
-
base64_encoding: "disable"
content: "<your_own_value>"
id: "6"
name: "default_name_7"
methods: "delete"
name: "default_name_9"
preview: "disable"
preview_data_length: "11"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
request: "disable"
request_failure: "error"
request_path: "<your_own_value>"
request_server: "<your_own_value> (source icap.server.name)"
respmod_default_action: "forward"
respmod_forward_rules:
-
action: "forward"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "24"
host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
http_resp_status_code:
-
code: "27"
name: "default_name_28"
response: "disable"
response_failure: "error"
response_path: "<your_own_value>"
response_req_hdr: "disable"
response_server: "<your_own_value> (source icap.server.name)"
streaming_content_bypass: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_access_proxy_virtual_host – Configure Access Proxy virtual hosts in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_access\_proxy\_virtual\_host – Configure Access Proxy virtual hosts in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_access_proxy_virtual_host`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and access\_proxy\_virtual\_host 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_access\_proxy\_virtual\_host** dictionary | | Configure Access Proxy virtual hosts. |
| | **host** string | | The host name. |
| | **host\_type** string | **Choices:*** sub-string
* wildcard
| Type of host pattern. |
| | **name** string / required | | Virtual host name. |
| | **ssl\_certificate** string | | SSL certificate for this host. Source vpn.certificate.local.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Access Proxy virtual hosts.
fortios_firewall_access_proxy_virtual_host:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_access_proxy_virtual_host:
host: "myhostname"
host_type: "sub-string"
name: "default_name_5"
ssl_certificate: "<your_own_value> (source vpn.certificate.local.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_certificate_setting – VPN certificate setting in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_setting – VPN certificate setting in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_certificate_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_certificate feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **vpn\_certificate\_setting** dictionary | | VPN certificate setting. |
| | **certname\_dsa1024** string | | 1024 bit DSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_dsa2048** string | | 2048 bit DSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_ecdsa256** string | | 256 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_ecdsa384** string | | 384 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_ecdsa521** string | | 521 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_ed25519** string | | 253 bit EdDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_ed448** string | | 456 bit EdDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_rsa1024** string | | 1024 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_rsa2048** string | | 2048 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **certname\_rsa4096** string | | 4096 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
| | **check\_ca\_cert** string | **Choices:*** enable
* disable
| Enable/disable verification of the user certificate and pass authentication if any CA in the chain is trusted . |
| | **check\_ca\_chain** string | **Choices:*** enable
* disable
| Enable/disable verification of the entire certificate chain and pass authentication only if the chain is complete and all of the CAs in the chain are trusted . |
| | **cmp\_key\_usage\_checking** string | **Choices:*** enable
* disable
| Enable/disable server certificate key usage checking in CMP mode . |
| | **cmp\_save\_extra\_certs** string | **Choices:*** enable
* disable
| Enable/disable saving extra certificates in CMP mode. |
| | **cn\_match** string | **Choices:*** substring
* value
| When searching for a matching certificate, control how to find matches in the cn attribute of the certificate subject name. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ocsp\_default\_server** string | | Default OCSP server. Source vpn.certificate.ocsp-server.name. |
| | **ocsp\_option** string | **Choices:*** certificate
* server
| Specify whether the OCSP URL is from certificate or configured OCSP server. |
| | **ocsp\_status** string | **Choices:*** enable
* disable
| Enable/disable receiving certificates using the OCSP. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **ssl\_ocsp\_option** string | **Choices:*** certificate
* server
| Specify whether the OCSP URL is from the certificate or the default OCSP server. |
| | **ssl\_ocsp\_source\_ip** string | | Source IP address to use to communicate with the OCSP server. |
| | **ssl\_ocsp\_status** string | **Choices:*** enable
* disable
| Enable/disable SSL OCSP. |
| | **strict\_crl\_check** string | **Choices:*** enable
* disable
| Enable/disable strict mode CRL checking. |
| | **strict\_ocsp\_check** string | **Choices:*** enable
* disable
| Enable/disable strict mode OCSP checking. |
| | **subject\_match** string | **Choices:*** substring
* value
| When searching for a matching certificate, control how to find matches in the certificate subject name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: VPN certificate setting.
fortios_vpn_certificate_setting:
vdom: "{{ vdom }}"
vpn_certificate_setting:
certname_dsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_dsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa256: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa384: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa521: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed25519: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed448: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa4096: "<your_own_value> (source vpn.certificate.local.name)"
check_ca_cert: "enable"
check_ca_chain: "enable"
cmp_key_usage_checking: "enable"
cmp_save_extra_certs: "enable"
cn_match: "substring"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ocsp_default_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
ocsp_option: "certificate"
ocsp_status: "enable"
ssl_min_proto_version: "default"
ssl_ocsp_option: "certificate"
ssl_ocsp_source_ip: "<your_own_value>"
ssl_ocsp_status: "enable"
strict_crl_check: "enable"
strict_ocsp_check: "enable"
subject_match: "substring"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_policy – Configure IPv4 policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_policy – Configure IPv4 policies in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **action** string | **Choices:*** move
| the action indiactor to move an object in the list |
| **after** string | | mkey of target identifier |
| **before** string | | mkey of target identifier |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_policy** dictionary | | Configure IPv4 policies. |
| | **action** string | **Choices:*** accept
* deny
* ipsec
| Policy action (allow/deny/ipsec). |
| | **anti\_replay** string | **Choices:*** enable
* disable
| Enable/disable anti-replay check. |
| | **app\_category** list / elements=string | | Application category ID list. |
| | | **id** integer / required | | Category IDs. |
| | **app\_group** list / elements=string | | Application group names. |
| | | **name** string / required | | Application group names. Source application.group.name. |
| | **application** list / elements=string | | Application ID list. |
| | | **id** integer / required | | Application IDs. |
| | **application\_list** string | | Name of an existing Application list. Source application.list.name. |
| | **auth\_cert** string | | HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. |
| | **auth\_path** string | **Choices:*** enable
* disable
| Enable/disable authentication-based routing. |
| | **auth\_redirect\_addr** string | | HTTP-to-HTTPS redirect address for firewall authentication. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading security profile processing to CP processors. |
| | **av\_profile** string | | Name of an existing Antivirus profile. Source antivirus.profile.name. |
| | **block\_notification** string | **Choices:*** enable
* disable
| Enable/disable block notification. |
| | **captive\_portal\_exempt** string | **Choices:*** enable
* disable
| Enable to exempt some users from the captive portal. |
| | **capture\_packet** string | **Choices:*** enable
* disable
| Enable/disable capture packets. |
| | **cifs\_profile** string | | Name of an existing CIFS profile. Source cifs.profile.name. |
| | **comments** string | | Comment. |
| | **custom\_log\_fields** list / elements=string | | Custom fields to append to log messages for this policy. |
| | | **field\_id** string | | Custom log field. Source log.custom-field.id. |
| | **decrypted\_traffic\_mirror** string | | Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. |
| | **delay\_tcp\_npu\_session** string | **Choices:*** enable
* disable
| Enable TCP NPU session delay to guarantee packet order of 3-way handshake. |
| | **devices** list / elements=string | | Names of devices or device groups that can be matched by the policy. |
| | | **name** string / required | | Device or group name. Source user.device.alias user.device-group.name user.device-category.name. |
| | **diffserv\_forward** string | **Choices:*** enable
* disable
| Enable to change packet"s DiffServ values to the specified diffservcode-forward value. |
| | **diffserv\_reverse** string | **Choices:*** enable
* disable
| Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode\_forward** string | | Change packet"s DiffServ to this value. |
| | **diffservcode\_rev** string | | Change packet"s reverse (reply) DiffServ to this value. |
| | **disclaimer** string | **Choices:*** enable
* disable
| Enable/disable user authentication disclaimer. |
| | **dlp\_sensor** string | | Name of an existing DLP sensor. Source dlp.sensor.name. |
| | **dnsfilter\_profile** string | | Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
| | **dscp\_match** string | **Choices:*** enable
* disable
| Enable DSCP check. |
| | **dscp\_negate** string | **Choices:*** enable
* disable
| Enable negated DSCP match. |
| | **dscp\_value** string | | DSCP value. |
| | **dsri** string | **Choices:*** enable
* disable
| Enable DSRI to ignore HTTP server responses. |
| | **dstaddr** list / elements=string | | Destination address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name. |
| | **dstaddr6** list / elements=string | | Destination IPv6 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vipgrp6.name firewall.vip6.name system .external-resource.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **dstintf** list / elements=string | | Outgoing (egress) interface. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **dynamic\_shaping** string | **Choices:*** enable
* disable
| Enable/disable dynamic RADIUS defined traffic shaping. |
| | **email\_collect** string | **Choices:*** enable
* disable
| Enable/disable email collection. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **file\_filter\_profile** string | | Name of an existing file-filter profile. Source file-filter.profile.name. |
| | **firewall\_session\_dirty** string | **Choices:*** check-all
* check-new
| How to handle sessions if the configuration of this firewall policy changes. |
| | **fixedport** string | **Choices:*** enable
* disable
| Enable to prevent source NAT from changing a session"s source port. |
| | **fsso** string | **Choices:*** enable
* disable
| Enable/disable Fortinet Single Sign-On. |
| | **fsso\_agent\_for\_ntlm** string | | FSSO agent to use for NTLM authentication. Source user.fsso.name. |
| | **fsso\_groups** list / elements=string | | Names of FSSO groups. |
| | | **name** string / required | | Names of FSSO groups. Source user.adgrp.name. |
| | **geoip\_anycast** string | **Choices:*** enable
* disable
| Enable/disable recognition of anycast IP addresses using the geography IP database. |
| | **geoip\_match** string | **Choices:*** physical-location
* registered-location
| Match geography address based either on its physical location or registered location. |
| | **global\_label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** list / elements=string | | Names of user groups that can authenticate with this policy. |
| | | **name** string / required | | Group name. Source user.group.name. |
| | **gtp\_profile** string | | GTP profile. Source firewall.gtp.name. |
| | **http\_policy\_redirect** string | **Choices:*** enable
* disable
| Redirect HTTP(S) traffic to matching transparent web proxy policy. |
| | **icap\_profile** string | | Name of an existing ICAP profile. Source icap.profile.name. |
| | **identity\_based\_route** string | | Name of identity-based routing rule. Source firewall.identity-based-route.name. |
| | **inbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. |
| | **inspection\_mode** string | **Choices:*** proxy
* flow
| Policy inspection mode (Flow/proxy). Default is Flow mode. |
| | **internet\_service** string | **Choices:*** enable
* disable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet\_service\_custom** list / elements=string | | Custom Internet Service name. |
| | | **name** string / required | | Custom Internet Service name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_custom\_group** list / elements=string | | Custom Internet Service group name. |
| | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | **internet\_service\_group** list / elements=string | | Internet Service group name. |
| | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | **internet\_service\_id** list / elements=string | | Internet Service ID. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | **internet\_service\_name** list / elements=string | | Internet Service name. |
| | | **name** string / required | | Internet Service name. Source firewall.internet-service-name.name. |
| | **internet\_service\_negate** string | **Choices:*** enable
* disable
| When enabled internet-service specifies what the service must NOT be. |
| | **internet\_service\_src** string | **Choices:*** enable
* disable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet\_service\_src\_custom** list / elements=string | | Custom Internet Service source name. |
| | | **name** string / required | | Custom Internet Service name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_src\_custom\_group** list / elements=string | | Custom Internet Service source group name. |
| | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | **internet\_service\_src\_group** list / elements=string | | Internet Service source group name. |
| | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | **internet\_service\_src\_id** list / elements=string | | Internet Service source ID. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | **internet\_service\_src\_name** list / elements=string | | Internet Service source name. |
| | | **name** string / required | | Internet Service name. Source firewall.internet-service-name.name. |
| | **internet\_service\_src\_negate** string | **Choices:*** enable
* disable
| When enabled internet-service-src specifies what the service must NOT be. |
| | **ippool** string | **Choices:*** enable
* disable
| Enable to use IP Pools for source NAT. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **label** string | | Label for the policy that appears when the GUI is in Section View mode. |
| | **learning\_mode** string | **Choices:*** enable
* disable
| Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. |
| | **logtraffic** string | **Choices:*** all
* utm
* disable
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic\_start** string | **Choices:*** enable
* disable
| Record logs when a session starts and ends. |
| | **match\_vip** string | **Choices:*** enable
* disable
| Enable to match packets that have had their destination addresses changed by a VIP. |
| | **match\_vip\_only** string | **Choices:*** enable
* disable
| Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. |
| | **mms\_profile** string | | Name of an existing MMS profile. Source firewall.mms-profile.name. |
| | **name** string | | Policy name. |
| | **nat** string | **Choices:*** enable
* disable
| Enable/disable source NAT. |
| | **natinbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: apply destination NAT to inbound traffic. |
| | **natip** string | | Policy-based IPsec VPN: source NAT IP address for outgoing traffic. |
| | **natoutbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: apply source NAT to outbound traffic. |
| | **np\_acceleration** string | **Choices:*** enable
* disable
| Enable/disable UTM Network Processor acceleration. |
| | **ntlm** string | **Choices:*** enable
* disable
| Enable/disable NTLM authentication. |
| | **ntlm\_enabled\_browsers** list / elements=string | | HTTP-User-Agent value of supported browsers. |
| | | **user\_agent\_string** string | | User agent string. |
| | **ntlm\_guest** string | **Choices:*** enable
* disable
| Enable/disable NTLM guest user access. |
| | **outbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. |
| | **passive\_wan\_health\_measurement** string | **Choices:*** enable
* disable
| Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. |
| | **per\_ip\_shaper** string | | Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
| | **permit\_any\_host** string | **Choices:*** enable
* disable
| Accept UDP packets from any host. |
| | **permit\_stun\_host** string | **Choices:*** enable
* disable
| Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. |
| | **policyid** integer / required | | Policy ID. |
| | **poolname** list / elements=string | | IP Pool names. |
| | | **name** string / required | | IP pool name. Source firewall.ippool.name. |
| | **poolname6** list / elements=string | | IPv6 pool names. |
| | | **name** string / required | | IPv6 pool name. Source firewall.ippool6.name. |
| | **profile\_group** string | | Name of profile group. Source firewall.profile-group.name. |
| | **profile\_protocol\_options** string | | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
| | **profile\_type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **radius\_mac\_auth\_bypass** string | **Choices:*** enable
* disable
| Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. |
| | **redirect\_url** string | | URL users are directed to after seeing and accepting the disclaimer or authenticating. |
| | **replacemsg\_override\_group** string | | Override the default replacement message group for this policy. Source system.replacemsg-group.name. |
| | **reputation\_direction** string | **Choices:*** source
* destination
| Direction of the initial traffic for reputation to take effect. |
| | **reputation\_minimum** integer | | Minimum Reputation to take action. Source firewall.internet-service-reputation.id. |
| | **rsso** string | **Choices:*** enable
* disable
| Enable/disable RADIUS single sign-on (RSSO). |
| | **rtp\_addr** list / elements=string | | Address names if this is an RTP NAT policy. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **rtp\_nat** string | **Choices:*** disable
* enable
| Enable Real Time Protocol (RTP) NAT. |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Block or monitor connections to Botnet servers or disable Botnet scanning. |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **schedule\_timeout** string | **Choices:*** enable
* disable
| Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity. |
| | **send\_deny\_packet** string | **Choices:*** disable
* enable
| Enable to send a reply when a session is denied or blocked by a firewall policy. |
| | **service** list / elements=string | | Service and service group names. |
| | | **name** string / required | | Service and service group names. Source firewall.service.custom.name firewall.service.group.name. |
| | **service\_negate** string | **Choices:*** enable
* disable
| When enabled service specifies what the service must NOT be. |
| | **session\_ttl** integer | | TTL in seconds for sessions accepted by this policy (0 means use the system ). |
| | **spamfilter\_profile** string | | Name of an existing Spam filter profile. Source spamfilter.profile.name. |
| | **src\_vendor\_mac** list / elements=string | | Vendor MAC source ID. |
| | | **id** integer / required | | Vendor MAC ID. Source firewall.vendor-mac.id. |
| | **srcaddr** list / elements=string | | Source address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **srcaddr6** list / elements=string | | Source IPv6 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
| | **srcaddr\_negate** string | **Choices:*** enable
* disable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **srcintf** list / elements=string | | Incoming (ingress) interface. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **ssh\_filter\_profile** string | | Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
| | **ssh\_policy\_redirect** string | **Choices:*** enable
* disable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl\_mirror** string | **Choices:*** enable
* disable
| Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). |
| | **ssl\_mirror\_intf** list / elements=string | | SSL mirror interface name. |
| | | **name** string / required | | Mirror Interface name. Source system.interface.name system.zone.name. |
| | **ssl\_ssh\_profile** string | | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable or disable this policy. |
| | **tcp\_mss\_receiver** integer | | Receiver TCP maximum segment size (MSS). |
| | **tcp\_mss\_sender** integer | | Sender TCP maximum segment size (MSS). |
| | **tcp\_session\_without\_syn** string | **Choices:*** all
* data-only
* disable
| Enable/disable creation of TCP session without SYN flag. |
| | **timeout\_send\_rst** string | **Choices:*** enable
* disable
| Enable/disable sending RST packets when TCP sessions expire. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos\_mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos\_negate** string | **Choices:*** enable
* disable
| Enable negated TOS match. |
| | **traffic\_shaper** string | | Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **url\_category** list / elements=string | | URL category ID list. |
| | | **id** integer / required | | URL category ID. |
| | **users** list / elements=string | | Names of individual users that can authenticate with this policy. |
| | | **name** string / required | | Names of individual users that can authenticate with this policy. Source user.local.name. |
| | **utm\_status** string | **Choices:*** enable
* disable
| Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter\_profile** string | | Name of an existing VideoFilter profile. Source videofilter.profile.name. |
| | **vlan\_cos\_fwd** integer | | VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. |
| | **vlan\_cos\_rev** integer | | VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest.. |
| | **vlan\_filter** string | | Set VLAN filters. |
| | **voip\_profile** string | | Name of an existing VoIP profile. Source voip.profile.name. |
| | **vpntunnel** string | | Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. |
| | **waf\_profile** string | | Name of an existing Web application firewall profile. Source waf.profile.name. |
| | **wanopt** string | **Choices:*** enable
* disable
| Enable/disable WAN optimization. |
| | **wanopt\_detection** string | **Choices:*** active
* passive
* False
| WAN optimization auto-detection mode. |
| | **wanopt\_passive\_opt** string | **Choices:*** default
* transparent
* non-transparent
| WAN optimization passive mode options. This option decides what IP address will be used to connect server. |
| | **wanopt\_peer** string | | WAN optimization peer. Source wanopt.peer.peer-host-id. |
| | **wanopt\_profile** string | | WAN optimization profile. Source wanopt.profile.name. |
| | **wccp** string | **Choices:*** enable
* disable
| Enable/disable forwarding traffic matching this policy to a configured WCCP server. |
| | **webcache** string | **Choices:*** enable
* disable
| Enable/disable web cache. |
| | **webcache\_https** string | **Choices:*** disable
* enable
| Enable/disable web cache for HTTPS. |
| | **webfilter\_profile** string | | Name of an existing Web filter profile. Source webfilter.profile.name. |
| | **webproxy\_forward\_server** string | | Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
| | **webproxy\_profile** string | | Webproxy profile name. Source web-proxy.profile.name. |
| | **wsso** string | **Choices:*** enable
* disable
| Enable/disable WiFi Single Sign On (WSSO). |
| | **ztna\_ems\_tag** list / elements=string | | Source ztna-ems-tag names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **ztna\_geo\_tag** list / elements=string | | Source ztna-geo-tag names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **ztna\_status** string | **Choices:*** enable
* disable
| Enable/disable zero trust access. |
| **self** string | | mkey of self identifier |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
* Adjust object order by moving self after(before) another.
* Only one of [after, before] must be specified when action is moving an object.
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 policies.
fortios_firewall_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
application:
-
id: "10"
application_list: "<your_own_value> (source application.list.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_path: "enable"
auth_redirect_addr: "<your_own_value>"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
block_notification: "enable"
captive_portal_exempt: "enable"
capture_packet: "enable"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
delay_tcp_npu_session: "enable"
devices:
-
name: "default_name_27 (source user.device.alias user.device-group.name user.device-category.name)"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
disclaimer: "enable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dscp_match: "enable"
dscp_negate: "enable"
dscp_value: "<your_own_value>"
dsri: "enable"
dstaddr:
-
name: "default_name_40 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_43 (source firewall.address6.name firewall.addrgrp6.name firewall.vipgrp6.name firewall.vip6.name system.external-resource
.name)"
dstintf:
-
name: "default_name_45 (source system.interface.name system.zone.name)"
dynamic_shaping: "enable"
email_collect: "enable"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso: "enable"
fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
fsso_groups:
-
name: "default_name_55 (source user.adgrp.name)"
geoip_anycast: "enable"
geoip_match: "physical-location"
global_label: "<your_own_value>"
groups:
-
name: "default_name_60 (source user.group.name)"
gtp_profile: "<your_own_value> (source firewall.gtp.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
identity_based_route: "<your_own_value> (source firewall.identity-based-route.name)"
inbound: "enable"
inspection_mode: "proxy"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_69 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_71 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_73 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "75 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_77 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_81 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_83 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_85 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "87 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_89 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
label: "<your_own_value>"
learning_mode: "enable"
logtraffic: "all"
logtraffic_start: "enable"
match_vip: "enable"
match_vip_only: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_100"
nat: "enable"
natinbound: "enable"
natip: "<your_own_value>"
natoutbound: "enable"
np_acceleration: "enable"
ntlm: "enable"
ntlm_enabled_browsers:
-
user_agent_string: "<your_own_value>"
ntlm_guest: "enable"
outbound: "enable"
passive_wan_health_measurement: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
permit_stun_host: "enable"
policyid: "115"
poolname:
-
name: "default_name_117 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_119 (source firewall.ippool6.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
radius_mac_auth_bypass: "enable"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
reputation_direction: "source"
reputation_minimum: "127 (source firewall.internet-service-reputation.id)"
rsso: "enable"
rtp_addr:
-
name: "default_name_130 (source firewall.address.name firewall.addrgrp.name)"
rtp_nat: "disable"
scan_botnet_connections: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
schedule_timeout: "enable"
send_deny_packet: "disable"
service:
-
name: "default_name_137 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "139"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
src_vendor_mac:
-
id: "142 (source firewall.vendor-mac.id)"
srcaddr:
-
name: "default_name_144 (source firewall.address.name firewall.addrgrp.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_147 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_149 (source system.interface.name system.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_154 (source system.interface.name system.zone.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "157"
tcp_mss_sender: "158"
tcp_session_without_syn: "all"
timeout_send_rst: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "167"
users:
-
name: "default_name_169 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
vlan_cos_fwd: "173"
vlan_cos_rev: "174"
vlan_filter: "<your_own_value>"
voip_profile: "<your_own_value> (source voip.profile.name)"
vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
wanopt: "enable"
wanopt_detection: "active"
wanopt_passive_opt: "default"
wanopt_peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
wanopt_profile: "<your_own_value> (source wanopt.profile.name)"
wccp: "enable"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
wsso: "enable"
ztna_ems_tag:
-
name: "default_name_192 (source firewall.address.name firewall.addrgrp.name)"
ztna_geo_tag:
-
name: "default_name_194 (source firewall.address.name firewall.addrgrp.name)"
ztna_status: "enable"
- name: move firewall.policy
fortios_firewall_policy:
vdom: "root"
action: "move"
self: "<mkey of self identifier>"
after: "<mkey of target identifier>"
#before: "<mkey of target identifier>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_vipgrp46 – Configure IPv4 to IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vipgrp46 – Configure IPv4 to IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vipgrp46`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp46 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vipgrp46** dictionary | | Configure IPv4 to IPv6 virtual IP groups. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32). |
| | **comments** string | | Comment. |
| | **member** list / elements=string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | | **name** string / required | | VIP46 name. Source firewall.vip46.name. |
| | **name** string / required | | VIP46 group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 to IPv6 virtual IP groups.
fortios_firewall_vipgrp46:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vipgrp46:
color: "3"
comments: "<your_own_value>"
member:
-
name: "default_name_6 (source firewall.vip46.name)"
name: "default_name_7"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ssl_web_user_bookmark – Configure SSL VPN user bookmark in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_web\_user\_bookmark – Configure SSL VPN user bookmark in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ssl_web_user_bookmark`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ssl\_web feature and user\_bookmark 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ssl\_web\_user\_bookmark** dictionary | | Configure SSL VPN user bookmark. |
| | **bookmarks** list / elements=string | | Bookmark table. |
| | | **additional\_params** string | | Additional parameters. |
| | | **apptype** string | **Choices:*** citrix
* ftp
* portforward
* rdp
* smb
* ssh
* telnet
* vnc
* web
* sftp
| Application type. |
| | | **description** string | | Description. |
| | | **domain** string | | Login domain. |
| | | **folder** string | | Network shared file folder parameter. |
| | | **form\_data** list / elements=string | | Form data. |
| | | | **name** string / required | | Name. |
| | | | **value** string | | Value. |
| | | **host** string | | Host name/IP parameter. |
| | | **listening\_port** integer | | Listening port (0 - 65535). |
| | | **load\_balancing\_info** string | | The load balancing information or cookie which should be provided to the connection broker. |
| | | **logon\_password** string | | Logon password. |
| | | **logon\_user** string | | Logon user. |
| | | **name** string / required | | Bookmark name. |
| | | **port** integer | | Remote port. |
| | | **preconnection\_blob** string | | An arbitrary string which identifies the RDP source. |
| | | **preconnection\_id** integer | | The numeric ID of the RDP source (0-2147483648). |
| | | **remote\_port** integer | | Remote port (0 - 65535). |
| | | **security** string | **Choices:*** rdp
* nla
* tls
* any
| Security mode for RDP connection. |
| | | **server\_layout** string | **Choices:*** de-de-qwertz
* en-gb-qwerty
* en-us-qwerty
* es-es-qwerty
* fr-fr-azerty
* fr-ch-qwertz
* it-it-qwerty
* ja-jp-qwerty
* pt-br-qwerty
* sv-se-qwerty
* tr-tr-qwerty
* failsafe
* fr-ca-qwerty
| Server side keyboard layout. |
| | | **show\_status\_window** string | **Choices:*** enable
* disable
| Enable/disable showing of status window. |
| | | **sso** string | **Choices:*** disable
* static
* auto
| Single Sign-On. |
| | | **sso\_credential** string | **Choices:*** sslvpn-login
* alternative
| Single sign-on credentials. |
| | | **sso\_credential\_sent\_once** string | **Choices:*** enable
* disable
| Single sign-on credentials are only sent once to remote server. |
| | | **sso\_password** string | | SSO password. |
| | | **sso\_username** string | | SSO user name. |
| | | **url** string | | URL parameter. |
| | **custom\_lang** string | | Personal language. Source system.custom-language.name. |
| | **name** string / required | | User and group name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SSL VPN user bookmark.
fortios_vpn_ssl_web_user_bookmark:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_user_bookmark:
bookmarks:
-
additional_params: "<your_own_value>"
apptype: "citrix"
description: "<your_own_value>"
domain: "<your_own_value>"
folder: "<your_own_value>"
form_data:
-
name: "default_name_10"
value: "<your_own_value>"
host: "<your_own_value>"
listening_port: "13"
load_balancing_info: "<your_own_value>"
logon_password: "<your_own_value>"
logon_user: "<your_own_value>"
name: "default_name_17"
port: "18"
preconnection_blob: "<your_own_value>"
preconnection_id: "20"
remote_port: "21"
security: "rdp"
server_layout: "de-de-qwertz"
show_status_window: "enable"
sso: "disable"
sso_credential: "sslvpn-login"
sso_credential_sent_once: "enable"
sso_password: "<your_own_value>"
sso_username: "<your_own_value>"
url: "myurl.com"
custom_lang: "<your_own_value> (source system.custom-language.name)"
name: "default_name_32"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_session_helper – Configure session helper in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_session\_helper – Configure session helper in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_session_helper`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and session\_helper 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_session\_helper** dictionary | | Configure session helper. |
| | **id** integer / required | | Session helper ID. |
| | **name** string | **Choices:*** ftp
* tftp
* ras
* h323
* tns
* mms
* sip
* pptp
* rtsp
* dns-udp
* dns-tcp
* pmap
* rsh
* dcerpc
* mgcp
* gtp-c
* gtp-u
* gtp-b
| Helper name. |
| | **port** integer | | Protocol port. |
| | **protocol** integer | | Protocol number. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure session helper.
fortios_system_session_helper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_session_helper:
id: "3"
name: "default_name_4"
port: "5"
protocol: "6"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_policy6 – Configure IPv6 policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_policy6 – Configure IPv6 policies in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_policy6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_policy6** dictionary | | Configure IPv6 policies. |
| | **action** string | **Choices:*** accept
* deny
* ipsec
| Policy action (allow/deny/ipsec). |
| | **anti\_replay** string | **Choices:*** enable
* disable
| Enable/disable anti-replay check. |
| | **app\_category** list / elements=string | | Application category ID list. |
| | | **id** integer / required | | Category IDs. |
| | **app\_group** list / elements=string | | Application group names. |
| | | **name** string / required | | Application group names. Source application.group.name. |
| | **application** list / elements=string | | Application ID list. |
| | | **id** integer / required | | Application IDs. |
| | **application\_list** string | | Name of an existing Application list. Source application.list.name. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable policy traffic ASIC offloading. |
| | **av\_profile** string | | Name of an existing Antivirus profile. Source antivirus.profile.name. |
| | **cifs\_profile** string | | Name of an existing CIFS profile. Source cifs.profile.name. |
| | **comments** string | | Comment. |
| | **custom\_log\_fields** list / elements=string | | Log field index numbers to append custom log fields to log messages for this policy. |
| | | **field\_id** string | | Custom log field. Source log.custom-field.id. |
| | **devices** list / elements=string | | Names of devices or device groups that can be matched by the policy. |
| | | **name** string / required | | Device or group name. Source user.device.alias user.device-group.name user.device-category.name. |
| | **diffserv\_forward** string | **Choices:*** enable
* disable
| Enable to change packet"s DiffServ values to the specified diffservcode-forward value. |
| | **diffserv\_reverse** string | **Choices:*** enable
* disable
| Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode\_forward** string | | Change packet"s DiffServ to this value. |
| | **diffservcode\_rev** string | | Change packet"s reverse (reply) DiffServ to this value. |
| | **dlp\_sensor** string | | Name of an existing DLP sensor. Source dlp.sensor.name. |
| | **dnsfilter\_profile** string | | Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
| | **dscp\_match** string | **Choices:*** enable
* disable
| Enable DSCP check. |
| | **dscp\_negate** string | **Choices:*** enable
* disable
| Enable negated DSCP match. |
| | **dscp\_value** string | | DSCP value. |
| | **dsri** string | **Choices:*** enable
* disable
| Enable DSRI to ignore HTTP server responses. |
| | **dstaddr** list / elements=string | | Destination address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **dstintf** list / elements=string | | Outgoing (egress) interface. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **firewall\_session\_dirty** string | **Choices:*** check-all
* check-new
| How to handle sessions if the configuration of this firewall policy changes. |
| | **fixedport** string | **Choices:*** enable
* disable
| Enable to prevent source NAT from changing a session"s source port. |
| | **fsso\_groups** list / elements=string | | Names of FSSO groups. |
| | | **name** string / required | | Names of FSSO groups. Source user.adgrp.name. |
| | **global\_label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** list / elements=string | | Names of user groups that can authenticate with this policy. |
| | | **name** string / required | | Group name. Source user.group.name. |
| | **http\_policy\_redirect** string | **Choices:*** enable
* disable
| Redirect HTTP(S) traffic to matching transparent web proxy policy. |
| | **icap\_profile** string | | Name of an existing ICAP profile. Source icap.profile.name. |
| | **inbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. |
| | **inspection\_mode** string | **Choices:*** proxy
* flow
| Policy inspection mode (Flow/proxy). Default is Flow mode. |
| | **ippool** string | **Choices:*** enable
* disable
| Enable to use IP Pools for source NAT. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **label** string | | Label for the policy that appears when the GUI is in Section View mode. |
| | **logtraffic** string | **Choices:*** all
* utm
* disable
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic\_start** string | **Choices:*** enable
* disable
| Record logs when a session starts and ends. |
| | **mms\_profile** string | | Name of an existing MMS profile. Source firewall.mms-profile.name. |
| | **name** string | | Policy name. |
| | **nat** string | **Choices:*** enable
* disable
| Enable/disable source NAT. |
| | **natinbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: apply destination NAT to inbound traffic. |
| | **natoutbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: apply source NAT to outbound traffic. |
| | **np\_acceleration** string | **Choices:*** enable
* disable
| Enable/disable UTM Network Processor acceleration. |
| | **outbound** string | **Choices:*** enable
* disable
| Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. |
| | **per\_ip\_shaper** string | | Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
| | **policyid** integer / required | | Policy ID. |
| | **poolname** list / elements=string | | IP Pool names. |
| | | **name** string / required | | IP pool name. Source firewall.ippool6.name. |
| | **profile\_group** string | | Name of profile group. Source firewall.profile-group.name. |
| | **profile\_protocol\_options** string | | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
| | **profile\_type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **replacemsg\_override\_group** string | | Override the default replacement message group for this policy. Source system.replacemsg-group.name. |
| | **rsso** string | **Choices:*** enable
* disable
| Enable/disable RADIUS single sign-on (RSSO). |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **send\_deny\_packet** string | **Choices:*** enable
* disable
| Enable/disable return of deny-packet. |
| | **service** list / elements=string | | Service and service group names. |
| | | **name** string / required | | Address name. Source firewall.service.custom.name firewall.service.group.name. |
| | **service\_negate** string | **Choices:*** enable
* disable
| When enabled service specifies what the service must NOT be. |
| | **session\_ttl** integer | | Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. |
| | **spamfilter\_profile** string | | Name of an existing Spam filter profile. Source spamfilter.profile.name. |
| | **srcaddr** list / elements=string | | Source address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **srcaddr\_negate** string | **Choices:*** enable
* disable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **srcintf** list / elements=string | | Incoming (ingress) interface. |
| | | **name** string / required | | Interface name. Source system.zone.name system.interface.name. |
| | **ssh\_filter\_profile** string | | Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
| | **ssh\_policy\_redirect** string | **Choices:*** enable
* disable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl\_mirror** string | **Choices:*** enable
* disable
| Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). |
| | **ssl\_mirror\_intf** list / elements=string | | SSL mirror interface name. |
| | | **name** string / required | | Interface name. Source system.zone.name system.interface.name. |
| | **ssl\_ssh\_profile** string | | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable or disable this policy. |
| | **tcp\_mss\_receiver** integer | | Receiver TCP maximum segment size (MSS). |
| | **tcp\_mss\_sender** integer | | Sender TCP maximum segment size (MSS). |
| | **tcp\_session\_without\_syn** string | **Choices:*** all
* data-only
* disable
| Enable/disable creation of TCP session without SYN flag. |
| | **timeout\_send\_rst** string | **Choices:*** enable
* disable
| Enable/disable sending RST packets when TCP sessions expire. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos\_mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos\_negate** string | **Choices:*** enable
* disable
| Enable negated TOS match. |
| | **traffic\_shaper** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **url\_category** list / elements=string | | URL category ID list. |
| | | **id** integer / required | | URL category ID. |
| | **users** list / elements=string | | Names of individual users that can authenticate with this policy. |
| | | **name** string / required | | Names of individual users that can authenticate with this policy. Source user.local.name. |
| | **utm\_status** string | **Choices:*** enable
* disable
| Enable AV/web/ips protection profile. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **vlan\_cos\_fwd** integer | | VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest |
| | **vlan\_cos\_rev** integer | | VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest |
| | **vlan\_filter** string | | Set VLAN filters. |
| | **voip\_profile** string | | Name of an existing VoIP profile. Source voip.profile.name. |
| | **vpntunnel** string | | Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. |
| | **waf\_profile** string | | Name of an existing Web application firewall profile. Source waf.profile.name. |
| | **webcache** string | **Choices:*** enable
* disable
| Enable/disable web cache. |
| | **webcache\_https** string | **Choices:*** disable
* enable
| Enable/disable web cache for HTTPS. |
| | **webfilter\_profile** string | | Name of an existing Web filter profile. Source webfilter.profile.name. |
| | **webproxy\_forward\_server** string | | Web proxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
| | **webproxy\_profile** string | | Webproxy profile name. Source web-proxy.profile.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 policies.
fortios_firewall_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy6:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
application:
-
id: "10"
application_list: "<your_own_value> (source application.list.name)"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
devices:
-
name: "default_name_19 (source user.device.alias user.device-group.name user.device-category.name)"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dscp_match: "enable"
dscp_negate: "enable"
dscp_value: "<your_own_value>"
dsri: "enable"
dstaddr:
-
name: "default_name_31 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name)"
dstaddr_negate: "enable"
dstintf:
-
name: "default_name_34 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso_groups:
-
name: "default_name_39 (source user.adgrp.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_42 (source user.group.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
inbound: "enable"
inspection_mode: "proxy"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
label: "<your_own_value>"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_53"
nat: "enable"
natinbound: "enable"
natoutbound: "enable"
np_acceleration: "enable"
outbound: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
policyid: "60"
poolname:
-
name: "default_name_62 (source firewall.ippool6.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
rsso: "enable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
send_deny_packet: "enable"
service:
-
name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "73"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_76 (source firewall.address6.name firewall.addrgrp6.name)"
srcaddr_negate: "enable"
srcintf:
-
name: "default_name_79 (source system.zone.name system.interface.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_84 (source system.zone.name system.interface.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "87"
tcp_mss_sender: "88"
tcp_session_without_syn: "all"
timeout_send_rst: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "97"
users:
-
name: "default_name_99 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
vlan_cos_fwd: "102"
vlan_cos_rev: "103"
vlan_filter: "<your_own_value>"
voip_profile: "<your_own_value> (source voip.profile.name)"
vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_replacemsg_mail – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mail – Replacement messages in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_mail`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and mail 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_mail** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mail:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mail:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_ipv6_tunnel – Configure IPv6/IPv4 in IPv6 tunnel in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ipv6\_tunnel – Configure IPv6/IPv4 in IPv6 tunnel in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ipv6_tunnel`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipv6\_tunnel 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_ipv6\_tunnel** dictionary | | Configure IPv6/IPv4 in IPv6 tunnel. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable tunnel ASIC offloading. |
| | **destination** string | | Remote IPv6 address of the tunnel. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **name** string / required | | IPv6 tunnel name. |
| | **source** string | | Local IPv6 address of the tunnel. |
| | **use\_sdwan** string | **Choices:*** disable
* enable
| Enable/disable use of SD-WAN to reach remote gateway. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6/IPv4 in IPv6 tunnel.
fortios_system_ipv6_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ipv6_tunnel:
auto_asic_offload: "enable"
destination: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
name: "default_name_6"
source: "<your_own_value>"
use_sdwan: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_configuration_fact – Retrieve Facts of FortiOS Configurable Objects. fortinet.fortios.fortios\_configuration\_fact – Retrieve Facts of FortiOS Configurable Objects.
===============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_configuration_fact`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Collects facts from network devices running the fortios operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. This facts module will only collect those facts which user specified in playbook.
Requirements
------------
The below requirements are needed on the host that executes this module.
* install galaxy collection fortinet.fortios >= 2.0.0.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **filters** list / elements=string | | A list of expressions to filter the returned results. The items of the list are combined as LOGICAL AND with operator ampersand. One item itself could be concatenated with a comma as LOGICAL OR. |
| **formatters** list / elements=string | | A list of fields to display for returned results. |
| **params** dictionary | | the parameter for each selector, see definition in above list. |
| **selector** string / required | **Choices:*** log\_gui-display
* system\_fortiguard-service
* router\_route-map
* system\_sso-admin
* wireless-controller\_address
* vpn.ssl\_monitor
* system.auto-update\_status
* system\_cmdb
* authentication\_rule
* log.fortianalyzer\_override-setting
* firewall.ssl\_setting
* vpn.ipsec\_phase2-interface
* router\_key-chain
* system\_ddns
* firewall\_traffic-class
* system\_replacemsg-group
* system\_ftm-push
* system\_sms-server
* firewall\_central-snat-map
* firewall\_multicast-address6
* vpn.status.ssl\_hw-acceleration-status
* system.replacemsg\_sslvpn
* ips\_view-map
* system\_pppoe-interface
* webfilter\_categories
* firewall\_addrgrp6
* log.disk\_filter
* system.session-info\_full-stat
* firewall\_proxy-address
* emailfilter\_block-allow-list
* router\_bgp
* switch-controller\_custom-command
* system\_resource-limits
* system.replacemsg\_auth
* system.autoupdate\_schedule
* waf\_sub-class
* firewall\_local-in-policy6
* log.fortianalyzer2\_override-setting
* log.fortianalyzer\_override-filter
* system.replacemsg\_icap
* system\_object-tagging
* spamfilter\_profile
* switch-controller\_remote-log
* system.replacemsg\_mms
* switch-controller.security-policy\_local-access
* web-proxy\_profile
* log.fortianalyzer-cloud\_override-filter
* spamfilter\_mheader
* system\_smc-ntp
* user\_adgrp
* system\_auto-script
* switch-controller\_quarantine
* firewall.service\_category
* system\_standalone-cluster
* system\_link-monitor
* switch-controller\_stp-settings
* user\_security-exempt-list
* log.fortianalyzer-cloud\_setting
* switch-controller.qos\_qos-policy
* firewall\_sniffer
* wireless-controller\_ssid-policy
* wireless-controller\_wag-profile
* log.fortiguard\_override-setting
* system.replacemsg\_mm7
* system.replacemsg\_mm4
* firewall\_internet-service
* system.replacemsg\_mm3
* system.replacemsg\_mm1
* firewall.iprope.appctrl\_status
* firewall\_vipgrp46
* log.webtrends\_filter
* webfilter\_ips-urlfilter-setting6
* system\_sso-forticloud-admin
* gtp\_apngrp
* log\_setting
* firewall\_address6-template
* wireless-controller\_scan
* wireless-controller.hotspot20\_h2qp-wan-metric
* system\_automation-action
* system.autoupdate\_tunneling
* webfilter\_ips-urlfilter-setting
* switch-controller\_network-monitor-settings
* system\_alias
* switch-controller\_mac-sync-settings
* web-proxy\_forward-server-group
* system\_session-helper
* router\_community-list
* wireless-controller\_qos-profile
* firewall\_dnstranslation
* vpn.ssl.web\_portal
* system\_vdom-property
* system.replacemsg\_device-detection-portal
* log.syslogd2\_setting
* firewall\_internet-service-custom-group
* system.performance.firewall\_statistics
* firewall\_profile-group
* firewall.service\_group
* system.autoupdate\_push-update
* firewall\_address6
* endpoint-control\_profile
* wireless-controller\_vap-status
* wireless-controller\_wids-profile
* emailfilter\_bword
* log.fortiguard\_filter
* firewall\_ipv6-eh-filter
* switch-controller.ptp\_settings
* endpoint-control\_fctems
* user\_device-category
* firewall\_identity-based-route
* system.session-helper-info\_list
* system\_console
* firewall.iprope.appctrl\_list
* system\_ntp
* firewall\_access-proxy-virtual-host
* system\_nat64
* report\_layout
* wireless-controller\_timers
* wireless-controller.hotspot20\_icon
* log.memory\_global-setting
* router\_multicast-flow
* ssh-filter\_profile
* system\_fortisandbox
* system\_virtual-wan-link
* ips\_sensor
* firewall.wildcard-fqdn\_custom
* router\_static
* alertemail\_setting
* user\_fortitoken
* web-proxy\_debug-url
* vpn.ike\_gateway
* webfilter\_override
* switch-controller\_nac-device
* system\_fsso-polling
* user\_peer
* vpn.ssl.web\_host-check-software
* gtp\_message-filter-v0v1
* switch-controller\_lldp-profile
* switch-controller\_dynamic-port-policy
* system.replacemsg\_nac-quar
* system\_stp
* user\_nac-policy
* wireless-controller\_snmp
* emailfilter\_fortishield
* switch-controller.security-policy\_captive-portal
* firewall\_shaping-policy
* wireless-controller\_wlchanlistlic
* log\_custom-field
* switch-controller\_mac-policy
* firewall\_address
* certificate\_crl
* firewall.ssh\_setting
* vpn.ssl.web\_realm
* switch-controller.auto-config\_policy
* router\_access-list
* system\_nd-proxy
* log.memory\_setting
* system\_alarm
* system\_ipv6-neighbor-cache
* wireless-controller\_log
* extender\_lte-carrier-by-mcc-mnc
* webfilter\_ftgd-statistics
* hardware.npu.np6\_ipsec-stats
* firewall\_vendor-mac-summary
* system\_cluster-sync
* wanopt\_settings
* emailfilter\_dnsbl
* endpoint-control\_registered-forticlient
* system\_dedicated-mgmt
* file-filter\_profile
* log.fortianalyzer-cloud\_override-setting
* firewall\_policy46
* system.source-ip\_status
* system\_modem
* router\_static6
* firewall\_decrypted-traffic-mirror
* antivirus\_settings
* switch-controller\_storm-control-policy
* switch-controller\_802-1X-settings
* system\_session-ttl
* system\_storage
* system\_isf-queue-profile
* log.memory\_filter
* firewall\_auth-portal
* antivirus\_notification
* user\_ldap
* ips\_global
* wanopt\_remote-storage
* system\_speed-test-schedule
* wireless-controller.hotspot20\_qos-map
* system.session-info\_ttl
* vpn\_l2tp
* monitoring\_np6-ipsec-engine
* system\_npu
* firewall\_vip46
* authentication\_setting
* vpn.certificate\_ocsp-server
* antivirus\_heuristic
* spamfilter\_bword
* system\_custom-language
* web-proxy\_explicit
* log.syslogd3\_override-setting
* wireless-controller\_wtp-group
* system\_vdom-sflow
* switch-controller\_igmp-snooping
* waf\_signature
* log.null-device\_setting
* ips\_rule-settings
* log.syslogd\_setting
* system.session-info\_expectation
* switch-controller.security-policy\_802-1X
* system\_np6
* report\_setting
* gtp\_tunnel-limit
* user\_setting
* icap\_profile
* system\_geoip-override
* vpn.ipsec\_phase1
* vpn.ipsec\_phase2
* wireless-controller.hotspot20\_anqp-network-auth-type
* webfilter\_ips-urlfilter-cache-setting
* firewall.ipmacbinding\_setting
* log.fortianalyzer2\_filter
* system.ip-conflict\_status
* application\_rule-settings
* switch-controller\_flow-tracking
* log.syslogd4\_filter
* system\_speed-test-server
* firewall\_acl
* system\_proxy-arp
* webfilter\_ftgd-local-rating
* switch-controller\_snmp-user
* nsxt\_setting
* ips\_custom
* switch-controller\_switch-interface-tag
* router\_policy6
* switch-controller.qos\_ip-dscp-map
* log\_eventfilter
* firewall\_internet-service-custom
* switch-controller\_traffic-sniffer
* router\_auth-path
* firewall\_internet-service-ipbl-reason
* system\_external-resource
* firewall\_security-policy
* user\_exchange
* system\_ips-urlfilter-dns6
* vpn.ipsec.tunnel\_details
* report\_style
* log.syslogd2\_override-filter
* wireless-controller\_wtp
* wireless-controller\_rf-analysis
* system\_ipip-tunnel
* system\_saml
* system.dhcp6\_server
* emailfilter\_profile
* hardware.npu.np6\_sse-stats
* log.fortianalyzer3\_override-filter
* hardware\_status
* firewall\_multicast-policy
* vpn\_ocvpn
* spamfilter\_bwl
* switch-controller\_fortilink-settings
* firewall\_proute6
* system\_arp
* firewall\_internet-service-addition
* webfilter\_status
* system\_ips
* emailfilter\_bwl
* system\_password-policy
* wireless-controller\_mpsk-profile
* switch-controller\_virtual-port-pool
* wireless-controller\_setting
* system.3g-modem\_custom
* wireless-controller.hotspot20\_anqp-ip-address-type
* firewall\_vipgrp
* switch-controller\_switch-profile
* vpn.ipsec.stats\_tunnel
* system\_switch-interface
* router\_isis
* firewall\_policy
* log.syslogd\_override-setting
* system\_lte-modem
* firewall\_access-proxy
* router\_info
* system.performance.firewall\_packet-distribution
* webfilter\_content
* firewall\_vipgrp6
* emailfilter\_mheader
* firewall.shaper\_traffic
* firewall.schedule\_onetime
* antivirus\_profile
* gtp\_ie-allow-list
* log.fortianalyzer\_setting
* videofilter\_youtube-key
* vpn.ipsec.tunnel\_name
* firewall\_ippool6
* wireless-controller\_status
* system\_central-management
* system.replacemsg\_http
* vpn.status.ssl\_list
* vpn.ipsec.tunnel\_summary
* hardware.npu.np6\_session-stats
* cifs\_domain-controller
* system\_zone
* system\_vdom-dns
* firewall\_multicast-address
* wireless-controller\_wtp-profile
* vpn.ssl\_settings
* router\_ospf
* switch-controller.qos\_queue-policy
* dpdk\_cpus
* endpoint-control\_forticlient-ems
* ftp-proxy\_explicit
* hardware.npu.np6\_port-list
* user\_device-group
* vpn.certificate\_crl
* system.replacemsg\_admin
* wireless-controller\_wtp-status
* webfilter\_profile
* switch-controller\_storm-control
* firewall\_ssl-ssh-profile
* vpn.ssl\_client
* gtp\_ie-white-list
* firewall\_city
* log.disk\_setting
* nsxt\_service-chain
* dlp\_filepattern
* firewall\_acl6
* firewall\_ippool
* web-proxy\_url-match
* dlp\_fp-sensitivity
* system\_interface
* log.syslogd3\_override-filter
* router\_bfd
* system\_fortimanager
* firewall\_internet-service-extension
* system.replacemsg\_webproxy
* user\_password-policy
* wireless-controller\_inter-controller
* certificate\_remote
* log.syslogd4\_setting
* firewall\_internet-service-owner
* hardware\_cpu
* switch-controller\_switch-group
* user\_fsso
* firewall\_vipgrp64
* user\_quarantine
* system\_ips-urlfilter-dns
* wireless-controller\_addrgrp
* system\_fm
* wireless-controller\_apcfg-profile
* system\_global
* vpn.ipsec.stats\_crypto
* wireless-controller.hotspot20\_anqp-nai-realm
* hardware\_memory
* system\_physical-switch
* system\_affinity-packet-redistribution
* system\_status
* firewall\_gtp
* firewall\_internet-service-reputation
* firewall\_proute
* videofilter\_profile
* log.fortianalyzer3\_setting
* system.auto-update\_versions
* firewall\_vip
* system\_virtual-switch
* firewall\_mms-profile
* wanopt\_auth-group
* wanopt\_webcache
* system.snmp\_user
* firewall\_ip-translation
* system\_settings
* log.fortianalyzer2\_setting
* wireless-controller\_vap
* ipsec\_tunnel
* wanopt\_cache-service
* log.syslogd4\_override-filter
* switch-controller\_switch-log
* firewall\_internet-service-group
* system.replacemsg\_mail
* extender\_modem-status
* system\_replacemsg-image
* system.performance\_status
* system\_acme
* antivirus\_quarantine
* switch-controller.initial-config\_template
* log.fortianalyzer2\_override-filter
* system.session-info\_list
* vpn.certificate\_ca
* endpoint-control\_forticlient-registration-sync
* system\_sdn-connector
* vpn.ssl.web\_user-group-bookmark
* system\_fortiguard-log-service
* endpoint-control\_settings
* system\_central-mgmt
* hardware\_nic
* log.null-device\_filter
* gtp\_message-filter-v2
* dlp\_settings
* wireless-controller\_utm-profile
* router\_rip
* router\_aspath-list
* firewall.schedule\_group
* firewall\_internet-service-list
* system\_dscp-based-priority
* dlp\_sensitivity
* icap\_server
* vpn.ipsec\_phase1-interface
* authentication\_scheme
* router\_prefix-list6
* system\_sdwan
* log.fortianalyzer3\_filter
* system\_email-server
* dlp\_sensor
* application\_list
* firewall\_internet-service-append
* vpn.ssl.web\_user-bookmark
* firewall.shaper\_traffic-shaper
* system\_management-tunnel
* system\_csf
* firewall.shaper\_per-ip-shaper
* switch-controller.ptp\_policy
* switch-controller\_stp-instance
* mgmt-data\_status
* dnsfilter\_profile
* user\_device-access-list
* system\_ha-monitor
* monitoring\_npu-hpe
* wireless-controller.hotspot20\_anqp-venue-name
* system.snmp\_sysinfo
* system\_session
* application\_custom
* ips\_session
* system\_api-user
* system.info.admin\_ssh
* ips\_rule
* spamfilter\_fortishield
* log.fortianalyzer-cloud\_filter
* system\_netflow
* vpn.ipsec\_forticlient
* system\_automation-trigger
* firewall\_policy64
* wireless-controller.hotspot20\_h2qp-osu-provider
* application\_name
* wireless-controller\_access-control-list
* firewall.service\_custom
* spamfilter\_iptrust
* firewall\_internet-service-botnet
* firewall\_internet-service-definition
* system\_mobile-tunnel
* wireless-controller\_nac-profile
* user\_saml
* firewall\_ttl-policy
* wireless-controller\_client-info
* system\_vne-tunnel
* system.replacemsg\_utm
* gtp\_apn
* vpn\_pptp
* wireless-controller.hotspot20\_hs-profile
* log.webtrends\_setting
* firewall\_local-in-policy
* extender-controller\_dataplan
* system\_gi-gk
* wireless-controller\_region
* router\_policy
* switch-controller\_port-policy
* switch-controller.qos\_dot1p-map
* firewall\_multicast-policy6
* switch-controller.initial-config\_vlans
* system\_federated-upgrade
* wanopt\_content-delivery-network-rule
* firewall\_region
* system\_dns-database
* waf\_main-class
* firewall\_policy6
* system\_vdom-radius-server
* system\_vdom
* user\_tacacs+
* wanopt\_peer
* log.syslogd3\_setting
* report\_dataset
* webfilter\_ftgd-local-cat
* router\_multicast6
* vpn.certificate\_remote
* extender\_lte-carrier-list
* system\_fips-cc
* switch-controller\_snmp-community
* system\_geneve
* system\_ha
* log.syslogd3\_filter
* user\_radius
* firewall\_DoS-policy6
* switch-controller.auto-config\_default
* system\_tos-based-priority
* vpn.certificate\_local
* system\_accprofile
* vpn.status\_pptp
* wireless-controller\_global
* log.syslogd\_filter
* vpn.status\_l2tp
* system\_ipsec-aggregate
* wireless-controller\_ap-status
* switch-controller\_poe
* log.syslogd2\_filter
* wireless-controller\_ble-profile
* system\_password-policy-guest-admin
* user\_pop3
* switch-controller\_vlan-policy
* system\_geoip-country
* switch-controller\_system
* videofilter\_youtube-channel-filter
* voip\_profile
* vpn.ipsec\_manualkey-interface
* emailfilter\_options
* system.info.admin\_status
* switch-controller\_snmp-sysinfo
* firewall\_internet-service-sld
* system\_vdom-netflow
* firewall.ipmacbinding\_table
* system\_automation-destination
* dlp\_fp-doc-source
* firewall\_ldb-monitor
* firewall.ssh\_host-key
* system\_vdom-link
* system\_admin
* system\_fortianalyzer-connectivity
* router\_ospf6
* user\_device
* log.fortiguard\_setting
* system.snmp\_community
* wireless-controller\_arrp-profile
* ips\_settings
* log.syslogd\_override-filter
* system\_vdom-exception
* system\_wccp
* antivirus\_mms-checksum
* router\_info6
* system\_ha-nonsync-csum
* system\_automation-stitch
* system\_mem-mgr
* firewall\_profile-protocol-options
* report\_theme
* firewall.ssh\_local-key
* system\_mgmt-csum
* system.performance\_top
* firewall\_vip64
* web-proxy\_wisp
* spamfilter\_options
* system.checksum\_status
* system\_dns-server
* system.replacemsg\_alertmail
* log.fortiguard\_override-filter
* endpoint-control\_client
* system\_fortiguard
* web-proxy\_global
* wanopt\_profile
* switch-controller\_traffic-policy
* wireless-controller.hotspot20\_anqp-3gpp-cellular
* system.replacemsg\_ec
* switch-controller\_vlan
* system\_vxlan
* switch-controller\_snmp-trap-threshold
* webfilter\_search-engine
* system\_ipv6-tunnel
* certificate\_local
* system.lldp\_network-policy
* user\_fsso-polling
* system.dhcp\_server
* report\_chart
* vpn.certificate\_setting
* router\_bfd6
* system.replacemsg\_nntp
* system.session-info\_statistics
* firewall\_proxy-policy
* system\_dns
* user\_peergrp
* vpn.ipsec\_concentrator
* webfilter\_override-usr
* ips\_decoder
* dnsfilter\_domain-filter
* report.sql\_status
* switch-controller.auto-config\_custom
* wireless-controller\_vap-group
* emailfilter\_iptrust
* system\_startup-error-log
* firewall\_internet-service-name
* system\_affinity-interrupt
* firewall\_shaping-profile
* log.syslogd4\_override-setting
* firewall\_interface-policy6
* vpn.ipsec\_manualkey
* firewall.shaper\_per-ip
* firewall\_vendor-mac
* switch-controller\_global
* router\_setting
* user\_local
* firewall.schedule\_recurring
* system\_sit-tunnel
* system\_arp-table
* firewall\_carrier-endpoint-bwl
* switch-controller\_lldp-settings
* webfilter\_content-header
* system\_auto-install
* log.fortianalyzer3\_override-setting
* user\_domain-controller
* router\_multicast
* firewall\_ssl-server
* system.replacemsg\_traffic-quota
* system\_virtual-wire-pair
* system\_mac-address-table
* system.replacemsg\_automation
* log.fortianalyzer\_filter
* system\_network-visibility
* firewall\_internet-service-ipbl-vendor
* switch-controller\_nac-settings
* firewall\_interface-policy
* extender\_extender-info
* system.replacemsg\_fortiguard-wf
* wireless-controller\_bonjour-profile
* gtp\_apn-shaper
* webfilter\_urlfilter
* wireless-controller\_spectral-info
* credential-store\_domain-controller
* hardware.npu.np6\_synproxy-stats
* system\_probe-response
* wireless-controller.hotspot20\_h2qp-operator-name
* switch-controller\_sflow
* cifs\_profile
* webfilter\_fortiguard
* extender\_sys-info
* wireless-controller.hotspot20\_anqp-roaming-consortium
* firewall\_DoS-policy
* firewall\_proxy-addrgrp
* firewall\_addrgrp
* system\_sflow
* router\_ripng
* firewall\_vip6
* web-proxy\_forward-server
* system.replacemsg\_spam
* certificate\_ca
* firewall\_country
* firewall.ssh\_local-ca
* spamfilter\_dnsbl
* switch-controller\_location
* firewall.consolidated\_policy
* router\_access-list6
* system\_session6
* hardware.npu.np6\_dce
* waf\_profile
* firewall.wildcard-fqdn\_group
* switch-controller\_managed-switch
* user\_group
* log.syslogd2\_override-setting
* user\_krb-keytab
* firewall.iprope\_list
* system\_ptp
* dpdk\_global
* application\_group
* system.replacemsg\_ftp
* log\_threat-weight
* extender-controller\_extender
* wireless-controller.hotspot20\_h2qp-conn-capability
* router\_prefix-list
* system\_gre-tunnel
* system\_ike
| selector of the retrieved fortigate facts |
| **selectors** list / elements=string | | A list of selectors. if parameter selector not specified, the module will use selectors. |
| **sorters** list / elements=string | | A list of expressions to sort the returned results. The items of the list are in ascending order with operator ampersand. One item itself could be in decending order with a comma inside. |
| **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
* Different selector may have different parameters, users are expected to look up them for a specific selector.
* For some selectors, the objects are global, no params are allowed to appear.
* If params is empty a non-unique object, the whole object list is returned.
* This module has support for all configuration API, excluding any monitor API.
* The result of API request is stored in results as a list.
Examples
--------
```
- hosts: fortigateslab
connection: httpapi
collections:
- fortinet.fortios
vars:
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
vdom: "root"
tasks:
- name: Get multiple selectors info concurrently
fortios_configuration_fact:
selectors:
- selector: firewall_address
params:
name: "gmail.com"
- selector: system_interface
- selector: log_eventfilter
params: {}
- name: fact gathering
fortios_configuration_fact:
vdom: ""
filters:
- name==port1
- vlanid==0
sorters:
- name,vlanid
- management-ip
formatters:
- name
- management-ip
- vlanid
selector: 'system_interface'
- name: get all
fortios_configuration_fact:
vdom: ""
access_token: ""
selector: log_custom-field
- name: get single
fortios_configuration_fact:
vdom: ""
access_token: ""
selector: log_custom-field
#optionally list or single get
params:
id: "3"
- name: fetch one firewall address
fortios_configuration_fact:
selector: firewall_address
params:
name: "login.microsoft.com"
- name: fetch all firewall addresses
fortios_configuration_fact:
selector: firewall_address
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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:** GET |
| **name** string | always | Name of the table used to fulfill the request **Sample:** firmware |
| **path** string | always | Path of the table used to fulfill the request **Sample:** system |
| **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 |
### Authors
* Jie Xue (@JieX19)
* Link Zheng (@chillancezen)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@fshen01)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_wildcard_fqdn_group – Config global Wildcard FQDN address groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_wildcard\_fqdn\_group – Config global Wildcard FQDN address groups in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_wildcard_fqdn_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_wildcard\_fqdn feature and group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_wildcard\_fqdn\_group** dictionary | | Config global Wildcard FQDN address groups. |
| | **color** integer | | GUI icon color. |
| | **comment** string | | Comment. |
| | **member** list / elements=string | | Address group members. |
| | | **name** string / required | | Address name. Source firewall.wildcard-fqdn.custom.name. |
| | **name** string / required | | Address group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable address visibility. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Config global Wildcard FQDN address groups.
fortios_firewall_wildcard_fqdn_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_wildcard_fqdn_group:
color: "3"
comment: "Comment."
member:
-
name: "default_name_6 (source firewall.wildcard-fqdn.custom.name)"
name: "default_name_7"
uuid: "<your_own_value>"
visibility: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_vap_status – Wireless controller VAP-status in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_vap\_status – Wireless controller VAP-status in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_vap_status`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and vap\_status 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_vap\_status** dictionary | | Wireless controller VAP-status. |
| | **set\_1** string | | verbose |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Wireless controller VAP-status.
fortios_wireless_controller_vap_status:
vdom: "{{ vdom }}"
wireless_controller_vap_status:
set_1: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ssl_ssh_profile – Configure SSL/SSH protocol options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssl\_ssh\_profile – Configure SSL/SSH protocol options in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ssl_ssh_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ssl\_ssh\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ssl\_ssh\_profile** dictionary | | Configure SSL/SSH protocol options. |
| | **allowlist** string | **Choices:*** enable
* disable
| Enable/disable exempting servers by FortiGuard allowlist. |
| | **block\_blacklisted\_certificates** string | **Choices:*** disable
* enable
| Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist. |
| | **block\_blocklisted\_certificates** string | **Choices:*** disable
* enable
| Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist. |
| | **caname** string | | CA certificate used by SSL Inspection. Source vpn.certificate.local.name. |
| | **comment** string | | Optional comments. |
| | **dot** dictionary | | Configure DNS over TLS options. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is not issued by a trusted CA. |
| | **ftps** dictionary | | Configure FTPS options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **https** dictionary | | Configure HTTPS options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_probe\_failure** string | **Choices:*** allow
* block
| Action based on certificate probe failure. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* certificate-inspection
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **imaps** dictionary | | Configure IMAPS options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **mapi\_over\_https** string | **Choices:*** enable
* disable
| Enable/disable inspection of MAPI over HTTPS. |
| | **name** string / required | | Name. |
| | **pop3s** dictionary | | Configure POP3S options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **rpc\_over\_https** string | **Choices:*** enable
* disable
| Enable/disable inspection of RPC over HTTPS. |
| | **server\_cert** string | | Certificate used by SSL Inspection to replace server certificate. Source vpn.certificate.local.name. |
| | **server\_cert\_mode** string | **Choices:*** re-sign
* replace
| Re-sign or replace the server"s certificate. |
| | **smtps** dictionary | | Configure SMTPS options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **ssh** dictionary | | Configure SSH options. |
| | | **inspect\_all** string | **Choices:*** disable
* deep-inspection
| Level of SSL inspection. |
| | | **ports** integer | | Ports to use for scanning (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **ssh\_algorithm** string | **Choices:*** compatible
* high-encryption
| Relative strength of encryption algorithms accepted during negotiation. |
| | | **ssh\_policy\_check** string | **Choices:*** disable
* enable
| Enable/disable SSH policy check. |
| | | **ssh\_tun\_policy\_check** string | **Choices:*** disable
* enable
| Enable/disable SSH tunnel policy check. |
| | | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | | **unsupported\_version** string | **Choices:*** bypass
* block
| Action based on SSH version being unsupported. |
| | **ssl** dictionary | | Configure SSL options. |
| | | **allow\_invalid\_server\_cert** string | **Choices:*** enable
* disable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | | **cert\_validation\_failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | | **cert\_validation\_timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | | **client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | | **client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | | **expired\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | | **inspect\_all** string | **Choices:*** disable
* certificate-inspection
* deep-inspection
| Level of SSL inspection. |
| | | **invalid\_server\_cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | | **revoked\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | | **sni\_server\_cert\_check** string | **Choices:*** enable
* strict
* disable
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | | **unsupported\_ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | | **unsupported\_ssl\_cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | | **unsupported\_ssl\_negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | | **untrusted\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | | **untrusted\_server\_cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **ssl\_anomalies\_log** string | **Choices:*** disable
* enable
| Enable/disable logging SSL anomalies. |
| | **ssl\_exempt** list / elements=string | | Servers to exempt from SSL inspection. |
| | | **address** string | | IPv4 address object. Source firewall.address.name firewall.addrgrp.name. |
| | | **address6** string | | IPv6 address object. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **fortiguard\_category** integer | | FortiGuard category ID. |
| | | **id** integer / required | | ID number. |
| | | **regex** string | | Exempt servers by regular expression. |
| | | **type** string | **Choices:*** fortiguard-category
* address
* address6
* wildcard-fqdn
* regex
| Type of address object (IPv4 or IPv6) or FortiGuard category. |
| | | **wildcard\_fqdn** string | | Exempt servers by wildcard FQDN. Source firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name. |
| | **ssl\_exemptions\_log** string | **Choices:*** disable
* enable
| Enable/disable logging SSL exemptions. |
| | **ssl\_negotiation\_log** string | **Choices:*** disable
* enable
| Enable/disable logging SSL negotiation. |
| | **ssl\_server** list / elements=string | | SSL servers. |
| | | **ftps\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during the FTPS handshake. |
| | | **ftps\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during the FTPS handshake. |
| | | **https\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during the HTTPS handshake. |
| | | **https\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during the HTTPS handshake. |
| | | **id** integer / required | | SSL server ID. |
| | | **imaps\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during the IMAPS handshake. |
| | | **imaps\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during the IMAPS handshake. |
| | | **ip** string | | IPv4 address of the SSL server. |
| | | **pop3s\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during the POP3S handshake. |
| | | **pop3s\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during the POP3S handshake. |
| | | **smtps\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during the SMTPS handshake. |
| | | **smtps\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during the SMTPS handshake. |
| | | **ssl\_other\_client\_cert\_request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request during an SSL protocol handshake. |
| | | **ssl\_other\_client\_certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate during an SSL protocol handshake. |
| | **supported\_alpn** string | **Choices:*** http1-1
* http2
* all
* none
| Configure ALPN option. |
| | **untrusted\_caname** string | | Untrusted CA certificate used by SSL Inspection. Source vpn.certificate.local.name. |
| | **use\_ssl\_server** string | **Choices:*** disable
* enable
| Enable/disable the use of SSL server table for SSL offloading. |
| | **whitelist** string | **Choices:*** enable
* disable
| Enable/disable exempting servers by FortiGuard whitelist. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SSL/SSH protocol options.
fortios_firewall_ssl_ssh_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ssl_ssh_profile:
allowlist: "enable"
block_blacklisted_certificates: "disable"
block_blocklisted_certificates: "disable"
caname: "<your_own_value> (source vpn.certificate.local.name)"
comment: "Optional comments."
dot:
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_certificate: "bypass"
expired_server_cert: "allow"
proxy_after_tcp_handshake: "enable"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_server_cert: "allow"
ftps:
allow_invalid_server_cert: "enable"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
invalid_server_cert: "allow"
ports: "28"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
https:
allow_invalid_server_cert: "enable"
cert_probe_failure: "allow"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
invalid_server_cert: "allow"
ports: "46"
proxy_after_tcp_handshake: "enable"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
imaps:
allow_invalid_server_cert: "enable"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
invalid_server_cert: "allow"
ports: "64"
proxy_after_tcp_handshake: "enable"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
mapi_over_https: "enable"
name: "default_name_75"
pop3s:
allow_invalid_server_cert: "enable"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
invalid_server_cert: "allow"
ports: "84"
proxy_after_tcp_handshake: "enable"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
rpc_over_https: "enable"
server_cert: "<your_own_value> (source vpn.certificate.local.name)"
server_cert_mode: "re-sign"
smtps:
allow_invalid_server_cert: "enable"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
invalid_server_cert: "allow"
ports: "105"
proxy_after_tcp_handshake: "enable"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
status: "disable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
ssh:
inspect_all: "disable"
ports: "117"
proxy_after_tcp_handshake: "enable"
ssh_algorithm: "compatible"
ssh_policy_check: "disable"
ssh_tun_policy_check: "disable"
status: "disable"
unsupported_version: "bypass"
ssl:
allow_invalid_server_cert: "enable"
cert_validation_failure: "allow"
cert_validation_timeout: "allow"
client_cert_request: "bypass"
client_certificate: "bypass"
expired_server_cert: "allow"
inspect_all: "disable"
invalid_server_cert: "allow"
revoked_server_cert: "allow"
sni_server_cert_check: "enable"
unsupported_ssl: "bypass"
unsupported_ssl_cipher: "allow"
unsupported_ssl_negotiation: "allow"
untrusted_cert: "allow"
untrusted_server_cert: "allow"
ssl_anomalies_log: "disable"
ssl_exempt:
-
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
address6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
fortiguard_category: "144"
id: "145"
regex: "<your_own_value>"
type: "fortiguard-category"
wildcard_fqdn: "<your_own_value> (source firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name)"
ssl_exemptions_log: "disable"
ssl_negotiation_log: "disable"
ssl_server:
-
ftps_client_cert_request: "bypass"
ftps_client_certificate: "bypass"
https_client_cert_request: "bypass"
https_client_certificate: "bypass"
id: "156"
imaps_client_cert_request: "bypass"
imaps_client_certificate: "bypass"
ip: "<your_own_value>"
pop3s_client_cert_request: "bypass"
pop3s_client_certificate: "bypass"
smtps_client_cert_request: "bypass"
smtps_client_certificate: "bypass"
ssl_other_client_cert_request: "bypass"
ssl_other_client_certificate: "bypass"
supported_alpn: "http1-1"
untrusted_caname: "<your_own_value> (source vpn.certificate.local.name)"
use_ssl_server: "disable"
whitelist: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_ssl_setting – SSL proxy settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssl\_setting – SSL proxy settings in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ssl_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_ssl feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ssl\_setting** dictionary | | SSL proxy settings. |
| | **abbreviate\_handshake** string | **Choices:*** enable
* disable
| Enable/disable use of SSL abbreviated handshake. |
| | **cert\_cache\_capacity** integer | | Maximum capacity of the host certificate cache (0 - 500). |
| | **cert\_cache\_timeout** integer | | Time limit to keep certificate cache (1 - 120 min). |
| | **kxp\_queue\_threshold** integer | | Maximum length of the CP KXP queue. When the queue becomes full, the proxy switches cipher functions to the main CPU (0 - 512). |
| | **no\_matching\_cipher\_action** string | **Choices:*** bypass
* drop
| Bypass or drop the connection when no matching cipher is found. |
| | **proxy\_connect\_timeout** integer | | Time limit to make an internal connection to the appropriate proxy process (1 - 60 sec). |
| | **session\_cache\_capacity** integer | | Capacity of the SSL session cache (--Obsolete--) (1 - 1000). |
| | **session\_cache\_timeout** integer | | Time limit to keep SSL session state (1 - 60 min). |
| | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
| Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation . |
| | **ssl\_queue\_threshold** integer | | Maximum length of the CP SSL queue. When the queue becomes full, the proxy switches cipher functions to the main CPU (0 - 512). |
| | **ssl\_send\_empty\_frags** string | **Choices:*** enable
* disable
| Enable/disable sending empty fragments to avoid attack on CBC IV (for SSL 3.0 and TLS 1.0 only). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSL proxy settings.
fortios_firewall_ssl_setting:
vdom: "{{ vdom }}"
firewall_ssl_setting:
abbreviate_handshake: "enable"
cert_cache_capacity: "4"
cert_cache_timeout: "5"
kxp_queue_threshold: "6"
no_matching_cipher_action: "bypass"
proxy_connect_timeout: "8"
session_cache_capacity: "9"
session_cache_timeout: "10"
ssl_dh_bits: "768"
ssl_queue_threshold: "12"
ssl_send_empty_frags: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_accprofile – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_accprofile – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_accprofile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and accprofile 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_accprofile** dictionary | | Configure access profiles for system administrators. |
| | **admintimeout** integer | | Administrator timeout for this access profile (0 - 480 min). |
| | **admintimeout\_override** string | **Choices:*** enable
* disable
| Enable/disable overriding the global administrator idle timeout. |
| | **authgrp** string | **Choices:*** none
* read
* read-write
| Administrator access to Users and Devices. |
| | **comments** string | | Comment. |
| | **ftviewgrp** string | **Choices:*** none
* read
* read-write
| FortiView. |
| | **fwgrp** string | **Choices:*** none
* read
* read-write
* custom
| Administrator access to the Firewall configuration. |
| | **fwgrp\_permission** dictionary | | Custom firewall permission. |
| | | **address** string | **Choices:*** none
* read
* read-write
| Address Configuration. |
| | | **policy** string | **Choices:*** none
* read
* read-write
| Policy Configuration. |
| | | **schedule** string | **Choices:*** none
* read
* read-write
| Schedule Configuration. |
| | | **service** string | **Choices:*** none
* read
* read-write
| Service Configuration. |
| | **loggrp** string | **Choices:*** none
* read
* read-write
* custom
| Administrator access to Logging and Reporting including viewing log messages. |
| | **loggrp\_permission** dictionary | | Custom Log & Report permission. |
| | | **config** string | **Choices:*** none
* read
* read-write
| Log & Report configuration. |
| | | **data\_access** string | **Choices:*** none
* read
* read-write
| Log & Report Data Access. |
| | | **report\_access** string | **Choices:*** none
* read
* read-write
| Log & Report Report Access. |
| | | **threat\_weight** string | **Choices:*** none
* read
* read-write
| Log & Report Threat Weight. |
| | **name** string / required | | Profile name. |
| | **netgrp** string | **Choices:*** none
* read
* read-write
* custom
| Network Configuration. |
| | **netgrp\_permission** dictionary | | Custom network permission. |
| | | **cfg** string | **Choices:*** none
* read
* read-write
| Network Configuration. |
| | | **packet\_capture** string | **Choices:*** none
* read
* read-write
| Packet Capture Configuration. |
| | | **route\_cfg** string | **Choices:*** none
* read
* read-write
| Router Configuration. |
| | **scope** string | **Choices:*** vdom
* global
| Scope of admin access: global or specific VDOM(s). |
| | **secfabgrp** string | **Choices:*** none
* read
* read-write
| Security Fabric. |
| | **sysgrp** string | **Choices:*** none
* read
* read-write
* custom
| System Configuration. |
| | **sysgrp\_permission** dictionary | | Custom system permission. |
| | | **admin** string | **Choices:*** none
* read
* read-write
| Administrator Users. |
| | | **cfg** string | **Choices:*** none
* read
* read-write
| System Configuration. |
| | | **mnt** string | **Choices:*** none
* read
* read-write
| Maintenance. |
| | | **upd** string | **Choices:*** none
* read
* read-write
| FortiGuard Updates. |
| | **system\_diagnostics** string | **Choices:*** enable
* disable
| Enable/disable permission to run system diagnostic commands. |
| | **utmgrp** string | **Choices:*** none
* read
* read-write
* custom
| Administrator access to Security Profiles. |
| | **utmgrp\_permission** dictionary | | Custom Security Profile permissions. |
| | | **antivirus** string | **Choices:*** none
* read
* read-write
| Antivirus profiles and settings. |
| | | **application\_control** string | **Choices:*** none
* read
* read-write
| Application Control profiles and settings. |
| | | **data\_loss\_prevention** string | **Choices:*** none
* read
* read-write
| DLP profiles and settings. |
| | | **dnsfilter** string | **Choices:*** none
* read
* read-write
| DNS Filter profiles and settings. |
| | | **emailfilter** string | **Choices:*** none
* read
* read-write
| AntiSpam filter and settings. |
| | | **endpoint\_control** string | **Choices:*** none
* read
* read-write
| FortiClient Profiles. |
| | | **file\_filter** string | **Choices:*** none
* read
* read-write
| File-filter profiles and settings. |
| | | **icap** string | **Choices:*** none
* read
* read-write
| ICAP profiles and settings. |
| | | **ips** string | **Choices:*** none
* read
* read-write
| IPS profiles and settings. |
| | | **mmsgtp** string | **Choices:*** none
* read
* read-write
| UTM permission. |
| | | **spamfilter** string | **Choices:*** none
* read
* read-write
| AntiSpam filter and settings. |
| | | **voip** string | **Choices:*** none
* read
* read-write
| VoIP profiles and settings. |
| | | **waf** string | **Choices:*** none
* read
* read-write
| Web Application Firewall profiles and settings. |
| | | **webfilter** string | **Choices:*** none
* read
* read-write
| Web Filter profiles and settings. |
| | **vpngrp** string | **Choices:*** none
* read
* read-write
| Administrator access to IPsec, SSL, PPTP, and L2TP VPN. |
| | **wanoptgrp** string | **Choices:*** none
* read
* read-write
| Administrator access to WAN Opt & Cache. |
| | **wifi** string | **Choices:*** none
* read
* read-write
| Administrator access to the WiFi controller and Switch controller. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure access profiles for system administrators.
fortios_system_accprofile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_accprofile:
admintimeout: "3"
admintimeout_override: "enable"
authgrp: "none"
comments: "<your_own_value>"
ftviewgrp: "none"
fwgrp: "none"
fwgrp_permission:
address: "none"
policy: "none"
schedule: "none"
service: "none"
loggrp: "none"
loggrp_permission:
config: "none"
data_access: "none"
report_access: "none"
threat_weight: "none"
name: "default_name_20"
netgrp: "none"
netgrp_permission:
cfg: "none"
packet_capture: "none"
route_cfg: "none"
scope: "vdom"
secfabgrp: "none"
sysgrp: "none"
sysgrp_permission:
admin: "none"
cfg: "none"
mnt: "none"
upd: "none"
system_diagnostics: "enable"
utmgrp: "none"
utmgrp_permission:
antivirus: "none"
application_control: "none"
data_loss_prevention: "none"
dnsfilter: "none"
emailfilter: "none"
endpoint_control: "none"
file_filter: "none"
icap: "none"
ips: "none"
mmsgtp: "none"
spamfilter: "none"
voip: "none"
waf: "none"
webfilter: "none"
vpngrp: "none"
wanoptgrp: "none"
wifi: "none"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_ldap – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_ldap – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_ldap`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and ldap 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_ldap** dictionary | | Configure LDAP server entries. |
| | **account\_key\_filter** string | | Account key filter, using the UPN as the search filter. |
| | **account\_key\_processing** string | **Choices:*** same
* strip
| Account key processing operation, either keep or strip domain string of UPN in the token. |
| | **antiphish** string | **Choices:*** enable
* disable
| Enable/disable AntiPhishing credential backend. |
| | **ca\_cert** string | | CA certificate name. Source vpn.certificate.ca.name. |
| | **cnid** string | | Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn". |
| | **dn** string | | Distinguished name used to look up entries on the LDAP server. |
| | **group\_filter** string | | Filter used for group matching. |
| | **group\_member\_check** string | **Choices:*** user-attr
* group-object
* posix-group-object
| Group member checking methods. |
| | **group\_object\_filter** string | | Filter used for group searching. |
| | **group\_search\_base** string | | Search base used for group searching. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **member\_attr** string | | Name of attribute from which to get group membership. |
| | **name** string / required | | LDAP server entry name. |
| | **obtain\_user\_info** string | **Choices:*** enable
* disable
| Enable/disable obtaining of user information. |
| | **password** string | | Password for initial binding. |
| | **password\_attr** string | | Name of attribute to get password hash. |
| | **password\_expiry\_warning** string | **Choices:*** enable
* disable
| Enable/disable password expiry warnings. |
| | **password\_renewal** string | **Choices:*** enable
* disable
| Enable/disable online password renewal. |
| | **port** integer | | Port to be used for communication with the LDAP server . |
| | **search\_type** list / elements=string | **Choices:*** recursive
| Search type. |
| | **secondary\_server** string | | Secondary LDAP server CN domain name or IP. |
| | **secure** string | **Choices:*** disable
* starttls
* ldaps
| Port to be used for authentication. |
| | **server** string | | LDAP server CN domain name or IP. |
| | **server\_identity\_check** string | **Choices:*** enable
* disable
| Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). |
| | **source\_ip** string | | Source IP for communications to LDAP server. |
| | **source\_port** integer | | Source port to be used for communication with the LDAP server. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **tertiary\_server** string | | Tertiary LDAP server CN domain name or IP. |
| | **two\_factor** string | **Choices:*** disable
* fortitoken-cloud
| Enable/disable two-factor authentication. |
| | **two\_factor\_authentication** string | **Choices:*** fortitoken
* email
* sms
| Authentication method by FortiToken Cloud. |
| | **two\_factor\_notification** string | **Choices:*** email
* sms
| Notification method for user activation by FortiToken Cloud. |
| | **type** string | **Choices:*** simple
* anonymous
* regular
| Authentication type for LDAP searches. |
| | **user\_info\_exchange\_server** string | | MS Exchange server from which to fetch user information. Source user.exchange.name. |
| | **username** string | | Username (full DN) for initial binding. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure LDAP server entries.
fortios_user_ldap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_ldap:
account_key_filter: "<your_own_value>"
account_key_processing: "same"
antiphish: "enable"
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
cnid: "<your_own_value>"
dn: "<your_own_value>"
group_filter: "<your_own_value>"
group_member_check: "user-attr"
group_object_filter: "<your_own_value>"
group_search_base: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
member_attr: "<your_own_value>"
name: "default_name_16"
obtain_user_info: "enable"
password: "<your_own_value>"
password_attr: "<your_own_value>"
password_expiry_warning: "enable"
password_renewal: "enable"
port: "22"
search_type: "recursive"
secondary_server: "<your_own_value>"
secure: "disable"
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_port: "29"
ssl_min_proto_version: "default"
tertiary_server: "<your_own_value>"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_notification: "email"
type: "simple"
user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
username: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_hardware_nic – Display NIC information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_hardware\_nic – Display NIC information in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_hardware_nic`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify hardware feature and nic 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **hardware\_nic** dictionary | | Display NIC information. |
| | string | | NIC name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Display NIC information.
fortios_hardware_nic:
vdom: "{{ vdom }}"
hardware_nic:
<nic>: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_exchange – Configure MS Exchange server entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_exchange – Configure MS Exchange server entries in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_exchange`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and exchange 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_exchange** dictionary | | Configure MS Exchange server entries. |
| | **auth\_level** string | **Choices:*** connect
* call
* packet
* integrity
* privacy
| Authentication security level used for the RPC protocol layer. |
| | **auth\_type** string | **Choices:*** spnego
* ntlm
* kerberos
| Authentication security type used for the RPC protocol layer. |
| | **auto\_discover\_kdc** string | **Choices:*** enable
* disable
| Enable/disable automatic discovery of KDC IP addresses. |
| | **connect\_protocol** string | **Choices:*** rpc-over-tcp
* rpc-over-http
* rpc-over-https
| Connection protocol used to connect to MS Exchange service. |
| | **domain\_name** string | | MS Exchange server fully qualified domain name. |
| | **http\_auth\_type** string | **Choices:*** basic
* ntlm
| Authentication security type used for the HTTP transport. |
| | **ip** string | | Server IPv4 address. |
| | **kdc\_ip** list / elements=string | | KDC IPv4 addresses for Kerberos authentication. |
| | | **ipv4** string / required | | KDC IPv4 addresses for Kerberos authentication. |
| | **name** string / required | | MS Exchange server entry name. |
| | **password** string | | Password for the specified username. |
| | **server\_name** string | | MS Exchange server hostname. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum SSL/TLS protocol version for HTTPS transport . |
| | **username** string | | User name used to sign in to the server. Must have proper permissions for service. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure MS Exchange server entries.
fortios_user_exchange:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_exchange:
auth_level: "connect"
auth_type: "spnego"
auto_discover_kdc: "enable"
connect_protocol: "rpc-over-tcp"
domain_name: "<your_own_value>"
http_auth_type: "basic"
ip: "<your_own_value>"
kdc_ip:
-
ipv4: "<your_own_value>"
name: "default_name_12"
password: "<your_own_value>"
server_name: "<your_own_value>"
ssl_min_proto_version: "default"
username: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_hardware_npu_np6_sse_stats – Show NP6 hardware session statistics counters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_hardware\_npu\_np6\_sse\_stats – Show NP6 hardware session statistics counters in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_hardware_npu_np6_sse_stats`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify hardware\_npu\_np6 feature and sse\_stats 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **hardware\_npu\_np6\_sse\_stats** dictionary | | Show NP6 hardware session statistics counters. |
| | string | | NP6 ID |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Show NP6 hardware session statistics counters.
fortios_hardware_npu_np6_sse_stats:
vdom: "{{ vdom }}"
hardware_npu_np6_sse_stats:
<dev_id>: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_global`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and global 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_global** dictionary | | Configure wireless controller global settings. |
| | **ap\_log\_server** string | **Choices:*** enable
* disable
| Enable/disable configuring APs or FortiAPs to send log messages to a syslog server . |
| | **ap\_log\_server\_ip** string | | IP address that APs or FortiAPs send log messages to. |
| | **ap\_log\_server\_port** integer | | Port that APs or FortiAPs send log messages to. |
| | **control\_message\_offload** list / elements=string | **Choices:*** ebp-frame
* aeroscout-tag
* ap-list
* sta-list
* sta-cap-list
* stats
* aeroscout-mu
* sta-health
* spectral-analysis
| Configure CAPWAP control message data channel offload. |
| | **data\_ethernet\_II** string | **Choices:*** enable
* disable
| Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode . |
| | **discovery\_mc\_addr** string | | Multicast IP address for AP discovery . |
| | **fiapp\_eth\_type** integer | | Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). |
| | **image\_download** string | **Choices:*** enable
* disable
| Enable/disable WTP image download at join time. |
| | **ipsec\_base\_ip** string | | Base IP address for IPsec VPN tunnels between the access points and the wireless controller . |
| | **link\_aggregation** string | **Choices:*** enable
* disable
| Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . |
| | **location** string | | Description of the location of the wireless controller. |
| | **max\_clients** integer | | Maximum number of clients that can connect simultaneously . |
| | **max\_retransmit** integer | | Maximum number of tunnel packet retransmissions (0 - 64). |
| | **mesh\_eth\_type** integer | | Mesh Ethernet identifier included in backhaul packets (0 - 65535). |
| | **name** string | | Name of the wireless controller. |
| | **rogue\_scan\_mac\_adjacency** integer | | Maximum numerical difference between an AP"s Ethernet and wireless MAC values to match for rogue detection (0 - 31). |
| | **wtp\_share** string | **Choices:*** enable
* disable
| Enable/disable sharing of WTPs between VDOMs. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure wireless controller global settings.
fortios_wireless_controller_global:
vdom: "{{ vdom }}"
wireless_controller_global:
ap_log_server: "enable"
ap_log_server_ip: "<your_own_value>"
ap_log_server_port: "5"
control_message_offload: "ebp-frame"
data_ethernet_II: "enable"
discovery_mc_addr: "<your_own_value>"
fiapp_eth_type: "9"
image_download: "enable"
ipsec_base_ip: "<your_own_value>"
link_aggregation: "enable"
location: "<your_own_value>"
max_clients: "14"
max_retransmit: "15"
mesh_eth_type: "16"
name: "default_name_17"
rogue_scan_mac_adjacency: "18"
wtp_share: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_webfilter_override – Configure FortiGuard Web Filter administrative overrides in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_override – Configure FortiGuard Web Filter administrative overrides in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_webfilter_override`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and override 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **webfilter\_override** dictionary | | Configure FortiGuard Web Filter administrative overrides. |
| | **expires** string | | Override expiration date and time, from 5 minutes to 365 from now (format: yyyy/mm/dd hh:mm:ss). |
| | **id** integer / required | | Override rule ID. |
| | **initiator** string | | Initiating user of override (read-only setting). |
| | **ip** string | | IPv4 address which the override applies. |
| | **ip6** string | | IPv6 address which the override applies. |
| | **new\_profile** string | | Name of the new web filter profile used by the override. Source webfilter.profile.name. |
| | **old\_profile** string | | Name of the web filter profile which the override applies. Source webfilter.profile.name. |
| | **scope** string | **Choices:*** user
* user-group
* ip
* ip6
| Override either the specific user, user group, IPv4 address, or IPv6 address. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable override rule. |
| | **user** string | | Name of the user which the override applies. |
| | **user\_group** string | | Specify the user group for which the override applies. Source user.group.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiGuard Web Filter administrative overrides.
fortios_webfilter_override:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_override:
expires: "<your_own_value>"
id: "4"
initiator: "<your_own_value>"
ip: "<your_own_value>"
ip6: "<your_own_value>"
new_profile: "<your_own_value> (source webfilter.profile.name)"
old_profile: "<your_own_value> (source webfilter.profile.name)"
scope: "user"
status: "enable"
user: "<your_own_value>"
user_group: "<your_own_value> (source user.group.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wanopt_profile – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_profile – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wanopt_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wanopt\_profile** dictionary | | Configure WAN optimization profiles. |
| | **auth\_group** string | | Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. Source wanopt.auth-group.name. |
| | **cifs** dictionary | | Enable/disable CIFS (Windows sharing) WAN Optimization and configure CIFS WAN Optimization features. |
| | | **byte\_caching** string | **Choices:*** enable
* disable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. |
| | | **log\_traffic** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **port** integer | | Single port number or port number range for CIFS. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
| | | **prefer\_chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for HTTP WAN Optimization. |
| | | **protocol\_opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable HTTP WAN Optimization. |
| | | **tunnel\_sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **comments** string | | Comment. |
| | **ftp** dictionary | | Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features. |
| | | **byte\_caching** string | **Choices:*** enable
* disable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. |
| | | **log\_traffic** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **port** integer | | Single port number or port number range for FTP. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
| | | **prefer\_chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for HTTP WAN Optimization. |
| | | **protocol\_opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** enable
* disable
| Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable HTTP WAN Optimization. |
| | | **tunnel\_sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **http** dictionary | | Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features. |
| | | **byte\_caching** string | **Choices:*** enable
* disable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. |
| | | **log\_traffic** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **port** integer | | Single port number or port number range for HTTP. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
| | | **prefer\_chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for HTTP WAN Optimization. |
| | | **protocol\_opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** enable
* disable
| Enable/disable SSL/TLS offloading (hardware acceleration) for HTTPS traffic in this tunnel. |
| | | **ssl\_port** integer | | Port on which to expect HTTPS traffic for SSL/TLS offloading. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable HTTP WAN Optimization. |
| | | **tunnel\_non\_http** string | **Choices:*** enable
* disable
| Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can occur if an application sends non-HTTP traffic using an HTTP destination port. |
| | | **tunnel\_sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | | **unknown\_http\_version** string | **Choices:*** reject
* tunnel
* best-effort
| How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. |
| | **mapi** dictionary | | Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features. |
| | | **byte\_caching** string | **Choices:*** enable
* disable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. |
| | | **log\_traffic** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **port** integer | | Single port number or port number range for MAPI. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
| | | **secure\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable HTTP WAN Optimization. |
| | | **tunnel\_sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **name** string / required | | Profile name. |
| | **tcp** dictionary | | Enable/disable TCP WAN Optimization and configure TCP WAN Optimization features. |
| | | **byte\_caching** string | **Choices:*** enable
* disable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. |
| | | **byte\_caching\_opt** string | **Choices:*** mem-only
* mem-disk
| Select whether TCP byte-caching uses system memory only or both memory and disk space. |
| | | **log\_traffic** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **port** string | | Single port number or port number range for TCP. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
| | | **secure\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** enable
* disable
| Enable/disable SSL/TLS offloading. |
| | | **ssl\_port** integer | | Port on which to expect HTTPS traffic for SSL/TLS offloading. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable HTTP WAN Optimization. |
| | | **tunnel\_sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **transparent** string | **Choices:*** enable
* disable
| Enable/disable transparent mode. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WAN optimization profiles.
fortios_wanopt_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wanopt_profile:
auth_group: "<your_own_value> (source wanopt.auth-group.name)"
cifs:
byte_caching: "enable"
log_traffic: "enable"
port: "7"
prefer_chunking: "dynamic"
protocol_opt: "protocol"
secure_tunnel: "enable"
status: "enable"
tunnel_sharing: "private"
comments: "<your_own_value>"
ftp:
byte_caching: "enable"
log_traffic: "enable"
port: "17"
prefer_chunking: "dynamic"
protocol_opt: "protocol"
secure_tunnel: "enable"
ssl: "enable"
status: "enable"
tunnel_sharing: "private"
http:
byte_caching: "enable"
log_traffic: "enable"
port: "27"
prefer_chunking: "dynamic"
protocol_opt: "protocol"
secure_tunnel: "enable"
ssl: "enable"
ssl_port: "32"
status: "enable"
tunnel_non_http: "enable"
tunnel_sharing: "private"
unknown_http_version: "reject"
mapi:
byte_caching: "enable"
log_traffic: "enable"
port: "40"
secure_tunnel: "enable"
status: "enable"
tunnel_sharing: "private"
name: "default_name_44"
tcp:
byte_caching: "enable"
byte_caching_opt: "mem-only"
log_traffic: "enable"
port: "<your_own_value>"
secure_tunnel: "enable"
ssl: "enable"
ssl_port: "52"
status: "enable"
tunnel_sharing: "private"
transparent: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_vdom_property – Configure VDOM property in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_property – Configure VDOM property in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_vdom_property`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom\_property 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_vdom\_property** dictionary | | Configure VDOM property. |
| | **custom\_service** string | | Maximum guaranteed number of firewall custom services. |
| | **description** string | | Description. |
| | **dialup\_tunnel** string | | Maximum guaranteed number of dial-up tunnels. |
| | **firewall\_address** string | | Maximum guaranteed number of firewall addresses (IPv4, IPv6, multicast). |
| | **firewall\_addrgrp** string | | Maximum guaranteed number of firewall address groups (IPv4, IPv6). |
| | **firewall\_policy** string | | Maximum guaranteed number of firewall policies (IPv4, IPv6, policy46, policy64, DoS-policy4, DoS-policy6, multicast). |
| | **ipsec\_phase1** string | | Maximum guaranteed number of VPN IPsec phase 1 tunnels. |
| | **ipsec\_phase1\_interface** string | | Maximum guaranteed number of VPN IPsec phase1 interface tunnels. |
| | **ipsec\_phase2** string | | Maximum guaranteed number of VPN IPsec phase 2 tunnels. |
| | **ipsec\_phase2\_interface** string | | Maximum guaranteed number of VPN IPsec phase2 interface tunnels. |
| | **log\_disk\_quota** string | | Log disk quota in MB (range depends on how much disk space is available). |
| | **name** string / required | | VDOM name. Source system.vdom.name. |
| | **onetime\_schedule** string | | Maximum guaranteed number of firewall one-time schedules. |
| | **proxy** string | | Maximum guaranteed number of concurrent proxy users. |
| | **recurring\_schedule** string | | Maximum guaranteed number of firewall recurring schedules. |
| | **service\_group** string | | Maximum guaranteed number of firewall service groups. |
| | **session** string | | Maximum guaranteed number of sessions. |
| | **snmp\_index** integer | | Permanent SNMP Index of the virtual domain (0 - 4294967295). |
| | **sslvpn** string | | Maximum guaranteed number of SSL-VPNs. |
| | **user** string | | Maximum guaranteed number of local users. |
| | **user\_group** string | | Maximum guaranteed number of user groups. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VDOM property.
fortios_system_vdom_property:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom_property:
custom_service: "<your_own_value>"
description: "<your_own_value>"
dialup_tunnel: "<your_own_value>"
firewall_address: "<your_own_value>"
firewall_addrgrp: "<your_own_value>"
firewall_policy: "<your_own_value>"
ipsec_phase1: "<your_own_value>"
ipsec_phase1_interface: "<your_own_value>"
ipsec_phase2: "<your_own_value>"
ipsec_phase2_interface: "<your_own_value>"
log_disk_quota: "<your_own_value>"
name: "default_name_14 (source system.vdom.name)"
onetime_schedule: "<your_own_value>"
proxy: "<your_own_value>"
recurring_schedule: "<your_own_value>"
service_group: "<your_own_value>"
session: "<your_own_value>"
snmp_index: "20"
sslvpn: "<your_own_value>"
user: "<your_own_value>"
user_group: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_extender_lte_carrier_list – Display extender modem carrier list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_lte\_carrier\_list – Display extender modem carrier list in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_extender_lte_carrier_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender feature and lte\_carrier\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **extender\_lte\_carrier\_list** dictionary | | Display extender modem carrier list. |
| | string | | extender serial number. Source extender-controller.extender.id. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Display extender modem carrier list.
fortios_extender_lte_carrier_list:
vdom: "{{ vdom }}"
extender_lte_carrier_list:
<sn>: "<your_own_value> (source extender-controller.extender.id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_schedule_onetime – Onetime schedule configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_schedule\_onetime – Onetime schedule configuration in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_schedule_onetime`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_schedule feature and onetime 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_schedule\_onetime** dictionary | | Onetime schedule configuration. |
| | **color** integer | | Color of icon on the GUI. |
| | **end** string | | Schedule end date and time, format hh:mm yyyy/mm/dd. |
| | **expiration\_days** integer | | Write an event log message this many days before the schedule expires. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **name** string / required | | Onetime schedule name. |
| | **start** string | | Schedule start date and time, format hh:mm yyyy/mm/dd. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Onetime schedule configuration.
fortios_firewall_schedule_onetime:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_schedule_onetime:
color: "3"
end: "<your_own_value>"
expiration_days: "5"
fabric_object: "enable"
name: "default_name_7"
start: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_network_auth_type – Configure network authentication type in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_network\_auth\_type – Configure network authentication type in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_network_auth_type`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller\_hotspot20 feature and anqp\_network\_auth\_type 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_hotspot20\_anqp\_network\_auth\_type** dictionary | | Configure network authentication type. |
| | **auth\_type** string | **Choices:*** acceptance-of-terms
* online-enrollment
* http-redirection
* dns-redirection
| Network authentication type. |
| | **name** string / required | | Authentication type name. |
| | **url** string | | Redirect URL. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure network authentication type.
fortios_wireless_controller_hotspot20_anqp_network_auth_type:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_network_auth_type:
auth_type: "acceptance-of-terms"
name: "default_name_4"
url: "myurl.com"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_certificate_local – Local keys and certificates in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_local – Local keys and certificates in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_certificate_local`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_certificate feature and local 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_certificate\_local** dictionary | | Local keys and certificates. |
| | **acme\_ca\_url** string | | The URL for the ACME CA server (Let"s Encrypt is the ). |
| | **acme\_domain** string | | A valid domain that resolves to this Fortigate. |
| | **acme\_email** string | | Contact email address that is required by some CAs like LetsEncrypt. |
| | **acme\_renew\_window** integer | | Beginning of the renewal window (in days before certificate expiration, 30 by default). |
| | **acme\_rsa\_key\_size** integer | | Length of the RSA private key of the generated cert (Minimum 2048 bits). |
| | **auto\_regenerate\_days** integer | | Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). |
| | **auto\_regenerate\_days\_warning** integer | | Number of days to wait before an expiry warning message is generated (0 = disabled). |
| | **ca\_identifier** string | | CA identifier of the CA server for signing via SCEP. |
| | **certificate** string | | PEM format certificate. |
| | **cmp\_path** string | | Path location inside CMP server. |
| | **cmp\_regeneration\_method** string | **Choices:*** keyupate
* renewal
| CMP auto-regeneration method. |
| | **cmp\_server** string | | "ADDRESS:PORT" for CMP server. |
| | **cmp\_server\_cert** string | | CMP server certificate. Source vpn.certificate.ca.name. |
| | **comments** string | | Comment. |
| | **csr** string | | Certificate Signing Request. |
| | **enroll\_protocol** string | **Choices:*** none
* scep
* cmpv2
* acme2
| Certificate enrollment protocol. |
| | **ike\_localid** string | | Local ID the FortiGate uses for authentication as a VPN client. |
| | **ike\_localid\_type** string | **Choices:*** asn1dn
* fqdn
| IKE local ID type. |
| | **last\_updated** integer | | Time at which certificate was last updated. |
| | **name** string / required | | Name. |
| | **name\_encoding** string | **Choices:*** printable
* utf8
| Name encoding method for auto-regeneration. |
| | **password** string | | Password as a PEM file. |
| | **private\_key** string | | PEM format key, encrypted with a password. |
| | **range** string | **Choices:*** global
* vdom
| Either a global or VDOM IP address range for the certificate. |
| | **scep\_password** string | | SCEP server challenge password for auto-regeneration. |
| | **scep\_url** string | | SCEP server URL. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Certificate source type. |
| | **source\_ip** string | | Source IP address for communications to the SCEP server. |
| | **state** string | | Certificate Signing Request State. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Local keys and certificates.
fortios_vpn_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_local:
acme_ca_url: "<your_own_value>"
acme_domain: "<your_own_value>"
acme_email: "<your_own_value>"
acme_renew_window: "6"
acme_rsa_key_size: "7"
auto_regenerate_days: "8"
auto_regenerate_days_warning: "9"
ca_identifier: "myId_10"
certificate: "<your_own_value>"
cmp_path: "<your_own_value>"
cmp_regeneration_method: "keyupate"
cmp_server: "<your_own_value>"
cmp_server_cert: "<your_own_value> (source vpn.certificate.ca.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "21"
name: "default_name_22"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
range: "global"
scep_password: "<your_own_value>"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
state: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_endpoint_control_client – Configure endpoint control client lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_client – Configure endpoint control client lists in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_endpoint_control_client`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
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 client 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **endpoint\_control\_client** dictionary | | Configure endpoint control client lists. |
| | **ad\_groups** string | | Endpoint client AD logon groups. |
| | **ftcl\_uid** string | | Endpoint FortiClient UID. |
| | **id** integer / required | | Endpoint client ID. |
| | **info** string | | Endpoint client information. |
| | **src\_ip** string | | Endpoint client IP address. |
| | **src\_mac** string | | Endpoint client MAC address. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure endpoint control client lists.
fortios_endpoint_control_client:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_client:
ad_groups: "<your_own_value>"
ftcl_uid: "<your_own_value>"
id: "5"
info: "<your_own_value>"
src_ip: "<your_own_value>"
src_mac: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_videofilter_youtube_key – Configure YouTube API keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_videofilter\_youtube\_key – Configure YouTube API keys in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_videofilter_youtube_key`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify videofilter feature and youtube\_key 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **videofilter\_youtube\_key** dictionary | | Configure YouTube API keys. |
| | **id** integer / required | | ID. |
| | **key** string | | Key. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable YouTube API service. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure YouTube API keys.
fortios_videofilter_youtube_key:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
videofilter_youtube_key:
id: "3"
key: "<your_own_value>"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_proxy_policy – Configure proxy policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_proxy\_policy – Configure proxy policies in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_proxy_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_proxy\_policy** dictionary | | Configure proxy policies. |
| | **access\_proxy** list / elements=string | | Access Proxy. |
| | | **name** string / required | | Access Proxy name. Source firewall.access-proxy.name. |
| | **action** string | **Choices:*** accept
* deny
* redirect
| Accept or deny traffic matching the policy parameters. |
| | **application\_list** string | | Name of an existing Application list. Source application.list.name. |
| | **av\_profile** string | | Name of an existing Antivirus profile. Source antivirus.profile.name. |
| | **cifs\_profile** string | | Name of an existing CIFS profile. Source cifs.profile.name. |
| | **comments** string | | Optional comments. |
| | **decrypted\_traffic\_mirror** string | | Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. |
| | **device\_ownership** string | **Choices:*** enable
* disable
| When enabled, the ownership enforcement will be done at policy level. |
| | **disclaimer** string | **Choices:*** disable
* domain
* policy
* user
| Web proxy disclaimer setting: by domain, policy, or user. |
| | **dlp\_sensor** string | | Name of an existing DLP sensor. Source dlp.sensor.name. |
| | **dstaddr** list / elements=string | | Destination address objects. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip.name firewall.vipgrp.name firewall.vip46.name firewall.vipgrp46.name system.external-resource.name. |
| | **dstaddr6** list / elements=string | | IPv6 destination address objects. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name firewall.vip64.name firewall.vipgrp64.name system.external-resource.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled, destination addresses match against any address EXCEPT the specified destination addresses. |
| | **dstintf** list / elements=string | | Destination interface names. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **file\_filter\_profile** string | | Name of an existing file-filter profile. Source file-filter.profile.name. |
| | **global\_label** string | | Global web-based manager visible label. |
| | **groups** list / elements=string | | Names of group objects. |
| | | **name** string / required | | Group name. Source user.group.name. |
| | **http\_tunnel\_auth** string | **Choices:*** enable
* disable
| Enable/disable HTTP tunnel authentication. |
| | **icap\_profile** string | | Name of an existing ICAP profile. Source icap.profile.name. |
| | **internet\_service** string | **Choices:*** enable
* disable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet\_service\_custom** list / elements=string | | Custom Internet Service name. |
| | | **name** string / required | | Custom name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_custom\_group** list / elements=string | | Custom Internet Service group name. |
| | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | **internet\_service\_group** list / elements=string | | Internet Service group name. |
| | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | **internet\_service\_id** list / elements=string | | Internet Service ID. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | **internet\_service\_name** list / elements=string | | Internet Service name. |
| | | **name** string / required | | Internet Service name. Source firewall.internet-service-name.name. |
| | **internet\_service\_negate** string | **Choices:*** enable
* disable
| When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **label** string | | VDOM-specific GUI visible label. |
| | **logtraffic** string | **Choices:*** all
* utm
* disable
| Enable/disable logging traffic through the policy. |
| | **logtraffic\_start** string | **Choices:*** enable
* disable
| Enable/disable policy log traffic start. |
| | **mms\_profile** string | | Name of an existing MMS profile. Source firewall.mms-profile.name. |
| | **name** string | | Policy name. |
| | **policyid** integer / required | | Policy ID. |
| | **poolname** list / elements=string | | Name of IP pool object. |
| | | **name** string / required | | IP pool name. Source firewall.ippool.name. |
| | **profile\_group** string | | Name of profile group. Source firewall.profile-group.name. |
| | **profile\_protocol\_options** string | | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
| | **profile\_type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **proxy** string | **Choices:*** explicit-web
* transparent-web
* ftp
* ssh
* ssh-tunnel
* wanopt
* access-proxy
| Type of explicit proxy. |
| | **redirect\_url** string | | Redirect URL for further explicit web proxy processing. |
| | **replacemsg\_override\_group** string | | Authentication replacement message override group. Source system.replacemsg-group.name. |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Enable/disable scanning of connections to Botnet servers. |
| | **schedule** string | | Name of schedule object. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **service** list / elements=string | | Name of service objects. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **service\_negate** string | **Choices:*** enable
* disable
| When enabled, services match against any service EXCEPT the specified destination services. |
| | **session\_ttl** integer | | TTL in seconds for sessions accepted by this policy (0 means use the system ). |
| | **spamfilter\_profile** string | | Name of an existing Spam filter profile. Source spamfilter.profile.name. |
| | **srcaddr** list / elements=string | | Source address objects. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. |
| | **srcaddr6** list / elements=string | | IPv6 source address objects. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
| | **srcaddr\_negate** string | **Choices:*** enable
* disable
| When enabled, source addresses match against any address EXCEPT the specified source addresses. |
| | **srcintf** list / elements=string | | Source interface names. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **ssh\_filter\_profile** string | | Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
| | **ssh\_policy\_redirect** string | **Choices:*** enable
* disable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl\_ssh\_profile** string | | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of the policy. |
| | **transparent** string | **Choices:*** enable
* disable
| Enable to use the IP address of the client to connect to the server. |
| | **users** list / elements=string | | Names of user objects. |
| | | **name** string / required | | Group name. Source user.local.name. |
| | **utm\_status** string | **Choices:*** enable
* disable
| Enable the use of UTM profiles/sensors/lists. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter\_profile** string | | Name of an existing VideoFilter profile. Source videofilter.profile.name. |
| | **voip\_profile** string | | Name of an existing VoIP profile. Source voip.profile.name. |
| | **waf\_profile** string | | Name of an existing Web application firewall profile. Source waf.profile.name. |
| | **webcache** string | **Choices:*** enable
* disable
| Enable/disable web caching. |
| | **webcache\_https** string | **Choices:*** disable
* enable
| Enable/disable web caching for HTTPS (Requires deep-inspection enabled in ssl-ssh-profile). |
| | **webfilter\_profile** string | | Name of an existing Web filter profile. Source webfilter.profile.name. |
| | **webproxy\_forward\_server** string | | Name of web proxy forward server. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
| | **webproxy\_profile** string | | Name of web proxy profile. Source web-proxy.profile.name. |
| | **ztna\_ems\_tag** list / elements=string | | ZTNA EMS Tag names. |
| | | **name** string / required | | EMS Tag name. Source firewall.address.name firewall.addrgrp.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure proxy policies.
fortios_firewall_proxy_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_policy:
access_proxy:
-
name: "default_name_4 (source firewall.access-proxy.name)"
action: "accept"
application_list: "<your_own_value> (source application.list.name)"
av_profile: "<your_own_value> (source antivirus.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
device_ownership: "enable"
disclaimer: "disable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dstaddr:
-
name: "default_name_15 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip
.name firewall.vipgrp.name firewall.vip46.name firewall.vipgrp46.name system.external-resource.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name firewall.vip64.name firewall
.vipgrp64.name system.external-resource.name)"
dstintf:
-
name: "default_name_20 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_25 (source user.group.name)"
http_tunnel_auth: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_30 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_32 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_34 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "36 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_38 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
label: "<your_own_value>"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_45"
policyid: "46"
poolname:
-
name: "default_name_48 (source firewall.ippool.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
proxy: "explicit-web"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_botnet_connections: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_58 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "60"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_63 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_66 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_68 (source system.interface.name system.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
transparent: "enable"
users:
-
name: "default_name_75 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
voip_profile: "<your_own_value> (source voip.profile.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
ztna_ems_tag:
-
name: "default_name_87 (source firewall.address.name firewall.addrgrp.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_ipip_tunnel – Configure IP in IP Tunneling in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ipip\_tunnel – Configure IP in IP Tunneling in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ipip_tunnel`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipip\_tunnel 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_ipip\_tunnel** dictionary | | Configure IP in IP Tunneling. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable tunnel ASIC offloading. |
| | **interface** string | | Interface name that is associated with the incoming traffic from available options. Source system.interface.name. |
| | **local\_gw** string | | IPv4 address for the local gateway. |
| | **name** string / required | | IPIP Tunnel name. |
| | **remote\_gw** string | | IPv4 address for the remote gateway. |
| | **use\_sdwan** string | **Choices:*** disable
* enable
| Enable/disable use of SD-WAN to reach remote gateway. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IP in IP Tunneling.
fortios_system_ipip_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ipip_tunnel:
auto_asic_offload: "enable"
interface: "<your_own_value> (source system.interface.name)"
local_gw: "<your_own_value>"
name: "default_name_6"
remote_gw: "<your_own_value>"
use_sdwan: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_fortisandbox – Configure FortiSandbox in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fortisandbox – Configure FortiSandbox in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_fortisandbox`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortisandbox 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_fortisandbox** dictionary | | Configure FortiSandbox. |
| | **email** string | | Notifier email address. |
| | **enc\_algorithm** string | **Choices:*** default
* high
* low
| Configure the level of SSL protection for secure communication with FortiSandbox. |
| | **forticloud** string | **Choices:*** enable
* disable
| Enable/disable FortiSandbox Cloud. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **server** string | | IPv4 or IPv6 address of the remote FortiSandbox. |
| | **source\_ip** string | | Source IP address for communications to FortiSandbox. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FortiSandbox. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSandbox.
fortios_system_fortisandbox:
vdom: "{{ vdom }}"
system_fortisandbox:
email: "<your_own_value>"
enc_algorithm: "default"
forticloud: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_peer – Configure peer users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_peer – Configure peer users in Fortinet’s FortiOS and FortiGate.
================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_peer`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and peer 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_peer** dictionary | | Configure peer users. |
| | **ca** string | | Name of the CA certificate as returned by the execute vpn certificate ca list command. Source vpn.certificate.ca.name. |
| | **cn** string | | Peer certificate common name. |
| | **cn\_type** string | **Choices:*** string
* email
* FQDN
* ipv4
* ipv6
| Peer certificate common name type. |
| | **ldap\_mode** string | **Choices:*** password
* principal-name
| Mode for LDAP peer authentication. |
| | **ldap\_password** string | | Password for LDAP server bind. |
| | **ldap\_server** string | | Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name. |
| | **ldap\_username** string | | Username for LDAP server bind. |
| | **mandatory\_ca\_verify** string | **Choices:*** enable
* disable
| Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. |
| | **name** string / required | | Peer name. |
| | **ocsp\_override\_server** string | | Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name. |
| | **passwd** string | | Peer"s password used for two-factor authentication. |
| | **subject** string | | Peer certificate name constraints. |
| | **two\_factor** string | **Choices:*** enable
* disable
| Enable/disable two-factor authentication, applying certificate and password-based authentication. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure peer users.
fortios_user_peer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_peer:
ca: "<your_own_value> (source vpn.certificate.ca.name)"
cn: "<your_own_value>"
cn_type: "string"
ldap_mode: "password"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
ldap_username: "<your_own_value>"
mandatory_ca_verify: "enable"
name: "default_name_11"
ocsp_override_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
passwd: "<your_own_value>"
subject: "<your_own_value>"
two_factor: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_vdom_exception – Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_exception – Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_vdom_exception`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom\_exception 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_vdom\_exception** dictionary | | Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope. |
| | **id** integer / required | | Index <1-4096>. |
| | **object** string | **Choices:*** log.fortianalyzer.setting
* log.fortianalyzer.override-setting
* log.fortianalyzer2.setting
* log.fortianalyzer2.override-setting
* log.fortianalyzer3.setting
* log.fortianalyzer3.override-setting
* system.central-management
* system.csf
* user.radius
* log.fortianalyzer-cloud.setting
* log.fortianalyzer-cloud.override-setting
* log.syslogd.setting
* log.syslogd.override-setting
* log.syslogd2.setting
* log.syslogd2.override-setting
* log.syslogd3.setting
* log.syslogd3.override-setting
* log.syslogd4.setting
* log.syslogd4.override-setting
* system.interface
* vpn.ipsec.phase1-interface
* vpn.ipsec.phase2-interface
* router.bgp
* router.route-map
* router.prefix-list
* firewall.ippool
* firewall.ippool6
* router.static
* router.static6
* firewall.vip
* firewall.vip6
* firewall.vip46
* firewall.vip64
* system.sdwan
* system.saml
* router.policy
* router.policy6
| Name of the configuration object that can be configured independently for all VDOMs. |
| | **oid** integer | | Object ID. |
| | **scope** string | **Choices:*** all
* inclusive
* exclusive
| Determine whether the configuration object can be configured separately for all VDOMs or if some VDOMs share the same configuration. |
| | **vdom** list / elements=string | | Names of the VDOMs. |
| | | **name** string / required | | VDOM name. Source system.vdom.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope.
fortios_system_vdom_exception:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom_exception:
id: "3"
object: "log.fortianalyzer.setting"
oid: "5"
scope: "all"
vdom:
-
name: "default_name_8 (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_spamfilter_profile – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_profile – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_spamfilter_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **spamfilter\_profile** dictionary | | Configure AntiSpam profiles. |
| | **comment** string | | Comment. |
| | **external** string | **Choices:*** enable
* disable
| Enable/disable external Email inspection. |
| | **flow\_based** string | **Choices:*** enable
* disable
| Enable/disable flow-based spam filtering. |
| | **gmail** dictionary | | Gmail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | **imap** dictionary | | IMAP. |
| | | **action** string | **Choices:*** pass
* tag
| Action for spam email. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **tag\_msg** string | | Subject text or header added to spam email. |
| | | **tag\_type** list / elements=string | **Choices:*** subject
* header
* spaminfo
| Tag subject or header for spam email. |
| | **mapi** dictionary | | MAPI. |
| | | **action** string | **Choices:*** pass
* discard
| Action for spam email. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | **msn\_hotmail** dictionary | | MSN Hotmail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | **name** string / required | | Profile name. |
| | **options** list / elements=string | **Choices:*** bannedword
* spambwl
* spamfsip
* spamfssubmit
* spamfschksum
* spamfsurl
* spamhelodns
* spamraddrdns
* spamrbl
* spamhdrcheck
* spamfsphish
| Options. |
| | **pop3** dictionary | | POP3. |
| | | **action** string | **Choices:*** pass
* tag
| Action for spam email. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **tag\_msg** string | | Subject text or header added to spam email. |
| | | **tag\_type** list / elements=string | **Choices:*** subject
* header
* spaminfo
| Tag subject or header for spam email. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **smtp** dictionary | | SMTP. |
| | | **action** string | **Choices:*** pass
* tag
* discard
| Action for spam email. |
| | | **hdrip** string | **Choices:*** disable
* enable
| Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. |
| | | **local\_override** string | **Choices:*** disable
* enable
| Enable/disable local filter to override SMTP remote check result. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **tag\_msg** string | | Subject text or header added to spam email. |
| | | **tag\_type** list / elements=string | **Choices:*** subject
* header
* spaminfo
| Tag subject or header for spam email. |
| | **spam\_bwl\_table** integer | | Anti-spam black/white list table ID. Source spamfilter.bwl.id. |
| | **spam\_bword\_table** integer | | Anti-spam banned word table ID. Source spamfilter.bword.id. |
| | **spam\_bword\_threshold** integer | | Spam banned word threshold. |
| | **spam\_filtering** string | **Choices:*** enable
* disable
| Enable/disable spam filtering. |
| | **spam\_iptrust\_table** integer | | Anti-spam IP trust table ID. Source spamfilter.iptrust.id. |
| | **spam\_log** string | **Choices:*** disable
* enable
| Enable/disable spam logging for email filtering. |
| | **spam\_log\_fortiguard\_response** string | **Choices:*** disable
* enable
| Enable/disable logging FortiGuard spam response. |
| | **spam\_mheader\_table** integer | | Anti-spam MIME header table ID. Source spamfilter.mheader.id. |
| | **spam\_rbl\_table** integer | | Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id. |
| | **yahoo\_mail** dictionary | | Yahoo! Mail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam profiles.
fortios_spamfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_profile:
comment: "Comment."
external: "enable"
flow_based: "enable"
gmail:
log: "enable"
imap:
action: "pass"
log: "enable"
tag_msg: "<your_own_value>"
tag_type: "subject"
mapi:
action: "pass"
log: "enable"
msn_hotmail:
log: "enable"
name: "default_name_18"
options: "bannedword"
pop3:
action: "pass"
log: "enable"
tag_msg: "<your_own_value>"
tag_type: "subject"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
smtp:
action: "pass"
hdrip: "disable"
local_override: "disable"
log: "enable"
tag_msg: "<your_own_value>"
tag_type: "subject"
spam_bwl_table: "33 (source spamfilter.bwl.id)"
spam_bword_table: "34 (source spamfilter.bword.id)"
spam_bword_threshold: "35"
spam_filtering: "enable"
spam_iptrust_table: "37 (source spamfilter.iptrust.id)"
spam_log: "disable"
spam_log_fortiguard_response: "disable"
spam_mheader_table: "40 (source spamfilter.mheader.id)"
spam_rbl_table: "41 (source spamfilter.dnsbl.id)"
yahoo_mail:
log: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_dynamic_port_policy – Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_dynamic\_port\_policy – Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_dynamic_port_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and dynamic\_port\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_dynamic\_port\_policy** dictionary | | Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device. |
| | **description** string | | Description for the Dynamic port policy. |
| | **fortilink** string | | FortiLink interface for which this Dynamic port policy belongs to. Source system.interface.name. |
| | **name** string / required | | Dynamic port policy name. |
| | **policy** list / elements=string | | Port policies with matching criteria and actions. |
| | | **802\_1x** string | | 802.1x security policy to be applied when using this policy. Source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name. |
| | | **bounce\_port\_link** string | **Choices:*** disable
* enable
| Enable/disable bouncing (administratively bring the link down, up) of a switch port where this policy is applied. Helps to clear and reassign VLAN from lldp-profile. |
| | | **category** string | **Choices:*** device
* interface-tag
| Category of Dynamic port policy. |
| | | **description** string | | Description for the policy. |
| | | **family** string | | Policy matching family. |
| | | **host** string | | Policy matching host. |
| | | **interface\_tags** list / elements=string | | Policy matching the FortiSwitch interface object tags. |
| | | | **tag\_name** string | | FortiSwitch port tag name. Source switch-controller.switch-interface-tag.name. |
| | | **lldp\_profile** string | | LLDP profile to be applied when using this policy. Source switch-controller.lldp-profile.name. |
| | | **mac** string | | Policy matching MAC address. |
| | | **name** string / required | | Policy name. |
| | | **qos\_policy** string | | QoS policy to be applied when using this policy. Source switch-controller.qos.qos-policy.name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable policy. |
| | | **type** string | | Policy matching type. |
| | | **vlan\_policy** string | | VLAN policy to be applied when using this policy. Source switch-controller.vlan-policy.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
fortios_switch_controller_dynamic_port_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_dynamic_port_policy:
description: "<your_own_value>"
fortilink: "<your_own_value> (source system.interface.name)"
name: "default_name_5"
policy:
-
802_1x: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name)"
bounce_port_link: "disable"
category: "device"
description: "<your_own_value>"
family: "<your_own_value>"
host: "myhostname"
interface_tags:
-
tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
mac: "<your_own_value>"
name: "default_name_17"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
status: "enable"
type: "<your_own_value>"
vlan_policy: "<your_own_value> (source switch-controller.vlan-policy.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_system – Configure system-wide switch controller settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_system – Configure system-wide switch controller settings in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_system`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and system 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_system** dictionary | | Configure system-wide switch controller settings. |
| | **data\_sync\_interval** integer | | Time interval between collection of switch data (30 - 1800 sec). |
| | **dynamic\_periodic\_interval** integer | | Periodic time interval to run Dynamic port policy engine (5 - 60 sec). |
| | **iot\_holdoff** integer | | MAC entry"s creation time. Time must be greater than this value for an entry to be created (0 - 10080 mins). |
| | **iot\_mac\_idle** integer | | MAC entry"s idle time. MAC entry is removed after this value (0 - 10080 mins). |
| | **iot\_scan\_interval** integer | | IoT scan interval (2 - 10080 mins). |
| | **iot\_weight\_threshold** integer | | MAC entry"s confidence value. Value is re-queried when below this value . |
| | **nac\_periodic\_interval** integer | | Periodic time interval to run NAC engine (5 - 60 sec). |
| | **parallel\_process** integer | | Maximum number of parallel processes (1 - 300). |
| | **parallel\_process\_override** string | **Choices:*** disable
* enable
| Enable/disable parallel process override. |
| | **tunnel\_mode** string | **Choices:*** compatible
* strict
| Compatible/strict tunnel mode. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure system-wide switch controller settings.
fortios_switch_controller_system:
vdom: "{{ vdom }}"
switch_controller_system:
data_sync_interval: "3"
dynamic_periodic_interval: "4"
iot_holdoff: "5"
iot_mac_idle: "6"
iot_scan_interval: "7"
iot_weight_threshold: "8"
nac_periodic_interval: "9"
parallel_process: "10"
parallel_process_override: "disable"
tunnel_mode: "compatible"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_memory_filter – Filters for memory buffer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_memory\_filter – Filters for memory buffer in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_memory_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_memory feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_memory\_filter** dictionary | | Filters for memory buffer. |
| | **admin** string | **Choices:*** enable
* disable
| Enable/disable admin login/logout logging. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **auth** string | **Choices:*** enable
* disable
| Enable/disable firewall authentication logging. |
| | **cpu\_memory\_usage** string | **Choices:*** enable
* disable
| Enable/disable CPU & memory usage logging every 5 minutes. |
| | **dhcp** string | **Choices:*** enable
* disable
| Enable/disable DHCP service messages logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **event** string | **Choices:*** enable
* disable
| Enable/disable event logging. |
| | **filter** string | | Memory log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **ha** string | **Choices:*** enable
* disable
| Enable/disable HA logging. |
| | **ipsec** string | **Choices:*** enable
* disable
| Enable/disable IPsec negotiation messages logging. |
| | **ldb\_monitor** string | **Choices:*** enable
* disable
| Enable/disable VIP real server health monitoring logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **notification** string | **Choices:*** enable
* disable
| Enable/disable notification messages logging. |
| | **pattern** string | **Choices:*** enable
* disable
| Enable/disable pattern update logging. |
| | **ppp** string | **Choices:*** enable
* disable
| Enable/disable L2TP/PPTP/PPPoE logging. |
| | **radius** string | **Choices:*** enable
* disable
| Enable/disable RADIUS messages logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Log every message above and including this severity level. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **sslvpn\_log\_adm** string | **Choices:*** enable
* disable
| Enable/disable SSL administrator login logging. |
| | **sslvpn\_log\_auth** string | **Choices:*** enable
* disable
| Enable/disable SSL user authentication logging. |
| | **sslvpn\_log\_session** string | **Choices:*** enable
* disable
| Enable/disable SSL session logging. |
| | **system** string | **Choices:*** enable
* disable
| Enable/disable system activity logging. |
| | **vip\_ssl** string | **Choices:*** enable
* disable
| Enable/disable VIP SSL logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| | **wan\_opt** string | **Choices:*** enable
* disable
| Enable/disable WAN optimization event logging. |
| | **wireless\_activity** string | **Choices:*** enable
* disable
| Enable/disable wireless activity event logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for memory buffer.
fortios_log_memory_filter:
vdom: "{{ vdom }}"
log_memory_filter:
admin: "enable"
anomaly: "enable"
auth: "enable"
cpu_memory_usage: "enable"
dhcp: "enable"
dns: "enable"
event: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "17"
gtp: "enable"
ha: "enable"
ipsec: "enable"
ldb_monitor: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
notification: "enable"
pattern: "enable"
ppp: "enable"
radius: "enable"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
sslvpn_log_adm: "enable"
sslvpn_log_auth: "enable"
sslvpn_log_session: "enable"
system: "enable"
vip_ssl: "enable"
voip: "enable"
wan_opt: "enable"
wireless_activity: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_internet_service_owner – Internet Service owner in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_owner – Internet Service owner in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_internet_service_owner`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet\_service\_owner 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_internet\_service\_owner** dictionary | | Internet Service owner. |
| | **id** integer / required | | Internet Service owner ID. |
| | **name** string | | Internet Service owner name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Internet Service owner.
fortios_firewall_internet_service_owner:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_owner:
id: "3"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_timers – Configure CAPWAP timers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_timers – Configure CAPWAP timers in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_timers`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and timers 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_timers** dictionary | | Configure CAPWAP timers. |
| | **ble\_scan\_report\_intv** integer | | Time between running Bluetooth Low Energy (BLE) reports (10 - 3600 sec). |
| | **client\_idle\_timeout** integer | | Time after which a client is considered idle and times out (20 - 3600 sec). |
| | **darrp\_day** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Weekday on which to run DARRP optimization. |
| | **darrp\_optimize** integer | | Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). |
| | **darrp\_time** list / elements=string | | Time at which DARRP optimizations run (you can add up to 8 times). |
| | | **time** string / required | | Time. |
| | **discovery\_interval** integer | | Time between discovery requests (2 - 180 sec). |
| | **drma\_interval** integer | | Dynamic radio mode assignment (DRMA) schedule interval in minutes (10 - 1440). |
| | **echo\_interval** integer | | Time between echo requests sent by the managed WTP, AP, or FortiAP (1 - 255 sec). |
| | **fake\_ap\_log** integer | | Time between recording logs about fake APs if periodic fake AP logging is configured (0 - 1440 min). |
| | **ipsec\_intf\_cleanup** integer | | Time period to keep IPsec VPN interfaces up after WTP sessions are disconnected (30 - 3600 sec). |
| | **radio\_stats\_interval** integer | | Time between running radio reports (1 - 255 sec). |
| | **rogue\_ap\_log** integer | | Time between logging rogue AP messages if periodic rogue AP logging is configured (0 - 1440 min). |
| | **sta\_capability\_interval** integer | | Time between running station capability reports (1 - 255 sec). |
| | **sta\_locate\_timer** integer | | Time between running client presence flushes to remove clients that are listed but no longer present (0 - 86400 sec). |
| | **sta\_stats\_interval** integer | | Time between running client (station) reports (1 - 255 sec). |
| | **vap\_stats\_interval** integer | | Time between running Virtual Access Point (VAP) reports (1 - 255 sec). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure CAPWAP timers.
fortios_wireless_controller_timers:
vdom: "{{ vdom }}"
wireless_controller_timers:
ble_scan_report_intv: "3"
client_idle_timeout: "4"
darrp_day: "sunday"
darrp_optimize: "6"
darrp_time:
-
time: "<your_own_value>"
discovery_interval: "9"
drma_interval: "10"
echo_interval: "11"
fake_ap_log: "12"
ipsec_intf_cleanup: "13"
radio_stats_interval: "14"
rogue_ap_log: "15"
sta_capability_interval: "16"
sta_locate_timer: "17"
sta_stats_interval: "18"
vap_stats_interval: "19"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_nac_policy – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_nac\_policy – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_nac_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and nac\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_nac\_policy** dictionary | | Configure NAC policy matching pattern to identify matching NAC devices. |
| | **category** string | **Choices:*** device
* firewall-user
* ems-tag
| Category of NAC policy. |
| | **description** string | | Description for the NAC policy matching pattern. |
| | **ems\_tag** string | | NAC policy matching EMS tag. Source firewall.address.name. |
| | **family** string | | NAC policy matching family. |
| | **host** string | | NAC policy matching host. |
| | **hw\_vendor** string | | NAC policy matching hardware vendor. |
| | **hw\_version** string | | NAC policy matching hardware version. |
| | **mac** string | | NAC policy matching MAC address. |
| | **name** string / required | | NAC policy name. |
| | **os** string | | NAC policy matching operating system. |
| | **src** string | | NAC policy matching source. |
| | **ssid\_policy** string | | SSID policy to be applied on the matched NAC policy. Source wireless-controller.ssid-policy.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable NAC policy. |
| | **sw\_version** string | | NAC policy matching software version. |
| | **switch\_auto\_auth** string | **Choices:*** global
* disable
* enable
| NAC device auto authorization when discovered and nac-policy matched. |
| | **switch\_fortilink** string | | FortiLink interface for which this NAC policy belongs to. Source system.interface.name. |
| | **switch\_mac\_policy** string | | switch-mac-policy to be applied on the matched NAC policy. Source switch-controller.mac-policy.name. |
| | **switch\_port\_policy** string | | switch-port-policy to be applied on the matched NAC policy. Source switch-controller.port-policy.name. |
| | **switch\_scope** list / elements=string | | List of managed FortiSwitches on which NAC policy can be applied. |
| | | **switch\_id** string | | Managed FortiSwitch name from available options. Source switch-controller.managed-switch.switch-id. |
| | **type** string | | NAC policy matching type. |
| | **user** string | | NAC policy matching user. |
| | **user\_group** string | | NAC policy matching user group. Source user.group.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NAC policy matching pattern to identify matching NAC devices.
fortios_user_nac_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_nac_policy:
category: "device"
description: "<your_own_value>"
ems_tag: "<your_own_value> (source firewall.address.name)"
family: "<your_own_value>"
host: "myhostname"
hw_vendor: "<your_own_value>"
hw_version: "<your_own_value>"
mac: "<your_own_value>"
name: "default_name_11"
os: "<your_own_value>"
src: "<your_own_value>"
ssid_policy: "<your_own_value> (source wireless-controller.ssid-policy.name)"
status: "enable"
sw_version: "<your_own_value>"
switch_auto_auth: "global"
switch_fortilink: "<your_own_value> (source system.interface.name)"
switch_mac_policy: "<your_own_value> (source switch-controller.mac-policy.name)"
switch_port_policy: "<your_own_value> (source switch-controller.port-policy.name)"
switch_scope:
-
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
type: "<your_own_value>"
user: "<your_own_value>"
user_group: "<your_own_value> (source user.group.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_dlp_sensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dlp\_sensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dlp_sensitivity`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and sensitivity 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dlp\_sensitivity** dictionary | | Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source. |
| | **name** string / required | | DLP Sensitivity Levels. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source.
fortios_dlp_sensitivity:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_sensitivity:
name: "default_name_3"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_traffic_sniffer – Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_traffic\_sniffer – Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_traffic_sniffer`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and traffic\_sniffer 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_traffic\_sniffer** dictionary | | Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters. |
| | **erspan\_ip** string | | Configure ERSPAN collector IP address. |
| | **mode** string | **Choices:*** erspan-auto
* rspan
* none
| Configure traffic sniffer mode. |
| | **target\_ip** list / elements=string | | Sniffer IPs to filter. |
| | | **description** string | | Description for the sniffer IP. |
| | | **dst\_entry\_id** integer | | FortiSwitch dest entry ID for the sniffer IP. |
| | | **ip** string / required | | Sniffer IP. |
| | | **src\_entry\_id** integer | | FortiSwitch source entry ID for the sniffer IP. |
| | **target\_mac** list / elements=string | | Sniffer MACs to filter. |
| | | **description** string | | Description for the sniffer MAC. |
| | | **dst\_entry\_id** integer | | FortiSwitch dest entry ID for the sniffer MAC. |
| | | **mac** string / required | | Sniffer MAC. |
| | | **src\_entry\_id** integer | | FortiSwitch source entry ID for the sniffer MAC. |
| | **target\_port** list / elements=string | | Sniffer ports to filter. |
| | | **description** string | | Description for the sniffer port entry. |
| | | **in\_ports** list / elements=string | | Configure source ingress port interfaces. |
| | | | **name** string / required | | Interface name. |
| | | **out\_ports** list / elements=string | | Configure source egress port interfaces. |
| | | | **name** string / required | | Interface name. |
| | | **switch\_id** string | | Managed-switch ID. Source switch-controller.managed-switch.switch-id. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
fortios_switch_controller_traffic_sniffer:
vdom: "{{ vdom }}"
switch_controller_traffic_sniffer:
erspan_ip: "<your_own_value>"
mode: "erspan-auto"
target_ip:
-
description: "<your_own_value>"
dst_entry_id: "7"
ip: "<your_own_value>"
src_entry_id: "9"
target_mac:
-
description: "<your_own_value>"
dst_entry_id: "12"
mac: "<your_own_value>"
src_entry_id: "14"
target_port:
-
description: "<your_own_value>"
in_ports:
-
name: "default_name_18"
out_ports:
-
name: "default_name_20"
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortiguard_filter – Filters for FortiCloud in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortiguard\_filter – Filters for FortiCloud in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortiguard_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortiguard feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortiguard\_filter** dictionary | | Filters for FortiCloud. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | FortiCloud log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for FortiCloud.
fortios_log_fortiguard_filter:
vdom: "{{ vdom }}"
log_fortiguard_filter:
anomaly: "enable"
dlp_archive: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "13"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_custom_language – Configure custom languages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_custom\_language – Configure custom languages in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_custom_language`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and custom\_language 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_custom\_language** dictionary | | Configure custom languages. |
| | **comments** string | | Comment. |
| | **filename** string | | Custom language file path. |
| | **name** string / required | | Name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure custom languages.
fortios_system_custom_language:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_custom_language:
comments: "<your_own_value>"
filename: "<your_own_value>"
name: "default_name_5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_profile_protocol_options – Configure protocol options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_profile\_protocol\_options – Configure protocol options in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_profile_protocol_options`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile\_protocol\_options 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_profile\_protocol\_options** dictionary | | Configure protocol options. |
| | **cifs** dictionary | | Configure CIFS protocol options. |
| | | **domain\_controller** string | | Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name. |
| | | **options** list / elements=string | **Choices:*** oversize
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **server\_credential\_type** string | **Choices:*** none
* credential-replication
* credential-keytab
| CIFS server credential type. |
| | | **server\_keytab** string | | Server keytab. |
| | | | **keytab** string | | Base64 encoded keytab file containing credential of the server. |
| | | | **principal** string / required | | Service principal. For example, "host/[email protected]". |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **tcp\_window\_maximum** integer | | Maximum dynamic TCP window size . |
| | | **tcp\_window\_minimum** integer | | Minimum dynamic TCP window size . |
| | | **tcp\_window\_size** integer | | Set TCP static window size . |
| | | **tcp\_window\_type** string | **Choices:*** system
* static
* dynamic
| Specify type of TCP window to use for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **comment** string | | Optional comments. |
| | **dns** dictionary | | Configure DNS protocol options. |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | **ftp** dictionary | | Configure FTP protocol options. |
| | | **comfort\_amount** integer | | Amount of data to send in a transmission for client comforting (1 - 10240 bytes). |
| | | **comfort\_interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec). |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** clientcomfort
* oversize
* splice
* bypass-rest-command
* bypass-mode-command
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **stream\_based\_uncompressed\_limit** integer | | Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.). |
| | | **tcp\_window\_maximum** integer | | Maximum dynamic TCP window size. |
| | | **tcp\_window\_minimum** integer | | Minimum dynamic TCP window size. |
| | | **tcp\_window\_size** integer | | Set TCP static window size. |
| | | **tcp\_window\_type** string | **Choices:*** system
* static
* dynamic
| TCP window type to use for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **http** dictionary | | Configure HTTP protocol options. |
| | | **block\_page\_status\_code** integer | | Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599). |
| | | **comfort\_amount** integer | | Amount of data to send in a transmission for client comforting (1 - 10240 bytes). |
| | | **comfort\_interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec). |
| | | **fortinet\_bar** string | **Choices:*** enable
* disable
| Enable/disable Fortinet bar on HTML content. |
| | | **fortinet\_bar\_port** integer | | Port for use by Fortinet Bar (1 - 65535). |
| | | **http\_policy** string | **Choices:*** disable
* enable
| Enable/disable HTTP policy check. |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** clientcomfort
* servercomfort
* oversize
* chunkedbypass
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **post\_lang** list / elements=string | **Choices:*** jisx0201
* jisx0208
* jisx0212
* gb2312
* ksc5601-ex
* euc-jp
* sjis
* iso2022-jp
* iso2022-jp-1
* iso2022-jp-2
* euc-cn
* ces-gbk
* hz
* ces-big5
* euc-kr
* iso2022-jp-3
* iso8859-1
* tis620
* cp874
* cp1252
* cp1251
| ID codes for character sets to be used to convert to UTF-8 for banned words and DLP on HTTP posts (maximum of 5 character sets). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **range\_block** string | **Choices:*** disable
* enable
| Enable/disable blocking of partial downloads. |
| | | **retry\_count** integer | | Number of attempts to retry HTTP connection (0 - 100). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **stream\_based\_uncompressed\_limit** integer | | Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.). |
| | | **streaming\_content\_bypass** string | **Choices:*** enable
* disable
| Enable/disable bypassing of streaming content from buffering. |
| | | **strip\_x\_forwarded\_for** string | **Choices:*** disable
* enable
| Enable/disable stripping of HTTP X-Forwarded-For header. |
| | | **switching\_protocols** string | **Choices:*** bypass
* block
| Bypass from scanning, or block a connection that attempts to switch protocol. |
| | | **tcp\_window\_maximum** integer | | Maximum dynamic TCP window size . |
| | | **tcp\_window\_minimum** integer | | Minimum dynamic TCP window size . |
| | | **tcp\_window\_size** integer | | Set TCP static window size . |
| | | **tcp\_window\_type** string | **Choices:*** system
* static
* dynamic
| Specify type of TCP window to use for this protocol. |
| | | **tunnel\_non\_http** string | **Choices:*** enable
* disable
| Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can occur if an application sends non-HTTP traffic using an HTTP destination port. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | | **unknown\_http\_version** string | **Choices:*** reject
* tunnel
* best-effort
| How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. |
| | **imap** dictionary | | Configure IMAP protocol options. |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** fragmail
* oversize
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **mail\_signature** dictionary | | Configure Mail signature. |
| | | **signature** string | | Email signature to be added to outgoing email (if the signature contains spaces, enclose with quotation marks). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable adding an email signature to SMTP email messages as they pass through the FortiGate. |
| | **mapi** dictionary | | Configure MAPI protocol options. |
| | | **options** list / elements=string | **Choices:*** fragmail
* oversize
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **name** string / required | | Name. |
| | **nntp** dictionary | | Configure NNTP protocol options. |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* splice
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **oversize\_log** string | **Choices:*** disable
* enable
| Enable/disable logging for antivirus oversize file blocking. |
| | **pop3** dictionary | | Configure POP3 protocol options. |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** fragmail
* oversize
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **replacemsg\_group** string | | Name of the replacement message group to be used Source system.replacemsg-group.name. |
| | **rpc\_over\_http** string | **Choices:*** enable
* disable
| Enable/disable inspection of RPC over HTTP. |
| | **smtp** dictionary | | Configure SMTP protocol options. |
| | | **inspect\_all** string | **Choices:*** enable
* disable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** fragmail
* oversize
* splice
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **ports** integer | | Ports to scan for content (1 - 65535). |
| | | **proxy\_after\_tcp\_handshake** string | **Choices:*** enable
* disable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **server\_busy** string | **Choices:*** enable
* disable
| Enable/disable SMTP server busy when server not available. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of scanning for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **ssh** dictionary | | Configure SFTP and SCP protocol options. |
| | | **comfort\_amount** integer | | Amount of data to send in a transmission for client comforting (1 - 65535 bytes). |
| | | **comfort\_interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec). |
| | | **options** list / elements=string | **Choices:*** oversize
* clientcomfort
* servercomfort
| One or more options that can be applied to the session. |
| | | **oversize\_limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB). |
| | | **scan\_bzip2** string | **Choices:*** enable
* disable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl\_offloaded** string | **Choices:*** False
* True
| SSL decryption and encryption performed by an external device. |
| | | **stream\_based\_uncompressed\_limit** integer | | Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.). |
| | | **tcp\_window\_maximum** integer | | Maximum dynamic TCP window size. |
| | | **tcp\_window\_minimum** integer | | Minimum dynamic TCP window size. |
| | | **tcp\_window\_size** integer | | Set TCP static window size. |
| | | **tcp\_window\_type** string | **Choices:*** system
* static
* dynamic
| TCP window type to use for this protocol. |
| | | **uncompressed\_nest\_limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
| | | **uncompressed\_oversize\_limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited). |
| | **switching\_protocols\_log** string | **Choices:*** disable
* enable
| Enable/disable logging for HTTP/HTTPS switching protocols. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure protocol options.
fortios_firewall_profile_protocol_options:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_profile_protocol_options:
cifs:
domain_controller: "<your_own_value> (source credential-store.domain-controller.server-name)"
options: "oversize"
oversize_limit: "6"
ports: "7"
scan_bzip2: "enable"
server_credential_type: "none"
server_keytab:
-
keytab: "<your_own_value>"
principal: "<your_own_value>"
status: "enable"
tcp_window_maximum: "14"
tcp_window_minimum: "15"
tcp_window_size: "16"
tcp_window_type: "system"
uncompressed_nest_limit: "18"
uncompressed_oversize_limit: "19"
comment: "Optional comments."
dns:
ports: "22"
status: "enable"
ftp:
comfort_amount: "25"
comfort_interval: "26"
inspect_all: "enable"
options: "clientcomfort"
oversize_limit: "29"
ports: "30"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
stream_based_uncompressed_limit: "34"
tcp_window_maximum: "35"
tcp_window_minimum: "36"
tcp_window_size: "37"
tcp_window_type: "system"
uncompressed_nest_limit: "39"
uncompressed_oversize_limit: "40"
http:
block_page_status_code: "42"
comfort_amount: "43"
comfort_interval: "44"
fortinet_bar: "enable"
fortinet_bar_port: "46"
http_policy: "disable"
inspect_all: "enable"
options: "clientcomfort"
oversize_limit: "50"
ports: "51"
post_lang: "jisx0201"
proxy_after_tcp_handshake: "enable"
range_block: "disable"
retry_count: "55"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
stream_based_uncompressed_limit: "59"
streaming_content_bypass: "enable"
strip_x_forwarded_for: "disable"
switching_protocols: "bypass"
tcp_window_maximum: "63"
tcp_window_minimum: "64"
tcp_window_size: "65"
tcp_window_type: "system"
tunnel_non_http: "enable"
uncompressed_nest_limit: "68"
uncompressed_oversize_limit: "69"
unknown_http_version: "reject"
imap:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "74"
ports: "75"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "80"
uncompressed_oversize_limit: "81"
mail_signature:
signature: "<your_own_value>"
status: "disable"
mapi:
options: "fragmail"
oversize_limit: "87"
ports: "88"
scan_bzip2: "enable"
status: "enable"
uncompressed_nest_limit: "91"
uncompressed_oversize_limit: "92"
name: "default_name_93"
nntp:
inspect_all: "enable"
options: "oversize"
oversize_limit: "97"
ports: "98"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
status: "enable"
uncompressed_nest_limit: "102"
uncompressed_oversize_limit: "103"
oversize_log: "disable"
pop3:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "108"
ports: "109"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "114"
uncompressed_oversize_limit: "115"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
rpc_over_http: "enable"
smtp:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "121"
ports: "122"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
server_busy: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "128"
uncompressed_oversize_limit: "129"
ssh:
comfort_amount: "131"
comfort_interval: "132"
options: "oversize"
oversize_limit: "134"
scan_bzip2: "enable"
ssl_offloaded: "no"
stream_based_uncompressed_limit: "137"
tcp_window_maximum: "138"
tcp_window_minimum: "139"
tcp_window_size: "140"
tcp_window_type: "system"
uncompressed_nest_limit: "142"
uncompressed_oversize_limit: "143"
switching_protocols_log: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_ipv6_neighbor_cache – Configure IPv6 neighbor cache table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ipv6\_neighbor\_cache – Configure IPv6 neighbor cache table in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ipv6_neighbor_cache`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipv6\_neighbor\_cache 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_ipv6\_neighbor\_cache** dictionary | | Configure IPv6 neighbor cache table. |
| | **id** integer / required | | Unique integer ID of the entry. |
| | **interface** string | | Select the associated interface name from available options. Source system.interface.name. |
| | **ipv6** string | | IPv6 address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **mac** string | | MAC address (format: xx:xx:xx:xx:xx:xx). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 neighbor cache table.
fortios_system_ipv6_neighbor_cache:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ipv6_neighbor_cache:
id: "3"
interface: "<your_own_value> (source system.interface.name)"
ipv6: "<your_own_value>"
mac: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_quarantine – Configure quarantine support in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_quarantine – Configure quarantine support in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_quarantine`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **user\_quarantine** dictionary | | Configure quarantine support. |
| | **firewall\_groups** string | | Firewall address group which includes all quarantine MAC address. Source firewall.addrgrp.name. |
| | **quarantine** string | **Choices:*** enable
* disable
| Enable/disable quarantine. |
| | **targets** list / elements=string | | Quarantine entry to hold multiple MACs. |
| | | **description** string | | Description for the quarantine entry. |
| | | **entry** string / required | | Quarantine entry name. |
| | | **macs** list / elements=string | | Quarantine MACs. |
| | | | **description** string | | Description for the quarantine MAC. |
| | | | **drop** string | **Choices:*** disable
* enable
| Enable/Disable dropping of quarantined device traffic |
| | | | **entry\_id** integer | | FSW entry id for the quarantine MAC. |
| | | | **mac** string / required | | Quarantine MAC. |
| | | | **parent** string | | Parent entry name. |
| | **traffic\_policy** string | | Traffic policy for quarantined MACs. Source switch-controller.traffic-policy.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure quarantine support.
fortios_user_quarantine:
vdom: "{{ vdom }}"
user_quarantine:
firewall_groups: "<your_own_value> (source firewall.addrgrp.name)"
quarantine: "enable"
targets:
-
description: "<your_own_value>"
entry: "<your_own_value>"
macs:
-
description: "<your_own_value>"
drop: "disable"
entry_id: "11"
mac: "<your_own_value>"
parent: "<your_own_value>"
traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_nsxt_service_chain – Configure NSX-T service chain in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_nsxt\_service\_chain – Configure NSX-T service chain in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_nsxt_service_chain`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify nsxt feature and service\_chain 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **nsxt\_service\_chain** dictionary | | Configure NSX-T service chain. |
| | **id** integer / required | | Chain ID. |
| | **name** string | | Chain name. |
| | **service\_index** list / elements=string | | Configure service index. |
| | | **id** integer / required | | Service index. |
| | | **name** string | | Index name. |
| | | **reverse\_index** integer | | Reverse service index. |
| | | **vd** string | | VDOM name. Source system.vdom.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NSX-T service chain.
fortios_nsxt_service_chain:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
nsxt_service_chain:
id: "3"
name: "default_name_4"
service_index:
-
id: "6"
name: "default_name_7"
reverse_index: "8"
vd: "<your_own_value> (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_setting – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_setting – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_setting** dictionary | | VDOM wireless controller configuration. |
| | **account\_id** string | | FortiCloud customer account ID. |
| | **country** string | **Choices:*** NA
* AL
* DZ
* AO
* AR
* AM
* AU
* AT
* AZ
* BH
* BD
* BB
* BY
* BE
* BZ
* BO
* BA
* BR
* BN
* BG
* KH
* CL
* CN
* CO
* CR
* HR
* CY
* CZ
* DK
* DO
* EC
* EG
* SV
* EE
* FI
* FR
* GE
* DE
* GR
* GL
* GD
* GU
* GT
* HT
* HN
* HK
* HU
* IS
* IN
* ID
* IR
* IE
* IL
* IT
* JM
* JO
* KZ
* KE
* KP
* KR
* KW
* LV
* LB
* LI
* LT
* LU
* MO
* MK
* MY
* MT
* MX
* MC
* MA
* MZ
* MM
* NP
* NL
* AN
* AW
* NZ
* False
* OM
* PK
* PA
* PG
* PY
* PE
* PH
* PL
* PT
* PR
* QA
* RO
* RU
* RW
* SA
* RS
* ME
* SG
* SK
* SI
* ZA
* ES
* LK
* SE
* SD
* CH
* SY
* TW
* TZ
* TH
* TT
* TN
* TR
* AE
* UA
* GB
* US
* PS
* UY
* UZ
* VE
* VN
* YE
* ZB
* ZW
* JP
* CA
* CF
* BS
* BF
* KY
* CX
* GH
* GY
* CI
* MW
* MV
* FM
* KN
* LC
* VC
* SN
* TM
* TC
* UG
* VU
* AF
* AS
* BJ
* BM
* BT
* BW
* CM
* TD
* CG
* CD
* DM
* ET
* GF
* PF
* FO
* FJ
* GI
* GP
* IQ
* IM
* LA
* LS
* LY
* MG
* ML
* MH
* MQ
* MR
* MU
* YT
* MD
* NI
* NE
* MP
* PW
* RE
* BL
* MF
* PM
* SL
* SR
* TG
* VI
* WF
* ZM
| Country or region in which the FortiGate is located. The country determines the 802.11 bands and channels that are available. |
| | **darrp\_optimize** integer | | Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). |
| | **darrp\_optimize\_schedules** list / elements=string | | Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. |
| | | **name** string / required | | Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. |
| | **device\_holdoff** integer | | Lower limit of creation time of device for identification in minutes (0 - 60). |
| | **device\_idle** integer | | Upper limit of idle time of device for identification in minutes (0 - 14400). |
| | **device\_weight** integer | | Upper limit of confidence of device for identification (0 - 255). |
| | **duplicate\_ssid** string | **Choices:*** enable
* disable
| Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM. |
| | **fake\_ssid\_action** list / elements=string | **Choices:*** log
* suppress
| Actions taken for detected fake SSID. |
| | **fapc\_compatibility** string | **Choices:*** enable
* disable
| Enable/disable FAP-C series compatibility. |
| | **offending\_ssid** list / elements=string | | Configure offending SSID. |
| | | **action** string | **Choices:*** log
* suppress
| Actions taken for detected offending SSID. |
| | | **id** integer / required | | ID. |
| | | **ssid\_pattern** string | | Define offending SSID pattern (case insensitive), eg: word, word\*, \*word, wo\*rd. |
| | **phishing\_ssid\_detect** string | **Choices:*** enable
* disable
| Enable/disable phishing SSID detection. |
| | **wfa\_compatibility** string | **Choices:*** enable
* disable
| Enable/disable WFA compatibility. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: VDOM wireless controller configuration.
fortios_wireless_controller_setting:
vdom: "{{ vdom }}"
wireless_controller_setting:
account_id: "<your_own_value>"
country: "NA"
darrp_optimize: "5"
darrp_optimize_schedules:
-
name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
device_holdoff: "8"
device_idle: "9"
device_weight: "10"
duplicate_ssid: "enable"
fake_ssid_action: "log"
fapc_compatibility: "enable"
offending_ssid:
-
action: "log"
id: "16"
ssid_pattern: "<your_own_value>"
phishing_ssid_detect: "enable"
wfa_compatibility: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_router_access_list – Configure access lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_access\_list – Configure access lists in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_access_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and access\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_access\_list** dictionary | | Configure access lists. |
| | **comments** string | | Comment. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | Rule. |
| | | **action** string | **Choices:*** permit
* deny
| Permit or deny this IP address and netmask prefix. |
| | | **exact\_match** string | **Choices:*** enable
* disable
| Enable/disable exact match. |
| | | **flags** integer | | Flags. |
| | | **id** integer / required | | Rule ID. |
| | | **prefix** string | | IPv4 prefix to define regular filter criteria, such as "any" or subnets. |
| | | **wildcard** string | | Wildcard to define Cisco-style wildcard filter criteria. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure access lists.
fortios_router_access_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_access_list:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
exact_match: "enable"
flags: "8"
id: "9"
prefix: "<your_own_value>"
wildcard: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_switch_group – Configure FortiSwitch switch groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_switch\_group – Configure FortiSwitch switch groups in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_switch_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and switch\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_switch\_group** dictionary | | Configure FortiSwitch switch groups. |
| | **description** string | | Optional switch group description. |
| | **fortilink** string | | FortiLink interface to which switch group members belong. Source system.interface.name. |
| | **members** list / elements=string | | FortiSwitch members belonging to this switch group. |
| | | **name** string / required | | Managed device ID. Source switch-controller.managed-switch.switch-id. |
| | | **switch\_id** string | | Managed device ID. Source switch-controller.managed-switch.switch-id. |
| | **name** string / required | | Switch group name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch switch groups.
fortios_switch_controller_switch_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_switch_group:
description: "<your_own_value>"
fortilink: "<your_own_value> (source system.interface.name)"
members:
-
name: "default_name_6 (source switch-controller.managed-switch.switch-id)"
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
name: "default_name_8"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_proxy_arp – Configure proxy-ARP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_proxy\_arp – Configure proxy-ARP in Fortinet’s FortiOS and FortiGate.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_proxy_arp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and proxy\_arp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_proxy\_arp** dictionary | | Configure proxy-ARP. |
| | **end\_ip** string | | End IP of IP range to be proxied. |
| | **id** integer / required | | Unique integer ID of the entry. |
| | **interface** string | | Interface acting proxy-ARP. Source system.interface.name. |
| | **ip** string | | IP address or start IP to be proxied. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure proxy-ARP.
fortios_system_proxy_arp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_proxy_arp:
end_ip: "<your_own_value>"
id: "4"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_certificate_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_certificate\_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_certificate_crl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify certificate feature and crl 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **certificate\_crl** dictionary | | Certificate Revocation List as a PEM file. |
| | **crl** string | | Certificate Revocation List as a PEM file. |
| | **http\_url** string | | HTTP server URL for CRL auto-update. |
| | **last\_updated** integer | | Time at which CRL was last updated. |
| | **ldap\_password** string | | LDAP server user password. |
| | **ldap\_server** string | | LDAP server name for CRL auto-update. |
| | **ldap\_username** string | | LDAP server user name. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either global or VDOM IP address range for the certificate. |
| | **scep\_cert** string | | Local certificate for SCEP communication for CRL auto-update. Source certificate.local.name. |
| | **scep\_url** string | | SCEP server URL for CRL auto-update. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Certificate source type. |
| | **source\_ip** string | | Source IP address for communications to a HTTP or SCEP CA server. |
| | **update\_interval** integer | | Time in seconds before the FortiGate checks for an updated CRL. Set to 0 to update only when it expires. |
| | **update\_vdom** string | | VDOM for CRL update. Source system.vdom.name. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Certificate Revocation List as a PEM file.
fortios_certificate_crl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_crl:
crl: "<your_own_value>"
http_url: "<your_own_value>"
last_updated: "5"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value>"
ldap_username: "<your_own_value>"
name: "default_name_9"
range: "global"
scep_cert: "<your_own_value> (source certificate.local.name)"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
update_interval: "15"
update_vdom: "<your_own_value> (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_wildcard_fqdn_custom – Config global/VDOM Wildcard FQDN address in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_wildcard\_fqdn\_custom – Config global/VDOM Wildcard FQDN address in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_wildcard_fqdn_custom`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_wildcard\_fqdn feature and custom 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_wildcard\_fqdn\_custom** dictionary | | Config global/VDOM Wildcard FQDN address. |
| | **color** integer | | GUI icon color. |
| | **comment** string | | Comment. |
| | **name** string / required | | Address name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable address visibility. |
| | **wildcard\_fqdn** string | | Wildcard FQDN. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Config global/VDOM Wildcard FQDN address.
fortios_firewall_wildcard_fqdn_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_wildcard_fqdn_custom:
color: "3"
comment: "Comment."
name: "default_name_5"
uuid: "<your_own_value>"
visibility: "enable"
wildcard_fqdn: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_virtual_port_pool – Configure virtual pool in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_virtual\_port\_pool – Configure virtual pool in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_virtual_port_pool`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and virtual\_port\_pool 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_virtual\_port\_pool** dictionary | | Configure virtual pool. |
| | **description** string | | Virtual switch pool description. |
| | **name** string / required | | Virtual switch pool name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure virtual pool.
fortios_switch_controller_virtual_port_pool:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_virtual_port_pool:
description: "<your_own_value>"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_physical_switch – Configure physical switches in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_physical\_switch – Configure physical switches in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_physical_switch`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and physical\_switch 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_physical\_switch** dictionary | | Configure physical switches. |
| | **age\_enable** string | **Choices:*** enable
* disable
| Enable/disable layer 2 age timer. |
| | **age\_val** integer | | Layer 2 table age timer Value. |
| | **name** string / required | | Name. |
| | **port** list / elements=string | | Configure member ports. |
| | | **name** string / required | | Physical port name. |
| | | **speed** string | **Choices:*** auto
* 10full
* 10half
* 100full
* 100half
* 1000full
* 1000half
* 1000auto
* 10000full
* 10000auto
* 40000full
* 100Gfull
| Speed. |
| | | **status** string | **Choices:*** up
* down
| Interface status. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure physical switches.
fortios_system_physical_switch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_physical_switch:
age_enable: "enable"
age_val: "4"
name: "default_name_5"
port:
-
name: "default_name_7"
speed: "auto"
status: "up"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_prefix_list – Configure IPv4 prefix lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_prefix\_list – Configure IPv4 prefix lists in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_prefix_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and prefix\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_prefix\_list** dictionary | | Configure IPv4 prefix lists. |
| | **comments** string | | Comment. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | IPv4 prefix list rule. |
| | | **action** string | **Choices:*** permit
* deny
| Permit or deny this IP address and netmask prefix. |
| | | **flags** integer | | Flags. |
| | | **ge** integer | | Minimum prefix length to be matched (0 - 32). |
| | | **id** integer / required | | Rule ID. |
| | | **le** integer | | Maximum prefix length to be matched (0 - 32). |
| | | **prefix** string | | IPv4 prefix to define regular filter criteria, such as "any" or subnets. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 prefix lists.
fortios_router_prefix_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_prefix_list:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
flags: "7"
ge: "8"
id: "9"
le: "10"
prefix: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_location – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_location – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_location`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and location 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_location** dictionary | | Configure FortiSwitch location services. |
| | **address\_civic** dictionary | | Configure location civic address. |
| | | **additional** string | | Location additional details. |
| | | **additional\_code** string | | Location additional code details. |
| | | **block** string | | Location block details. |
| | | **branch\_road** string | | Location branch road details. |
| | | **building** string | | Location building details. |
| | | **city** string | | Location city details. |
| | | **city\_division** string | | Location city division details. |
| | | **country** string | | The two-letter ISO 3166 country code in capital ASCII letters eg. US, CA, DK, DE. |
| | | **country\_subdivision** string | | National subdivisions (state, canton, region, province, or prefecture). |
| | | **county** string | | County, parish, gun (JP), or district (IN). |
| | | **direction** string | | Leading street direction. |
| | | **floor** string | | Floor. |
| | | **landmark** string | | Landmark or vanity address. |
| | | **language** string | | Language. |
| | | **name** string | | Name (residence and office occupant). |
| | | **number** string | | House number. |
| | | **number\_suffix** string | | House number suffix. |
| | | **parent\_key** string | | Parent key name. |
| | | **place\_type** string | | Placetype. |
| | | **post\_office\_box** string | | Post office box (P.O. box). |
| | | **postal\_community** string | | Postal community name. |
| | | **primary\_road** string | | Primary road name. |
| | | **road\_section** string | | Road section. |
| | | **room** string | | Room number. |
| | | **script** string | | Script used to present the address information. |
| | | **seat** string | | Seat number. |
| | | **street** string | | Street. |
| | | **street\_name\_post\_mod** string | | Street name post modifier. |
| | | **street\_name\_pre\_mod** string | | Street name pre modifier. |
| | | **street\_suffix** string | | Street suffix. |
| | | **sub\_branch\_road** string | | Sub branch road name. |
| | | **trailing\_str\_suffix** string | | Trailing street suffix. |
| | | **unit** string | | Unit (apartment, suite). |
| | | **zip** string | | Postal/zip code. |
| | **coordinates** dictionary | | Configure location GPS coordinates. |
| | | **altitude** string | | +/- Floating point no. eg. 117.47. |
| | | **altitude\_unit** string | **Choices:*** m
* f
| m ( meters), f ( floors). |
| | | **datum** string | **Choices:*** WGS84
* NAD83
* NAD83/MLLW
| WGS84, NAD83, NAD83/MLLW. |
| | | **latitude** string | | Floating point start with ( +/- ) or end with ( N or S ) eg. +/-16.67 or 16.67N. |
| | | **longitude** string | | Floating point start with ( +/- ) or end with ( E or W ) eg. +/-26.789 or 26.789E. |
| | | **parent\_key** string | | Parent key name. |
| | **elin\_number** dictionary | | Configure location ELIN number. |
| | | **elin\_num** string | | Configure ELIN callback number. |
| | | **parent\_key** string | | Parent key name. |
| | **name** string / required | | Unique location item name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch location services.
fortios_switch_controller_location:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_location:
address_civic:
additional: "<your_own_value>"
additional_code: "<your_own_value>"
block: "<your_own_value>"
branch_road: "<your_own_value>"
building: "<your_own_value>"
city: "<your_own_value>"
city_division: "<your_own_value>"
country: "<your_own_value>"
country_subdivision: "<your_own_value>"
county: "<your_own_value>"
direction: "<your_own_value>"
floor: "<your_own_value>"
landmark: "<your_own_value>"
language: "<your_own_value>"
name: "default_name_18"
number: "<your_own_value>"
number_suffix: "<your_own_value>"
parent_key: "<your_own_value>"
place_type: "<your_own_value>"
post_office_box: "<your_own_value>"
postal_community: "<your_own_value>"
primary_road: "<your_own_value>"
road_section: "<your_own_value>"
room: "<your_own_value>"
script: "<your_own_value>"
seat: "<your_own_value>"
street: "<your_own_value>"
street_name_post_mod: "<your_own_value>"
street_name_pre_mod: "<your_own_value>"
street_suffix: "<your_own_value>"
sub_branch_road: "<your_own_value>"
trailing_str_suffix: "<your_own_value>"
unit: "<your_own_value>"
zip: "<your_own_value>"
coordinates:
altitude: "<your_own_value>"
altitude_unit: "m"
datum: "WGS84"
latitude: "<your_own_value>"
longitude: "<your_own_value>"
parent_key: "<your_own_value>"
elin_number:
elin_num: "<your_own_value>"
parent_key: "<your_own_value>"
name: "default_name_48"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_schedule_group – Schedule group configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_schedule\_group – Schedule group configuration in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_schedule_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_schedule feature and group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_schedule\_group** dictionary | | Schedule group configuration. |
| | **color** integer | | Color of icon on the GUI. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **member** list / elements=string | | Schedules added to the schedule group. |
| | | **name** string / required | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name. |
| | **name** string / required | | Schedule group name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Schedule group configuration.
fortios_firewall_schedule_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_schedule_group:
color: "3"
fabric_object: "enable"
member:
-
name: "default_name_6 (source firewall.schedule.onetime.name firewall.schedule.recurring.name)"
name: "default_name_7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_application_group – Configure firewall application groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_application\_group – Configure firewall application groups in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_application_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **application\_group** dictionary | | Configure firewall application groups. |
| | **application** list / elements=string | | Application ID list. |
| | | **id** integer / required | | Application IDs. |
| | **behavior** string | | Application behavior filter. |
| | **category** list / elements=string | | Application category ID list. |
| | | **id** integer / required | | Category IDs. |
| | **comment** string | | Comment |
| | **name** string / required | | Application group name. |
| | **popularity** list / elements=string | **Choices:*** 1
* 2
* 3
* 4
* 5
| Application popularity filter (1 - 5, from least to most popular). |
| | **protocols** string | | Application protocol filter. |
| | **risk** list / elements=string | | Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). |
| | | **level** integer / required | | Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). |
| | **technology** string | | Application technology filter. |
| | **type** string | **Choices:*** application
* category
* filter
| Application group type. |
| | **vendor** string | | Application vendor filter. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure firewall application groups.
fortios_application_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_group:
application:
-
id: "4"
behavior: "<your_own_value>"
category:
-
id: "7"
comment: "Comment"
name: "default_name_9"
popularity: "1"
protocols: "<your_own_value>"
risk:
-
level: "13"
technology: "<your_own_value>"
type: "application"
vendor: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_webproxy – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_webproxy – Replacement messages in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_webproxy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and webproxy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_webproxy** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_webproxy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_webproxy:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_traffic_policy – Configure FortiSwitch traffic policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_traffic\_policy – Configure FortiSwitch traffic policy in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_traffic_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and traffic\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_traffic\_policy** dictionary | | Configure FortiSwitch traffic policy. |
| | **cos\_queue** integer | | COS queue(0 - 7), or unset to disable. |
| | **description** string | | Description of the traffic policy. |
| | **guaranteed\_bandwidth** integer | | Guaranteed bandwidth in kbps (max value = 524287000). |
| | **guaranteed\_burst** integer | | Guaranteed burst size in bytes (max value = 4294967295). |
| | **id** integer | | FSW Policer id |
| | **maximum\_burst** integer | | Maximum burst size in bytes (max value = 4294967295). |
| | **name** string / required | | Traffic policy name. |
| | **policer\_status** string | **Choices:*** enable
* disable
| Enable/disable policer config on the traffic policy. |
| | **type** string | **Choices:*** ingress
* egress
| Configure type of policy(ingress/egress). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch traffic policy.
fortios_switch_controller_traffic_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_traffic_policy:
cos_queue: "3"
description: "<your_own_value>"
guaranteed_bandwidth: "5"
guaranteed_burst: "6"
id: "7"
maximum_burst: "8"
name: "default_name_9"
policer_status: "enable"
type: "ingress"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_vipgrp6 – Configure IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vipgrp6 – Configure IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vipgrp6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vipgrp6** dictionary | | Configure IPv6 virtual IP groups. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32). |
| | **comments** string | | Comment. |
| | **member** list / elements=string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | | **name** string / required | | IPv6 VIP name. Source firewall.vip6.name. |
| | **name** string / required | | IPv6 VIP group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 virtual IP groups.
fortios_firewall_vipgrp6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vipgrp6:
color: "3"
comments: "<your_own_value>"
member:
-
name: "default_name_6 (source firewall.vip6.name)"
name: "default_name_7"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_setting – Configure user authentication setting in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_setting – Configure user authentication setting in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **user\_setting** dictionary | | Configure user authentication setting. |
| | **auth\_blackout\_time** integer | | Time in seconds an IP address is denied access after failing to authenticate five times within one minute. |
| | **auth\_ca\_cert** string | | HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name. |
| | **auth\_cert** string | | HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. |
| | **auth\_http\_basic** string | **Choices:*** enable
* disable
| Enable/disable use of HTTP basic authentication for identity-based firewall policies. |
| | **auth\_invalid\_max** integer | | Maximum number of failed authentication attempts before the user is blocked. |
| | **auth\_lockout\_duration** integer | | Lockout period in seconds after too many login failures. |
| | **auth\_lockout\_threshold** integer | | Maximum number of failed login attempts before login lockout is triggered. |
| | **auth\_on\_demand** string | **Choices:*** always
* implicitly
| Always/implicitly trigger firewall authentication on demand. |
| | **auth\_portal\_timeout** integer | | Time in minutes before captive portal user have to re-authenticate (1 - 30 min). |
| | **auth\_ports** list / elements=string | | Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET. |
| | | **id** integer / required | | ID. |
| | | **port** integer | | Non-standard port for firewall user authentication. |
| | | **type** string | **Choices:*** http
* https
* ftp
* telnet
| Service type. |
| | **auth\_secure\_http** string | **Choices:*** enable
* disable
| Enable/disable redirecting HTTP user authentication to more secure HTTPS. |
| | **auth\_src\_mac** string | **Choices:*** enable
* disable
| Enable/disable source MAC for user identity. |
| | **auth\_ssl\_allow\_renegotiation** string | **Choices:*** enable
* disable
| Allow/forbid SSL re-negotiation for HTTPS authentication. |
| | **auth\_ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **auth\_timeout** integer | | Time in minutes before the firewall user authentication timeout requires the user to re-authenticate. |
| | **auth\_timeout\_type** string | **Choices:*** idle-timeout
* hard-timeout
* new-session
| Control if authenticated users have to login again after a hard timeout, after an idle timeout, or after a session timeout. |
| | **auth\_type** list / elements=string | **Choices:*** http
* https
* ftp
* telnet
| Supported firewall policy authentication protocols/methods. |
| | **per\_policy\_disclaimer** string | **Choices:*** enable
* disable
| Enable/disable per policy disclaimer. |
| | **radius\_ses\_timeout\_act** string | **Choices:*** hard-timeout
* ignore-timeout
| Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server session timeouts. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure user authentication setting.
fortios_user_setting:
vdom: "{{ vdom }}"
user_setting:
auth_blackout_time: "3"
auth_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_http_basic: "enable"
auth_invalid_max: "7"
auth_lockout_duration: "8"
auth_lockout_threshold: "9"
auth_on_demand: "always"
auth_portal_timeout: "11"
auth_ports:
-
id: "13"
port: "14"
type: "http"
auth_secure_http: "enable"
auth_src_mac: "enable"
auth_ssl_allow_renegotiation: "enable"
auth_ssl_min_proto_version: "default"
auth_timeout: "20"
auth_timeout_type: "idle-timeout"
auth_type: "http"
per_policy_disclaimer: "enable"
radius_ses_timeout_act: "hard-timeout"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_isis – Configure IS-IS in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_isis – Configure IS-IS in Fortinet’s FortiOS and FortiGate.
=============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_isis`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and isis 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_isis** dictionary | | Configure IS-IS. |
| | **adjacency\_check** string | **Choices:*** enable
* disable
| Enable/disable adjacency check. |
| | **adjacency\_check6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 adjacency check. |
| | **adv\_passive\_only** string | **Choices:*** enable
* disable
| Enable/disable IS-IS advertisement of passive interfaces only. |
| | **adv\_passive\_only6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 IS-IS advertisement of passive interfaces only. |
| | **auth\_keychain\_l1** string | | Authentication key-chain for level 1 PDUs. Source router.key-chain.name. |
| | **auth\_keychain\_l2** string | | Authentication key-chain for level 2 PDUs. Source router.key-chain.name. |
| | **auth\_mode\_l1** string | **Choices:*** password
* md5
| Level 1 authentication mode. |
| | **auth\_mode\_l2** string | **Choices:*** password
* md5
| Level 2 authentication mode. |
| | **auth\_password\_l1** string | | Authentication password for level 1 PDUs. |
| | **auth\_password\_l2** string | | Authentication password for level 2 PDUs. |
| | **auth\_sendonly\_l1** string | **Choices:*** enable
* disable
| Enable/disable level 1 authentication send-only. |
| | **auth\_sendonly\_l2** string | **Choices:*** enable
* disable
| Enable/disable level 2 authentication send-only. |
| | **default\_originate** string | **Choices:*** enable
* disable
| Enable/disable distribution of default route information. |
| | **default\_originate6** string | **Choices:*** enable
* disable
| Enable/disable distribution of default IPv6 route information. |
| | **dynamic\_hostname** string | **Choices:*** enable
* disable
| Enable/disable dynamic hostname. |
| | **ignore\_lsp\_errors** string | **Choices:*** enable
* disable
| Enable/disable ignoring of LSP errors with bad checksums. |
| | **is\_type** string | **Choices:*** level-1-2
* level-1
* level-2-only
| IS type. |
| | **isis\_interface** list / elements=string | | IS-IS interface configuration. |
| | | **auth\_keychain\_l1** string | | Authentication key-chain for level 1 PDUs. Source router.key-chain.name. |
| | | **auth\_keychain\_l2** string | | Authentication key-chain for level 2 PDUs. Source router.key-chain.name. |
| | | **auth\_mode\_l1** string | **Choices:*** md5
* password
| Level 1 authentication mode. |
| | | **auth\_mode\_l2** string | **Choices:*** md5
* password
| Level 2 authentication mode. |
| | | **auth\_password\_l1** string | | Authentication password for level 1 PDUs. |
| | | **auth\_password\_l2** string | | Authentication password for level 2 PDUs. |
| | | **auth\_send\_only\_l1** string | **Choices:*** enable
* disable
| Enable/disable authentication send-only for level 1 PDUs. |
| | | **auth\_send\_only\_l2** string | **Choices:*** enable
* disable
| Enable/disable authentication send-only for level 2 PDUs. |
| | | **circuit\_type** string | **Choices:*** level-1-2
* level-1
* level-2
| IS-IS interface"s circuit type |
| | | **csnp\_interval\_l1** integer | | Level 1 CSNP interval. |
| | | **csnp\_interval\_l2** integer | | Level 2 CSNP interval. |
| | | **hello\_interval\_l1** integer | | Level 1 hello interval. |
| | | **hello\_interval\_l2** integer | | Level 2 hello interval. |
| | | **hello\_multiplier\_l1** integer | | Level 1 multiplier for Hello holding time. |
| | | **hello\_multiplier\_l2** integer | | Level 2 multiplier for Hello holding time. |
| | | **hello\_padding** string | **Choices:*** enable
* disable
| Enable/disable padding to IS-IS hello packets. |
| | | **lsp\_interval** integer | | LSP transmission interval (milliseconds). |
| | | **lsp\_retransmit\_interval** integer | | LSP retransmission interval (sec). |
| | | **mesh\_group** string | **Choices:*** enable
* disable
| Enable/disable IS-IS mesh group. |
| | | **mesh\_group\_id** integer | | Mesh group ID <0-4294967295>, 0: mesh-group blocked. |
| | | **metric\_l1** integer | | Level 1 metric for interface. |
| | | **metric\_l2** integer | | Level 2 metric for interface. |
| | | **name** string / required | | IS-IS interface name. Source system.interface.name. |
| | | **network\_type** string | **Choices:*** broadcast
* point-to-point
* loopback
| IS-IS interface"s network type |
| | | **priority\_l1** integer | | Level 1 priority. |
| | | **priority\_l2** integer | | Level 2 priority. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable interface for IS-IS. |
| | | **status6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 interface for IS-IS. |
| | | **wide\_metric\_l1** integer | | Level 1 wide metric for interface. |
| | | **wide\_metric\_l2** integer | | Level 2 wide metric for interface. |
| | **isis\_net** list / elements=string | | IS-IS net configuration. |
| | | **id** integer / required | | isis-net ID. |
| | | **net** string | | IS-IS net xx.xxxx. ... .xxxx.xx. |
| | **lsp\_gen\_interval\_l1** integer | | Minimum interval for level 1 LSP regenerating. |
| | **lsp\_gen\_interval\_l2** integer | | Minimum interval for level 2 LSP regenerating. |
| | **lsp\_refresh\_interval** integer | | LSP refresh time in seconds. |
| | **max\_lsp\_lifetime** integer | | Maximum LSP lifetime in seconds. |
| | **metric\_style** string | **Choices:*** narrow
* wide
* transition
* narrow-transition
* narrow-transition-l1
* narrow-transition-l2
* wide-l1
* wide-l2
* wide-transition
* wide-transition-l1
* wide-transition-l2
* transition-l1
* transition-l2
| Use old-style (ISO 10589) or new-style packet formats |
| | **overload\_bit** string | **Choices:*** enable
* disable
| Enable/disable signal other routers not to use us in SPF. |
| | **overload\_bit\_on\_startup** integer | | Overload-bit only temporarily after reboot. |
| | **overload\_bit\_suppress** list / elements=string | **Choices:*** external
* interlevel
| Suppress overload-bit for the specific prefixes. |
| | **redistribute** list / elements=string | | IS-IS redistribute protocols. |
| | | **level** string | **Choices:*** level-1-2
* level-1
* level-2
| Level. |
| | | **metric** integer | | Metric. |
| | | **metric\_type** string | **Choices:*** external
* internal
| Metric type. |
| | | **protocol** string / required | | Protocol name. |
| | | **routemap** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| Status. |
| | **redistribute6** list / elements=string | | IS-IS IPv6 redistribution for routing protocols. |
| | | **level** string | **Choices:*** level-1-2
* level-1
* level-2
| Level. |
| | | **metric** integer | | Metric. |
| | | **metric\_type** string | **Choices:*** external
* internal
| Metric type. |
| | | **protocol** string / required | | Protocol name. |
| | | **routemap** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable redistribution. |
| | **redistribute6\_l1** string | **Choices:*** enable
* disable
| Enable/disable redistribution of level 1 IPv6 routes into level 2. |
| | **redistribute6\_l1\_list** string | | Access-list for IPv6 route redistribution from l1 to l2. Source router.access-list6.name. |
| | **redistribute6\_l2** string | **Choices:*** enable
* disable
| Enable/disable redistribution of level 2 IPv6 routes into level 1. |
| | **redistribute6\_l2\_list** string | | Access-list for IPv6 route redistribution from l2 to l1. Source router.access-list6.name. |
| | **redistribute\_l1** string | **Choices:*** enable
* disable
| Enable/disable redistribution of level 1 routes into level 2. |
| | **redistribute\_l1\_list** string | | Access-list for route redistribution from l1 to l2. Source router.access-list.name. |
| | **redistribute\_l2** string | **Choices:*** enable
* disable
| Enable/disable redistribution of level 2 routes into level 1. |
| | **redistribute\_l2\_list** string | | Access-list for route redistribution from l2 to l1. Source router.access-list.name. |
| | **spf\_interval\_exp\_l1** string | | Level 1 SPF calculation delay. |
| | **spf\_interval\_exp\_l2** string | | Level 2 SPF calculation delay. |
| | **summary\_address** list / elements=string | | IS-IS summary addresses. |
| | | **id** integer / required | | Summary address entry ID. |
| | | **level** string | **Choices:*** level-1-2
* level-1
* level-2
| Level. |
| | | **prefix** string | | Prefix. |
| | **summary\_address6** list / elements=string | | IS-IS IPv6 summary address. |
| | | **id** integer / required | | Prefix entry ID. |
| | | **level** string | **Choices:*** level-1-2
* level-1
* level-2
| Level. |
| | | **prefix6** string | | IPv6 prefix. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IS-IS.
fortios_router_isis:
vdom: "{{ vdom }}"
router_isis:
adjacency_check: "enable"
adjacency_check6: "enable"
adv_passive_only: "enable"
adv_passive_only6: "enable"
auth_keychain_l1: "<your_own_value> (source router.key-chain.name)"
auth_keychain_l2: "<your_own_value> (source router.key-chain.name)"
auth_mode_l1: "password"
auth_mode_l2: "password"
auth_password_l1: "<your_own_value>"
auth_password_l2: "<your_own_value>"
auth_sendonly_l1: "enable"
auth_sendonly_l2: "enable"
default_originate: "enable"
default_originate6: "enable"
dynamic_hostname: "enable"
ignore_lsp_errors: "enable"
is_type: "level-1-2"
isis_interface:
-
auth_keychain_l1: "<your_own_value> (source router.key-chain.name)"
auth_keychain_l2: "<your_own_value> (source router.key-chain.name)"
auth_mode_l1: "md5"
auth_mode_l2: "md5"
auth_password_l1: "<your_own_value>"
auth_password_l2: "<your_own_value>"
auth_send_only_l1: "enable"
auth_send_only_l2: "enable"
circuit_type: "level-1-2"
csnp_interval_l1: "30"
csnp_interval_l2: "31"
hello_interval_l1: "32"
hello_interval_l2: "33"
hello_multiplier_l1: "34"
hello_multiplier_l2: "35"
hello_padding: "enable"
lsp_interval: "37"
lsp_retransmit_interval: "38"
mesh_group: "enable"
mesh_group_id: "40"
metric_l1: "41"
metric_l2: "42"
name: "default_name_43 (source system.interface.name)"
network_type: "broadcast"
priority_l1: "45"
priority_l2: "46"
status: "enable"
status6: "enable"
wide_metric_l1: "49"
wide_metric_l2: "50"
isis_net:
-
id: "52"
net: "<your_own_value>"
lsp_gen_interval_l1: "54"
lsp_gen_interval_l2: "55"
lsp_refresh_interval: "56"
max_lsp_lifetime: "57"
metric_style: "narrow"
overload_bit: "enable"
overload_bit_on_startup: "60"
overload_bit_suppress: "external"
redistribute:
-
level: "level-1-2"
metric: "64"
metric_type: "external"
protocol: "<your_own_value>"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
redistribute_l1: "enable"
redistribute_l1_list: "<your_own_value> (source router.access-list.name)"
redistribute_l2: "enable"
redistribute_l2_list: "<your_own_value> (source router.access-list.name)"
redistribute6:
-
level: "level-1-2"
metric: "75"
metric_type: "external"
protocol: "<your_own_value>"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
redistribute6_l1: "enable"
redistribute6_l1_list: "<your_own_value> (source router.access-list6.name)"
redistribute6_l2: "enable"
redistribute6_l2_list: "<your_own_value> (source router.access-list6.name)"
spf_interval_exp_l1: "<your_own_value>"
spf_interval_exp_l2: "<your_own_value>"
summary_address:
-
id: "87"
level: "level-1-2"
prefix: "<your_own_value>"
summary_address6:
-
id: "91"
level: "level-1-2"
prefix6: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_fortianalyzer_cloud_override_filter – Override filters for FortiAnalyzer Cloud in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_cloud\_override\_filter – Override filters for FortiAnalyzer Cloud in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer_cloud_override_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer\_cloud feature and override\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer\_cloud\_override\_filter** dictionary | | Override filters for FortiAnalyzer Cloud. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | FortiAnalyzer Cloud log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override filters for FortiAnalyzer Cloud.
fortios_log_fortianalyzer_cloud_override_filter:
vdom: "{{ vdom }}"
log_fortianalyzer_cloud_override_filter:
anomaly: "enable"
dlp_archive: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "13"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_inter_controller – Configure inter wireless controller operation in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_inter\_controller – Configure inter wireless controller operation in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_inter_controller`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and inter\_controller 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_inter\_controller** dictionary | | Configure inter wireless controller operation. |
| | **fast\_failover\_max** integer | | Maximum number of retransmissions for fast failover HA messages between peer wireless controllers (3 - 64). |
| | **fast\_failover\_wait** integer | | Minimum wait time before an AP transitions from secondary controller to primary controller (10 - 86400 sec). |
| | **inter\_controller\_key** string | | Secret key for inter-controller communications. |
| | **inter\_controller\_mode** string | **Choices:*** disable
* l2-roaming
* 1+1
| Configure inter-controller mode (disable, l2-roaming, 1+1). |
| | **inter\_controller\_peer** list / elements=string | | Fast failover peer wireless controller list. |
| | | **id** integer / required | | ID. |
| | | **peer\_ip** string | | Peer wireless controller"s IP address. |
| | | **peer\_port** integer | | Port used by the wireless controller"s for inter-controller communications (1024 - 49150). |
| | | **peer\_priority** string | **Choices:*** primary
* secondary
| Peer wireless controller"s priority (primary or secondary). |
| | **inter\_controller\_pri** string | **Choices:*** primary
* secondary
| Configure inter-controller"s priority (primary or secondary). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure inter wireless controller operation.
fortios_wireless_controller_inter_controller:
vdom: "{{ vdom }}"
wireless_controller_inter_controller:
fast_failover_max: "3"
fast_failover_wait: "4"
inter_controller_key: "<your_own_value>"
inter_controller_mode: "disable"
inter_controller_peer:
-
id: "8"
peer_ip: "<your_own_value>"
peer_port: "10"
peer_priority: "primary"
inter_controller_pri: "primary"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ssh_setting – SSH proxy settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssh\_setting – SSH proxy settings in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ssh_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_ssh feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ssh\_setting** dictionary | | SSH proxy settings. |
| | **caname** string | | CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. |
| | **host\_trusted\_checking** string | **Choices:*** enable
* disable
| Enable/disable host trusted checking. |
| | **hostkey\_dsa1024** string | | DSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **hostkey\_ecdsa256** string | | ECDSA nid256 certificate used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **hostkey\_ecdsa384** string | | ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **hostkey\_ecdsa521** string | | ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **hostkey\_ed25519** string | | ED25519 hostkey used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **hostkey\_rsa2048** string | | RSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. |
| | **untrusted\_caname** string | | Untrusted CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSH proxy settings.
fortios_firewall_ssh_setting:
vdom: "{{ vdom }}"
firewall_ssh_setting:
caname: "<your_own_value> (source firewall.ssh.local-ca.name)"
host_trusted_checking: "enable"
hostkey_dsa1024: "myhostname (source firewall.ssh.local-key.name)"
hostkey_ecdsa256: "myhostname (source firewall.ssh.local-key.name)"
hostkey_ecdsa384: "myhostname (source firewall.ssh.local-key.name)"
hostkey_ecdsa521: "myhostname (source firewall.ssh.local-key.name)"
hostkey_ed25519: "myhostname (source firewall.ssh.local-key.name)"
hostkey_rsa2048: "myhostname (source firewall.ssh.local-key.name)"
untrusted_caname: "<your_own_value> (source firewall.ssh.local-ca.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_vxlan – Configure VXLAN devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vxlan – Configure VXLAN devices in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_vxlan`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vxlan 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_vxlan** dictionary | | Configure VXLAN devices. |
| | **dstport** integer | | VXLAN destination port (1 - 65535). |
| | **interface** string | | Outgoing interface for VXLAN encapsulated traffic. Source system.interface.name. |
| | **ip\_version** string | **Choices:*** ipv4-unicast
* ipv6-unicast
* ipv4-multicast
* ipv6-multicast
| IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. |
| | **multicast\_ttl** integer | | VXLAN multicast TTL (1-255). |
| | **name** string / required | | VXLAN device or interface name. Must be a unique interface name. |
| | **remote\_ip** list / elements=string | | IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. |
| | | **ip** string / required | | IPv4 address. |
| | **remote\_ip6** list / elements=string | | IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. |
| | | **ip6** string / required | | IPv6 address. |
| | **vni** integer | | VXLAN network ID. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VXLAN devices.
fortios_system_vxlan:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vxlan:
dstport: "3"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "ipv4-unicast"
multicast_ttl: "6"
name: "default_name_7"
remote_ip:
-
ip: "<your_own_value>"
remote_ip6:
-
ip6: "<your_own_value>"
vni: "12"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_802_1x_settings – Configure global 802.1X settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_802\_1x\_settings – Configure global 802.1X settings in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_802_1x_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and 802\_1x\_settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_802\_1x\_settings** dictionary | | Configure global 802.1X settings. |
| | **link\_down\_auth** string | **Choices:*** set-unauth
* no-action
| Interface-reauthentication state to set if a link is down. |
| | **max\_reauth\_attempt** integer | | Maximum number of authentication attempts (0 - 15). |
| | **reauth\_period** integer | | Period of time to allow for reauthentication (1 - 1440 sec). |
| | **tx\_period** integer | | 802.1X Tx period (seconds). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure global 802.1X settings.
fortios_switch_controller_802_1x_settings:
vdom: "{{ vdom }}"
switch_controller_802_1x_settings:
link_down_auth: "set-unauth"
max_reauth_attempt: "4"
reauth_period: "5"
tx_period: "6"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_waf_profile – Web application firewall configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_waf\_profile – Web application firewall configuration in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_waf_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **waf\_profile** dictionary | | Web application firewall configuration. |
| | **address\_list** dictionary | | Black address list and white address list. |
| | | **blocked\_address** list / elements=string | | Blocked address. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **blocked\_log** string | **Choices:*** enable
* disable
| Enable/disable logging on blocked addresses. |
| | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | **status** string | **Choices:*** enable
* disable
| Status. |
| | | **trusted\_address** list / elements=string | | Trusted address. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **comment** string | | Comment. |
| | **constraint** dictionary | | WAF HTTP protocol restrictions. |
| | | **content\_length** dictionary | | HTTP content length in request. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP content in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **exception** list / elements=string | | HTTP constraint exception. |
| | | | **address** string | | Host address. Source firewall.address.name firewall.addrgrp.name. |
| | | | **content\_length** string | **Choices:*** enable
* disable
| HTTP content length in request. |
| | | | **header\_length** string | **Choices:*** enable
* disable
| HTTP header length in request. |
| | | | **hostname** string | **Choices:*** enable
* disable
| Enable/disable hostname check. |
| | | | **id** integer / required | | Exception ID. |
| | | | **line\_length** string | **Choices:*** enable
* disable
| HTTP line length in request. |
| | | | **malformed** string | **Choices:*** enable
* disable
| Enable/disable malformed HTTP request check. |
| | | | **max\_cookie** string | **Choices:*** enable
* disable
| Maximum number of cookies in HTTP request. |
| | | | **max\_header\_line** string | **Choices:*** enable
* disable
| Maximum number of HTTP header line. |
| | | | **max\_range\_segment** string | **Choices:*** enable
* disable
| Maximum number of range segments in HTTP range line. |
| | | | **max\_url\_param** string | **Choices:*** enable
* disable
| Maximum number of parameters in URL. |
| | | | **method** string | **Choices:*** enable
* disable
| Enable/disable HTTP method check. |
| | | | **param\_length** string | **Choices:*** enable
* disable
| Maximum length of parameter in URL, HTTP POST request or HTTP body. |
| | | | **pattern** string | | URL pattern. |
| | | | **regex** string | **Choices:*** enable
* disable
| Enable/disable regular expression based pattern match. |
| | | | **url\_param\_length** string | **Choices:*** enable
* disable
| Maximum length of parameter in URL. |
| | | | **version** string | **Choices:*** enable
* disable
| Enable/disable HTTP version check. |
| | | **header\_length** dictionary | | HTTP header length in request. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP header in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **hostname** dictionary | | Enable/disable hostname check. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **line\_length** dictionary | | HTTP line length in request. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP line in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **malformed** dictionary | | Enable/disable malformed HTTP request check. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **max\_cookie** dictionary | | Maximum number of cookies in HTTP request. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **max\_cookie** integer | | Maximum number of cookies in HTTP request (0 to 2147483647). |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **max\_header\_line** dictionary | | Maximum number of HTTP header line. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **max\_header\_line** integer | | Maximum number HTTP header lines (0 to 2147483647). |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **max\_range\_segment** dictionary | | Maximum number of range segments in HTTP range line. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **max\_range\_segment** integer | | Maximum number of range segments in HTTP range line (0 to 2147483647). |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **max\_url\_param** dictionary | | Maximum number of parameters in URL. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **max\_url\_param** integer | | Maximum number of parameters in URL (0 to 2147483647). |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **method** dictionary | | Enable/disable HTTP method check. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **param\_length** dictionary | | Maximum length of parameter in URL, HTTP POST request or HTTP body. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Maximum length of parameter in URL, HTTP POST request or HTTP body in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **url\_param\_length** dictionary | | Maximum length of parameter in URL. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Maximum length of URL parameter in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | | **version** dictionary | | Enable/disable HTTP version check. |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable the constraint. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging. |
| | **external** string | **Choices:*** disable
* enable
| Disable/Enable external HTTP Inspection. |
| | **method** dictionary | | Method restriction. |
| | | **default\_allowed\_methods** list / elements=string | **Choices:*** get
* post
* put
* head
* connect
* trace
* options
* delete
* others
| Methods. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **method\_policy** list / elements=string | | HTTP method policy. |
| | | | **address** string | | Host address. Source firewall.address.name firewall.addrgrp.name. |
| | | | **allowed\_methods** string | **Choices:*** get
* post
* put
* head
* connect
* trace
* options
* delete
* others
| Allowed Methods. |
| | | | **id** integer / required | | HTTP method policy ID. |
| | | | **pattern** string | | URL pattern. |
| | | | **regex** string | **Choices:*** enable
* disable
| Enable/disable regular expression based pattern match. |
| | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | **status** string | **Choices:*** enable
* disable
| Status. |
| | **name** string / required | | WAF Profile name. |
| | **signature** dictionary | | WAF signatures. |
| | | **credit\_card\_detection\_threshold** integer | | The minimum number of Credit cards to detect violation. |
| | | **custom\_signature** list / elements=string | | Custom signature. |
| | | | **action** string | **Choices:*** allow
* block
* erase
| Action. |
| | | | **case\_sensitivity** string | **Choices:*** disable
* enable
| Case sensitivity in pattern. |
| | | | **direction** string | **Choices:*** request
* response
| Traffic direction. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **name** string / required | | Signature name. |
| | | | **pattern** string | | Match pattern. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Status. |
| | | | **target** string | **Choices:*** arg
* arg-name
* req-body
* req-cookie
* req-cookie-name
* req-filename
* req-header
* req-header-name
* req-raw-uri
* req-uri
* resp-body
* resp-hdr
* resp-status
| Match HTTP target. |
| | | **disabled\_signature** list / elements=string | | Disabled signatures |
| | | | **id** integer / required | | Signature ID. Source waf.signature.id. |
| | | **disabled\_sub\_class** list / elements=string | | Disabled signature subclasses. |
| | | | **id** integer / required | | Signature subclass ID. Source waf.sub-class.id. |
| | | **main\_class** list / elements=string | | Main signature class. |
| | | | **action** string | **Choices:*** allow
* block
* erase
| Action. |
| | | | **id** integer / required | | Main signature class ID. Source waf.main-class.id. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
| | | | **status** string | **Choices:*** enable
* disable
| Status. |
| | **url\_access** list / elements=string | | URL access list |
| | | **access\_pattern** list / elements=string | | URL access pattern. |
| | | | **id** integer / required | | URL access pattern ID. |
| | | | **negate** string | **Choices:*** enable
* disable
| Enable/disable match negation. |
| | | | **pattern** string | | URL pattern. |
| | | | **regex** string | **Choices:*** enable
* disable
| Enable/disable regular expression based pattern match. |
| | | | **srcaddr** string | | Source address. Source firewall.address.name firewall.addrgrp.name. |
| | | **action** string | **Choices:*** bypass
* permit
* block
| Action. |
| | | **address** string | | Host address. Source firewall.address.name firewall.addrgrp.name. |
| | | **id** integer / required | | URL access ID. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** high
* medium
* low
| Severity. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Web application firewall configuration.
fortios_waf_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
waf_profile:
address_list:
blocked_address:
-
name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
blocked_log: "enable"
severity: "high"
status: "enable"
trusted_address:
-
name: "default_name_10 (source firewall.address.name firewall.addrgrp.name)"
comment: "Comment."
constraint:
content_length:
action: "allow"
length: "15"
log: "enable"
severity: "high"
status: "enable"
exception:
-
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
content_length: "enable"
header_length: "enable"
hostname: "enable"
id: "24"
line_length: "enable"
malformed: "enable"
max_cookie: "enable"
max_header_line: "enable"
max_range_segment: "enable"
max_url_param: "enable"
method: "enable"
param_length: "enable"
pattern: "<your_own_value>"
regex: "enable"
url_param_length: "enable"
version: "enable"
header_length:
action: "allow"
length: "39"
log: "enable"
severity: "high"
status: "enable"
hostname:
action: "allow"
log: "enable"
severity: "high"
status: "enable"
line_length:
action: "allow"
length: "50"
log: "enable"
severity: "high"
status: "enable"
malformed:
action: "allow"
log: "enable"
severity: "high"
status: "enable"
max_cookie:
action: "allow"
log: "enable"
max_cookie: "62"
severity: "high"
status: "enable"
max_header_line:
action: "allow"
log: "enable"
max_header_line: "68"
severity: "high"
status: "enable"
max_range_segment:
action: "allow"
log: "enable"
max_range_segment: "74"
severity: "high"
status: "enable"
max_url_param:
action: "allow"
log: "enable"
max_url_param: "80"
severity: "high"
status: "enable"
method:
action: "allow"
log: "enable"
severity: "high"
status: "enable"
param_length:
action: "allow"
length: "90"
log: "enable"
severity: "high"
status: "enable"
url_param_length:
action: "allow"
length: "96"
log: "enable"
severity: "high"
status: "enable"
version:
action: "allow"
log: "enable"
severity: "high"
status: "enable"
extended_log: "enable"
external: "disable"
method:
default_allowed_methods: "get"
log: "enable"
method_policy:
-
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
allowed_methods: "get"
id: "113"
pattern: "<your_own_value>"
regex: "enable"
severity: "high"
status: "enable"
name: "default_name_118"
signature:
credit_card_detection_threshold: "120"
custom_signature:
-
action: "allow"
case_sensitivity: "disable"
direction: "request"
log: "enable"
name: "default_name_126"
pattern: "<your_own_value>"
severity: "high"
status: "enable"
target: "arg"
disabled_signature:
-
id: "132 (source waf.signature.id)"
disabled_sub_class:
-
id: "134 (source waf.sub-class.id)"
main_class:
-
action: "allow"
id: "137 (source waf.main-class.id)"
log: "enable"
severity: "high"
status: "enable"
url_access:
-
access_pattern:
-
id: "143"
negate: "enable"
pattern: "<your_own_value>"
regex: "enable"
srcaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
action: "bypass"
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
id: "150"
log: "enable"
severity: "high"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_smc_ntp – Configure SMC NTP information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_smc\_ntp – Configure SMC NTP information in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_smc_ntp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and smc\_ntp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_smc\_ntp** dictionary | | Configure SMC NTP information. |
| | **channel** integer | | SMC NTP client will send NTP packets through this channel. |
| | **ntpserver** list / elements=string | | Configure the FortiGate SMC to connect to an NTP server. |
| | | **id** integer / required | | NTP server ID. |
| | | **server** string | | IP address of the NTP server. |
| | **ntpsync** string | **Choices:*** enable
* disable
| Enable/disable setting the FortiGate SMC system time by synchronizing with an NTP server. |
| | **syncinterval** integer | | SMC NTP synchronization interval (1 - 65535 secs). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SMC NTP information.
fortios_system_smc_ntp:
vdom: "{{ vdom }}"
system_smc_ntp:
channel: "3"
ntpserver:
-
id: "5"
server: "192.168.100.40"
ntpsync: "enable"
syncinterval: "8"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_storm_control_policy – Configure FortiSwitch storm control policy to be applied on managed-switch ports in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_storm\_control\_policy – Configure FortiSwitch storm control policy to be applied on managed-switch ports in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_storm_control_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and storm\_control\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_storm\_control\_policy** dictionary | | Configure FortiSwitch storm control policy to be applied on managed-switch ports. |
| | **broadcast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop/allow broadcast traffic in override mode. |
| | **description** string | | Description of the storm control policy. |
| | **name** string / required | | Storm control policy name. |
| | **rate** integer | | Threshold rate in packets per second at which storm traffic is controlled in override mode . |
| | **storm\_control\_mode** string | **Choices:*** global
* override
* disabled
| Set Storm control mode. |
| | **unknown\_multicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop/allow unknown multicast traffic in override mode. |
| | **unknown\_unicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop/allow unknown unicast traffic in override mode. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch storm control policy to be applied on managed-switch ports.
fortios_switch_controller_storm_control_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_storm_control_policy:
broadcast: "enable"
description: "<your_own_value>"
name: "default_name_5"
rate: "6"
storm_control_mode: "global"
unknown_multicast: "enable"
unknown_unicast: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_traffic_quota – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_traffic\_quota – Replacement messages in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_traffic_quota`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and traffic\_quota 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_traffic\_quota** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_traffic_quota:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_traffic_quota:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_spectral_info – Wireless controller spectrum analysis in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_spectral\_info – Wireless controller spectrum analysis in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_spectral_info`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and spectral\_info 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_spectral\_info** dictionary | | Wireless controller spectrum analysis. |
| | **set\_wtp\_id** string | | WTP ID. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Wireless controller spectrum analysis.
fortios_wireless_controller_spectral_info:
vdom: "{{ vdom }}"
wireless_controller_spectral_info:
set_wtp_id: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer2_override_setting – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer2\_override\_setting – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer2_override_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer2 feature and override\_setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer2\_override\_setting** dictionary | | Override FortiAnalyzer settings. |
| | **\_\_change\_ip** integer | | Hidden attribute. |
| | **access\_config** string | **Choices:*** enable
* disable
| Enable/disable FortiAnalyzer access to configuration and data. |
| | **certificate** string | | Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. |
| | **certificate\_verification** string | **Choices:*** enable
* disable
| Enable/disable identity verification of FortiAnalyzer by use of certificate. |
| | **conn\_timeout** integer | | FortiAnalyzer connection time-out in seconds (for status and log buffer). |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
| Configure the level of SSL protection for secure communication with FortiAnalyzer. |
| | **faz\_type** integer | | Hidden setting index of FortiAnalyzer. |
| | **hmac\_algorithm** string | **Choices:*** sha256
* sha1
| FortiAnalyzer IPsec tunnel HMAC algorithm. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ips\_archive** string | **Choices:*** enable
* disable
| Enable/disable IPS packet archive logging. |
| | **max\_log\_rate** integer | | FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
| | **mgmt\_name** string | | Hidden management name of FortiAnalyzer. |
| | **monitor\_failure\_retry\_period** integer | | Time between FortiAnalyzer connection retries in seconds (for status and log buffer). |
| | **monitor\_keepalive\_period** integer | | Time between OFTP keepalives in seconds (for status and log buffer). |
| | **override** string | **Choices:*** enable
* disable
| Enable/disable overriding FortiAnalyzer settings or use global settings. |
| | **preshared\_key** string | | Preshared-key used for auto-authorization on FortiAnalyzer. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **reliable** string | **Choices:*** enable
* disable
| Enable/disable reliable logging to FortiAnalyzer. |
| | **serial** list / elements=string | | Serial numbers of the FortiAnalyzer. |
| | | **name** string / required | | Serial Number. |
| | **server** string | | The remote FortiAnalyzer. |
| | **source\_ip** string | | Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiAnalyzer. |
| | **upload\_day** string | | Day of week (month) to upload logs. |
| | **upload\_interval** string | **Choices:*** daily
* weekly
* monthly
| Frequency to upload log files to FortiAnalyzer. |
| | **upload\_option** string | **Choices:*** store-and-upload
* realtime
* 1-minute
* 5-minute
| Enable/disable logging to hard disk and then uploading to FortiAnalyzer. |
| | **upload\_time** string | | Time to upload logs (hh:mm). |
| | **use\_management\_vdom** string | **Choices:*** enable
* disable
| Enable/disable use of management VDOM IP address as source IP for logs sent to FortiAnalyzer. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override FortiAnalyzer settings.
fortios_log_fortianalyzer2_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer2_override_setting:
__change_ip: "3"
access_config: "enable"
certificate: "<your_own_value> (source certificate.local.name)"
certificate_verification: "enable"
conn_timeout: "7"
enc_algorithm: "high-medium"
faz_type: "9"
hmac_algorithm: "sha256"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
max_log_rate: "14"
mgmt_name: "<your_own_value>"
monitor_failure_retry_period: "16"
monitor_keepalive_period: "17"
override: "enable"
preshared_key: "<your_own_value>"
priority: "default"
reliable: "enable"
serial:
-
name: "default_name_23"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
use_management_vdom: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_web_proxy_forward_server_group – Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_forward\_server\_group – Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_web_proxy_forward_server_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web\_proxy feature and forward\_server\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **web\_proxy\_forward\_server\_group** dictionary | | Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing. |
| | **affinity** string | **Choices:*** enable
* disable
| Enable/disable affinity, attaching a source-ip"s traffic to the assigned forwarding server until the forward-server-affinity-timeout is reached (under web-proxy global). |
| | **group\_down\_option** string | **Choices:*** block
* pass
| Action to take when all of the servers in the forward server group are down: block sessions until at least one server is back up or pass sessions to their destination. |
| | **ldb\_method** string | **Choices:*** weighted
* least-session
* active-passive
| Load balance method: weighted or least-session. |
| | **name** string / required | | Configure a forward server group consisting one or multiple forward servers. Supports failover and load balancing. |
| | **server\_list** list / elements=string | | Add web forward servers to a list to form a server group. Optionally assign weights to each server. |
| | | **name** string / required | | Forward server name. Source web-proxy.forward-server.name. |
| | | **weight** integer | | Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100) |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing.
fortios_web_proxy_forward_server_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_forward_server_group:
affinity: "enable"
group_down_option: "block"
ldb_method: "weighted"
name: "default_name_6"
server_list:
-
name: "default_name_8 (source web-proxy.forward-server.name)"
weight: "9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_interface – Configure interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_interface – Configure interfaces in Fortinet’s FortiOS and FortiGate.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_interface`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and interface 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_interface** dictionary | | Configure interfaces. |
| | **ac\_name** string | | PPPoE server name. |
| | **aggregate** string | | Aggregate interface. |
| | **algorithm** string | **Choices:*** L2
* L3
* L4
| Frame distribution algorithm. |
| | **alias** string | | Alias will be displayed with the interface name to make it easier to distinguish. |
| | **allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* telnet
* fgfm
* radius-acct
* probe-response
* capwap
* ftm
* fabric
| Permitted types of management access to this interface. |
| | **ap\_discover** string | **Choices:*** enable
* disable
| Enable/disable automatic registration of unknown FortiAP devices. |
| | **arpforward** string | **Choices:*** enable
* disable
| Enable/disable ARP forwarding. |
| | **auth\_type** string | **Choices:*** auto
* pap
* chap
* mschapv1
* mschapv2
| PPP authentication type to use. |
| | **auto\_auth\_extension\_device** string | **Choices:*** enable
* disable
| Enable/disable automatic authorization of dedicated Fortinet extension device on this interface. |
| | **bandwidth\_measure\_time** integer | | Bandwidth measure time |
| | **bfd** string | **Choices:*** global
* enable
* disable
| Bidirectional Forwarding Detection (BFD) settings. |
| | **bfd\_desired\_min\_tx** integer | | BFD desired minimal transmit interval. |
| | **bfd\_detect\_mult** integer | | BFD detection multiplier. |
| | **bfd\_required\_min\_rx** integer | | BFD required minimal receive interval. |
| | **broadcast\_forticlient\_discovery** string | **Choices:*** enable
* disable
| Enable/disable broadcasting FortiClient discovery messages. |
| | **broadcast\_forward** string | **Choices:*** enable
* disable
| Enable/disable broadcast forwarding. |
| | **captive\_portal** integer | | Enable/disable captive portal. |
| | **cli\_conn\_status** integer | | CLI connection status. |
| | **client\_options** list / elements=string | | DHCP client options. |
| | | **code** integer | | DHCP client option code. |
| | | **id** integer / required | | ID. |
| | | **ip** string | | DHCP option IPs. |
| | | **type** string | **Choices:*** hex
* string
* ip
* fqdn
| DHCP client option type. |
| | | **value** string | | DHCP client option value. |
| | **color** integer | | Color of icon on the GUI. |
| | **dedicated\_to** string | **Choices:*** none
* management
| Configure interface for single purpose. |
| | **defaultgw** string | **Choices:*** enable
* disable
| Enable to get the gateway IP from the DHCP or PPPoE server. |
| | **description** string | | Description. |
| | **detected\_peer\_mtu** integer | | MTU of detected peer (0 - 4294967295). |
| | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| Protocols used to detect the server. |
| | **detectserver** string | | Gateway"s ping server for this IP. |
| | **device\_access\_list** string | | Device access list. |
| | **device\_identification** string | **Choices:*** enable
* disable
| Enable/disable passively gathering of device identity information about the devices on the network connected to this interface. |
| | **device\_identification\_active\_scan** string | **Choices:*** enable
* disable
| Enable/disable active gathering of device identity information about the devices on the network connected to this interface. |
| | **device\_netscan** string | **Choices:*** disable
* enable
| Enable/disable inclusion of devices detected on this interface in network vulnerability scans. |
| | **device\_user\_identification** string | **Choices:*** enable
* disable
| Enable/disable passive gathering of user identity information about users on this interface. |
| | **devindex** integer | | Device Index. |
| | **dhcp\_client\_identifier** string | | DHCP client identifier. |
| | **dhcp\_relay\_agent\_option** string | **Choices:*** enable
* disable
| Enable/disable DHCP relay agent option. |
| | **dhcp\_relay\_interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **dhcp\_relay\_interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **dhcp\_relay\_ip** string | | DHCP relay IP address. |
| | **dhcp\_relay\_request\_all\_server** string | **Choices:*** disable
* enable
| Enable/disable sending of DHCP requests to all servers. |
| | **dhcp\_relay\_service** string | **Choices:*** disable
* enable
| Enable/disable allowing this interface to act as a DHCP relay. |
| | **dhcp\_relay\_type** string | **Choices:*** regular
* ipsec
| DHCP relay type (regular or IPsec). |
| | **dhcp\_renew\_time** integer | | DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server. |
| | **disc\_retry\_timeout** integer | | Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout. |
| | **disconnect\_threshold** integer | | Time in milliseconds to wait before sending a notification that this interface is down or disconnected. |
| | **distance** integer | | Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route. |
| | **dns\_server\_override** string | **Choices:*** enable
* disable
| Enable/disable use DNS acquired by DHCP or PPPoE. |
| | **drop\_fragment** string | **Choices:*** enable
* disable
| Enable/disable drop fragment packets. |
| | **drop\_overlapped\_fragment** string | **Choices:*** enable
* disable
| Enable/disable drop overlapped fragment packets. |
| | **egress\_cos** string | **Choices:*** disable
* cos0
* cos1
* cos2
* cos3
* cos4
* cos5
* cos6
* cos7
| Override outgoing CoS in user VLAN tag. |
| | **egress\_queues** dictionary | | Configure queues of NP port on egress path. |
| | | **cos0** string | | CoS profile name for CoS 0. Source system.isf-queue-profile.name. |
| | | **cos1** string | | CoS profile name for CoS 1. Source system.isf-queue-profile.name. |
| | | **cos2** string | | CoS profile name for CoS 2. Source system.isf-queue-profile.name. |
| | | **cos3** string | | CoS profile name for CoS 3. Source system.isf-queue-profile.name. |
| | | **cos4** string | | CoS profile name for CoS 4. Source system.isf-queue-profile.name. |
| | | **cos5** string | | CoS profile name for CoS 5. Source system.isf-queue-profile.name. |
| | | **cos6** string | | CoS profile name for CoS 6. Source system.isf-queue-profile.name. |
| | | **cos7** string | | CoS profile name for CoS 7. Source system.isf-queue-profile.name. |
| | **egress\_shaping\_profile** string | | Outgoing traffic shaping profile. Source firewall.shaping-profile.profile-name. |
| | **endpoint\_compliance** string | **Choices:*** enable
* disable
| Enable/disable endpoint compliance enforcement. |
| | **estimated\_downstream\_bandwidth** integer | | Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization. |
| | **estimated\_upstream\_bandwidth** integer | | Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization. |
| | **explicit\_ftp\_proxy** string | **Choices:*** enable
* disable
| Enable/disable the explicit FTP proxy on this interface. |
| | **explicit\_web\_proxy** string | **Choices:*** enable
* disable
| Enable/disable the explicit web proxy on this interface. |
| | **external** string | **Choices:*** enable
* disable
| Enable/disable identifying the interface as an external interface (which usually means it"s connected to the Internet). |
| | **fail\_action\_on\_extender** string | **Choices:*** soft-restart
* hard-restart
* reboot
| Action on extender when interface fail . |
| | **fail\_alert\_interfaces** list / elements=string | | Names of the FortiGate interfaces from which the link failure alert is sent for this interface. |
| | | **name** string / required | | Names of the physical interfaces belonging to the aggregate or redundant interface. Source system.interface.name. |
| | **fail\_alert\_method** string | **Choices:*** link-failed-signal
* link-down
| Select link-failed-signal or link-down method to alert about a failed link. |
| | **fail\_detect** string | **Choices:*** enable
* disable
| Enable/disable fail detection features for this interface. |
| | **fail\_detect\_option** list / elements=string | **Choices:*** detectserver
* link-down
| Options for detecting that this interface has failed. |
| | **fortiheartbeat** string | **Choices:*** enable
* disable
| Enable/disable FortiHeartBeat (FortiTelemetry on GUI). |
| | **fortilink** string | **Choices:*** enable
* disable
| Enable FortiLink to dedicate this interface to manage other Fortinet devices. |
| | **fortilink\_backup\_link** integer | | fortilink split interface backup link. |
| | **fortilink\_neighbor\_detect** string | **Choices:*** lldp
* fortilink
| Protocol for FortiGate neighbor discovery. |
| | **fortilink\_split\_interface** string | **Choices:*** enable
* disable
| Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy (maximum 2 interfaces in the "members" command). |
| | **fortilink\_stacking** string | **Choices:*** enable
* disable
| Enable/disable FortiLink switch-stacking on this interface. |
| | **forward\_domain** integer | | Transparent mode forward domain. |
| | **gi\_gk** string | **Choices:*** enable
* disable
| Enable/disable Gi Gatekeeper. |
| | **gwdetect** string | **Choices:*** enable
* disable
| Enable/disable detect gateway alive for first. |
| | **ha\_priority** integer | | HA election priority for the PING server. |
| | **icmp\_accept\_redirect** string | **Choices:*** enable
* disable
| Enable/disable ICMP accept redirect. |
| | **icmp\_send\_redirect** string | **Choices:*** enable
* disable
| Enable/disable ICMP send redirect. |
| | **ident\_accept** string | **Choices:*** enable
* disable
| Enable/disable authentication for this interface. |
| | **idle\_timeout** integer | | PPPoE auto disconnect after idle timeout seconds, 0 means no timeout. |
| | **inbandwidth** integer | | Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited. |
| | **ingress\_cos** string | **Choices:*** disable
* cos0
* cos1
* cos2
* cos3
* cos4
* cos5
* cos6
* cos7
| Override incoming CoS in user VLAN tag on VLAN interface or assign a priority VLAN tag on physical interface. |
| | **ingress\_shaping\_profile** string | | Incoming traffic shaping profile. Source firewall.shaping-profile.profile-name. |
| | **ingress\_spillover\_threshold** integer | | Ingress Spillover threshold (0 - 16776000 kbps). |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **internal** integer | | Implicitly created. |
| | **ip** string | | Interface IPv4 address and subnet mask, syntax: X.X.X.X/24. |
| | **ip\_managed\_by\_fortiipam** string | **Choices:*** enable
* disable
| Enable/disable automatic IP address assignment of this interface by FortiIPAM. |
| | **ipmac** string | **Choices:*** enable
* disable
| Enable/disable IP/MAC binding. |
| | **ips\_sniffer\_mode** string | **Choices:*** enable
* disable
| Enable/disable the use of this interface as a one-armed sniffer. |
| | **ipunnumbered** string | | Unnumbered IP used for PPPoE interfaces for which no unique local address is provided. |
| | **ipv6** dictionary | | IPv6 of interface. |
| | | **autoconf** string | **Choices:*** enable
* disable
| Enable/disable address auto config. |
| | | **cli\_conn6\_status** integer | | CLI IPv6 connection status. |
| | | **dhcp6\_client\_options** list / elements=string | **Choices:*** rapid
* iapd
* iana
| DHCPv6 client options. |
| | | **dhcp6\_information\_request** string | **Choices:*** enable
* disable
| Enable/disable DHCPv6 information request. |
| | | **dhcp6\_prefix\_delegation** string | **Choices:*** enable
* disable
| Enable/disable DHCPv6 prefix delegation. |
| | | **dhcp6\_prefix\_hint** string | | DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. |
| | | **dhcp6\_prefix\_hint\_plt** integer | | DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. |
| | | **dhcp6\_prefix\_hint\_vlt** integer | | DHCPv6 prefix hint valid life time (sec). |
| | | **dhcp6\_relay\_ip** string | | DHCPv6 relay IP address. |
| | | **dhcp6\_relay\_service** string | **Choices:*** disable
* enable
| Enable/disable DHCPv6 relay. |
| | | **dhcp6\_relay\_type** string | **Choices:*** regular
| DHCPv6 relay type. |
| | | **icmp6\_send\_redirect** string | **Choices:*** enable
* disable
| Enable/disable sending of ICMPv6 redirects. |
| | | **interface\_identifier** string | | IPv6 interface identifier. |
| | | **ip6\_address** string | | Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx |
| | | **ip6\_allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* telnet
* fgfm
* capwap
* fabric
| Allow management access to the interface. |
| | | **ip6\_default\_life** integer | | Default life (sec). |
| | | **ip6\_delegated\_prefix\_list** list / elements=string | | Advertised IPv6 delegated prefix list. |
| | | | **autonomous\_flag** string | **Choices:*** enable
* disable
| Enable/disable the autonomous flag. |
| | | | **onlink\_flag** string | **Choices:*** enable
* disable
| Enable/disable the onlink flag. |
| | | | **prefix\_id** integer | | Prefix ID. |
| | | | **rdnss** string | | Recursive DNS server option. |
| | | | **rdnss\_service** string | **Choices:*** delegated
* default
* specify
| Recursive DNS service option. |
| | | | **subnet** string | | Add subnet ID to routing prefix. |
| | | | **upstream\_interface** string | | Name of the interface that provides delegated information. Source system.interface.name. |
| | | **ip6\_dns\_server\_override** string | **Choices:*** enable
* disable
| Enable/disable using the DNS server acquired by DHCP. |
| | | **ip6\_extra\_addr** list / elements=string | | Extra IPv6 address prefixes of interface. |
| | | | **prefix** string / required | | IPv6 address prefix. |
| | | **ip6\_hop\_limit** integer | | Hop limit (0 means unspecified). |
| | | **ip6\_link\_mtu** integer | | IPv6 link MTU. |
| | | **ip6\_manage\_flag** string | **Choices:*** enable
* disable
| Enable/disable the managed flag. |
| | | **ip6\_max\_interval** integer | | IPv6 maximum interval (4 to 1800 sec). |
| | | **ip6\_min\_interval** integer | | IPv6 minimum interval (3 to 1350 sec). |
| | | **ip6\_mode** string | **Choices:*** static
* dhcp
* pppoe
* delegated
| Addressing mode (static, DHCP, delegated). |
| | | **ip6\_other\_flag** string | **Choices:*** enable
* disable
| Enable/disable the other IPv6 flag. |
| | | **ip6\_prefix\_list** list / elements=string | | Advertised prefix list. |
| | | | **autonomous\_flag** string | **Choices:*** enable
* disable
| Enable/disable the autonomous flag. |
| | | | **dnssl** list / elements=string | | DNS search list option. |
| | | | | **domain** string / required | | Domain name. |
| | | | **onlink\_flag** string | **Choices:*** enable
* disable
| Enable/disable the onlink flag. |
| | | | **preferred\_life\_time** integer | | Preferred life time (sec). |
| | | | **prefix** string / required | | IPv6 prefix. |
| | | | **rdnss** string | | Recursive DNS server option. |
| | | | **valid\_life\_time** integer | | Valid life time (sec). |
| | | **ip6\_prefix\_mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from DHCP or RA. |
| | | **ip6\_reachable\_time** integer | | IPv6 reachable time (milliseconds; 0 means unspecified). |
| | | **ip6\_retrans\_time** integer | | IPv6 retransmit time (milliseconds; 0 means unspecified). |
| | | **ip6\_send\_adv** string | **Choices:*** enable
* disable
| Enable/disable sending advertisements about the interface. |
| | | **ip6\_subnet** string | | Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx |
| | | **ip6\_upstream\_interface** string | | Interface name providing delegated information. Source system.interface.name. |
| | | **nd\_cert** string | | Neighbor discovery certificate. Source certificate.local.name. |
| | | **nd\_cga\_modifier** string | | Neighbor discovery CGA modifier. |
| | | **nd\_mode** string | **Choices:*** basic
* SEND-compatible
| Neighbor discovery mode. |
| | | **nd\_security\_level** integer | | Neighbor discovery security level (0 - 7; 0 = least secure). |
| | | **nd\_timestamp\_delta** integer | | Neighbor discovery timestamp delta value (1 - 3600 sec; ). |
| | | **nd\_timestamp\_fuzz** integer | | Neighbor discovery timestamp fuzz factor (1 - 60 sec; ). |
| | | **ra\_send\_mtu** string | **Choices:*** enable
* disable
| Enable/disable sending link MTU in RA packet. |
| | | **unique\_autoconf\_addr** string | **Choices:*** enable
* disable
| Enable/disable unique auto config address. |
| | | **vrip6\_link\_local** string | | Link-local IPv6 address of virtual router. |
| | | **vrrp6** list / elements=string | | IPv6 VRRP configuration. |
| | | | **accept\_mode** string | **Choices:*** enable
* disable
| Enable/disable accept mode. |
| | | | **adv\_interval** integer | | Advertisement interval (1 - 255 seconds). |
| | | | **preempt** string | **Choices:*** enable
* disable
| Enable/disable preempt mode. |
| | | | **priority** integer | | Priority of the virtual router (1 - 255). |
| | | | **start\_time** integer | | Startup time (1 - 255 seconds). |
| | | | **status** string | **Choices:*** enable
* disable
| Enable/disable VRRP. |
| | | | **vrdst6** string | | Monitor the route to this destination. |
| | | | **vrgrp** integer | | VRRP group ID (1 - 65535). |
| | | | **vrid** integer / required | | Virtual router identifier (1 - 255). |
| | | | **vrip6** string | | IPv6 address of the virtual router. |
| | | **vrrp\_virtual\_mac6** string | **Choices:*** enable
* disable
| Enable/disable virtual MAC for VRRP. |
| | **l2forward** string | **Choices:*** enable
* disable
| Enable/disable l2 forwarding. |
| | **lacp\_ha\_slave** string | **Choices:*** enable
* disable
| LACP HA slave. |
| | **lacp\_mode** string | **Choices:*** static
* passive
* active
| LACP mode. |
| | **lacp\_speed** string | **Choices:*** slow
* fast
| How often the interface sends LACP messages. |
| | **lcp\_echo\_interval** integer | | Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. |
| | **lcp\_max\_echo\_fails** integer | | Maximum missed LCP echo messages before disconnect. |
| | **link\_up\_delay** integer | | Number of milliseconds to wait before considering a link is up. |
| | **lldp\_network\_policy** string | | LLDP-MED network policy profile. Source system.lldp.network-policy.name. |
| | **lldp\_reception** string | **Choices:*** enable
* disable
* vdom
| Enable/disable Link Layer Discovery Protocol (LLDP) reception. |
| | **lldp\_transmission** string | **Choices:*** enable
* disable
* vdom
| Enable/disable Link Layer Discovery Protocol (LLDP) transmission. |
| | **macaddr** string | | Change the interface"s MAC address. |
| | **managed\_device** list / elements=string | | Available when FortiLink is enabled, used for managed devices through FortiLink interface. |
| | | **name** string / required | | Managed dev identifier. |
| | **managed\_subnetwork\_size** string | **Choices:*** 256
* 512
* 1024
* 2048
* 4096
* 8192
* 16384
* 32768
* 65536
| Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit"s DHCP server settings. |
| | **management\_ip** string | | High Availability in-band management IP address of this interface. |
| | **measured\_downstream\_bandwidth** integer | | Measured downstream bandwidth (kbps). |
| | **measured\_upstream\_bandwidth** integer | | Measured upstream bandwidth (kbps). |
| | **mediatype** string | **Choices:*** cfp2-sr10
* cfp2-lr4
| Select SFP media interface type |
| | **member** list / elements=string | | Physical interfaces that belong to the aggregate or redundant interface. |
| | | **interface\_name** string | | Physical interface name. Source system.interface.name. |
| | **min\_links** integer | | Minimum number of aggregated ports that must be up. |
| | **min\_links\_down** string | **Choices:*** operational
* administrative
| Action to take when less than the configured minimum number of links are active. |
| | **mode** string | **Choices:*** static
* dhcp
* pppoe
| Addressing mode (static, DHCP, PPPoE). |
| | **monitor\_bandwidth** string | **Choices:*** enable
* disable
| Enable monitoring bandwidth on this interface. |
| | **mtu** integer | | MTU value for this interface. |
| | **mtu\_override** string | **Choices:*** enable
* disable
| Enable to set a custom MTU for this interface. |
| | **name** string / required | | Name. |
| | **ndiscforward** string | **Choices:*** enable
* disable
| Enable/disable NDISC forwarding. |
| | **netbios\_forward** string | **Choices:*** disable
* enable
| Enable/disable NETBIOS forwarding. |
| | **netflow\_sampler** string | **Choices:*** disable
* tx
* rx
* both
| Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both). |
| | **outbandwidth** integer | | Bandwidth limit for outgoing traffic (0 - 16776000 kbps). |
| | **padt\_retry\_timeout** integer | | PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time. |
| | **password** string | | PPPoE account"s password. |
| | **ping\_serv\_status** integer | | PING server status. |
| | **polling\_interval** integer | | sFlow polling interval (1 - 255 sec). |
| | **pppoe\_unnumbered\_negotiate** string | **Choices:*** enable
* disable
| Enable/disable PPPoE unnumbered negotiation. |
| | **pptp\_auth\_type** string | **Choices:*** auto
* pap
* chap
* mschapv1
* mschapv2
| PPTP authentication type. |
| | **pptp\_client** string | **Choices:*** enable
* disable
| Enable/disable PPTP client. |
| | **pptp\_password** string | | PPTP password. |
| | **pptp\_server\_ip** string | | PPTP server IP address. |
| | **pptp\_timeout** integer | | Idle timer in minutes (0 for disabled). |
| | **pptp\_user** string | | PPTP user name. |
| | **preserve\_session\_route** string | **Choices:*** enable
* disable
| Enable/disable preservation of session route when dirty. |
| | **priority** integer | | Priority of learned routes. |
| | **priority\_override** string | **Choices:*** enable
* disable
| Enable/disable fail back to higher priority port once recovered. |
| | **proxy\_captive\_portal** string | **Choices:*** enable
* disable
| Enable/disable proxy captive portal on this interface. |
| | **redundant\_interface** string | | Redundant interface. |
| | **remote\_ip** string | | Remote IP address of tunnel. |
| | **replacemsg\_override\_group** string | | Replacement message override group. |
| | **ring\_rx** integer | | RX ring size. |
| | **ring\_tx** integer | | TX ring size. |
| | **role** string | **Choices:*** lan
* wan
* dmz
* undefined
| Interface role. |
| | **sample\_direction** string | **Choices:*** tx
* rx
* both
| Data that NetFlow collects (rx, tx, or both). |
| | **sample\_rate** integer | | sFlow sample rate (10 - 99999). |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Enable monitoring or blocking connections to Botnet servers through this interface. |
| | **secondary\_IP** string | **Choices:*** enable
* disable
| Enable/disable adding a secondary IP to this interface. |
| | **secondaryip** list / elements=string | | Second IP address of interface. |
| | | **allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* telnet
* fgfm
* radius-acct
* probe-response
* capwap
* ftm
* fabric
| Management access settings for the secondary IP address. |
| | | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| Protocols used to detect the server. |
| | | **detectserver** string | | Gateway"s ping server for this IP. |
| | | **gwdetect** string | **Choices:*** enable
* disable
| Enable/disable detect gateway alive for first. |
| | | **ha\_priority** integer | | HA election priority for the PING server. |
| | | **id** integer / required | | ID. |
| | | **ip** string | | Secondary IP address of the interface. |
| | | **ping\_serv\_status** integer | | PING server status. |
| | **security\_exempt\_list** string | | Name of security-exempt-list. |
| | **security\_external\_logout** string | | URL of external authentication logout server. |
| | **security\_external\_web** string | | URL of external authentication web server. |
| | **security\_groups** list / elements=string | | User groups that can authenticate with the captive portal. |
| | | **name** string / required | | Names of user groups that can authenticate with the captive portal. Source user.group.name. |
| | **security\_mac\_auth\_bypass** string | **Choices:*** enable
* disable
* mac-auth-only
| Enable/disable MAC authentication bypass. |
| | **security\_mode** string | **Choices:*** none
* captive-portal
* 802.1X
| Turn on captive portal authentication for this interface. |
| | **security\_redirect\_url** string | | URL redirection after disclaimer/authentication. |
| | **service\_name** string | | PPPoE service name. |
| | **sflow\_sampler** string | **Choices:*** enable
* disable
| Enable/disable sFlow on this interface. |
| | **snmp\_index** integer | | Permanent SNMP Index of the interface. |
| | **speed** string | **Choices:*** auto
* 10full
* 10half
* 100full
* 100half
* 1000full
* 1000half
* 1000auto
* 10000full
* 10000auto
* 40000full
* 100Gfull
| Interface speed. The default setting and the options available depend on the interface hardware. |
| | **spillover\_threshold** integer | | Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited. |
| | **src\_check** string | **Choices:*** enable
* disable
| Enable/disable source IP check. |
| | **status** string | **Choices:*** up
* down
| Bring the interface up or shut the interface down. |
| | **stp** string | **Choices:*** disable
* enable
| Enable/disable STP. |
| | **stp\_ha\_secondary** string | **Choices:*** disable
* enable
* priority-adjust
| Control STP behaviour on HA secondary. |
| | **stp\_ha\_slave** string | **Choices:*** disable
* enable
* priority-adjust
| Control STP behaviour on HA slave. |
| | **stpforward** string | **Choices:*** enable
* disable
| Enable/disable STP forwarding. |
| | **stpforward\_mode** string | **Choices:*** rpl-all-ext-id
* rpl-bridge-ext-id
* rpl-nothing
| Configure STP forwarding mode. |
| | **subst** string | **Choices:*** enable
* disable
| Enable to always send packets from this interface to a destination MAC address. |
| | **substitute\_dst\_mac** string | | Destination MAC address that all packets are sent to from this interface. |
| | **swc\_first\_create** integer | | Initial create for switch-controller VLANs. |
| | **swc\_vlan** integer | | Creation status for switch-controller VLANs. |
| | **switch** string | | Contained in switch. |
| | **switch\_controller\_access\_vlan** string | **Choices:*** enable
* disable
| Block FortiSwitch port-to-port traffic. |
| | **switch\_controller\_arp\_inspection** string | **Choices:*** enable
* disable
| Enable/disable FortiSwitch ARP inspection. |
| | **switch\_controller\_dhcp\_snooping** string | **Choices:*** enable
* disable
| Switch controller DHCP snooping. |
| | **switch\_controller\_dhcp\_snooping\_option82** string | **Choices:*** enable
* disable
| Switch controller DHCP snooping option82. |
| | **switch\_controller\_dhcp\_snooping\_verify\_mac** string | **Choices:*** enable
* disable
| Switch controller DHCP snooping verify MAC. |
| | **switch\_controller\_dynamic** string | | Integrated FortiLink settings for managed FortiSwitch. Source switch-controller.fortilink-settings.name. |
| | **switch\_controller\_feature** string | **Choices:*** none
* default-vlan
* quarantine
* rspan
* voice
* video
* nac
| Interface"s purpose when assigning traffic (read only). |
| | **switch\_controller\_igmp\_snooping** string | **Choices:*** enable
* disable
| Switch controller IGMP snooping. |
| | **switch\_controller\_igmp\_snooping\_fast\_leave** string | **Choices:*** enable
* disable
| Switch controller IGMP snooping fast-leave. |
| | **switch\_controller\_igmp\_snooping\_proxy** string | **Choices:*** enable
* disable
| Switch controller IGMP snooping proxy. |
| | **switch\_controller\_iot\_scanning** string | **Choices:*** enable
* disable
| Enable/disable managed FortiSwitch IoT scanning. |
| | **switch\_controller\_learning\_limit** integer | | Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default). |
| | **switch\_controller\_mgmt\_vlan** integer | | VLAN to use for FortiLink management purposes. |
| | **switch\_controller\_nac** string | | Integrated NAC settings for managed FortiSwitch. Source switch-controller.nac-settings.name. |
| | **switch\_controller\_rspan\_mode** string | **Choices:*** disable
* enable
| Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface. |
| | **switch\_controller\_source\_ip** string | **Choices:*** outbound
* fixed
| Source IP address used in FortiLink over L3 connections. |
| | **switch\_controller\_traffic\_policy** string | | Switch controller traffic policy for the VLAN. Source switch-controller.traffic-policy.name. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| | **tcp\_mss** integer | | TCP maximum segment size. 0 means do not change segment size. |
| | **trust\_ip6\_1** string | | Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
| | **trust\_ip6\_2** string | | Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
| | **trust\_ip6\_3** string | | Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
| | **trust\_ip\_1** string | | Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
| | **trust\_ip\_2** string | | Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
| | **trust\_ip\_3** string | | Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
| | **type** string | **Choices:*** physical
* vlan
* aggregate
* redundant
* tunnel
* vdom-link
* loopback
* switch
* hard-switch
* vap-switch
* wl-mesh
* fext-wan
* vxlan
* hdlc
* switch-vlan
* emac-vlan
* geneve
* ssl
| Interface type. |
| | **username** string | | Username of the PPPoE account, provided by your ISP. |
| | **vdom** string | | Interface is in this virtual domain (VDOM). Source system.vdom.name. |
| | **vindex** integer | | Switch control interface VLAN ID. |
| | **vlan\_protocol** string | **Choices:*** 8021q
* 8021ad
| Ethernet protocol of VLAN. |
| | **vlanforward** string | **Choices:*** enable
* disable
| Enable/disable traffic forwarding between VLANs on this interface. |
| | **vlanid** integer | | VLAN ID (1 - 4094). |
| | **vrf** integer | | Virtual Routing Forwarding ID. |
| | **vrrp** list / elements=string | | VRRP configuration. |
| | | **accept\_mode** string | **Choices:*** enable
* disable
| Enable/disable accept mode. |
| | | **adv\_interval** integer | | Advertisement interval (1 - 255 seconds). |
| | | **ignore\_default\_route** string | **Choices:*** enable
* disable
| Enable/disable ignoring of default route when checking destination. |
| | | **preempt** string | **Choices:*** enable
* disable
| Enable/disable preempt mode. |
| | | **priority** integer | | Priority of the virtual router (1 - 255). |
| | | **proxy\_arp** list / elements=string | | VRRP Proxy ARP configuration. |
| | | | **id** integer / required | | ID. |
| | | | **ip** string | | Set IP addresses of proxy ARP. |
| | | **start\_time** integer | | Startup time (1 - 255 seconds). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this VRRP configuration. |
| | | **version** string | **Choices:*** 2
* 3
| VRRP version. |
| | | **vrdst** string | | Monitor the route to this destination. |
| | | **vrdst\_priority** integer | | Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). |
| | | **vrgrp** integer | | VRRP group ID (1 - 65535). |
| | | **vrid** integer / required | | Virtual router identifier (1 - 255). |
| | | **vrip** string | | IP address of the virtual router. |
| | **vrrp\_virtual\_mac** string | **Choices:*** enable
* disable
| Enable/disable use of virtual MAC for VRRP. |
| | **wccp** string | **Choices:*** enable
* disable
| Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers. |
| | **weight** integer | | Default weight for static routes (if route has no weight configured). |
| | **wins\_ip** string | | WINS server IP. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure interfaces.
fortios_system_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_interface:
ac_name: "<your_own_value>"
aggregate: "<your_own_value>"
algorithm: "L2"
alias: "<your_own_value>"
allowaccess: "ping"
ap_discover: "enable"
arpforward: "enable"
auth_type: "auto"
auto_auth_extension_device: "enable"
bandwidth_measure_time: "12"
bfd: "global"
bfd_desired_min_tx: "14"
bfd_detect_mult: "15"
bfd_required_min_rx: "16"
broadcast_forticlient_discovery: "enable"
broadcast_forward: "enable"
captive_portal: "19"
cli_conn_status: "20"
client_options:
-
code: "22"
id: "23"
ip: "<your_own_value>"
type: "hex"
value: "<your_own_value>"
color: "27"
dedicated_to: "none"
defaultgw: "enable"
description: "<your_own_value>"
detected_peer_mtu: "31"
detectprotocol: "ping"
detectserver: "<your_own_value>"
device_access_list: "<your_own_value>"
device_identification: "enable"
device_identification_active_scan: "enable"
device_netscan: "disable"
device_user_identification: "enable"
devindex: "39"
dhcp_client_identifier: "myId_40"
dhcp_relay_agent_option: "enable"
dhcp_relay_interface: "<your_own_value> (source system.interface.name)"
dhcp_relay_interface_select_method: "auto"
dhcp_relay_ip: "<your_own_value>"
dhcp_relay_request_all_server: "disable"
dhcp_relay_service: "disable"
dhcp_relay_type: "regular"
dhcp_renew_time: "48"
disc_retry_timeout: "49"
disconnect_threshold: "50"
distance: "51"
dns_server_override: "enable"
drop_fragment: "enable"
drop_overlapped_fragment: "enable"
egress_cos: "disable"
egress_queues:
cos0: "<your_own_value> (source system.isf-queue-profile.name)"
cos1: "<your_own_value> (source system.isf-queue-profile.name)"
cos2: "<your_own_value> (source system.isf-queue-profile.name)"
cos3: "<your_own_value> (source system.isf-queue-profile.name)"
cos4: "<your_own_value> (source system.isf-queue-profile.name)"
cos5: "<your_own_value> (source system.isf-queue-profile.name)"
cos6: "<your_own_value> (source system.isf-queue-profile.name)"
cos7: "<your_own_value> (source system.isf-queue-profile.name)"
egress_shaping_profile: "<your_own_value> (source firewall.shaping-profile.profile-name)"
endpoint_compliance: "enable"
estimated_downstream_bandwidth: "67"
estimated_upstream_bandwidth: "68"
explicit_ftp_proxy: "enable"
explicit_web_proxy: "enable"
external: "enable"
fail_action_on_extender: "soft-restart"
fail_alert_interfaces:
-
name: "default_name_74 (source system.interface.name)"
fail_alert_method: "link-failed-signal"
fail_detect: "enable"
fail_detect_option: "detectserver"
fortiheartbeat: "enable"
fortilink: "enable"
fortilink_backup_link: "80"
fortilink_neighbor_detect: "lldp"
fortilink_split_interface: "enable"
fortilink_stacking: "enable"
forward_domain: "84"
gi_gk: "enable"
gwdetect: "enable"
ha_priority: "87"
icmp_accept_redirect: "enable"
icmp_send_redirect: "enable"
ident_accept: "enable"
idle_timeout: "91"
inbandwidth: "92"
ingress_cos: "disable"
ingress_shaping_profile: "<your_own_value> (source firewall.shaping-profile.profile-name)"
ingress_spillover_threshold: "95"
interface: "<your_own_value> (source system.interface.name)"
internal: "97"
ip: "<your_own_value>"
ip_managed_by_fortiipam: "enable"
ipmac: "enable"
ips_sniffer_mode: "enable"
ipunnumbered: "<your_own_value>"
ipv6:
autoconf: "enable"
cli_conn6_status: "105"
dhcp6_client_options: "rapid"
dhcp6_information_request: "enable"
dhcp6_prefix_delegation: "enable"
dhcp6_prefix_hint: "<your_own_value>"
dhcp6_prefix_hint_plt: "110"
dhcp6_prefix_hint_vlt: "111"
dhcp6_relay_ip: "<your_own_value>"
dhcp6_relay_service: "disable"
dhcp6_relay_type: "regular"
icmp6_send_redirect: "enable"
interface_identifier: "<your_own_value>"
ip6_address: "<your_own_value>"
ip6_allowaccess: "ping"
ip6_default_life: "119"
ip6_delegated_prefix_list:
-
autonomous_flag: "enable"
onlink_flag: "enable"
prefix_id: "123"
rdnss: "<your_own_value>"
rdnss_service: "delegated"
subnet: "<your_own_value>"
upstream_interface: "<your_own_value> (source system.interface.name)"
ip6_dns_server_override: "enable"
ip6_extra_addr:
-
prefix: "<your_own_value>"
ip6_hop_limit: "131"
ip6_link_mtu: "132"
ip6_manage_flag: "enable"
ip6_max_interval: "134"
ip6_min_interval: "135"
ip6_mode: "static"
ip6_other_flag: "enable"
ip6_prefix_list:
-
autonomous_flag: "enable"
dnssl:
-
domain: "<your_own_value>"
onlink_flag: "enable"
preferred_life_time: "143"
prefix: "<your_own_value>"
rdnss: "<your_own_value>"
valid_life_time: "146"
ip6_prefix_mode: "dhcp6"
ip6_reachable_time: "148"
ip6_retrans_time: "149"
ip6_send_adv: "enable"
ip6_subnet: "<your_own_value>"
ip6_upstream_interface: "<your_own_value> (source system.interface.name)"
nd_cert: "<your_own_value> (source certificate.local.name)"
nd_cga_modifier: "<your_own_value>"
nd_mode: "basic"
nd_security_level: "156"
nd_timestamp_delta: "157"
nd_timestamp_fuzz: "158"
ra_send_mtu: "enable"
unique_autoconf_addr: "enable"
vrip6_link_local: "<your_own_value>"
vrrp_virtual_mac6: "enable"
vrrp6:
-
accept_mode: "enable"
adv_interval: "165"
preempt: "enable"
priority: "167"
start_time: "168"
status: "enable"
vrdst6: "<your_own_value>"
vrgrp: "171"
vrid: "172"
vrip6: "<your_own_value>"
l2forward: "enable"
lacp_ha_slave: "enable"
lacp_mode: "static"
lacp_speed: "slow"
lcp_echo_interval: "178"
lcp_max_echo_fails: "179"
link_up_delay: "180"
lldp_network_policy: "<your_own_value> (source system.lldp.network-policy.name)"
lldp_reception: "enable"
lldp_transmission: "enable"
macaddr: "<your_own_value>"
managed_device:
-
name: "default_name_186"
managed_subnetwork_size: "256"
management_ip: "<your_own_value>"
measured_downstream_bandwidth: "189"
measured_upstream_bandwidth: "190"
mediatype: "cfp2-sr10"
member:
-
interface_name: "<your_own_value> (source system.interface.name)"
min_links: "194"
min_links_down: "operational"
mode: "static"
monitor_bandwidth: "enable"
mtu: "198"
mtu_override: "enable"
name: "default_name_200"
ndiscforward: "enable"
netbios_forward: "disable"
netflow_sampler: "disable"
outbandwidth: "204"
padt_retry_timeout: "205"
password: "<your_own_value>"
ping_serv_status: "207"
polling_interval: "208"
pppoe_unnumbered_negotiate: "enable"
pptp_auth_type: "auto"
pptp_client: "enable"
pptp_password: "<your_own_value>"
pptp_server_ip: "<your_own_value>"
pptp_timeout: "214"
pptp_user: "<your_own_value>"
preserve_session_route: "enable"
priority: "217"
priority_override: "enable"
proxy_captive_portal: "enable"
redundant_interface: "<your_own_value>"
remote_ip: "<your_own_value>"
replacemsg_override_group: "<your_own_value>"
ring_rx: "223"
ring_tx: "224"
role: "lan"
sample_direction: "tx"
sample_rate: "227"
scan_botnet_connections: "disable"
secondary_IP: "enable"
secondaryip:
-
allowaccess: "ping"
detectprotocol: "ping"
detectserver: "<your_own_value>"
gwdetect: "enable"
ha_priority: "235"
id: "236"
ip: "<your_own_value>"
ping_serv_status: "238"
security_exempt_list: "<your_own_value>"
security_external_logout: "<your_own_value>"
security_external_web: "<your_own_value>"
security_groups:
-
name: "default_name_243 (source user.group.name)"
security_mac_auth_bypass: "enable"
security_mode: "none"
security_redirect_url: "<your_own_value>"
service_name: "<your_own_value>"
sflow_sampler: "enable"
snmp_index: "249"
speed: "auto"
spillover_threshold: "251"
src_check: "enable"
status: "up"
stp: "disable"
stp_ha_secondary: "disable"
stp_ha_slave: "disable"
stpforward: "enable"
stpforward_mode: "rpl-all-ext-id"
subst: "enable"
substitute_dst_mac: "<your_own_value>"
swc_first_create: "261"
swc_vlan: "262"
switch: "<your_own_value>"
switch_controller_access_vlan: "enable"
switch_controller_arp_inspection: "enable"
switch_controller_dhcp_snooping: "enable"
switch_controller_dhcp_snooping_option82: "enable"
switch_controller_dhcp_snooping_verify_mac: "enable"
switch_controller_dynamic: "<your_own_value> (source switch-controller.fortilink-settings.name)"
switch_controller_feature: "none"
switch_controller_igmp_snooping: "enable"
switch_controller_igmp_snooping_fast_leave: "enable"
switch_controller_igmp_snooping_proxy: "enable"
switch_controller_iot_scanning: "enable"
switch_controller_learning_limit: "275"
switch_controller_mgmt_vlan: "276"
switch_controller_nac: "<your_own_value> (source switch-controller.nac-settings.name)"
switch_controller_rspan_mode: "disable"
switch_controller_source_ip: "outbound"
switch_controller_traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_283"
tags:
-
name: "default_name_285 (source system.object-tagging.tags.name)"
tcp_mss: "286"
trust_ip_1: "<your_own_value>"
trust_ip_2: "<your_own_value>"
trust_ip_3: "<your_own_value>"
trust_ip6_1: "<your_own_value>"
trust_ip6_2: "<your_own_value>"
trust_ip6_3: "<your_own_value>"
type: "physical"
username: "<your_own_value>"
vdom: "<your_own_value> (source system.vdom.name)"
vindex: "296"
vlan_protocol: "8021q"
vlanforward: "enable"
vlanid: "299"
vrf: "300"
vrrp:
-
accept_mode: "enable"
adv_interval: "303"
ignore_default_route: "enable"
preempt: "enable"
priority: "306"
proxy_arp:
-
id: "308"
ip: "<your_own_value>"
start_time: "310"
status: "enable"
version: "2"
vrdst: "<your_own_value>"
vrdst_priority: "314"
vrgrp: "315"
vrid: "316"
vrip: "<your_own_value>"
vrrp_virtual_mac: "enable"
wccp: "enable"
weight: "320"
wins_ip: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_emailfilter_options – Configure AntiSpam options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_options – Configure AntiSpam options in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_emailfilter_options`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and options 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **emailfilter\_options** dictionary | | Configure AntiSpam options. |
| | **dns\_timeout** integer | | DNS query time out (1 - 30 sec). |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam options.
fortios_emailfilter_options:
vdom: "{{ vdom }}"
emailfilter_options:
dns_timeout: "3"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ttl_policy – Configure TTL policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ttl\_policy – Configure TTL policies in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ttl_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ttl\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ttl\_policy** dictionary | | Configure TTL policies. |
| | **action** string | **Choices:*** accept
* deny
| Action to be performed on traffic matching this policy . |
| | **id** integer / required | | ID. |
| | **schedule** string | | Schedule object from available options. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group .name. |
| | **service** list / elements=string | | Service object(s) from available options. Separate multiple names with a space. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address object(s) from available options. Separate multiple names with a space. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **srcintf** string | | Source interface name from available interfaces. Source system.zone.name system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this TTL policy. |
| | **ttl** string | | Value/range to match against the packet"s Time to Live value (format: ttl[ - ttl\_high], 1 - 255). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure TTL policies.
fortios_firewall_ttl_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ttl_policy:
action: "accept"
id: "4"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_7 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
status: "enable"
ttl: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_mem_mgr – Configure memory manager in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_mem\_mgr – Configure memory manager in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_mem_mgr`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and mem\_mgr 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_mem\_mgr** dictionary | | Configure memory manager. |
| | **mass\_mmsd** integer | | memory limit for Mass MMS Daemon (% of free memory) |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure memory manager.
fortios_system_mem_mgr:
vdom: "{{ vdom }}"
system_mem_mgr:
mass_mmsd: "3"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_authentication_rule – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_authentication\_rule – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_authentication_rule`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and rule 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **authentication\_rule** dictionary | | Configure Authentication Rules. |
| | **active\_auth\_method** string | | Select an active authentication method. Source authentication.scheme.name. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Select an IPv4 destination address from available options. Required for web proxy authentication. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. |
| | **dstaddr6** list / elements=string | | Select an IPv6 destination address from available options. Required for web proxy authentication. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ip\_based** string | **Choices:*** enable
* disable
| Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. |
| | **name** string / required | | Authentication rule name. |
| | **protocol** string | **Choices:*** http
* ftp
* socks
* ssh
| Select the protocol to use for authentication . Users connect to the FortiGate using this protocol and are asked to authenticate. |
| | **srcaddr** list / elements=string | | Select an IPv4 source address from available options. Required for web proxy authentication. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name. |
| | **srcaddr6** list / elements=string | | Select an IPv6 source address. Required for web proxy authentication. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **srcintf** list / elements=string | | Incoming (ingress) interface. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **sso\_auth\_method** string | | Select a single-sign on (SSO) authentication method. Source authentication.scheme.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this authentication rule. |
| | **transaction\_based** string | **Choices:*** enable
* disable
| Enable/disable transaction based authentication . |
| | **web\_auth\_cookie** string | **Choices:*** enable
* disable
| Enable/disable Web authentication cookies . |
| | **web\_portal** string | **Choices:*** enable
* disable
| Enable/disable web portal for proxy transparent policy . |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Authentication Rules.
fortios_authentication_rule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
authentication_rule:
active_auth_method: "<your_own_value> (source authentication.scheme.name)"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_6 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
.external-resource.name)"
dstaddr6:
-
name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)"
ip_based: "enable"
name: "default_name_10"
protocol: "http"
srcaddr:
-
name: "default_name_13 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
srcaddr6:
-
name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_17 (source system.interface.name system.zone.name)"
sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
status: "enable"
transaction_based: "enable"
web_auth_cookie: "enable"
web_portal: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_auto_script – Configure auto script in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_auto\_script – Configure auto script in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_auto_script`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and auto\_script 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_auto\_script** dictionary | | Configure auto script. |
| | **interval** integer | | Repeat interval in seconds. |
| | **name** string / required | | Auto script name. |
| | **output\_size** integer | | Number of megabytes to limit script output to (10 - 1024). |
| | **repeat** integer | | Number of times to repeat this script (0 = infinite). |
| | **script** string | | List of FortiOS CLI commands to repeat. |
| | **start** string | **Choices:*** manual
* auto
| Script starting mode. |
| | **timeout** integer | | Maximum running time for this script in seconds (0 = no timeout). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure auto script.
fortios_system_auto_script:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_auto_script:
interval: "3"
name: "default_name_4"
output_size: "5"
repeat: "6"
script: "<your_own_value>"
start: "manual"
timeout: "9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_nac_quar – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_nac\_quar – Replacement messages in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_nac_quar`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and nac\_quar 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_nac\_quar** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_nac_quar:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_nac_quar:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_shaping_policy – Configure shaping policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_shaping\_policy – Configure shaping policies in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_shaping_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_shaping\_policy** dictionary | | Configure shaping policies. |
| | **app\_category** list / elements=string | | IDs of one or more application categories that this shaper applies application control traffic shaping to. |
| | | **id** integer / required | | Category IDs. |
| | **app\_group** list / elements=string | | One or more application group names. |
| | | **name** string / required | | Application group name. Source application.group.name. |
| | **application** list / elements=string | | IDs of one or more applications that this shaper applies application control traffic shaping to. |
| | | **id** integer / required | | Application IDs. |
| | **class\_id** integer | | Traffic class ID. Source firewall.traffic-class.class-id. |
| | **comment** string | | Comments. |
| | **diffserv\_forward** string | **Choices:*** enable
* disable
| Enable to change packet"s DiffServ values to the specified diffservcode-forward value. |
| | **diffserv\_reverse** string | **Choices:*** enable
* disable
| Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode\_forward** string | | Change packet"s DiffServ to this value. |
| | **diffservcode\_rev** string | | Change packet"s reverse (reply) DiffServ to this value. |
| | **dstaddr** list / elements=string | | IPv4 destination address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **dstaddr6** list / elements=string | | IPv6 destination address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **dstintf** list / elements=string | | One or more outgoing (egress) interfaces. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **groups** list / elements=string | | Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. |
| | | **name** string / required | | Group name. Source user.group.name. |
| | **id** integer / required | | Shaping policy ID. |
| | **internet\_service** string | **Choices:*** enable
* disable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet\_service\_custom** list / elements=string | | Custom Internet Service name. |
| | | **name** string / required | | Custom Internet Service name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_custom\_group** list / elements=string | | Custom Internet Service group name. |
| | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | **internet\_service\_group** list / elements=string | | Internet Service group name. |
| | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | **internet\_service\_id** list / elements=string | | Internet Service ID. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | **internet\_service\_name** list / elements=string | | Internet Service ID. |
| | | **name** string / required | | Internet Service name. Source firewall.internet-service-name.name. |
| | **internet\_service\_src** string | **Choices:*** enable
* disable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet\_service\_src\_custom** list / elements=string | | Custom Internet Service source name. |
| | | **name** string / required | | Custom Internet Service name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_src\_custom\_group** list / elements=string | | Custom Internet Service source group name. |
| | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | **internet\_service\_src\_group** list / elements=string | | Internet Service source group name. |
| | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | **internet\_service\_src\_id** list / elements=string | | Internet Service source ID. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | **internet\_service\_src\_name** list / elements=string | | Internet Service source name. |
| | | **name** string / required | | Internet Service name. Source firewall.internet-service-name.name. |
| | **ip\_version** string | **Choices:*** 4
* 6
| Apply this traffic shaping policy to IPv4 or IPv6 traffic. |
| | **name** string | | Shaping policy name. |
| | **per\_ip\_shaper** string | | Per-IP traffic shaper to apply with this policy. Source firewall.shaper.per-ip-shaper.name. |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **service** list / elements=string | | Service and service group names. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | IPv4 source address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **srcaddr6** list / elements=string | | IPv6 source address and address group names. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **srcintf** list / elements=string | | One or more incoming (ingress) interfaces. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this traffic shaping policy. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos\_mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos\_negate** string | **Choices:*** enable
* disable
| Enable negated TOS match. |
| | **traffic\_shaper** string | | Traffic shaper to apply to traffic forwarded by the firewall policy. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Traffic shaper to apply to response traffic received by the firewall policy. Source firewall.shaper.traffic-shaper.name. |
| | **url\_category** list / elements=string | | IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. |
| | | **id** integer / required | | URL category ID. |
| | **users** list / elements=string | | Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. |
| | | **name** string / required | | User name. Source user.local.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure shaping policies.
fortios_firewall_shaping_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaping_policy:
app_category:
-
id: "4"
app_group:
-
name: "default_name_6 (source application.group.name)"
application:
-
id: "8"
class_id: "9 (source firewall.traffic-class.class-id)"
comment: "Comments."
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
dstaddr:
-
name: "default_name_16 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_20 (source system.interface.name system.zone.name)"
groups:
-
name: "default_name_22 (source user.group.name)"
id: "23"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_26 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_28 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_30 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "32 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_34 (source firewall.internet-service-name.name)"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_37 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_39 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_41 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "43 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_45 (source firewall.internet-service-name.name)"
ip_version: "4"
name: "default_name_47"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_51 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_53 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_55 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_57 (source system.interface.name system.zone.name)"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "65"
users:
-
name: "default_name_67 (source user.local.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_vipgrp64 – Configure IPv6 to IPv4 virtual IP groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vipgrp64 – Configure IPv6 to IPv4 virtual IP groups in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vipgrp64`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp64 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vipgrp64** dictionary | | Configure IPv6 to IPv4 virtual IP groups. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32). |
| | **comments** string | | Comment. |
| | **member** list / elements=string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | | **name** string / required | | VIP64 name. Source firewall.vip64.name. |
| | **name** string / required | | VIP64 group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 to IPv4 virtual IP groups.
fortios_firewall_vipgrp64:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vipgrp64:
color: "3"
comments: "<your_own_value>"
member:
-
name: "default_name_6 (source firewall.vip64.name)"
name: "default_name_7"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer2_override_filter – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer2\_override\_filter – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer2_override_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer2 feature and override\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer2\_override\_filter** dictionary | | Override filters for FortiAnalyzer. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **filter** string | | FortiAnalyzer 2 log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Log every message above and including this severity level. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override filters for FortiAnalyzer.
fortios_log_fortianalyzer2_override_filter:
vdom: "{{ vdom }}"
log_fortianalyzer2_override_filter:
anomaly: "enable"
dlp_archive: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
severity: "emergency"
sniffer_traffic: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_web_proxy_forward_server – Configure forward-server addresses in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_forward\_server – Configure forward-server addresses in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_web_proxy_forward_server`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web\_proxy feature and forward\_server 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **web\_proxy\_forward\_server** dictionary | | Configure forward-server addresses. |
| | **addr\_type** string | **Choices:*** ip
* fqdn
| Address type of the forwarding proxy server: IP or FQDN. |
| | **comment** string | | Comment. |
| | **fqdn** string | | Forward server Fully Qualified Domain Name (FQDN). |
| | **healthcheck** string | **Choices:*** disable
* enable
| Enable/disable forward server health checking. Attempts to connect through the remote forwarding server to a destination to verify that the forwarding server is operating normally. |
| | **ip** string | | Forward proxy server IP address. |
| | **monitor** string | | URL for forward server health check monitoring . |
| | **name** string / required | | Server name. |
| | **password** string | | HTTP authentication password. |
| | **port** integer | | Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535). |
| | **server\_down\_option** string | **Choices:*** block
* pass
| Action to take when the forward server is found to be down: block sessions until the server is back up or pass sessions to their destination. |
| | **username** string | | HTTP authentication user name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure forward-server addresses.
fortios_web_proxy_forward_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_forward_server:
addr_type: "ip"
comment: "Comment."
fqdn: "<your_own_value>"
healthcheck: "disable"
ip: "<your_own_value>"
monitor: "<your_own_value>"
name: "default_name_9"
password: "<your_own_value>"
port: "11"
server_down_option: "block"
username: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_central_snat_map – Configure central SNAT policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_central\_snat\_map – Configure central SNAT policies in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_central_snat_map`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and central\_snat\_map 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **action** string | **Choices:*** move
| the action indiactor to move an object in the list |
| **after** string | | mkey of target identifier |
| **before** string | | mkey of target identifier |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_central\_snat\_map** dictionary | | Configure central SNAT policies. |
| | **comments** string | | Comment. |
| | **dst\_addr** list / elements=string | | Destination address name from available addresses. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **dst\_addr6** list / elements=string | | IPv6 Destination address. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **dstintf** list / elements=string | | Destination interface name from available interfaces. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **nat** string | **Choices:*** disable
* enable
| Enable/disable source NAT. |
| | **nat\_ippool** list / elements=string | | Name of the IP pools to be used to translate addresses from available IP Pools. |
| | | **name** string / required | | IP pool name. Source firewall.ippool.name. |
| | **nat\_ippool6** list / elements=string | | IPv6 pools to be used for source NAT. |
| | | **name** string / required | | IPv6 pool name. Source firewall.ippool6.name. |
| | **nat\_port** string | | Translated port or port range (0 to 65535). |
| | **orig\_addr** list / elements=string | | Original address. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **orig\_addr6** list / elements=string | | IPv6 Original address. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **orig\_port** string | | Original TCP port (0 to 65535). |
| | **policyid** integer / required | | Policy ID. |
| | **protocol** integer | | Integer value for the protocol type (0 - 255). |
| | **srcintf** list / elements=string | | Source interface name from available interfaces. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of this policy. |
| | **type** string | **Choices:*** ipv4
* ipv6
| IPv4/IPv6 source NAT. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **self** string | | mkey of self identifier |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
* Adjust object order by moving self after(before) another.
* Only one of [after, before] must be specified when action is moving an object.
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure central SNAT policies.
fortios_firewall_central_snat_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_central_snat_map:
comments: "<your_own_value>"
dst_addr:
-
name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
dst_addr6:
-
name: "default_name_7 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_9 (source system.interface.name system.zone.name)"
nat: "disable"
nat_ippool:
-
name: "default_name_12 (source firewall.ippool.name)"
nat_ippool6:
-
name: "default_name_14 (source firewall.ippool6.name)"
nat_port: "<your_own_value>"
orig_addr:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
orig_addr6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
orig_port: "<your_own_value>"
policyid: "21"
protocol: "22"
srcintf:
-
name: "default_name_24 (source system.interface.name system.zone.name)"
status: "enable"
type: "ipv4"
uuid: "<your_own_value>"
- name: move firewall.central_snat_map
fortios_firewall_central_snat_map:
vdom: "root"
action: "move"
self: "<mkey of self identifier>"
after: "<mkey of target identifier>"
#before: "<mkey of target identifier>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_fortiguard_setting – Configure logging to FortiCloud in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortiguard\_setting – Configure logging to FortiCloud in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortiguard_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortiguard feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortiguard\_setting** dictionary | | Configure logging to FortiCloud. |
| | **conn\_timeout** integer | | FortiCloud connection timeout in seconds |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
| Enable and set the SSL security level for for sending encrypted logs to FortiCloud. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **max\_log\_rate** integer | | FortiCloud maximum log rate in MBps (0 = unlimited). |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **source\_ip** string | | Source IP address used to connect FortiCloud. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiCloud. |
| | **upload\_day** string | | Day of week to roll logs. |
| | **upload\_interval** string | **Choices:*** daily
* weekly
* monthly
| Frequency of uploading log files to FortiCloud. |
| | **upload\_option** string | **Choices:*** store-and-upload
* realtime
* 1-minute
* 5-minute
| Configure how log messages are sent to FortiCloud. |
| | **upload\_time** string | | Time of day to roll logs (hh:mm). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure logging to FortiCloud.
fortios_log_fortiguard_setting:
vdom: "{{ vdom }}"
log_fortiguard_setting:
conn_timeout: "3"
enc_algorithm: "high-medium"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "7"
priority: "default"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_dlp_fp_doc_source – Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dlp\_fp\_doc\_source – Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dlp_fp_doc_source`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and fp\_doc\_source 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dlp\_fp\_doc\_source** dictionary | | Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. |
| | **date** integer | | Day of the month on which to scan the server (1 - 31). |
| | **file\_path** string | | Path on the server to the fingerprint files (max 119 characters). |
| | **file\_pattern** string | | Files matching this pattern on the server are fingerprinted. Optionally use the \* and ? wildcards. |
| | **keep\_modified** string | **Choices:*** enable
* disable
| Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. |
| | **name** string / required | | Name of the DLP fingerprint database. |
| | **password** string | | Password required to log into the file server. |
| | **period** string | **Choices:*** none
* daily
* weekly
* monthly
| Frequency for which the FortiGate checks the server for new or changed files. |
| | **remove\_deleted** string | **Choices:*** enable
* disable
| Enable to keep the fingerprint database up to date when a file is deleted from the server. |
| | **scan\_on\_creation** string | **Choices:*** enable
* disable
| Enable to keep the fingerprint database up to date when a file is added or changed on the server. |
| | **scan\_subdirectories** string | **Choices:*** enable
* disable
| Enable/disable scanning subdirectories to find files to create fingerprints from. |
| | **sensitivity** string | | Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. Source dlp .fp-sensitivity.name. |
| | **server** string | | IPv4 or IPv6 address of the server. |
| | **server\_type** string | **Choices:*** samba
| Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. |
| | **tod\_hour** integer | | Hour of the day on which to scan the server (0 - 23). |
| | **tod\_min** integer | | Minute of the hour on which to scan the server (0 - 59). |
| | **username** string | | User name required to log into the file server. |
| | **vdom** string | **Choices:*** mgmt
* current
| Select the VDOM that can communicate with the file server. |
| | **weekday** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Day of the week on which to scan the server. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
fortios_dlp_fp_doc_source:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_fp_doc_source:
date: "3"
file_path: "<your_own_value>"
file_pattern: "<your_own_value>"
keep_modified: "enable"
name: "default_name_7"
password: "<your_own_value>"
period: "none"
remove_deleted: "enable"
scan_on_creation: "enable"
scan_subdirectories: "enable"
sensitivity: "<your_own_value> (source dlp.fp-sensitivity.name)"
server: "192.168.100.40"
server_type: "samba"
tod_hour: "16"
tod_min: "17"
username: "<your_own_value>"
vdom: "mgmt"
weekday: "sunday"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_internet_service_addition – Configure Internet Services Addition in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_addition – Configure Internet Services Addition in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_internet_service_addition`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet\_service\_addition 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_internet\_service\_addition** dictionary | | Configure Internet Services Addition. |
| | **comment** string | | Comment. |
| | **entry** list / elements=string | | Entries added to the Internet Service addition database. |
| | | **id** integer / required | | Entry ID(1-255). |
| | | **port\_range** list / elements=string | | Port ranges in the custom entry. |
| | | | **end\_port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535). |
| | | | **id** integer / required | | Custom entry port range ID. |
| | | | **start\_port** integer | | Integer value for starting TCP/UDP/SCTP destination port in range (1 to 65535). |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **id** integer / required | | Internet Service ID in the Internet Service database. Source firewall.internet-service.id. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Internet Services Addition.
fortios_firewall_internet_service_addition:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_addition:
comment: "Comment."
entry:
-
id: "5"
port_range:
-
end_port: "7"
id: "8"
start_port: "9"
protocol: "10"
id: "11 (source firewall.internet-service.id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_igmp_snooping – Configure FortiSwitch IGMP snooping global settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_igmp\_snooping – Configure FortiSwitch IGMP snooping global settings in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_igmp_snooping`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and igmp\_snooping 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_igmp\_snooping** dictionary | | Configure FortiSwitch IGMP snooping global settings. |
| | **aging\_time** integer | | Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec). |
| | **flood\_unknown\_multicast** string | **Choices:*** enable
* disable
| Enable/disable unknown multicast flooding. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch IGMP snooping global settings.
fortios_switch_controller_igmp_snooping:
vdom: "{{ vdom }}"
switch_controller_igmp_snooping:
aging_time: "3"
flood_unknown_multicast: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_pppoe_interface – Configure the PPPoE interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_pppoe\_interface – Configure the PPPoE interfaces in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_pppoe_interface`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and pppoe\_interface 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_pppoe\_interface** dictionary | | Configure the PPPoE interfaces. |
| | **ac\_name** string | | PPPoE AC name. |
| | **auth\_type** string | **Choices:*** auto
* pap
* chap
* mschapv1
* mschapv2
| PPP authentication type to use. |
| | **device** string | | Name for the physical interface. Source system.interface.name. |
| | **dial\_on\_demand** string | **Choices:*** enable
* disable
| Enable/disable dial on demand to dial the PPPoE interface when packets are routed to the PPPoE interface. |
| | **disc\_retry\_timeout** integer | | PPPoE discovery init timeout value in (0-4294967295 sec). |
| | **idle\_timeout** integer | | PPPoE auto disconnect after idle timeout (0-4294967295 sec). |
| | **ipunnumbered** string | | PPPoE unnumbered IP. |
| | **ipv6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 Control Protocol (IPv6CP). |
| | **lcp\_echo\_interval** integer | | PPPoE LCP echo interval in (0-4294967295 sec). |
| | **lcp\_max\_echo\_fails** integer | | Maximum missed LCP echo messages before disconnect (0-4294967295). |
| | **name** string / required | | Name of the PPPoE interface. |
| | **padt\_retry\_timeout** integer | | PPPoE terminate timeout value in (0-4294967295 sec). |
| | **password** string | | Enter the password. |
| | **pppoe\_unnumbered\_negotiate** string | **Choices:*** enable
* disable
| Enable/disable PPPoE unnumbered negotiation. |
| | **service\_name** string | | PPPoE service name. |
| | **username** string | | User name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure the PPPoE interfaces.
fortios_system_pppoe_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_pppoe_interface:
ac_name: "<your_own_value>"
auth_type: "auto"
device: "<your_own_value> (source system.interface.name)"
dial_on_demand: "enable"
disc_retry_timeout: "7"
idle_timeout: "8"
ipunnumbered: "<your_own_value>"
ipv6: "enable"
lcp_echo_interval: "11"
lcp_max_echo_fails: "12"
name: "default_name_13"
padt_retry_timeout: "14"
password: "<your_own_value>"
pppoe_unnumbered_negotiate: "enable"
service_name: "<your_own_value>"
username: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_log – Configure wireless controller event log filters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_log – Configure wireless controller event log filters in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_log`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and log 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_log** dictionary | | Configure wireless controller event log filters. |
| | **addrgrp\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log address group message. |
| | **ble\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log BLE detection message. |
| | **clb\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log client load balancing message. |
| | **dhcp\_starv\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log DHCP starvation event message. |
| | **led\_sched\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log LED schedule event message. |
| | **radio\_event\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log radio event message. |
| | **rogue\_event\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log rogue AP event message. |
| | **sta\_event\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log station event message. |
| | **sta\_locate\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log station locate message. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable wireless event logging. |
| | **wids\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log WIDS message. |
| | **wtp\_event\_log** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log WTP event message. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure wireless controller event log filters.
fortios_wireless_controller_log:
vdom: "{{ vdom }}"
wireless_controller_log:
addrgrp_log: "emergency"
ble_log: "emergency"
clb_log: "emergency"
dhcp_starv_log: "emergency"
led_sched_log: "emergency"
radio_event_log: "emergency"
rogue_event_log: "emergency"
sta_event_log: "emergency"
sta_locate_log: "emergency"
status: "enable"
wids_log: "emergency"
wtp_event_log: "emergency"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_bgp – Configure BGP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_bgp – Configure BGP in Fortinet’s FortiOS and FortiGate.
==========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_bgp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and bgp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_bgp** dictionary | | Configure BGP. |
| | **additional\_path** string | **Choices:*** enable
* disable
| Enable/disable selection of BGP IPv4 additional paths. |
| | **additional\_path6** string | **Choices:*** enable
* disable
| Enable/disable selection of BGP IPv6 additional paths. |
| | **additional\_path\_select** integer | | Number of additional paths to be selected for each IPv4 NLRI. |
| | **additional\_path\_select6** integer | | Number of additional paths to be selected for each IPv6 NLRI. |
| | **admin\_distance** list / elements=string | | Administrative distance modifications. |
| | | **distance** integer | | Administrative distance to apply (1 - 255). |
| | | **id** integer / required | | ID. |
| | | **neighbour\_prefix** string | | Neighbor address prefix. |
| | | **route\_list** string | | Access list of routes to apply new distance to. Source router.access-list.name. |
| | **aggregate\_address** list / elements=string | | BGP aggregate address table. |
| | | **as\_set** string | **Choices:*** enable
* disable
| Enable/disable generate AS set path information. |
| | | **id** integer / required | | ID. |
| | | **prefix** string | | Aggregate prefix. |
| | | **summary\_only** string | **Choices:*** enable
* disable
| Enable/disable filter more specific routes from updates. |
| | **aggregate\_address6** list / elements=string | | BGP IPv6 aggregate address table. |
| | | **as\_set** string | **Choices:*** enable
* disable
| Enable/disable generate AS set path information. |
| | | **id** integer / required | | ID. |
| | | **prefix6** string | | Aggregate IPv6 prefix. |
| | | **summary\_only** string | **Choices:*** enable
* disable
| Enable/disable filter more specific routes from updates. |
| | **always\_compare\_med** string | **Choices:*** enable
* disable
| Enable/disable always compare MED. |
| | **as** integer | | Router AS number, valid from 1 to 4294967295, 0 to disable BGP. |
| | **bestpath\_as\_path\_ignore** string | **Choices:*** enable
* disable
| Enable/disable ignore AS path. |
| | **bestpath\_cmp\_confed\_aspath** string | **Choices:*** enable
* disable
| Enable/disable compare federation AS path length. |
| | **bestpath\_cmp\_routerid** string | **Choices:*** enable
* disable
| Enable/disable compare router ID for identical EBGP paths. |
| | **bestpath\_med\_confed** string | **Choices:*** enable
* disable
| Enable/disable compare MED among confederation paths. |
| | **bestpath\_med\_missing\_as\_worst** string | **Choices:*** enable
* disable
| Enable/disable treat missing MED as least preferred. |
| | **client\_to\_client\_reflection** string | **Choices:*** enable
* disable
| Enable/disable client-to-client route reflection. |
| | **cluster\_id** string | | Route reflector cluster ID. |
| | **confederation\_identifier** integer | | Confederation identifier. |
| | **confederation\_peers** list / elements=string | | Confederation peers. |
| | | **peer** string / required | | Peer ID. |
| | **dampening** string | **Choices:*** enable
* disable
| Enable/disable route-flap dampening. |
| | **dampening\_max\_suppress\_time** integer | | Maximum minutes a route can be suppressed. |
| | **dampening\_reachability\_half\_life** integer | | Reachability half-life time for penalty (min). |
| | **dampening\_reuse** integer | | Threshold to reuse routes. |
| | **dampening\_route\_map** string | | Criteria for dampening. Source router.route-map.name. |
| | **dampening\_suppress** integer | | Threshold to suppress routes. |
| | **dampening\_unreachability\_half\_life** integer | | Unreachability half-life time for penalty (min). |
| | **default\_local\_preference** integer | | Default local preference. |
| | **deterministic\_med** string | **Choices:*** enable
* disable
| Enable/disable enforce deterministic comparison of MED. |
| | **distance\_external** integer | | Distance for routes external to the AS. |
| | **distance\_internal** integer | | Distance for routes internal to the AS. |
| | **distance\_local** integer | | Distance for routes local to the AS. |
| | **ebgp\_multipath** string | **Choices:*** enable
* disable
| Enable/disable EBGP multi-path. |
| | **enforce\_first\_as** string | **Choices:*** enable
* disable
| Enable/disable enforce first AS for EBGP routes. |
| | **fast\_external\_failover** string | **Choices:*** enable
* disable
| Enable/disable reset peer BGP session if link goes down. |
| | **graceful\_end\_on\_timer** string | **Choices:*** enable
* disable
| Enable/disable to exit graceful restart on timer only. |
| | **graceful\_restart** string | **Choices:*** enable
* disable
| Enable/disable BGP graceful restart capabilities. |
| | **graceful\_restart\_time** integer | | Time needed for neighbors to restart (sec). |
| | **graceful\_stalepath\_time** integer | | Time to hold stale paths of restarting neighbor (sec). |
| | **graceful\_update\_delay** integer | | Route advertisement/selection delay after restart (sec). |
| | **holdtime\_timer** integer | | Number of seconds to mark peer as dead. |
| | **ibgp\_multipath** string | **Choices:*** enable
* disable
| Enable/disable IBGP multi-path. |
| | **ignore\_optional\_capability** string | **Choices:*** enable
* disable
| Don"t send unknown optional capability notification message |
| | **keepalive\_timer** integer | | Frequency to send keep alive requests. |
| | **log\_neighbour\_changes** string | **Choices:*** enable
* disable
| Enable logging of BGP neighbour"s changes |
| | **multipath\_recursive\_distance** string | **Choices:*** enable
* disable
| Enable/disable use of recursive distance to select multipath. |
| | **neighbor** list / elements=string | | BGP neighbor table. |
| | | **activate** string | **Choices:*** enable
* disable
| Enable/disable address family IPv4 for this neighbor. |
| | | **activate6** string | **Choices:*** enable
* disable
| Enable/disable address family IPv6 for this neighbor. |
| | | **additional\_path** string | **Choices:*** send
* receive
* both
* disable
| Enable/disable IPv4 additional-path capability. |
| | | **additional\_path6** string | **Choices:*** send
* receive
* both
* disable
| Enable/disable IPv6 additional-path capability. |
| | | **adv\_additional\_path** integer | | Number of IPv4 additional paths that can be advertised to this neighbor. |
| | | **adv\_additional\_path6** integer | | Number of IPv6 additional paths that can be advertised to this neighbor. |
| | | **advertisement\_interval** integer | | Minimum interval (sec) between sending updates. |
| | | **allowas\_in** integer | | IPv4 The maximum number of occurrence of my AS number allowed. |
| | | **allowas\_in6** integer | | IPv6 The maximum number of occurrence of my AS number allowed. |
| | | **allowas\_in\_enable** string | **Choices:*** enable
* disable
| Enable/disable IPv4 Enable to allow my AS in AS path. |
| | | **allowas\_in\_enable6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 Enable to allow my AS in AS path. |
| | | **as\_override** string | **Choices:*** enable
* disable
| Enable/disable replace peer AS with own AS for IPv4. |
| | | **as\_override6** string | **Choices:*** enable
* disable
| Enable/disable replace peer AS with own AS for IPv6. |
| | | **attribute\_unchanged** list / elements=string | **Choices:*** as-path
* med
* next-hop
| IPv4 List of attributes that should be unchanged. |
| | | **attribute\_unchanged6** list / elements=string | **Choices:*** as-path
* med
* next-hop
| IPv6 List of attributes that should be unchanged. |
| | | **bfd** string | **Choices:*** enable
* disable
| Enable/disable BFD for this neighbor. |
| | | **capability\_default\_originate** string | **Choices:*** enable
* disable
| Enable/disable advertise default IPv4 route to this neighbor. |
| | | **capability\_default\_originate6** string | **Choices:*** enable
* disable
| Enable/disable advertise default IPv6 route to this neighbor. |
| | | **capability\_dynamic** string | **Choices:*** enable
* disable
| Enable/disable advertise dynamic capability to this neighbor. |
| | | **capability\_graceful\_restart** string | **Choices:*** enable
* disable
| Enable/disable advertise IPv4 graceful restart capability to this neighbor. |
| | | **capability\_graceful\_restart6** string | **Choices:*** enable
* disable
| Enable/disable advertise IPv6 graceful restart capability to this neighbor. |
| | | **capability\_orf** string | **Choices:*** none
* receive
* send
* both
| Accept/Send IPv4 ORF lists to/from this neighbor. |
| | | **capability\_orf6** string | **Choices:*** none
* receive
* send
* both
| Accept/Send IPv6 ORF lists to/from this neighbor. |
| | | **capability\_route\_refresh** string | **Choices:*** enable
* disable
| Enable/disable advertise route refresh capability to this neighbor. |
| | | **conditional\_advertise** list / elements=string | | Conditional advertisement. |
| | | | **advertise\_routemap** string | | Name of advertising route map. Source router.route-map.name. |
| | | | **condition\_routemap** string | | Name of condition route map. Source router.route-map.name. |
| | | | **condition\_type** string | **Choices:*** exist
* non-exist
| Type of condition. |
| | | **connect\_timer** integer | | Interval (sec) for connect timer. |
| | | **default\_originate\_routemap** string | | Route map to specify criteria to originate IPv4 default. Source router.route-map.name. |
| | | **default\_originate\_routemap6** string | | Route map to specify criteria to originate IPv6 default. Source router.route-map.name. |
| | | **description** string | | Description. |
| | | **distribute\_list\_in** string | | Filter for IPv4 updates from this neighbor. Source router.access-list.name. |
| | | **distribute\_list\_in6** string | | Filter for IPv6 updates from this neighbor. Source router.access-list6.name. |
| | | **distribute\_list\_out** string | | Filter for IPv4 updates to this neighbor. Source router.access-list.name. |
| | | **distribute\_list\_out6** string | | Filter for IPv6 updates to this neighbor. Source router.access-list6.name. |
| | | **dont\_capability\_negotiate** string | **Choices:*** enable
* disable
| Don"t negotiate capabilities with this neighbor |
| | | **ebgp\_enforce\_multihop** string | **Choices:*** enable
* disable
| Enable/disable allow multi-hop EBGP neighbors. |
| | | **ebgp\_multihop\_ttl** integer | | EBGP multihop TTL for this peer. |
| | | **filter\_list\_in** string | | BGP filter for IPv4 inbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_in6** string | | BGP filter for IPv6 inbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_out** string | | BGP filter for IPv4 outbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_out6** string | | BGP filter for IPv6 outbound routes. Source router.aspath-list.name. |
| | | **holdtime\_timer** integer | | Interval (sec) before peer considered dead. |
| | | **interface** string | | Interface Source system.interface.name. |
| | | **ip** string / required | | IP/IPv6 address of neighbor. |
| | | **keep\_alive\_timer** integer | | Keep alive timer interval (sec). |
| | | **link\_down\_failover** string | **Choices:*** enable
* disable
| Enable/disable failover upon link down. |
| | | **local\_as** integer | | Local AS number of neighbor. |
| | | **local\_as\_no\_prepend** string | **Choices:*** enable
* disable
| Do not prepend local-as to incoming updates. |
| | | **local\_as\_replace\_as** string | **Choices:*** enable
* disable
| Replace real AS with local-as in outgoing updates. |
| | | **maximum\_prefix** integer | | Maximum number of IPv4 prefixes to accept from this peer. |
| | | **maximum\_prefix6** integer | | Maximum number of IPv6 prefixes to accept from this peer. |
| | | **maximum\_prefix\_threshold** integer | | Maximum IPv4 prefix threshold value (1 - 100 percent). |
| | | **maximum\_prefix\_threshold6** integer | | Maximum IPv6 prefix threshold value (1 - 100 percent). |
| | | **maximum\_prefix\_warning\_only** string | **Choices:*** enable
* disable
| Enable/disable IPv4 Only give warning message when limit is exceeded. |
| | | **maximum\_prefix\_warning\_only6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 Only give warning message when limit is exceeded. |
| | | **next\_hop\_self** string | **Choices:*** enable
* disable
| Enable/disable IPv4 next-hop calculation for this neighbor. |
| | | **next\_hop\_self6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 next-hop calculation for this neighbor. |
| | | **next\_hop\_self\_rr** string | **Choices:*** enable
* disable
| Enable/disable setting nexthop"s address to interface"s IPv4 address for route-reflector routes. |
| | | **next\_hop\_self\_rr6** string | **Choices:*** enable
* disable
| Enable/disable setting nexthop"s address to interface"s IPv6 address for route-reflector routes. |
| | | **override\_capability** string | **Choices:*** enable
* disable
| Enable/disable override result of capability negotiation. |
| | | **passive** string | **Choices:*** enable
* disable
| Enable/disable sending of open messages to this neighbor. |
| | | **password** string | | Password used in MD5 authentication. |
| | | **prefix\_list\_in** string | | IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. |
| | | **prefix\_list\_in6** string | | IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. |
| | | **prefix\_list\_out** string | | IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. |
| | | **prefix\_list\_out6** string | | IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. |
| | | **remote\_as** integer | | AS number of neighbor. |
| | | **remove\_private\_as** string | **Choices:*** enable
* disable
| Enable/disable remove private AS number from IPv4 outbound updates. |
| | | **remove\_private\_as6** string | **Choices:*** enable
* disable
| Enable/disable remove private AS number from IPv6 outbound updates. |
| | | **restart\_time** integer | | Graceful restart delay time (sec, 0 = global default). |
| | | **retain\_stale\_time** integer | | Time to retain stale routes. |
| | | **route\_map\_in** string | | IPv4 Inbound route map filter. Source router.route-map.name. |
| | | **route\_map\_in6** string | | IPv6 Inbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out** string | | IPv4 Outbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out6** string | | IPv6 Outbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out6\_preferable** string | | IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. |
| | | **route\_map\_out\_preferable** string | | IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. |
| | | **route\_reflector\_client** string | **Choices:*** enable
* disable
| Enable/disable IPv4 AS route reflector client. |
| | | **route\_reflector\_client6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 AS route reflector client. |
| | | **route\_server\_client** string | **Choices:*** enable
* disable
| Enable/disable IPv4 AS route server client. |
| | | **route\_server\_client6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 AS route server client. |
| | | **send\_community** string | **Choices:*** standard
* extended
* both
* disable
| IPv4 Send community attribute to neighbor. |
| | | **send\_community6** string | **Choices:*** standard
* extended
* both
* disable
| IPv6 Send community attribute to neighbor. |
| | | **shutdown** string | **Choices:*** enable
* disable
| Enable/disable shutdown this neighbor. |
| | | **soft\_reconfiguration** string | **Choices:*** enable
* disable
| Enable/disable allow IPv4 inbound soft reconfiguration. |
| | | **soft\_reconfiguration6** string | **Choices:*** enable
* disable
| Enable/disable allow IPv6 inbound soft reconfiguration. |
| | | **stale\_route** string | **Choices:*** enable
* disable
| Enable/disable stale route after neighbor down. |
| | | **strict\_capability\_match** string | **Choices:*** enable
* disable
| Enable/disable strict capability matching. |
| | | **unsuppress\_map** string | | IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. |
| | | **unsuppress\_map6** string | | IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. |
| | | **update\_source** string | | Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. |
| | | **weight** integer | | Neighbor weight. |
| | **neighbor\_group** list / elements=string | | BGP neighbor group table. |
| | | **activate** string | **Choices:*** enable
* disable
| Enable/disable address family IPv4 for this neighbor. |
| | | **activate6** string | **Choices:*** enable
* disable
| Enable/disable address family IPv6 for this neighbor. |
| | | **additional\_path** string | **Choices:*** send
* receive
* both
* disable
| Enable/disable IPv4 additional-path capability. |
| | | **additional\_path6** string | **Choices:*** send
* receive
* both
* disable
| Enable/disable IPv6 additional-path capability. |
| | | **adv\_additional\_path** integer | | Number of IPv4 additional paths that can be advertised to this neighbor. |
| | | **adv\_additional\_path6** integer | | Number of IPv6 additional paths that can be advertised to this neighbor. |
| | | **advertisement\_interval** integer | | Minimum interval (sec) between sending updates. |
| | | **allowas\_in** integer | | IPv4 The maximum number of occurrence of my AS number allowed. |
| | | **allowas\_in6** integer | | IPv6 The maximum number of occurrence of my AS number allowed. |
| | | **allowas\_in\_enable** string | **Choices:*** enable
* disable
| Enable/disable IPv4 Enable to allow my AS in AS path. |
| | | **allowas\_in\_enable6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 Enable to allow my AS in AS path. |
| | | **as\_override** string | **Choices:*** enable
* disable
| Enable/disable replace peer AS with own AS for IPv4. |
| | | **as\_override6** string | **Choices:*** enable
* disable
| Enable/disable replace peer AS with own AS for IPv6. |
| | | **attribute\_unchanged** string | **Choices:*** as-path
* med
* next-hop
| IPv4 List of attributes that should be unchanged. |
| | | **attribute\_unchanged6** string | **Choices:*** as-path
* med
* next-hop
| IPv6 List of attributes that should be unchanged. |
| | | **bfd** string | **Choices:*** enable
* disable
| Enable/disable BFD for this neighbor. |
| | | **capability\_default\_originate** string | **Choices:*** enable
* disable
| Enable/disable advertise default IPv4 route to this neighbor. |
| | | **capability\_default\_originate6** string | **Choices:*** enable
* disable
| Enable/disable advertise default IPv6 route to this neighbor. |
| | | **capability\_dynamic** string | **Choices:*** enable
* disable
| Enable/disable advertise dynamic capability to this neighbor. |
| | | **capability\_graceful\_restart** string | **Choices:*** enable
* disable
| Enable/disable advertise IPv4 graceful restart capability to this neighbor. |
| | | **capability\_graceful\_restart6** string | **Choices:*** enable
* disable
| Enable/disable advertise IPv6 graceful restart capability to this neighbor. |
| | | **capability\_orf** string | **Choices:*** none
* receive
* send
* both
| Accept/Send IPv4 ORF lists to/from this neighbor. |
| | | **capability\_orf6** string | **Choices:*** none
* receive
* send
* both
| Accept/Send IPv6 ORF lists to/from this neighbor. |
| | | **capability\_route\_refresh** string | **Choices:*** enable
* disable
| Enable/disable advertise route refresh capability to this neighbor. |
| | | **connect\_timer** integer | | Interval (sec) for connect timer. |
| | | **default\_originate\_routemap** string | | Route map to specify criteria to originate IPv4 default. Source router.route-map.name. |
| | | **default\_originate\_routemap6** string | | Route map to specify criteria to originate IPv6 default. Source router.route-map.name. |
| | | **description** string | | Description. |
| | | **distribute\_list\_in** string | | Filter for IPv4 updates from this neighbor. Source router.access-list.name. |
| | | **distribute\_list\_in6** string | | Filter for IPv6 updates from this neighbor. Source router.access-list6.name. |
| | | **distribute\_list\_out** string | | Filter for IPv4 updates to this neighbor. Source router.access-list.name. |
| | | **distribute\_list\_out6** string | | Filter for IPv6 updates to this neighbor. Source router.access-list6.name. |
| | | **dont\_capability\_negotiate** string | **Choices:*** enable
* disable
| Don"t negotiate capabilities with this neighbor |
| | | **ebgp\_enforce\_multihop** string | **Choices:*** enable
* disable
| Enable/disable allow multi-hop EBGP neighbors. |
| | | **ebgp\_multihop\_ttl** integer | | EBGP multihop TTL for this peer. |
| | | **filter\_list\_in** string | | BGP filter for IPv4 inbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_in6** string | | BGP filter for IPv6 inbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_out** string | | BGP filter for IPv4 outbound routes. Source router.aspath-list.name. |
| | | **filter\_list\_out6** string | | BGP filter for IPv6 outbound routes. Source router.aspath-list.name. |
| | | **holdtime\_timer** integer | | Interval (sec) before peer considered dead. |
| | | **interface** string | | Interface Source system.interface.name. |
| | | **keep\_alive\_timer** integer | | Keep alive timer interval (sec). |
| | | **link\_down\_failover** string | **Choices:*** enable
* disable
| Enable/disable failover upon link down. |
| | | **local\_as** integer | | Local AS number of neighbor. |
| | | **local\_as\_no\_prepend** string | **Choices:*** enable
* disable
| Do not prepend local-as to incoming updates. |
| | | **local\_as\_replace\_as** string | **Choices:*** enable
* disable
| Replace real AS with local-as in outgoing updates. |
| | | **maximum\_prefix** integer | | Maximum number of IPv4 prefixes to accept from this peer. |
| | | **maximum\_prefix6** integer | | Maximum number of IPv6 prefixes to accept from this peer. |
| | | **maximum\_prefix\_threshold** integer | | Maximum IPv4 prefix threshold value (1 - 100 percent). |
| | | **maximum\_prefix\_threshold6** integer | | Maximum IPv6 prefix threshold value (1 - 100 percent). |
| | | **maximum\_prefix\_warning\_only** string | **Choices:*** enable
* disable
| Enable/disable IPv4 Only give warning message when limit is exceeded. |
| | | **maximum\_prefix\_warning\_only6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 Only give warning message when limit is exceeded. |
| | | **name** string / required | | Neighbor group name. |
| | | **next\_hop\_self** string | **Choices:*** enable
* disable
| Enable/disable IPv4 next-hop calculation for this neighbor. |
| | | **next\_hop\_self6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 next-hop calculation for this neighbor. |
| | | **next\_hop\_self\_rr** string | **Choices:*** enable
* disable
| Enable/disable setting nexthop"s address to interface"s IPv4 address for route-reflector routes. |
| | | **next\_hop\_self\_rr6** string | **Choices:*** enable
* disable
| Enable/disable setting nexthop"s address to interface"s IPv6 address for route-reflector routes. |
| | | **override\_capability** string | **Choices:*** enable
* disable
| Enable/disable override result of capability negotiation. |
| | | **passive** string | **Choices:*** enable
* disable
| Enable/disable sending of open messages to this neighbor. |
| | | **prefix\_list\_in** string | | IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. |
| | | **prefix\_list\_in6** string | | IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. |
| | | **prefix\_list\_out** string | | IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. |
| | | **prefix\_list\_out6** string | | IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. |
| | | **remote\_as** integer | | AS number of neighbor. |
| | | **remove\_private\_as** string | **Choices:*** enable
* disable
| Enable/disable remove private AS number from IPv4 outbound updates. |
| | | **remove\_private\_as6** string | **Choices:*** enable
* disable
| Enable/disable remove private AS number from IPv6 outbound updates. |
| | | **restart\_time** integer | | Graceful restart delay time (sec, 0 = global default). |
| | | **retain\_stale\_time** integer | | Time to retain stale routes. |
| | | **route\_map\_in** string | | IPv4 Inbound route map filter. Source router.route-map.name. |
| | | **route\_map\_in6** string | | IPv6 Inbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out** string | | IPv4 Outbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out6** string | | IPv6 Outbound route map filter. Source router.route-map.name. |
| | | **route\_map\_out6\_preferable** string | | IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. |
| | | **route\_map\_out\_preferable** string | | IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. |
| | | **route\_reflector\_client** string | **Choices:*** enable
* disable
| Enable/disable IPv4 AS route reflector client. |
| | | **route\_reflector\_client6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 AS route reflector client. |
| | | **route\_server\_client** string | **Choices:*** enable
* disable
| Enable/disable IPv4 AS route server client. |
| | | **route\_server\_client6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 AS route server client. |
| | | **send\_community** string | **Choices:*** standard
* extended
* both
* disable
| IPv4 Send community attribute to neighbor. |
| | | **send\_community6** string | **Choices:*** standard
* extended
* both
* disable
| IPv6 Send community attribute to neighbor. |
| | | **shutdown** string | **Choices:*** enable
* disable
| Enable/disable shutdown this neighbor. |
| | | **soft\_reconfiguration** string | **Choices:*** enable
* disable
| Enable/disable allow IPv4 inbound soft reconfiguration. |
| | | **soft\_reconfiguration6** string | **Choices:*** enable
* disable
| Enable/disable allow IPv6 inbound soft reconfiguration. |
| | | **stale\_route** string | **Choices:*** enable
* disable
| Enable/disable stale route after neighbor down. |
| | | **strict\_capability\_match** string | **Choices:*** enable
* disable
| Enable/disable strict capability matching. |
| | | **unsuppress\_map** string | | IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. |
| | | **unsuppress\_map6** string | | IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. |
| | | **update\_source** string | | Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. |
| | | **weight** integer | | Neighbor weight. |
| | **neighbor\_range** list / elements=string | | BGP neighbor range table. |
| | | **id** integer / required | | Neighbor range ID. |
| | | **max\_neighbor\_num** integer | | Maximum number of neighbors. |
| | | **neighbor\_group** string | | Neighbor group name. Source router.bgp.neighbor-group.name. |
| | | **prefix** string | | Neighbor range prefix. |
| | **neighbor\_range6** list / elements=string | | BGP IPv6 neighbor range table. |
| | | **id** integer / required | | IPv6 neighbor range ID. |
| | | **max\_neighbor\_num** integer | | Maximum number of neighbors. |
| | | **neighbor\_group** string | | Neighbor group name. Source router.bgp.neighbor-group.name. |
| | | **prefix6** string | | IPv6 prefix. |
| | **network** list / elements=string | | BGP network table. |
| | | **backdoor** string | **Choices:*** enable
* disable
| Enable/disable route as backdoor. |
| | | **id** integer / required | | ID. |
| | | **prefix** string | | Network prefix. |
| | | **route\_map** string | | Route map to modify generated route. Source router.route-map.name. |
| | **network6** list / elements=string | | BGP IPv6 network table. |
| | | **backdoor** string | **Choices:*** enable
* disable
| Enable/disable route as backdoor. |
| | | **id** integer / required | | ID. |
| | | **prefix6** string | | Network IPv6 prefix. |
| | | **route\_map** string | | Route map to modify generated route. Source router.route-map.name. |
| | **network\_import\_check** string | **Choices:*** enable
* disable
| Enable/disable ensure BGP network route exists in IGP. |
| | **recursive\_next\_hop** string | **Choices:*** enable
* disable
| Enable/disable recursive resolution of next-hop using BGP route. |
| | **redistribute** list / elements=string | | BGP IPv4 redistribute table. |
| | | **name** string / required | | Distribute list entry name. |
| | | **route\_map** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| Status |
| | **redistribute6** list / elements=string | | BGP IPv6 redistribute table. |
| | | **name** string / required | | Distribute list entry name. |
| | | **route\_map** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| Status |
| | **router\_id** string | | Router ID. |
| | **scan\_time** integer | | Background scanner interval (sec), 0 to disable it. |
| | **synchronization** string | **Choices:*** enable
* disable
| Enable/disable only advertise routes from iBGP if routes present in an IGP. |
| | **vrf\_leak** list / elements=string | | BGP VRF leaking table. |
| | | **target** list / elements=string | | Target VRF table. |
| | | | **interface** string | | Interface which is used to leak routes to target VRF. Source system.interface.name. |
| | | | **route\_map** string | | Route map of VRF leaking. Source router.route-map.name. |
| | | | **vrf** string / required | | Target VRF ID <0 - 31>. |
| | | **vrf** string / required | | Origin VRF ID <0 - 31>. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure BGP.
fortios_router_bgp:
vdom: "{{ vdom }}"
router_bgp:
additional_path: "enable"
additional_path_select: "4"
additional_path_select6: "5"
additional_path6: "enable"
admin_distance:
-
distance: "8"
id: "9"
neighbour_prefix: "<your_own_value>"
route_list: "<your_own_value> (source router.access-list.name)"
aggregate_address:
-
as_set: "enable"
id: "14"
prefix: "<your_own_value>"
summary_only: "enable"
aggregate_address6:
-
as_set: "enable"
id: "19"
prefix6: "<your_own_value>"
summary_only: "enable"
always_compare_med: "enable"
as: "23"
bestpath_as_path_ignore: "enable"
bestpath_cmp_confed_aspath: "enable"
bestpath_cmp_routerid: "enable"
bestpath_med_confed: "enable"
bestpath_med_missing_as_worst: "enable"
client_to_client_reflection: "enable"
cluster_id: "<your_own_value>"
confederation_identifier: "31"
confederation_peers:
-
peer: "<your_own_value>"
dampening: "enable"
dampening_max_suppress_time: "35"
dampening_reachability_half_life: "36"
dampening_reuse: "37"
dampening_route_map: "<your_own_value> (source router.route-map.name)"
dampening_suppress: "39"
dampening_unreachability_half_life: "40"
default_local_preference: "41"
deterministic_med: "enable"
distance_external: "43"
distance_internal: "44"
distance_local: "45"
ebgp_multipath: "enable"
enforce_first_as: "enable"
fast_external_failover: "enable"
graceful_end_on_timer: "enable"
graceful_restart: "enable"
graceful_restart_time: "51"
graceful_stalepath_time: "52"
graceful_update_delay: "53"
holdtime_timer: "54"
ibgp_multipath: "enable"
ignore_optional_capability: "enable"
keepalive_timer: "57"
log_neighbour_changes: "enable"
multipath_recursive_distance: "enable"
neighbor:
-
activate: "enable"
activate6: "enable"
additional_path: "send"
additional_path6: "send"
adv_additional_path: "65"
adv_additional_path6: "66"
advertisement_interval: "67"
allowas_in: "68"
allowas_in_enable: "enable"
allowas_in_enable6: "enable"
allowas_in6: "71"
as_override: "enable"
as_override6: "enable"
attribute_unchanged: "as-path"
attribute_unchanged6: "as-path"
bfd: "enable"
capability_default_originate: "enable"
capability_default_originate6: "enable"
capability_dynamic: "enable"
capability_graceful_restart: "enable"
capability_graceful_restart6: "enable"
capability_orf: "none"
capability_orf6: "none"
capability_route_refresh: "enable"
conditional_advertise:
-
advertise_routemap: "<your_own_value> (source router.route-map.name)"
condition_routemap: "<your_own_value> (source router.route-map.name)"
condition_type: "exist"
connect_timer: "89"
default_originate_routemap: "<your_own_value> (source router.route-map.name)"
default_originate_routemap6: "<your_own_value> (source router.route-map.name)"
description: "<your_own_value>"
distribute_list_in: "<your_own_value> (source router.access-list.name)"
distribute_list_in6: "<your_own_value> (source router.access-list6.name)"
distribute_list_out: "<your_own_value> (source router.access-list.name)"
distribute_list_out6: "<your_own_value> (source router.access-list6.name)"
dont_capability_negotiate: "enable"
ebgp_enforce_multihop: "enable"
ebgp_multihop_ttl: "99"
filter_list_in: "<your_own_value> (source router.aspath-list.name)"
filter_list_in6: "<your_own_value> (source router.aspath-list.name)"
filter_list_out: "<your_own_value> (source router.aspath-list.name)"
filter_list_out6: "<your_own_value> (source router.aspath-list.name)"
holdtime_timer: "104"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
keep_alive_timer: "107"
link_down_failover: "enable"
local_as: "109"
local_as_no_prepend: "enable"
local_as_replace_as: "enable"
maximum_prefix: "112"
maximum_prefix_threshold: "113"
maximum_prefix_threshold6: "114"
maximum_prefix_warning_only: "enable"
maximum_prefix_warning_only6: "enable"
maximum_prefix6: "117"
next_hop_self: "enable"
next_hop_self_rr: "enable"
next_hop_self_rr6: "enable"
next_hop_self6: "enable"
override_capability: "enable"
passive: "enable"
password: "<your_own_value>"
prefix_list_in: "<your_own_value> (source router.prefix-list.name)"
prefix_list_in6: "<your_own_value> (source router.prefix-list6.name)"
prefix_list_out: "<your_own_value> (source router.prefix-list.name)"
prefix_list_out6: "<your_own_value> (source router.prefix-list6.name)"
remote_as: "129"
remove_private_as: "enable"
remove_private_as6: "enable"
restart_time: "132"
retain_stale_time: "133"
route_map_in: "<your_own_value> (source router.route-map.name)"
route_map_in6: "<your_own_value> (source router.route-map.name)"
route_map_out: "<your_own_value> (source router.route-map.name)"
route_map_out_preferable: "<your_own_value> (source router.route-map.name)"
route_map_out6: "<your_own_value> (source router.route-map.name)"
route_map_out6_preferable: "<your_own_value> (source router.route-map.name)"
route_reflector_client: "enable"
route_reflector_client6: "enable"
route_server_client: "enable"
route_server_client6: "enable"
send_community: "standard"
send_community6: "standard"
shutdown: "enable"
soft_reconfiguration: "enable"
soft_reconfiguration6: "enable"
stale_route: "enable"
strict_capability_match: "enable"
unsuppress_map: "<your_own_value> (source router.route-map.name)"
unsuppress_map6: "<your_own_value> (source router.route-map.name)"
update_source: "<your_own_value> (source system.interface.name)"
weight: "154"
neighbor_group:
-
activate: "enable"
activate6: "enable"
additional_path: "send"
additional_path6: "send"
adv_additional_path: "160"
adv_additional_path6: "161"
advertisement_interval: "162"
allowas_in: "163"
allowas_in_enable: "enable"
allowas_in_enable6: "enable"
allowas_in6: "166"
as_override: "enable"
as_override6: "enable"
attribute_unchanged: "as-path"
attribute_unchanged6: "as-path"
bfd: "enable"
capability_default_originate: "enable"
capability_default_originate6: "enable"
capability_dynamic: "enable"
capability_graceful_restart: "enable"
capability_graceful_restart6: "enable"
capability_orf: "none"
capability_orf6: "none"
capability_route_refresh: "enable"
connect_timer: "180"
default_originate_routemap: "<your_own_value> (source router.route-map.name)"
default_originate_routemap6: "<your_own_value> (source router.route-map.name)"
description: "<your_own_value>"
distribute_list_in: "<your_own_value> (source router.access-list.name)"
distribute_list_in6: "<your_own_value> (source router.access-list6.name)"
distribute_list_out: "<your_own_value> (source router.access-list.name)"
distribute_list_out6: "<your_own_value> (source router.access-list6.name)"
dont_capability_negotiate: "enable"
ebgp_enforce_multihop: "enable"
ebgp_multihop_ttl: "190"
filter_list_in: "<your_own_value> (source router.aspath-list.name)"
filter_list_in6: "<your_own_value> (source router.aspath-list.name)"
filter_list_out: "<your_own_value> (source router.aspath-list.name)"
filter_list_out6: "<your_own_value> (source router.aspath-list.name)"
holdtime_timer: "195"
interface: "<your_own_value> (source system.interface.name)"
keep_alive_timer: "197"
link_down_failover: "enable"
local_as: "199"
local_as_no_prepend: "enable"
local_as_replace_as: "enable"
maximum_prefix: "202"
maximum_prefix_threshold: "203"
maximum_prefix_threshold6: "204"
maximum_prefix_warning_only: "enable"
maximum_prefix_warning_only6: "enable"
maximum_prefix6: "207"
name: "default_name_208"
next_hop_self: "enable"
next_hop_self_rr: "enable"
next_hop_self_rr6: "enable"
next_hop_self6: "enable"
override_capability: "enable"
passive: "enable"
prefix_list_in: "<your_own_value> (source router.prefix-list.name)"
prefix_list_in6: "<your_own_value> (source router.prefix-list6.name)"
prefix_list_out: "<your_own_value> (source router.prefix-list.name)"
prefix_list_out6: "<your_own_value> (source router.prefix-list6.name)"
remote_as: "219"
remove_private_as: "enable"
remove_private_as6: "enable"
restart_time: "222"
retain_stale_time: "223"
route_map_in: "<your_own_value> (source router.route-map.name)"
route_map_in6: "<your_own_value> (source router.route-map.name)"
route_map_out: "<your_own_value> (source router.route-map.name)"
route_map_out_preferable: "<your_own_value> (source router.route-map.name)"
route_map_out6: "<your_own_value> (source router.route-map.name)"
route_map_out6_preferable: "<your_own_value> (source router.route-map.name)"
route_reflector_client: "enable"
route_reflector_client6: "enable"
route_server_client: "enable"
route_server_client6: "enable"
send_community: "standard"
send_community6: "standard"
shutdown: "enable"
soft_reconfiguration: "enable"
soft_reconfiguration6: "enable"
stale_route: "enable"
strict_capability_match: "enable"
unsuppress_map: "<your_own_value> (source router.route-map.name)"
unsuppress_map6: "<your_own_value> (source router.route-map.name)"
update_source: "<your_own_value> (source system.interface.name)"
weight: "244"
neighbor_range:
-
id: "246"
max_neighbor_num: "247"
neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
prefix: "<your_own_value>"
neighbor_range6:
-
id: "251"
max_neighbor_num: "252"
neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
prefix6: "<your_own_value>"
network:
-
backdoor: "enable"
id: "257"
prefix: "<your_own_value>"
route_map: "<your_own_value> (source router.route-map.name)"
network_import_check: "enable"
network6:
-
backdoor: "enable"
id: "263"
prefix6: "<your_own_value>"
route_map: "<your_own_value> (source router.route-map.name)"
recursive_next_hop: "enable"
redistribute:
-
name: "default_name_268"
route_map: "<your_own_value> (source router.route-map.name)"
status: "enable"
redistribute6:
-
name: "default_name_272"
route_map: "<your_own_value> (source router.route-map.name)"
status: "enable"
router_id: "<your_own_value>"
scan_time: "276"
synchronization: "enable"
vrf_leak:
-
target:
-
interface: "<your_own_value> (source system.interface.name)"
route_map: "<your_own_value> (source router.route-map.name)"
vrf: "<your_own_value>"
vrf: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_router_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_multicast`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_multicast** dictionary | | Configure router multicast. |
| | **interface** list / elements=string | | PIM interfaces. |
| | | **bfd** string | **Choices:*** enable
* disable
| Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD). |
| | | **cisco\_exclude\_genid** string | **Choices:*** enable
* disable
| Exclude GenID from hello packets (compatibility with old Cisco IOS). |
| | | **dr\_priority** integer | | DR election priority. |
| | | **hello\_holdtime** integer | | Time before old neighbor information expires (0 - 65535 sec). |
| | | **hello\_interval** integer | | Interval between sending PIM hello messages (0 - 65535 sec). |
| | | **igmp** dictionary | | IGMP configuration options. |
| | | | **access\_group** string | | Groups IGMP hosts are allowed to join. Source router.access-list.name. |
| | | | **immediate\_leave\_group** string | | Groups to drop membership for immediately after receiving IGMPv2 leave. Source router.access-list.name. |
| | | | **last\_member\_query\_count** integer | | Number of group specific queries before removing group (2 - 7). |
| | | | **last\_member\_query\_interval** integer | | Timeout between IGMPv2 leave and removing group (1 - 65535 msec). |
| | | | **query\_interval** integer | | Interval between queries to IGMP hosts (1 - 65535 sec). |
| | | | **query\_max\_response\_time** integer | | Maximum time to wait for a IGMP query response (1 - 25 sec). |
| | | | **query\_timeout** integer | | Timeout between queries before becoming querier for network (60 - 900). |
| | | | **router\_alert\_check** string | **Choices:*** enable
* disable
| Enable/disable require IGMP packets contain router alert option. |
| | | | **version** string | **Choices:*** 3
* 2
* 1
| Maximum version of IGMP to support. |
| | | **join\_group** list / elements=string | | Join multicast groups. |
| | | | **address** string / required | | Multicast group IP address. |
| | | **multicast\_flow** string | | Acceptable source for multicast group. Source router.multicast-flow.name. |
| | | **name** string / required | | Interface name. Source system.interface.name. |
| | | **neighbour\_filter** string | | Routers acknowledged as neighbor routers. Source router.access-list.name. |
| | | **passive** string | **Choices:*** enable
* disable
| Enable/disable listening to IGMP but not participating in PIM. |
| | | **pim\_mode** string | **Choices:*** sparse-mode
* dense-mode
| PIM operation mode. |
| | | **propagation\_delay** integer | | Delay flooding packets on this interface (100 - 5000 msec). |
| | | **rp\_candidate** string | **Choices:*** enable
* disable
| Enable/disable compete to become RP in elections. |
| | | **rp\_candidate\_group** string | | Multicast groups managed by this RP. Source router.access-list.name. |
| | | **rp\_candidate\_interval** integer | | RP candidate advertisement interval (1 - 16383 sec). |
| | | **rp\_candidate\_priority** integer | | Router"s priority as RP. |
| | | **rpf\_nbr\_fail\_back** string | **Choices:*** enable
* disable
| Enable/disable fail back for RPF neighbor query. |
| | | **rpf\_nbr\_fail\_back\_filter** string | | Filter for fail back RPF neighbors. Source router.access-list.name. |
| | | **state\_refresh\_interval** integer | | Interval between sending state-refresh packets (1 - 100 sec). |
| | | **static\_group** string | | Statically set multicast groups to forward out. Source router.multicast-flow.name. |
| | | **ttl\_threshold** integer | | Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255). |
| | **multicast\_routing** string | **Choices:*** enable
* disable
| Enable/disable IP multicast routing. |
| | **pim\_sm\_global** dictionary | | PIM sparse-mode global settings. |
| | | **accept\_register\_list** string | | Sources allowed to register packets with this Rendezvous Point (RP). Source router.access-list.name. |
| | | **accept\_source\_list** string | | Sources allowed to send multicast traffic. Source router.access-list.name. |
| | | **bsr\_allow\_quick\_refresh** string | **Choices:*** enable
* disable
| Enable/disable accept BSR quick refresh packets from neighbors. |
| | | **bsr\_candidate** string | **Choices:*** enable
* disable
| Enable/disable allowing this router to become a bootstrap router (BSR). |
| | | **bsr\_hash** integer | | BSR hash length (0 - 32). |
| | | **bsr\_interface** string | | Interface to advertise as candidate BSR. Source system.interface.name. |
| | | **bsr\_priority** integer | | BSR priority (0 - 255). |
| | | **cisco\_crp\_prefix** string | **Choices:*** enable
* disable
| Enable/disable making candidate RP compatible with old Cisco IOS. |
| | | **cisco\_ignore\_rp\_set\_priority** string | **Choices:*** enable
* disable
| Use only hash for RP selection (compatibility with old Cisco IOS). |
| | | **cisco\_register\_checksum** string | **Choices:*** enable
* disable
| Checksum entire register packet(for old Cisco IOS compatibility). |
| | | **cisco\_register\_checksum\_group** string | | Cisco register checksum only these groups. Source router.access-list.name. |
| | | **join\_prune\_holdtime** integer | | Join/prune holdtime (1 - 65535). |
| | | **message\_interval** integer | | Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535). |
| | | **null\_register\_retries** integer | | Maximum retries of null register (1 - 20). |
| | | **register\_rate\_limit** integer | | Limit of packets/sec per source registered through this RP (0 - 65535). |
| | | **register\_rp\_reachability** string | **Choices:*** enable
* disable
| Enable/disable check RP is reachable before registering packets. |
| | | **register\_source** string | **Choices:*** disable
* interface
* ip-address
| Override source address in register packets. |
| | | **register\_source\_interface** string | | Override with primary interface address. Source system.interface.name. |
| | | **register\_source\_ip** string | | Override with local IP address. |
| | | **register\_supression** integer | | Period of time to honor register-stop message (1 - 65535 sec). |
| | | **rp\_address** list / elements=string | | Statically configure RP addresses. |
| | | | **group** string | | Groups to use this RP. Source router.access-list.name. |
| | | | **id** integer / required | | ID. |
| | | | **ip\_address** string | | RP router address. |
| | | **rp\_register\_keepalive** integer | | Timeout for RP receiving data on (S,G) tree (1 - 65535 sec). |
| | | **spt\_threshold** string | **Choices:*** enable
* disable
| Enable/disable switching to source specific trees. |
| | | **spt\_threshold\_group** string | | Groups allowed to switch to source tree. Source router.access-list.name. |
| | | **ssm** string | **Choices:*** enable
* disable
| Enable/disable source specific multicast. |
| | | **ssm\_range** string | | Groups allowed to source specific multicast. Source router.access-list.name. |
| | **route\_limit** integer | | Maximum number of multicast routes. |
| | **route\_threshold** integer | | Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure router multicast.
fortios_router_multicast:
vdom: "{{ vdom }}"
router_multicast:
interface:
-
bfd: "enable"
cisco_exclude_genid: "enable"
dr_priority: "6"
hello_holdtime: "7"
hello_interval: "8"
igmp:
access_group: "<your_own_value> (source router.access-list.name)"
immediate_leave_group: "<your_own_value> (source router.access-list.name)"
last_member_query_count: "12"
last_member_query_interval: "13"
query_interval: "14"
query_max_response_time: "15"
query_timeout: "16"
router_alert_check: "enable"
version: "3"
join_group:
-
address: "<your_own_value>"
multicast_flow: "<your_own_value> (source router.multicast-flow.name)"
name: "default_name_22 (source system.interface.name)"
neighbour_filter: "<your_own_value> (source router.access-list.name)"
passive: "enable"
pim_mode: "sparse-mode"
propagation_delay: "26"
rp_candidate: "enable"
rp_candidate_group: "<your_own_value> (source router.access-list.name)"
rp_candidate_interval: "29"
rp_candidate_priority: "30"
rpf_nbr_fail_back: "enable"
rpf_nbr_fail_back_filter: "<your_own_value> (source router.access-list.name)"
state_refresh_interval: "33"
static_group: "<your_own_value> (source router.multicast-flow.name)"
ttl_threshold: "35"
multicast_routing: "enable"
pim_sm_global:
accept_register_list: "<your_own_value> (source router.access-list.name)"
accept_source_list: "<your_own_value> (source router.access-list.name)"
bsr_allow_quick_refresh: "enable"
bsr_candidate: "enable"
bsr_hash: "42"
bsr_interface: "<your_own_value> (source system.interface.name)"
bsr_priority: "44"
cisco_crp_prefix: "enable"
cisco_ignore_rp_set_priority: "enable"
cisco_register_checksum: "enable"
cisco_register_checksum_group: "<your_own_value> (source router.access-list.name)"
join_prune_holdtime: "49"
message_interval: "50"
null_register_retries: "51"
register_rate_limit: "52"
register_rp_reachability: "enable"
register_source: "disable"
register_source_interface: "<your_own_value> (source system.interface.name)"
register_source_ip: "<your_own_value>"
register_supression: "57"
rp_address:
-
group: "<your_own_value> (source router.access-list.name)"
id: "60"
ip_address: "<your_own_value>"
rp_register_keepalive: "62"
spt_threshold: "enable"
spt_threshold_group: "<your_own_value> (source router.access-list.name)"
ssm: "enable"
ssm_range: "<your_own_value> (source router.access-list.name)"
route_limit: "67"
route_threshold: "68"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer2_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer2\_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer2_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer2 feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer2\_filter** dictionary | | Filters for FortiAnalyzer. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | FortiAnalyzer 2 log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Log every message above and including this severity level. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for FortiAnalyzer.
fortios_log_fortianalyzer2_filter:
vdom: "{{ vdom }}"
log_fortianalyzer2_filter:
anomaly: "enable"
dlp_archive: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "13"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_disk_setting – Settings for local disk logging in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_disk\_setting – Settings for local disk logging in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_disk_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_disk feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_disk\_setting** dictionary | | Settings for local disk logging. |
| | **diskfull** string | **Choices:*** overwrite
* nolog
| Action to take when disk is full. The system can overwrite the oldest log messages or stop logging when the disk is full . |
| | **dlp\_archive\_quota** integer | | DLP archive quota (MB). |
| | **full\_final\_warning\_threshold** integer | | Log full final warning threshold as a percent (3 - 100). |
| | **full\_first\_warning\_threshold** integer | | Log full first warning threshold as a percent (1 - 98). |
| | **full\_second\_warning\_threshold** integer | | Log full second warning threshold as a percent (2 - 99). |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ips\_archive** string | **Choices:*** enable
* disable
| Enable/disable IPS packet archiving to the local disk. |
| | **log\_quota** integer | | Disk log quota (MB). |
| | **max\_log\_file\_size** integer | | Maximum log file size before rolling (1 - 100 Mbytes). |
| | **max\_policy\_packet\_capture\_size** integer | | Maximum size of policy sniffer in MB (0 means unlimited). |
| | **maximum\_log\_age** integer | | Delete log files older than (days). |
| | **report\_quota** integer | | Report quota (MB). |
| | **roll\_day** list / elements=string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Day of week on which to roll log file. |
| | **roll\_schedule** string | **Choices:*** daily
* weekly
| Frequency to check log file for rolling. |
| | **roll\_time** string | | Time of day to roll the log file (hh:mm). |
| | **source\_ip** string | | Source IP address to use for uploading disk log files. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable local disk logging. |
| | **upload** string | **Choices:*** enable
* disable
| Enable/disable uploading log files when they are rolled. |
| | **upload\_delete\_files** string | **Choices:*** enable
* disable
| Delete log files after uploading . |
| | **upload\_destination** string | **Choices:*** ftp-server
| The type of server to upload log files to. Only FTP is currently supported. |
| | **upload\_ssl\_conn** string | **Choices:*** default
* high
* low
* disable
| Enable/disable encrypted FTPS communication to upload log files. |
| | **uploaddir** string | | The remote directory on the FTP server to upload log files to. |
| | **uploadip** string | | IP address of the FTP server to upload log files to. |
| | **uploadpass** string | | Password required to log into the FTP server to upload disk log files. |
| | **uploadport** integer | | TCP port to use for communicating with the FTP server . |
| | **uploadsched** string | **Choices:*** disable
* enable
| Set the schedule for uploading log files to the FTP server . |
| | **uploadtime** string | | Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh). |
| | **uploadtype** list / elements=string | **Choices:*** traffic
* event
* virus
* webfilter
* IPS
* spamfilter
* dlp-archive
* anomaly
* voip
* dlp
* app-ctrl
* waf
* netscan
* gtp
* dns
* emailfilter
* ssh
* ssl
* cifs
* file-filter
* icap
| Types of log files to upload. Separate multiple entries with a space. |
| | **uploaduser** string | | Username required to log into the FTP server to upload disk log files. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Settings for local disk logging.
fortios_log_disk_setting:
vdom: "{{ vdom }}"
log_disk_setting:
diskfull: "overwrite"
dlp_archive_quota: "4"
full_final_warning_threshold: "5"
full_first_warning_threshold: "6"
full_second_warning_threshold: "7"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
log_quota: "11"
max_log_file_size: "12"
max_policy_packet_capture_size: "13"
maximum_log_age: "14"
report_quota: "15"
roll_day: "sunday"
roll_schedule: "daily"
roll_time: "<your_own_value>"
source_ip: "84.230.14.43"
status: "enable"
upload: "enable"
upload_delete_files: "enable"
upload_destination: "ftp-server"
upload_ssl_conn: "default"
uploaddir: "<your_own_value>"
uploadip: "<your_own_value>"
uploadpass: "<your_own_value>"
uploadport: "28"
uploadsched: "disable"
uploadtime: "<your_own_value>"
uploadtype: "traffic"
uploaduser: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_fortiguard_wf – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_fortiguard\_wf – Replacement messages in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_fortiguard_wf`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and fortiguard\_wf 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_fortiguard\_wf** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_fortiguard_wf:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_fortiguard_wf:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_shaping_profile – Configure shaping profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_shaping\_profile – Configure shaping profiles in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_shaping_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_shaping\_profile** dictionary | | Configure shaping profiles. |
| | **comment** string | | Comment. |
| | **default\_class\_id** integer | | Default class ID to handle unclassified packets (including all local traffic). Source firewall.traffic-class.class-id. |
| | **profile\_name** string | | Shaping profile name. |
| | **shaping\_entries** list / elements=string | | Define shaping entries of this shaping profile. |
| | | **burst\_in\_msec** integer | | Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth\*burst-in-msec. |
| | | **cburst\_in\_msec** integer | | Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth\*cburst-in-msec. |
| | | **class\_id** integer | | Class ID. Source firewall.traffic-class.class-id. |
| | | **guaranteed\_bandwidth\_percentage** integer | | Guaranteed bandwith in percentage. |
| | | **id** integer / required | | ID number. |
| | | **limit** integer | | Hard limit on the real queue size in packets. |
| | | **max** integer | | Average queue size in packets at which RED drop probability is maximal. |
| | | **maximum\_bandwidth\_percentage** integer | | Maximum bandwith in percentage. |
| | | **min** integer | | Average queue size in packets at which RED drop becomes a possibility. |
| | | **priority** string | **Choices:*** high
* medium
* low
* top
* critical
| Priority. |
| | | **red\_probability** integer | | Maximum probability (in percentage) for RED marking. |
| | **type** string | **Choices:*** policing
* queuing
| Select shaping profile type: policing / queuing. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure shaping profiles.
fortios_firewall_shaping_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaping_profile:
comment: "Comment."
default_class_id: "4 (source firewall.traffic-class.class-id)"
profile_name: "<your_own_value>"
shaping_entries:
-
burst_in_msec: "7"
cburst_in_msec: "8"
class_id: "9 (source firewall.traffic-class.class-id)"
guaranteed_bandwidth_percentage: "10"
id: "11"
limit: "12"
max: "13"
maximum_bandwidth_percentage: "14"
min: "15"
priority: "high"
red_probability: "17"
type: "policing"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ipsec_forticlient – Configure FortiClient policy realm in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_forticlient – Configure FortiClient policy realm in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ipsec_forticlient`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ipsec feature and forticlient 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ipsec\_forticlient** dictionary | | Configure FortiClient policy realm. |
| | **phase2name** string | | Phase 2 tunnel name that you defined in the FortiClient dialup configuration. Source vpn.ipsec.phase2.name vpn.ipsec.phase2-interface .name. |
| | **realm** string / required | | FortiClient realm name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this FortiClient configuration. |
| | **usergroupname** string | | User group name for FortiClient users. Source user.group.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiClient policy realm.
fortios_vpn_ipsec_forticlient:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_forticlient:
phase2name: "<your_own_value> (source vpn.ipsec.phase2.name vpn.ipsec.phase2-interface.name)"
realm: "<your_own_value>"
status: "enable"
usergroupname: "<your_own_value> (source user.group.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_extender_lte_carrier_by_mcc_mnc – Display extender modem carrier based on MCC and MNC in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_lte\_carrier\_by\_mcc\_mnc – Display extender modem carrier based on MCC and MNC in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_extender_lte_carrier_by_mcc_mnc`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender feature and lte\_carrier\_by\_mcc\_mnc 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **extender\_lte\_carrier\_by\_mcc\_mnc** dictionary | | Display extender modem carrier based on MCC and MNC. |
| | string | | extender serial number. Source extender-controller.extender.id. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Display extender modem carrier based on MCC and MNC.
fortios_extender_lte_carrier_by_mcc_mnc:
vdom: "{{ vdom }}"
extender_lte_carrier_by_mcc_mnc:
<sn>: "<your_own_value> (source extender-controller.extender.id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_ble_profile – Configure Bluetooth Low Energy profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_ble\_profile – Configure Bluetooth Low Energy profile in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_ble_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and ble\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_ble\_profile** dictionary | | Configure Bluetooth Low Energy profile. |
| | **advertising** list / elements=string | **Choices:*** ibeacon
* eddystone-uid
* eddystone-url
| Advertising type. |
| | **beacon\_interval** integer | | Beacon interval . |
| | **ble\_scanning** string | **Choices:*** enable
* disable
| Enable/disable Bluetooth Low Energy (BLE) scanning. |
| | **comment** string | | Comment. |
| | **eddystone\_instance** string | | Eddystone instance ID. |
| | **eddystone\_namespace** string | | Eddystone namespace ID. |
| | **eddystone\_url** string | | Eddystone URL. |
| | **eddystone\_url\_encode\_hex** string | | Eddystone encoded URL hexadecimal string |
| | **ibeacon\_uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **major\_id** integer | | Major ID. |
| | **minor\_id** integer | | Minor ID. |
| | **name** string / required | | Bluetooth Low Energy profile name. |
| | **txpower** string | **Choices:*** 0
* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10
* 11
* 12
| Transmit power level . |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Bluetooth Low Energy profile.
fortios_wireless_controller_ble_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_ble_profile:
advertising: "ibeacon"
beacon_interval: "4"
ble_scanning: "enable"
comment: "Comment."
eddystone_instance: "<your_own_value>"
eddystone_namespace: "<your_own_value>"
eddystone_url: "<your_own_value>"
eddystone_url_encode_hex: "<your_own_value>"
ibeacon_uuid: "<your_own_value>"
major_id: "12"
minor_id: "13"
name: "default_name_14"
txpower: "0"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_mac_address_table – Configure MAC address tables in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_mac\_address\_table – Configure MAC address tables in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_mac_address_table`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and mac\_address\_table 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_mac\_address\_table** dictionary | | Configure MAC address tables. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **mac** string / required | | MAC address. |
| | **reply\_substitute** string | | New MAC for reply traffic. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure MAC address tables.
fortios_system_mac_address_table:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_mac_address_table:
interface: "<your_own_value> (source system.interface.name)"
mac: "<your_own_value>"
reply_substitute: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_admin – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_admin – Replacement messages in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_admin`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and admin 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_admin** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_admin:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_admin:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_saml – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_saml – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_saml`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and saml 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_saml** dictionary | | Global settings for SAML authentication. |
| | **artifact\_resolution\_url** string | | SP artifact resolution URL. |
| | **binding\_protocol** string | **Choices:*** post
* redirect
| Binding protocol. |
| | **cert** string | | Certificate to sign SAML messages. Source certificate.local.name. |
| | **default\_login\_page** string | **Choices:*** normal
* sso
| Choose default login page. |
| | **default\_profile** string | | Default profile for new SSO admin. Source system.accprofile.name. |
| | **entity\_id** string | | SP entity ID. |
| | **idp\_artifact\_resolution\_url** string | | IDP artifact resolution URL. |
| | **idp\_cert** string | | IDP certificate name. Source certificate.remote.name. |
| | **idp\_entity\_id** string | | IDP entity ID. |
| | **idp\_single\_logout\_url** string | | IDP single logout URL. |
| | **idp\_single\_sign\_on\_url** string | | IDP single sign-on URL. |
| | **life** integer | | Length of the range of time when the assertion is valid (in minutes). |
| | **portal\_url** string | | SP portal URL. |
| | **role** string | **Choices:*** identity-provider
* service-provider
| SAML role. |
| | **server\_address** string | | Server address. |
| | **service\_providers** list / elements=string | | Authorized service providers. |
| | | **assertion\_attributes** list / elements=string | | Customized SAML attributes to send along with assertion. |
| | | | **name** string / required | | Name. |
| | | | **type** string | **Choices:*** username
* email
* profile-name
| Type. |
| | | **idp\_artifact\_resolution\_url** string | | IDP artifact resolution URL. |
| | | **idp\_entity\_id** string | | IDP entity ID. |
| | | **idp\_single\_logout\_url** string | | IDP single logout URL. |
| | | **idp\_single\_sign\_on\_url** string | | IDP single sign-on URL. |
| | | **name** string / required | | Name. |
| | | **prefix** string | | Prefix. |
| | | **sp\_artifact\_resolution\_url** string | | SP artifact resolution URL. |
| | | **sp\_binding\_protocol** string | **Choices:*** post
* redirect
| SP binding protocol. |
| | | **sp\_cert** string | | SP certificate name. Source certificate.remote.name. |
| | | **sp\_entity\_id** string | | SP entity ID. |
| | | **sp\_portal\_url** string | | SP portal URL. |
| | | **sp\_single\_logout\_url** string | | SP single logout URL. |
| | | **sp\_single\_sign\_on\_url** string | | SP single sign-on URL. |
| | **single\_logout\_url** string | | SP single logout URL. |
| | **single\_sign\_on\_url** string | | SP single sign-on URL. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable SAML authentication . |
| | **tolerance** integer | | Tolerance to the range of time when the assertion is valid (in minutes). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global settings for SAML authentication.
fortios_system_saml:
vdom: "{{ vdom }}"
system_saml:
artifact_resolution_url: "<your_own_value>"
binding_protocol: "post"
cert: "<your_own_value> (source certificate.local.name)"
default_login_page: "normal"
default_profile: "<your_own_value> (source system.accprofile.name)"
entity_id: "<your_own_value>"
idp_artifact_resolution_url: "<your_own_value>"
idp_cert: "<your_own_value> (source certificate.remote.name)"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
life: "14"
portal_url: "<your_own_value>"
role: "identity-provider"
server_address: "<your_own_value>"
service_providers:
-
assertion_attributes:
-
name: "default_name_20"
type: "username"
idp_artifact_resolution_url: "<your_own_value>"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
name: "default_name_26"
prefix: "<your_own_value>"
sp_artifact_resolution_url: "<your_own_value>"
sp_binding_protocol: "post"
sp_cert: "<your_own_value> (source certificate.remote.name)"
sp_entity_id: "<your_own_value>"
sp_portal_url: "<your_own_value>"
sp_single_logout_url: "<your_own_value>"
sp_single_sign_on_url: "<your_own_value>"
single_logout_url: "<your_own_value>"
single_sign_on_url: "<your_own_value>"
status: "enable"
tolerance: "38"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_extender_sys_info – Display detailed extender system information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_sys\_info – Display detailed extender system information in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_extender_sys_info`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender feature and sys\_info 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **extender\_sys\_info** dictionary | | Display detailed extender system information. |
| | string | | extender serial number. Source extender-controller.extender.id. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Display detailed extender system information.
fortios_extender_sys_info:
vdom: "{{ vdom }}"
extender_sys_info:
<sn>: "<your_own_value> (source extender-controller.extender.id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_endpoint_control_registered_forticlient – Registered FortiClient list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_registered\_forticlient – Registered FortiClient list in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_endpoint_control_registered_forticlient`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
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 registered\_forticlient 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **endpoint\_control\_registered\_forticlient** dictionary | | Registered FortiClient list. |
| | **flag** integer | | FortiClient registration flag. |
| | **ip** string | | Endpoint IP address. |
| | **mac** string | | Endpoint MAC address. |
| | **reg\_fortigate** string | | Registering FortiGate SN. |
| | **status** integer | | FortiClient registration status. |
| | **uid** string / required | | FortiClient UID. |
| | **vdom** string | | Registering vdom. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Registered FortiClient list.
fortios_endpoint_control_registered_forticlient:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_registered_forticlient:
flag: "3"
ip: "<your_own_value>"
mac: "<your_own_value>"
reg_fortigate: "<your_own_value>"
status: "7"
uid: "<your_own_value>"
vdom: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_fortitoken – Configure FortiToken in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_fortitoken – Configure FortiToken in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_fortitoken`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fortitoken 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_fortitoken** dictionary | | Configure FortiToken. |
| | **activation\_code** string | | Mobile token user activation-code. |
| | **activation\_expire** integer | | Mobile token user activation-code expire time. |
| | **comments** string | | Comment. |
| | **license** string | | Mobile token license. |
| | **os\_ver** string | | Device Mobile Version. |
| | **reg\_id** string | | Device Reg ID. |
| | **seed** string | | Token seed. |
| | **serial\_number** string | | Serial number. |
| | **status** string | **Choices:*** active
* lock
| Status |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiToken.
fortios_user_fortitoken:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fortitoken:
activation_code: "<your_own_value>"
activation_expire: "4"
comments: "<your_own_value>"
license: "<your_own_value>"
os_ver: "<your_own_value>"
reg_id: "<your_own_value>"
seed: "<your_own_value>"
serial_number: "<your_own_value>"
status: "active"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ssh_local_key – SSH proxy local keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssh\_local\_key – SSH proxy local keys in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ssh_local_key`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_ssh feature and local\_key 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ssh\_local\_key** dictionary | | SSH proxy local keys. |
| | **name** string / required | | SSH proxy local key name. |
| | **password** string | | Password for SSH private key. |
| | **private\_key** string | | SSH proxy private key, encrypted with a password. |
| | **public\_key** string | | SSH proxy public key. |
| | **source** string | **Choices:*** built-in
* user
| SSH proxy local key source type. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSH proxy local keys.
fortios_firewall_ssh_local_key:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ssh_local_key:
name: "default_name_3"
password: "<your_own_value>"
private_key: "<your_own_value>"
public_key: "<your_own_value>"
source: "built-in"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_session_ttl – Configure global session TTL timers for this FortiGate in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_session\_ttl – Configure global session TTL timers for this FortiGate in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_session_ttl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and session\_ttl 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_session\_ttl** dictionary | | Configure global session TTL timers for this FortiGate. |
| | **default** string | | Default timeout. |
| | **port** list / elements=string | | Session TTL port. |
| | | **end\_port** integer | | End port number. |
| | | **id** integer / required | | Table entry ID. |
| | | **protocol** integer | | Protocol (0 - 255). |
| | | **start\_port** integer | | Start port number. |
| | | **timeout** string | | Session timeout (TTL). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure global session TTL timers for this FortiGate.
fortios_system_session_ttl:
vdom: "{{ vdom }}"
system_session_ttl:
default: "<your_own_value>"
port:
-
end_port: "5"
id: "6"
protocol: "7"
start_port: "8"
timeout: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_mpsk_profile – Configure MPSK profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_mpsk\_profile – Configure MPSK profile in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_mpsk_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and mpsk\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_mpsk\_profile** dictionary | | Configure MPSK profile. |
| | **mpsk\_concurrent\_clients** integer | | Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535). |
| | **mpsk\_group** list / elements=string | | List of multiple PSK groups. |
| | | **mpsk\_key** list / elements=string | | List of multiple PSK entries. |
| | | | **comment** string | | Comment. |
| | | | **concurrent\_client\_limit\_type** string | **Choices:*** default
* unlimited
* specified
| MPSK client limit type options. |
| | | | **concurrent\_clients** integer | | Number of clients that can connect using this pre-shared key (1 - 65535). |
| | | | **mac** string | | MAC address. |
| | | | **mpsk\_schedules** list / elements=string | | Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. |
| | | | | **name** string / required | | Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime .name. |
| | | | **name** string / required | | Pre-shared key name. |
| | | | **passphrase** string | | WPA Pre-shared key. |
| | | **name** string / required | | MPSK group name. |
| | | **vlan\_id** integer | | Optional VLAN ID. |
| | | **vlan\_type** string | **Choices:*** no-vlan
* fixed-vlan
| MPSK group VLAN options. |
| | **name** string / required | | MPSK profile name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure MPSK profile.
fortios_wireless_controller_mpsk_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_mpsk_profile:
mpsk_concurrent_clients: "3"
mpsk_group:
-
mpsk_key:
-
comment: "Comment."
concurrent_client_limit_type: "default"
concurrent_clients: "8"
mac: "<your_own_value>"
mpsk_schedules:
-
name: "default_name_11 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
name: "default_name_12"
passphrase: "<your_own_value>"
name: "default_name_14"
vlan_id: "15"
vlan_type: "no-vlan"
name: "default_name_17"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_geneve – Configure GENEVE devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_geneve – Configure GENEVE devices in Fortinet’s FortiOS and FortiGate.
========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_geneve`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and geneve 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_geneve** dictionary | | Configure GENEVE devices. |
| | **dstport** integer | | GENEVE destination port (1 - 65535). |
| | **interface** string | | Outgoing interface for GENEVE encapsulated traffic. Source system.interface.name. |
| | **ip\_version** string | **Choices:*** ipv4-unicast
* ipv6-unicast
| IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. |
| | **name** string / required | | GENEVE device or interface name. Must be an unique interface name. |
| | **remote\_ip** string | | IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE. |
| | **remote\_ip6** string | | IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE. |
| | **type** string | **Choices:*** ethernet
* ppp
| GENEVE type. |
| | **vni** integer | | GENEVE network ID. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure GENEVE devices.
fortios_system_geneve:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_geneve:
dstport: "3"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "ipv4-unicast"
name: "default_name_6"
remote_ip: "<your_own_value>"
remote_ip6: "<your_own_value>"
type: "ethernet"
vni: "10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_monitoring_np6_ipsec_engine – Configure NP6 IPsec engine status monitoring in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_monitoring\_np6\_ipsec\_engine – Configure NP6 IPsec engine status monitoring in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_monitoring_np6_ipsec_engine`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify monitoring feature and np6\_ipsec\_engine 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **monitoring\_np6\_ipsec\_engine** dictionary | | Configure NP6 IPsec engine status monitoring. |
| | **interval** integer | | IPsec engine status check interval (1 - 60 seconds). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable NP6 IPsec engine status monitoring. |
| | **threshold** string | | IPsec engine status check threshold (x x x x x x x x, 8 integers from <1> to <255>). Example: Log is generated if IPsec engine 0 is busy each of every 15 consecutive interval checks. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NP6 IPsec engine status monitoring.
fortios_monitoring_np6_ipsec_engine:
vdom: "{{ vdom }}"
monitoring_np6_ipsec_engine:
interval: "3"
status: "enable"
threshold: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_ptp_settings – Global PTP settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_ptp\_settings – Global PTP settings in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_ptp_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_ptp feature and settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_ptp\_settings** dictionary | | Global PTP settings. |
| | **mode** string | **Choices:*** disable
* transparent-e2e
* transparent-p2p
| Enable/disable PTP mode. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global PTP settings.
fortios_switch_controller_ptp_settings:
vdom: "{{ vdom }}"
switch_controller_ptp_settings:
mode: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_antivirus_quarantine – Configure quarantine options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_quarantine – Configure quarantine options in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_antivirus_quarantine`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **antivirus\_quarantine** dictionary | | Configure quarantine options. |
| | **agelimit** integer | | Age limit for quarantined files (0 - 479 hours, 0 means forever). |
| | **destination** string | **Choices:*** **None** ←
* disk
* FortiAnalyzer
| Choose whether to quarantine files to the FortiGate disk or to FortiAnalyzer or to delete them instead of quarantining them. |
| | **drop\_blocked** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Do not quarantine dropped files found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. |
| | **drop\_heuristic** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Do not quarantine files detected by heuristics found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. |
| | **drop\_infected** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Do not quarantine infected files found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. |
| | **drop\_intercepted** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* mm1
* mm3
* mm4
* mm7
| drop intercepted from a protocol |
| | **lowspace** string | **Choices:*** drop-new
* ovrw-old
| Select the method for handling additional files when running low on disk space. |
| | **maxfilesize** integer | | Maximum file size to quarantine (0 - 500 Mbytes, 0 means unlimited). |
| | **quarantine\_quota** integer | | The amount of disk space to reserve for quarantining files (0 - 4294967295 Mbytes, depends on disk space). |
| | **store\_blocked** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Quarantine blocked files found in sessions using the selected protocols. |
| | **store\_heuristic** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Quarantine files detected by heuristics found in sessions using the selected protocols. |
| | **store\_infected** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* cifs
* mm1
* mm3
* mm4
* mm7
* ssh
| Quarantine infected files found in sessions using the selected protocols. |
| | **store\_intercepted** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* imaps
* smtps
* pop3s
* https
* ftps
* mapi
* mm1
* mm3
* mm4
* mm7
| quarantine intercepted from a protocol |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure quarantine options.
fortios_antivirus_quarantine:
vdom: "{{ vdom }}"
antivirus_quarantine:
agelimit: "3"
destination: "NULL"
drop_blocked: "imap"
drop_heuristic: "imap"
drop_infected: "imap"
drop_intercepted: "imap"
lowspace: "drop-new"
maxfilesize: "10"
quarantine_quota: "11"
store_blocked: "imap"
store_heuristic: "imap"
store_infected: "imap"
store_intercepted: "imap"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_mm7 – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mm7 – Replacement messages in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_mm7`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and mm7 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_mm7** dictionary | | Replacement messages. |
| | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | **addr\_type** string | **Choices:*** rfc2822-addr
* number
* short-code
| from address type |
| | **allow\_content\_adaptation** string | **Choices:*** enable
* disable
| allow content adaptations |
| | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | **class** string | **Choices:*** not-included
* personal
* informational
* advertisement
* auto
| message class |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **from** string | | from address |
| | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. Source system.replacemsg-image.name. |
| | **message** string | | message text |
| | **msg\_type** string | | Message type. |
| | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | **rsp\_status** string | **Choices:*** success
* partial-success
* client-err
* oper-restrict
* addr-err
* addr-not-found
* content-refused
* msg-id-not-found
* link-id-not-found
* msg-fmt-corrupt
* app-id-not-found
* repl-app-id-not-found
* srv-err
* not-possible
* msg-rejected
* multiple-addr-not-supp
* app-addr-not-supp
* gen-service-err
* improper-ident
* unsupp-ver
* unsupp-oper
* validation-err
* service-err
* service-unavail
* service-denied
* app-denied
| response status |
| | **smil\_part** string | | message encapsulation text |
| | **subject** string | | subject text string |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mm7:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mm7:
add_smil: "enable"
addr_type: "rfc2822-addr"
allow_content_adaptation: "enable"
charset: "utf-8"
class: "not-included"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "success"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_proxy_address – Web proxy address configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_proxy\_address – Web proxy address configuration in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_proxy_address`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy\_address 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_proxy\_address** dictionary | | Web proxy address configuration. |
| | **case\_sensitivity** string | **Choices:*** disable
* enable
| Enable to make the pattern case sensitive. |
| | **category** list / elements=string | | FortiGuard category ID. |
| | | **id** integer / required | | Fortiguard category id. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (1 - 32). |
| | **comment** string | | Optional comments. |
| | **header** string | | HTTP header name as a regular expression. |
| | **header\_group** list / elements=string | | HTTP header group. |
| | | **case\_sensitivity** string | **Choices:*** disable
* enable
| Case sensitivity in pattern. |
| | | **header** string | | HTTP header regular expression. |
| | | **header\_name** string | | HTTP header. |
| | | **id** integer / required | | ID. |
| | **header\_name** string | | Name of HTTP header. |
| | **host** string | | Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. |
| | **host\_regex** string | | Host name as a regular expression. |
| | **method** list / elements=string | **Choices:*** get
* post
* put
* head
* connect
* trace
* options
* delete
| HTTP request methods to be used. |
| | **name** string / required | | Address name. |
| | **path** string | | URL path as a regular expression. |
| | **query** string | | Match the query part of the URL as a regular expression. |
| | **referrer** string | **Choices:*** enable
* disable
| Enable/disable use of referrer field in the HTTP header to match the address. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| | **type** string | **Choices:*** host-regex
* url
* category
* method
* ua
* header
* src-advanced
* dst-advanced
| Proxy address type. |
| | **ua** list / elements=string | **Choices:*** chrome
* ms
* firefox
* safari
* other
| Names of browsers to be used as user agent. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable visibility of the object in the GUI. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Web proxy address configuration.
fortios_firewall_proxy_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_address:
case_sensitivity: "disable"
category:
-
id: "5"
color: "6"
comment: "Optional comments."
header: "<your_own_value>"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "13"
header_name: "<your_own_value>"
host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
host_regex: "myhostname"
method: "get"
name: "default_name_18"
path: "<your_own_value>"
query: "<your_own_value>"
referrer: "enable"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_24"
tags:
-
name: "default_name_26 (source system.object-tagging.tags.name)"
type: "host-regex"
ua: "chrome"
uuid: "<your_own_value>"
visibility: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_password_policy_guest_admin – Configure the password policy for guest administrators in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_password\_policy\_guest\_admin – Configure the password policy for guest administrators in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_password_policy_guest_admin`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and password\_policy\_guest\_admin 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_password\_policy\_guest\_admin** dictionary | | Configure the password policy for guest administrators. |
| | **apply\_to** list / elements=string | **Choices:*** guest-admin-password
| Guest administrator to which this password policy applies. |
| | **change\_4\_characters** string | **Choices:*** enable
* disable
| Enable/disable changing at least 4 characters for a new password (This attribute overrides reuse-password if both are enabled). |
| | **expire\_day** integer | | Number of days after which passwords expire (1 - 999 days). |
| | **expire\_status** string | **Choices:*** enable
* disable
| Enable/disable password expiration. |
| | **min\_change\_characters** integer | | Minimum number of unique characters in new password which do not exist in old password (This attribute overrides reuse-password if both are enabled). |
| | **min\_lower\_case\_letter** integer | | Minimum number of lowercase characters in password (0 - 128). |
| | **min\_non\_alphanumeric** integer | | Minimum number of non-alphanumeric characters in password (0 - 128). |
| | **min\_number** integer | | Minimum number of numeric characters in password (0 - 128). |
| | **min\_upper\_case\_letter** integer | | Minimum number of uppercase characters in password (0 - 128). |
| | **minimum\_length** integer | | Minimum password length (8 - 128). |
| | **reuse\_password** string | **Choices:*** enable
* disable
| Enable/disable reusing of password (if both reuse-password and change-4-characters are enabled, change-4-characters overrides). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable setting a password policy for locally defined administrator passwords and IPsec VPN pre-shared keys. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure the password policy for guest administrators.
fortios_system_password_policy_guest_admin:
vdom: "{{ vdom }}"
system_password_policy_guest_admin:
apply_to: "guest-admin-password"
change_4_characters: "enable"
expire_day: "5"
expire_status: "enable"
min_change_characters: "7"
min_lower_case_letter: "8"
min_non_alphanumeric: "9"
min_number: "10"
min_upper_case_letter: "11"
minimum_length: "12"
reuse_password: "enable"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_quarantine – Configure FortiSwitch quarantine support in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_quarantine – Configure FortiSwitch quarantine support in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_quarantine`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_quarantine** dictionary | | Configure FortiSwitch quarantine support. |
| | **quarantine** string | **Choices:*** enable
* disable
| Enable/disable quarantine. |
| | **targets** list / elements=string | | Quarantine MACs. |
| | | **description** string | | Description for the quarantine MAC. |
| | | **entry\_id** integer | | FSW entry id for the quarantine MAC. |
| | | **mac** string / required | | Quarantine MAC. |
| | | **tag** list / elements=string | | Tags for the quarantine MAC. |
| | | | **tags** string / required | | Tag string(eg. string1 string2 string3). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch quarantine support.
fortios_switch_controller_quarantine:
vdom: "{{ vdom }}"
switch_controller_quarantine:
quarantine: "enable"
targets:
-
description: "<your_own_value>"
entry_id: "6"
mac: "<your_own_value>"
tag:
-
tags: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_mobile_tunnel – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_mobile\_tunnel – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_mobile_tunnel`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and mobile\_tunnel 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_mobile\_tunnel** dictionary | | Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177. |
| | **hash\_algorithm** string | **Choices:*** hmac-md5
| Hash Algorithm (Keyed MD5). |
| | **home\_address** string | | Home IP address (Format: xxx.xxx.xxx.xxx). |
| | **home\_agent** string | | IPv4 address of the NEMO HA (Format: xxx.xxx.xxx.xxx). |
| | **lifetime** integer | | NMMO HA registration request lifetime (180 - 65535 sec). |
| | **n\_mhae\_key** string | | NEMO authentication key. |
| | **n\_mhae\_key\_type** string | **Choices:*** ascii
* base64
| NEMO authentication key type (ascii or base64). |
| | **n\_mhae\_spi** integer | | NEMO authentication SPI . |
| | **name** string / required | | Tunnel name. |
| | **network** list / elements=string | | NEMO network configuration. |
| | | **id** integer / required | | Network entry ID. |
| | | **interface** string | | Select the associated interface name from available options. Source system.interface.name. |
| | | **prefix** string | | Class IP and Netmask with correction (Format:xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx or xxx.xxx.xxx.xxx/x). |
| | **reg\_interval** integer | | NMMO HA registration interval (5 - 300). |
| | **reg\_retry** integer | | Maximum number of NMMO HA registration retries (1 to 30). |
| | **renew\_interval** integer | | Time before lifetime expiraton to send NMMO HA re-registration (5 - 60). |
| | **roaming\_interface** string | | Select the associated interface name from available options. Source system.interface.name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this mobile tunnel. |
| | **tunnel\_mode** string | **Choices:*** gre
| NEMO tunnnel mode (GRE tunnel). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
fortios_system_mobile_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_mobile_tunnel:
hash_algorithm: "hmac-md5"
home_address: "<your_own_value>"
home_agent: "<your_own_value>"
lifetime: "6"
n_mhae_key: "<your_own_value>"
n_mhae_key_type: "ascii"
n_mhae_spi: "9"
name: "default_name_10"
network:
-
id: "12"
interface: "<your_own_value> (source system.interface.name)"
prefix: "<your_own_value>"
reg_interval: "15"
reg_retry: "16"
renew_interval: "17"
roaming_interface: "<your_own_value> (source system.interface.name)"
status: "disable"
tunnel_mode: "gre"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_webfilter_ftgd_local_rating – Configure local FortiGuard Web Filter local ratings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_ftgd\_local\_rating – Configure local FortiGuard Web Filter local ratings in Fortinet’s FortiOS and FortiGate.
===================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_webfilter_ftgd_local_rating`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ftgd\_local\_rating 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **webfilter\_ftgd\_local\_rating** dictionary | | Configure local FortiGuard Web Filter local ratings. |
| | **comment** string | | Comment. |
| | **rating** string | | Local rating. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable local rating. |
| | **url** string / required | | URL to rate locally. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure local FortiGuard Web Filter local ratings.
fortios_webfilter_ftgd_local_rating:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_ftgd_local_rating:
comment: "Comment."
rating: "<your_own_value>"
status: "enable"
url: "myurl.com"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_wids_profile – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wids\_profile – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_wids_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and wids\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_wids\_profile** dictionary | | Configure wireless intrusion detection system (WIDS) profiles. |
| | **ap\_auto\_suppress** string | **Choices:*** enable
* disable
| Enable/disable on-wire rogue AP auto-suppression . |
| | **ap\_bgscan\_disable\_day** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Optionally turn off scanning for one or more days of the week. Separate the days with a space. By default, no days are set. |
| | **ap\_bgscan\_disable\_end** string | | End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . |
| | **ap\_bgscan\_disable\_schedules** list / elements=string | | Firewall schedules for turning off FortiAP radio background scan. Background scan will be disabled when at least one of the schedules is valid. Separate multiple schedule names with a space. |
| | | **name** string / required | | Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. |
| | **ap\_bgscan\_disable\_start** string | | Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . |
| | **ap\_bgscan\_duration** integer | | Listening time on a scanning channel (10 - 1000 msec). |
| | **ap\_bgscan\_idle** integer | | Waiting time for channel inactivity before scanning this channel (0 - 1000 msec). |
| | **ap\_bgscan\_intv** integer | | Period of time between scanning two channels (1 - 600 sec). |
| | **ap\_bgscan\_period** integer | | Period of time between background scans (60 - 3600 sec). |
| | **ap\_bgscan\_report\_intv** integer | | Period of time between background scan reports (15 - 600 sec). |
| | **ap\_fgscan\_report\_intv** integer | | Period of time between foreground scan reports (15 - 600 sec). |
| | **ap\_scan** string | **Choices:*** disable
* enable
| Enable/disable rogue AP detection. |
| | **ap\_scan\_passive** string | **Choices:*** enable
* disable
| Enable/disable passive scanning. Enable means do not send probe request on any channels . |
| | **ap\_scan\_threshold** string | | Minimum signal level/threshold in dBm required for the AP to report detected rogue AP (-95 to -20). |
| | **asleap\_attack** string | **Choices:*** enable
* disable
| Enable/disable asleap attack detection . |
| | **assoc\_flood\_thresh** integer | | The threshold value for association frame flooding. |
| | **assoc\_flood\_time** integer | | Number of seconds after which a station is considered not connected. |
| | **assoc\_frame\_flood** string | **Choices:*** enable
* disable
| Enable/disable association frame flooding detection . |
| | **auth\_flood\_thresh** integer | | The threshold value for authentication frame flooding. |
| | **auth\_flood\_time** integer | | Number of seconds after which a station is considered not connected. |
| | **auth\_frame\_flood** string | **Choices:*** enable
* disable
| Enable/disable authentication frame flooding detection . |
| | **comment** string | | Comment. |
| | **deauth\_broadcast** string | **Choices:*** enable
* disable
| Enable/disable broadcasting de-authentication detection . |
| | **deauth\_unknown\_src\_thresh** integer | | Threshold value per second to deauth unknown src for DoS attack (0: no limit). |
| | **eapol\_fail\_flood** string | **Choices:*** enable
* disable
| Enable/disable EAPOL-Failure flooding (to AP) detection . |
| | **eapol\_fail\_intv** integer | | The detection interval for EAPOL-Failure flooding (1 - 3600 sec). |
| | **eapol\_fail\_thresh** integer | | The threshold value for EAPOL-Failure flooding in specified interval. |
| | **eapol\_logoff\_flood** string | **Choices:*** enable
* disable
| Enable/disable EAPOL-Logoff flooding (to AP) detection . |
| | **eapol\_logoff\_intv** integer | | The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). |
| | **eapol\_logoff\_thresh** integer | | The threshold value for EAPOL-Logoff flooding in specified interval. |
| | **eapol\_pre\_fail\_flood** string | **Choices:*** enable
* disable
| Enable/disable premature EAPOL-Failure flooding (to STA) detection . |
| | **eapol\_pre\_fail\_intv** integer | | The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). |
| | **eapol\_pre\_fail\_thresh** integer | | The threshold value for premature EAPOL-Failure flooding in specified interval. |
| | **eapol\_pre\_succ\_flood** string | **Choices:*** enable
* disable
| Enable/disable premature EAPOL-Success flooding (to STA) detection . |
| | **eapol\_pre\_succ\_intv** integer | | The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). |
| | **eapol\_pre\_succ\_thresh** integer | | The threshold value for premature EAPOL-Success flooding in specified interval. |
| | **eapol\_start\_flood** string | **Choices:*** enable
* disable
| Enable/disable EAPOL-Start flooding (to AP) detection . |
| | **eapol\_start\_intv** integer | | The detection interval for EAPOL-Start flooding (1 - 3600 sec). |
| | **eapol\_start\_thresh** integer | | The threshold value for EAPOL-Start flooding in specified interval. |
| | **eapol\_succ\_flood** string | **Choices:*** enable
* disable
| Enable/disable EAPOL-Success flooding (to AP) detection . |
| | **eapol\_succ\_intv** integer | | The detection interval for EAPOL-Success flooding (1 - 3600 sec). |
| | **eapol\_succ\_thresh** integer | | The threshold value for EAPOL-Success flooding in specified interval. |
| | **invalid\_mac\_oui** string | **Choices:*** enable
* disable
| Enable/disable invalid MAC OUI detection. |
| | **long\_duration\_attack** string | **Choices:*** enable
* disable
| Enable/disable long duration attack detection based on user configured threshold . |
| | **long\_duration\_thresh** integer | | Threshold value for long duration attack detection (1000 - 32767 usec). |
| | **name** string / required | | WIDS profile name. |
| | **null\_ssid\_probe\_resp** string | **Choices:*** enable
* disable
| Enable/disable null SSID probe response detection . |
| | **sensor\_mode** string | **Choices:*** disable
* foreign
* both
| Scan WiFi nearby stations . |
| | **spoofed\_deauth** string | **Choices:*** enable
* disable
| Enable/disable spoofed de-authentication attack detection . |
| | **weak\_wep\_iv** string | **Choices:*** enable
* disable
| Enable/disable weak WEP IV (Initialization Vector) detection . |
| | **wireless\_bridge** string | **Choices:*** enable
* disable
| Enable/disable wireless bridge detection . |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure wireless intrusion detection system (WIDS) profiles.
fortios_wireless_controller_wids_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wids_profile:
ap_auto_suppress: "enable"
ap_bgscan_disable_day: "sunday"
ap_bgscan_disable_end: "<your_own_value>"
ap_bgscan_disable_schedules:
-
name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
ap_bgscan_disable_start: "<your_own_value>"
ap_bgscan_duration: "9"
ap_bgscan_idle: "10"
ap_bgscan_intv: "11"
ap_bgscan_period: "12"
ap_bgscan_report_intv: "13"
ap_fgscan_report_intv: "14"
ap_scan: "disable"
ap_scan_passive: "enable"
ap_scan_threshold: "<your_own_value>"
asleap_attack: "enable"
assoc_flood_thresh: "19"
assoc_flood_time: "20"
assoc_frame_flood: "enable"
auth_flood_thresh: "22"
auth_flood_time: "23"
auth_frame_flood: "enable"
comment: "Comment."
deauth_broadcast: "enable"
deauth_unknown_src_thresh: "27"
eapol_fail_flood: "enable"
eapol_fail_intv: "29"
eapol_fail_thresh: "30"
eapol_logoff_flood: "enable"
eapol_logoff_intv: "32"
eapol_logoff_thresh: "33"
eapol_pre_fail_flood: "enable"
eapol_pre_fail_intv: "35"
eapol_pre_fail_thresh: "36"
eapol_pre_succ_flood: "enable"
eapol_pre_succ_intv: "38"
eapol_pre_succ_thresh: "39"
eapol_start_flood: "enable"
eapol_start_intv: "41"
eapol_start_thresh: "42"
eapol_succ_flood: "enable"
eapol_succ_intv: "44"
eapol_succ_thresh: "45"
invalid_mac_oui: "enable"
long_duration_attack: "enable"
long_duration_thresh: "48"
name: "default_name_49"
null_ssid_probe_resp: "enable"
sensor_mode: "disable"
spoofed_deauth: "enable"
weak_wep_iv: "enable"
wireless_bridge: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_ssid_policy – Configure WiFi SSID policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_ssid\_policy – Configure WiFi SSID policies in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_ssid_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and ssid\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_ssid\_policy** dictionary | | Configure WiFi SSID policies. |
| | **description** string | | Description. |
| | **name** string / required | | Name. |
| | **vlan** string | | VLAN interface name. Source system.interface.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi SSID policies.
fortios_wireless_controller_ssid_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_ssid_policy:
description: "<your_own_value>"
name: "default_name_4"
vlan: "<your_own_value> (source system.interface.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_acme – Configure ACME client in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_acme – Configure ACME client in Fortinet’s FortiOS and FortiGate.
===================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_acme`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and acme 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_acme** dictionary | | Configure ACME client. |
| | **accounts** list / elements=string | | ACME accounts list. |
| | | **ca\_url** string | | Account ca\_url. |
| | | **email** string | | Account email. |
| | | **id** string / required | | Account id. |
| | | **privatekey** string | | Account Private Key. |
| | | **status** string | | Account status. |
| | | **url** string | | Account url. |
| | **interface** list / elements=string | | Interface(s) on which the ACME client will listen for challenges. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure ACME client.
fortios_system_acme:
vdom: "{{ vdom }}"
system_acme:
accounts:
-
ca_url: "<your_own_value>"
email: "<your_own_value>"
id: "6"
privatekey: "<your_own_value>"
status: "<your_own_value>"
url: "myurl.com"
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_eventfilter – Configure log event filters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_eventfilter – Configure log event filters in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_eventfilter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and eventfilter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_eventfilter** dictionary | | Configure log event filters. |
| | **cifs** string | **Choices:*** enable
* disable
| Enable/disable CIFS logging. |
| | **compliance\_check** string | **Choices:*** enable
* disable
| Enable/disable PCI DSS compliance check logging. |
| | **connector** string | **Choices:*** enable
* disable
| Enable/disable SDN connector logging. |
| | **endpoint** string | **Choices:*** enable
* disable
| Enable/disable endpoint event logging. |
| | **event** string | **Choices:*** enable
* disable
| Enable/disable event logging. |
| | **fortiextender** string | **Choices:*** enable
* disable
| Enable/disable FortiExtender logging. |
| | **ha** string | **Choices:*** enable
* disable
| Enable/disable ha event logging. |
| | **router** string | **Choices:*** enable
* disable
| Enable/disable router event logging. |
| | **sdwan** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN logging. |
| | **security\_rating** string | **Choices:*** enable
* disable
| Enable/disable Security Rating result logging. |
| | **switch\_controller** string | **Choices:*** enable
* disable
| Enable/disable Switch-Controller logging. |
| | **system** string | **Choices:*** enable
* disable
| Enable/disable system event logging. |
| | **user** string | **Choices:*** enable
* disable
| Enable/disable user authentication event logging. |
| | **vpn** string | **Choices:*** enable
* disable
| Enable/disable VPN event logging. |
| | **wan\_opt** string | **Choices:*** enable
* disable
| Enable/disable WAN optimization event logging. |
| | **wireless\_activity** string | **Choices:*** enable
* disable
| Enable/disable wireless event logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure log event filters.
fortios_log_eventfilter:
vdom: "{{ vdom }}"
log_eventfilter:
cifs: "enable"
compliance_check: "enable"
connector: "enable"
endpoint: "enable"
event: "enable"
fortiextender: "enable"
ha: "enable"
router: "enable"
sdwan: "enable"
security_rating: "enable"
switch_controller: "enable"
system: "enable"
user: "enable"
vpn: "enable"
wan_opt: "enable"
wireless_activity: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_hardware_npu_np6_dce – Show NP6 non-zero subengine drop counters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_hardware\_npu\_np6\_dce – Show NP6 non-zero subengine drop counters in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_hardware_npu_np6_dce`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify hardware\_npu\_np6 feature and dce 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **hardware\_npu\_np6\_dce** dictionary | | Show NP6 non-zero subengine drop counters. |
| | string | | NP6 ID |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Show NP6 non-zero subengine drop counters.
fortios_hardware_npu_np6_dce:
vdom: "{{ vdom }}"
hardware_npu_np6_dce:
<dev_id>: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_gtp_ie_allow_list – IE allow list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_ie\_allow\_list – IE allow list in Fortinet’s FortiOS and FortiGate.
===================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_gtp_ie_allow_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and ie\_allow\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **gtp\_ie\_allow\_list** dictionary | | IE allow list. |
| | **entries** list / elements=string | | Entries of allow list for unknown or out-of-state IEs. |
| | | **id** integer / required | | Entry ID. |
| | | **ie** integer | | IE ID (1 - 255). |
| | | **message** integer | | Message ID (1 - 255). |
| | **name** string / required | | IE allow list name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: IE allow list.
fortios_gtp_ie_allow_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_ie_allow_list:
entries:
-
id: "4"
ie: "5"
message: "6"
name: "default_name_7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_address – Configure IPv4 addresses in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_address – Configure IPv4 addresses in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_address`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_address** dictionary | | Configure IPv4 addresses. |
| | **allow\_routing** string | **Choices:*** enable
* disable
| Enable/disable use of this address in the static route configuration. |
| | **associated\_interface** string | | Network interface associated with address. Source system.interface.name system.zone.name. |
| | **cache\_ttl** integer | | Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. |
| | **clearpass\_spt** string | **Choices:*** unknown
* healthy
* quarantine
* checkup
* transient
* infected
| SPT (System Posture Token) value. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **country** string | | IP addresses associated to a specific country. |
| | **end\_ip** string | | Final IP address (inclusive) in the range for the address. |
| | **end\_mac** string | | Last MAC address in the range. |
| | **epg\_name** string | | Endpoint group name. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **filter** string | | Match criteria filter. |
| | **fqdn** string | | Fully Qualified Domain Name address. |
| | **fsso\_group** list / elements=string | | FSSO group(s). |
| | | **name** string / required | | FSSO group name. Source user.adgrp.name. |
| | **interface** string | | Name of interface whose IP address is to be used. Source system.interface.name. |
| | **list** list / elements=string | | IP address list. |
| | | **ip** string / required | | IP. |
| | | **net\_id** string | | Network ID. |
| | | **obj\_id** string | | Object ID. |
| | **macaddr** list / elements=string | | Multiple MAC address ranges. |
| | | **macaddr** string / required | | MAC address ranges <start>[-<end>] separated by space. |
| | **name** string / required | | Address name. |
| | **node\_ip\_only** string | **Choices:*** enable
* disable
| Enable/disable collection of node addresses only in Kubernetes. |
| | **obj\_id** string | | Object ID for NSX. |
| | **obj\_tag** string | | Tag of dynamic address object. |
| | **obj\_type** string | **Choices:*** ip
* mac
| Object type. |
| | **organization** string | | Organization domain name (Syntax: organization/domain). |
| | **policy\_group** string | | Policy group name. |
| | **sdn** string | **Choices:*** aci
* aws
* azure
* gcp
* nsx
* nuage
* oci
* openstack
| SDN. Source system.sdn-connector.name. |
| | **sdn\_addr\_type** string | **Choices:*** private
* public
* all
| Type of addresses to collect. |
| | **sdn\_tag** string | | SDN Tag. |
| | **start\_ip** string | | First IP address (inclusive) in the range for the address. |
| | **start\_mac** string | | First MAC address in the range. |
| | **sub\_type** string | **Choices:*** sdn
* clearpass-spt
* fsso
* ems-tag
| Sub-type of address. |
| | **subnet** string | | IP address and subnet mask of address. |
| | **subnet\_name** string | | Subnet name. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| | **tenant** string | | Tenant. |
| | **type** string | **Choices:*** ipmask
* iprange
* fqdn
* geography
* wildcard
* wildcard-fqdn
* dynamic
* interface-subnet
* mac
| Type of address. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable address visibility in the GUI. |
| | **wildcard** string | | IP address and wildcard netmask. |
| | **wildcard\_fqdn** string | | Fully Qualified Domain Name with wildcard characters. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 addresses.
fortios_firewall_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_address:
allow_routing: "enable"
associated_interface: "<your_own_value> (source system.interface.name system.zone.name)"
cache_ttl: "5"
clearpass_spt: "unknown"
color: "7"
comment: "Comment."
country: "<your_own_value>"
end_ip: "<your_own_value>"
end_mac: "<your_own_value>"
epg_name: "<your_own_value>"
fabric_object: "enable"
filter: "<your_own_value>"
fqdn: "<your_own_value>"
fsso_group:
-
name: "default_name_17 (source user.adgrp.name)"
interface: "<your_own_value> (source system.interface.name)"
list:
-
ip: "<your_own_value>"
net_id: "<your_own_value>"
obj_id: "<your_own_value>"
macaddr:
-
macaddr: "<your_own_value>"
name: "default_name_25"
node_ip_only: "enable"
obj_id: "<your_own_value>"
obj_tag: "<your_own_value>"
obj_type: "ip"
organization: "<your_own_value>"
policy_group: "<your_own_value>"
sdn: "aci"
sdn_addr_type: "private"
sdn_tag: "<your_own_value>"
start_ip: "<your_own_value>"
start_mac: "<your_own_value>"
sub_type: "sdn"
subnet: "<your_own_value>"
subnet_name: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_42"
tags:
-
name: "default_name_44 (source system.object-tagging.tags.name)"
tenant: "<your_own_value>"
type: "ipmask"
uuid: "<your_own_value>"
visibility: "enable"
wildcard: "<your_own_value>"
wildcard_fqdn: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_wtp – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wtp – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_wtp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and wtp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_wtp** dictionary | | Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate. |
| | **admin** string | **Choices:*** discovered
* disable
* enable
| Configure how the FortiGate operating as a wireless controller discovers and manages this WTP, AP or FortiAP. |
| | **allowaccess** list / elements=string | **Choices:*** telnet
* http
* https
* ssh
* snmp
| Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. |
| | **apcfg\_profile** string | | AP local configuration profile name. Source wireless-controller.apcfg-profile.name. |
| | **bonjour\_profile** string | | Bonjour profile name. Source wireless-controller.bonjour-profile.name. |
| | **coordinate\_enable** string | **Choices:*** enable
* disable
| Enable/disable WTP coordinates (X,Y axis). |
| | **coordinate\_latitude** string | | WTP latitude coordinate. |
| | **coordinate\_longitude** string | | WTP longitude coordinate. |
| | **coordinate\_x** string | | X axis coordinate. |
| | **coordinate\_y** string | | Y axis coordinate. |
| | **firmware\_provision** string | | Firmware version to provision to this FortiAP on bootup (major.minor.build, i.e. 6.2.1234). |
| | **image\_download** string | **Choices:*** enable
* disable
| Enable/disable WTP image download. |
| | **index** integer | | Index (0 - 4294967295). |
| | **ip\_fragment\_preventing** list / elements=string | **Choices:*** tcp-mss-adjust
* icmp-unreachable
| Method by which IP fragmentation is prevented for CAPWAP tunneled control and data packets . |
| | **lan** dictionary | | WTP LAN port mapping. |
| | | **port1\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 1 mode. |
| | | **port1\_ssid** string | | Bridge LAN port 1 to SSID. Source wireless-controller.vap.name. |
| | | **port2\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 2 mode. |
| | | **port2\_ssid** string | | Bridge LAN port 2 to SSID. Source wireless-controller.vap.name. |
| | | **port3\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 3 mode. |
| | | **port3\_ssid** string | | Bridge LAN port 3 to SSID. Source wireless-controller.vap.name. |
| | | **port4\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 4 mode. |
| | | **port4\_ssid** string | | Bridge LAN port 4 to SSID. Source wireless-controller.vap.name. |
| | | **port5\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 5 mode. |
| | | **port5\_ssid** string | | Bridge LAN port 5 to SSID. Source wireless-controller.vap.name. |
| | | **port6\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 6 mode. |
| | | **port6\_ssid** string | | Bridge LAN port 6 to SSID. Source wireless-controller.vap.name. |
| | | **port7\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 7 mode. |
| | | **port7\_ssid** string | | Bridge LAN port 7 to SSID. Source wireless-controller.vap.name. |
| | | **port8\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port 8 mode. |
| | | **port8\_ssid** string | | Bridge LAN port 8 to SSID. Source wireless-controller.vap.name. |
| | | **port\_esl\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| ESL port mode. |
| | | **port\_esl\_ssid** string | | Bridge ESL port to SSID. Source system.interface.name. |
| | | **port\_mode** string | **Choices:*** offline
* nat-to-wan
* bridge-to-wan
* bridge-to-ssid
| LAN port mode. |
| | | **port\_ssid** string | | Bridge LAN port to SSID. Source wireless-controller.vap.name. |
| | **led\_state** string | **Choices:*** enable
* disable
| Enable to allow the FortiAPs LEDs to light. Disable to keep the LEDs off. You may want to keep the LEDs off so they are not distracting in low light areas etc. |
| | **location** string | | Field for describing the physical location of the WTP, AP or FortiAP. |
| | **login\_passwd** string | | Set the managed WTP, FortiAP, or AP"s administrator password. |
| | **login\_passwd\_change** string | **Choices:*** True
* default
* False
| Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no). |
| | **mesh\_bridge\_enable** string | **Choices:*** default
* enable
* disable
| Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf AP. |
| | **name** string | | WTP, AP or FortiAP configuration name. |
| | **override\_allowaccess** string | **Choices:*** enable
* disable
| Enable to override the WTP profile management access configuration. |
| | **override\_ip\_fragment** string | **Choices:*** enable
* disable
| Enable/disable overriding the WTP profile IP fragment prevention setting. |
| | **override\_lan** string | **Choices:*** enable
* disable
| Enable to override the WTP profile LAN port setting. |
| | **override\_led\_state** string | **Choices:*** enable
* disable
| Enable to override the profile LED state setting for this FortiAP. You must enable this option to use the led-state command to turn off the FortiAP"s LEDs. |
| | **override\_login\_passwd\_change** string | **Choices:*** enable
* disable
| Enable to override the WTP profile login-password (administrator password) setting. |
| | **override\_split\_tunnel** string | **Choices:*** enable
* disable
| Enable/disable overriding the WTP profile split tunneling setting. |
| | **override\_wan\_port\_mode** string | **Choices:*** enable
* disable
| Enable/disable overriding the wan-port-mode in the WTP profile. |
| | **radio\_1** dictionary | | Configuration options for radio 1. |
| | | **auto\_power\_high** integer | | Automatic transmission power high limit in decibels (dB) of the measured power referenced to one milliwatt (mW), or dBm (10 - 17 dBm). |
| | | **auto\_power\_level** string | **Choices:*** enable
* disable
| Enable/disable automatic power-level adjustment to prevent co-channel interference . |
| | | **auto\_power\_low** integer | | Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20). |
| | | **band** string | **Choices:*** 802.11a
* 802.11b
* 802.11g
* 802.11n
* 802.11n-5G
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 1 operates on. |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **drma\_manual\_mode** string | **Choices:*** ap
* monitor
* ncf
* ncf-peek
| Radio mode to be used for DRMA manual mode . |
| | | **override\_analysis** string | **Choices:*** enable
* disable
| Enable to override the WTP profile spectrum analysis configuration. |
| | | **override\_band** string | **Choices:*** enable
* disable
| Enable to override the WTP profile band setting. |
| | | **override\_channel** string | **Choices:*** enable
* disable
| Enable to override WTP profile channel settings. |
| | | **override\_txpower** string | **Choices:*** enable
* disable
| Enable to override the WTP profile power level configuration. |
| | | **override\_vaps** string | **Choices:*** enable
* disable
| Enable to override WTP profile Virtual Access Point (VAP) settings. |
| | | **power\_level** integer | | Radio power level as a percentage of the maximum transmit power (0 - 100). |
| | | **power\_mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. |
| | | **power\_value** integer | | Radio EIRP power in dBm (1 - 33). |
| | | **radio\_id** integer | | radio-id |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **vap\_all** string | **Choices:*** enable
* disable
* tunnel
* bridge
* manual
| Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . |
| | | **vaps** list / elements=string | | Manually selected list of Virtual Access Points (VAPs). |
| | | | **name** string / required | | Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name. |
| | **radio\_2** dictionary | | Configuration options for radio 2. |
| | | **auto\_power\_high** integer | | Automatic transmission power high limit in decibels (dB) of the measured power referenced to one milliwatt (mW), or dBm (10 - 17 dBm). |
| | | **auto\_power\_level** string | **Choices:*** enable
* disable
| Enable/disable automatic power-level adjustment to prevent co-channel interference . |
| | | **auto\_power\_low** integer | | Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20). |
| | | **band** string | **Choices:*** 802.11a
* 802.11b
* 802.11g
* 802.11n
* 802.11n-5G
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 1 operates on. |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **drma\_manual\_mode** string | **Choices:*** ap
* monitor
* ncf
* ncf-peek
| Radio mode to be used for DRMA manual mode . |
| | | **override\_analysis** string | **Choices:*** enable
* disable
| Enable to override the WTP profile spectrum analysis configuration. |
| | | **override\_band** string | **Choices:*** enable
* disable
| Enable to override the WTP profile band setting. |
| | | **override\_channel** string | **Choices:*** enable
* disable
| Enable to override WTP profile channel settings. |
| | | **override\_txpower** string | **Choices:*** enable
* disable
| Enable to override the WTP profile power level configuration. |
| | | **override\_vaps** string | **Choices:*** enable
* disable
| Enable to override WTP profile Virtual Access Point (VAP) settings. |
| | | **power\_level** integer | | Radio power level as a percentage of the maximum transmit power (0 - 100). |
| | | **power\_mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. |
| | | **power\_value** integer | | Radio EIRP power in dBm (1 - 33). |
| | | **radio\_id** integer | | radio-id |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **vap\_all** string | **Choices:*** enable
* disable
* tunnel
* bridge
* manual
| Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . |
| | | **vaps** list / elements=string | | Manually selected list of Virtual Access Points (VAPs). |
| | | | **name** string / required | | Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name. |
| | **radio\_3** dictionary | | Configuration options for radio 3. |
| | | **auto\_power\_high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_level** string | **Choices:*** enable
* disable
| Enable/disable automatic power-level adjustment to prevent co-channel interference . |
| | | **auto\_power\_low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20). |
| | | **band** string | **Choices:*** 802.11a
* 802.11b
* 802.11g
* 802.11n
* 802.11n-5G
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 3 operates on. |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **drma\_manual\_mode** string | **Choices:*** ap
* monitor
* ncf
* ncf-peek
| Radio mode to be used for DRMA manual mode . |
| | | **override\_analysis** string | **Choices:*** enable
* disable
| Enable to override the WTP profile spectrum analysis configuration. |
| | | **override\_band** string | **Choices:*** enable
* disable
| Enable to override the WTP profile band setting. |
| | | **override\_channel** string | **Choices:*** enable
* disable
| Enable to override WTP profile channel settings. |
| | | **override\_txpower** string | **Choices:*** enable
* disable
| Enable to override the WTP profile power level configuration. |
| | | **override\_vaps** string | **Choices:*** enable
* disable
| Enable to override WTP profile Virtual Access Point (VAP) settings. |
| | | **power\_level** integer | | Radio power level as a percentage of the maximum transmit power (0 - 100). |
| | | **power\_mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. |
| | | **power\_value** integer | | Radio EIRP power in dBm (1 - 33). |
| | | **radio\_id** integer | | radio-id |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **vap\_all** string | **Choices:*** enable
* disable
* tunnel
* bridge
* manual
| Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . |
| | | **vaps** list / elements=string | | Manually selected list of Virtual Access Points (VAPs). |
| | | | **name** string / required | | Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
| | **radio\_4** dictionary | | Configuration options for radio 4. |
| | | **auto\_power\_high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_level** string | **Choices:*** enable
* disable
| Enable/disable automatic power-level adjustment to prevent co-channel interference . |
| | | **auto\_power\_low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
| | | **auto\_power\_target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20). |
| | | **band** string | **Choices:*** 802.11a
* 802.11b
* 802.11g
* 802.11n
* 802.11n-5G
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 4 operates on. |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **drma\_manual\_mode** string | **Choices:*** ap
* monitor
* ncf
* ncf-peek
| Radio mode to be used for DRMA manual mode . |
| | | **override\_analysis** string | **Choices:*** enable
* disable
| Enable to override the WTP profile spectrum analysis configuration. |
| | | **override\_band** string | **Choices:*** enable
* disable
| Enable to override the WTP profile band setting. |
| | | **override\_channel** string | **Choices:*** enable
* disable
| Enable to override WTP profile channel settings. |
| | | **override\_txpower** string | **Choices:*** enable
* disable
| Enable to override the WTP profile power level configuration. |
| | | **override\_vaps** string | **Choices:*** enable
* disable
| Enable to override WTP profile Virtual Access Point (VAP) settings. |
| | | **power\_level** integer | | Radio power level as a percentage of the maximum transmit power (0 - 100). |
| | | **power\_mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. |
| | | **power\_value** integer | | Radio EIRP power in dBm (1 - 33). |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **vap\_all** string | **Choices:*** enable
* disable
* tunnel
* bridge
* manual
| Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . |
| | | **vaps** list / elements=string | | Manually selected list of Virtual Access Points (VAPs). |
| | | | **name** string / required | | Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
| | **region** string | | Region name WTP is associated with. Source wireless-controller.region.name. |
| | **region\_x** string | | Relative horizontal region coordinate (between 0 and 1). |
| | **region\_y** string | | Relative vertical region coordinate (between 0 and 1). |
| | **split\_tunneling\_acl** list / elements=string | | Split tunneling ACL filter list. |
| | | **dest\_ip** string | | Destination IP and mask for the split-tunneling subnet. |
| | | **id** integer / required | | ID. |
| | **split\_tunneling\_acl\_local\_ap\_subnet** string | **Choices:*** enable
* disable
| Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL . |
| | **split\_tunneling\_acl\_path** string | **Choices:*** tunnel
* local
| Split tunneling ACL path is local/tunnel. |
| | **tun\_mtu\_downlink** integer | | Downlink tunnel MTU in octets. Set the value to either 0 (by default), 576, or 1500. |
| | **tun\_mtu\_uplink** integer | | Uplink tunnel maximum transmission unit (MTU) in octets (eight-bit bytes). Set the value to either 0 (by default), 576, or 1500. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **wan\_port\_mode** string | **Choices:*** wan-lan
* wan-only
| Enable/disable using the FortiAP WAN port as a LAN port. |
| | **wtp\_id** string | | WTP ID. |
| | **wtp\_mode** string | **Choices:*** normal
* remote
| WTP, AP, or FortiAP operating mode; normal (by default) or remote. A tunnel mode SSID can be assigned to an AP in normal mode but not remote mode, while a local-bridge mode SSID can be assigned to an AP in either normal mode or remote mode. |
| | **wtp\_profile** string | | WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
fortios_wireless_controller_wtp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wtp:
admin: "discovered"
allowaccess: "telnet"
apcfg_profile: "<your_own_value> (source wireless-controller.apcfg-profile.name)"
bonjour_profile: "<your_own_value> (source wireless-controller.bonjour-profile.name)"
coordinate_enable: "enable"
coordinate_latitude: "<your_own_value>"
coordinate_longitude: "<your_own_value>"
coordinate_x: "<your_own_value>"
coordinate_y: "<your_own_value>"
firmware_provision: "<your_own_value>"
image_download: "enable"
index: "14"
ip_fragment_preventing: "tcp-mss-adjust"
lan:
port_esl_mode: "offline"
port_esl_ssid: "<your_own_value> (source system.interface.name)"
port_mode: "offline"
port_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port1_mode: "offline"
port1_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port2_mode: "offline"
port2_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port3_mode: "offline"
port3_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port4_mode: "offline"
port4_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port5_mode: "offline"
port5_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port6_mode: "offline"
port6_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port7_mode: "offline"
port7_ssid: "<your_own_value> (source wireless-controller.vap.name)"
port8_mode: "offline"
port8_ssid: "<your_own_value> (source wireless-controller.vap.name)"
led_state: "enable"
location: "<your_own_value>"
login_passwd: "<your_own_value>"
login_passwd_change: "yes"
mesh_bridge_enable: "default"
name: "default_name_42"
override_allowaccess: "enable"
override_ip_fragment: "enable"
override_lan: "enable"
override_led_state: "enable"
override_login_passwd_change: "enable"
override_split_tunnel: "enable"
override_wan_port_mode: "enable"
radio_1:
auto_power_high: "51"
auto_power_level: "enable"
auto_power_low: "53"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "64"
power_mode: "dBm"
power_value: "66"
radio_id: "67"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_71 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
radio_2:
auto_power_high: "73"
auto_power_level: "enable"
auto_power_low: "75"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "86"
power_mode: "dBm"
power_value: "88"
radio_id: "89"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_93 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
radio_3:
auto_power_high: "95"
auto_power_level: "enable"
auto_power_low: "97"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "108"
power_mode: "dBm"
power_value: "110"
radio_id: "111"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_115 (source wireless-controller.vap-group.name system.interface.name)"
radio_4:
auto_power_high: "117"
auto_power_level: "enable"
auto_power_low: "119"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "130"
power_mode: "dBm"
power_value: "132"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_136 (source wireless-controller.vap-group.name system.interface.name)"
region: "<your_own_value> (source wireless-controller.region.name)"
region_x: "<your_own_value>"
region_y: "<your_own_value>"
split_tunneling_acl:
-
dest_ip: "<your_own_value>"
id: "142"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
tun_mtu_downlink: "145"
tun_mtu_uplink: "146"
uuid: "<your_own_value>"
wan_port_mode: "wan-lan"
wtp_id: "<your_own_value>"
wtp_mode: "normal"
wtp_profile: "<your_own_value> (source wireless-controller.wtp-profile.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_flow_tracking – Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_flow\_tracking – Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_flow_tracking`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and flow\_tracking 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_flow\_tracking** dictionary | | Configure FortiSwitch flow tracking and export via ipfix/netflow. |
| | **aggregates** list / elements=string | | Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. |
| | | **id** integer / required | | Aggregate id. |
| | | **ip** string | | IP address to group all matching traffic sessions to a flow. |
| | **collector\_ip** string | | Configure collector ip address. |
| | **collector\_port** integer | | Configure collector port number(0-65535). |
| | **format** string | **Choices:*** netflow1
* netflow5
* netflow9
* ipfix
| Configure flow tracking protocol. |
| | **level** string | **Choices:*** vlan
* ip
* port
* proto
* mac
| Configure flow tracking level. |
| | **max\_export\_pkt\_size** integer | | Configure flow max export packet size (512-9216). |
| | **sample\_mode** string | **Choices:*** local
* perimeter
* device-ingress
| Configure sample mode for the flow tracking. |
| | **sample\_rate** integer | | Configure sample rate for the perimeter and device-ingress sampling(0 - 99999). |
| | **timeout\_general** integer | | Configure flow session general timeout (60-604800). |
| | **timeout\_icmp** integer | | Configure flow session ICMP timeout (60-604800). |
| | **timeout\_max** integer | | Configure flow session max timeout (60-604800). |
| | **timeout\_tcp** integer | | Configure flow session TCP timeout (60-604800). |
| | **timeout\_tcp\_fin** integer | | Configure flow session TCP FIN timeout (60-604800). |
| | **timeout\_tcp\_rst** integer | | Configure flow session TCP RST timeout (60-604800). |
| | **timeout\_udp** integer | | Configure flow session UDP timeout (60-604800). |
| | **transport** string | **Choices:*** udp
* tcp
* sctp
| Configure L4 transport protocol for exporting packets. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch flow tracking and export via ipfix/netflow.
fortios_switch_controller_flow_tracking:
vdom: "{{ vdom }}"
switch_controller_flow_tracking:
aggregates:
-
id: "4"
ip: "<your_own_value>"
collector_ip: "<your_own_value>"
collector_port: "7"
format: "netflow1"
level: "vlan"
max_export_pkt_size: "10"
sample_mode: "local"
sample_rate: "12"
timeout_general: "13"
timeout_icmp: "14"
timeout_max: "15"
timeout_tcp: "16"
timeout_tcp_fin: "17"
timeout_tcp_rst: "18"
timeout_udp: "19"
transport: "udp"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_emailfilter_iptrust – Configure AntiSpam IP trust in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_iptrust – Configure AntiSpam IP trust in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_emailfilter_iptrust`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and iptrust 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **emailfilter\_iptrust** dictionary | | Configure AntiSpam IP trust. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter trusted IP addresses. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
| Type of address. |
| | | **id** integer / required | | Trusted IP entry ID. |
| | | **ip4\_subnet** string | | IPv4 network address or network address/subnet mask bits. |
| | | **ip6\_subnet** string | | IPv6 network address/subnet mask bits. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam IP trust.
fortios_emailfilter_iptrust:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_iptrust:
comment: "Optional comments."
entries:
-
addr_type: "ipv4"
id: "6"
ip4_subnet: "<your_own_value>"
ip6_subnet: "<your_own_value>"
status: "enable"
id: "10"
name: "default_name_11"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_syslogd2_override_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd2\_override\_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd2_override_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd2 feature and override\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd2\_override\_filter** dictionary | | Override filters for remote system server. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **filter** string | | Syslog 2 filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override filters for remote system server.
fortios_log_syslogd2_override_filter:
vdom: "{{ vdom }}"
log_syslogd2_override_filter:
anomaly: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "11"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
severity: "emergency"
sniffer_traffic: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_alias – Configure alias command in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_alias – Configure alias command in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_alias`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and alias 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_alias** dictionary | | Configure alias command. |
| | **command** string | | Command list to execute. |
| | **name** string / required | | Alias command name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure alias command.
fortios_system_alias:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_alias:
command: "<your_own_value>"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_fortianalyzer_cloud_setting – Global FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_cloud\_setting – Global FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer_cloud_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer\_cloud feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer\_cloud\_setting** dictionary | | Global FortiAnalyzer Cloud settings. |
| | **\_\_change\_ip** integer | | Hidden attribute. |
| | **access\_config** string | **Choices:*** enable
* disable
| Enable/disable FortiAnalyzer access to configuration and data. |
| | **certificate** string | | Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. |
| | **conn\_timeout** integer | | FortiAnalyzer connection time-out in seconds (for status and log buffer). |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
| Enable/disable sending FortiAnalyzer log data with SSL encryption. |
| | **faz\_type** integer | | Hidden setting index of FortiAnalyzer. |
| | **hmac\_algorithm** string | **Choices:*** sha256
* sha1
| FortiAnalyzer IPsec tunnel HMAC algorithm. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ips\_archive** string | **Choices:*** enable
* disable
| Enable/disable IPS packet archive logging. |
| | **max\_log\_rate** integer | | FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
| | **mgmt\_name** string | | Hidden management name of FortiAnalyzer. |
| | **monitor\_failure\_retry\_period** integer | | Time between FortiAnalyzer connection retries in seconds (for status and log buffer). |
| | **monitor\_keepalive\_period** integer | | Time between OFTP keepalives in seconds (for status and log buffer). |
| | **preshared\_key** string | | Preshared-key used for auto-authorization on FortiAnalyzer. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **source\_ip** string | | Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiAnalyzer. |
| | **upload\_day** string | | Day of week (month) to upload logs. |
| | **upload\_interval** string | **Choices:*** daily
* weekly
* monthly
| Frequency to upload log files to FortiAnalyzer. |
| | **upload\_option** string | **Choices:*** store-and-upload
* realtime
* 1-minute
* 5-minute
| Enable/disable logging to hard disk and then uploading to FortiAnalyzer. |
| | **upload\_time** string | | Time to upload logs (hh:mm). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global FortiAnalyzer Cloud settings.
fortios_log_fortianalyzer_cloud_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_cloud_setting:
__change_ip: "3"
access_config: "enable"
certificate: "<your_own_value> (source certificate.local.name)"
conn_timeout: "6"
enc_algorithm: "high-medium"
faz_type: "8"
hmac_algorithm: "sha256"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
max_log_rate: "13"
mgmt_name: "<your_own_value>"
monitor_failure_retry_period: "15"
monitor_keepalive_period: "16"
preshared_key: "<your_own_value>"
priority: "default"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_krb_keytab – Configure Kerberos keytab entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_krb\_keytab – Configure Kerberos keytab entries in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_krb_keytab`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and krb\_keytab 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_krb\_keytab** dictionary | | Configure Kerberos keytab entries. |
| | **keytab** string | | base64 coded keytab file containing a pre-shared key. |
| | **ldap\_server** string | | LDAP server name. Source user.ldap.name. |
| | **name** string / required | | Kerberos keytab entry name. |
| | **pac\_data** string | **Choices:*** enable
* disable
| Enable/disable parsing PAC data in the ticket. |
| | **password** string | | Password for keytab. |
| | **principal** string | | Kerberos service principal, e.g. HTTP/[email protected]. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Kerberos keytab entries.
fortios_user_krb_keytab:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_krb_keytab:
keytab: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_5"
pac_data: "enable"
password: "<your_own_value>"
principal: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ssl_client – clien in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_client – clien in Fortinet’s FortiOS and FortiGate.
=======================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ssl_client`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ssl feature and client 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ssl\_client** dictionary | | client |
| | **certificate** string | | Certificate to offer to SSL VPN server if it requests one. Source vpn.certificate.local.name. |
| | **comment** string | | Comment. |
| | **distance** integer | | Distance for routes added by SSL VPN (1 - 255). |
| | **interface** string | | SSL interface to send/receive traffic over. Source system.interface.name. |
| | **name** string / required | | SSL VPN tunnel name. |
| | **peer** string | | Authenticate peer"s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name. |
| | **port** integer | | SSL VPN server port. |
| | **priority** integer | | Priority for routes added by SSL VPN (0 - 4294967295). |
| | **psk** string | | Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x). |
| | **server** string | | IPv4, IPv6 or DNS address of the SSL VPN server. |
| | **source\_ip** string | | IPv4 or IPv6 address to use as a source for the SSL VPN connection to the server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this SSL VPN client configuration. |
| | **user** string | | Username to offer to the peer to authenticate the client. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: client
fortios_vpn_ssl_client:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_client:
certificate: "<your_own_value> (source vpn.certificate.local.name)"
comment: "Comment."
distance: "5"
interface: "<your_own_value> (source system.interface.name)"
name: "default_name_7"
peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
port: "9"
priority: "10"
psk: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
user: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_dlp_filepattern – Configure file patterns used by DLP blocking in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dlp\_filepattern – Configure file patterns used by DLP blocking in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dlp_filepattern`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and filepattern 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dlp\_filepattern** dictionary | | Configure file patterns used by DLP blocking. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Configure file patterns used by DLP blocking. |
| | | **file\_type** string | **Choices:*** 7z
* arj
* cab
* lzh
* rar
* tar
* zip
* bzip
* gzip
* bzip2
* xz
* bat
* msc
* uue
* mime
* base64
* binhex
* elf
* exe
* hta
* html
* jad
* class
* cod
* javascript
* msoffice
* msofficex
* fsg
* upx
* petite
* aspack
* sis
* hlp
* activemime
* jpeg
* gif
* tiff
* png
* bmp
* ignored
* unknown
* mpeg
* mov
* mp3
* wma
* wav
* pdf
* avi
* rm
* torrent
* hibun
* msi
* mach-o
* dmg
* .net
* xar
* chm
* iso
* crx
* flac
| Select a file type. |
| | | **filter\_type** string | **Choices:*** pattern
* type
| Filter by file name pattern or by file type. |
| | | **pattern** string / required | | Add a file name pattern. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table containing the file pattern list. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure file patterns used by DLP blocking.
fortios_dlp_filepattern:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_filepattern:
comment: "Optional comments."
entries:
-
file_type: "7z"
filter_type: "pattern"
pattern: "<your_own_value>"
id: "8"
name: "default_name_9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_ntp – Configure system NTP information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ntp – Configure system NTP information in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ntp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ntp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_ntp** dictionary | | Configure system NTP information. |
| | **authentication** string | **Choices:*** enable
* disable
| Enable/disable authentication. |
| | **interface** list / elements=string | | FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **key** string | | Key for authentication. |
| | **key\_id** integer | | Key ID for authentication. |
| | **key\_type** string | **Choices:*** MD5
* SHA1
| Key type for authentication (MD5, SHA1). |
| | **ntpserver** list / elements=string | | Configure the FortiGate to connect to any available third-party NTP server. |
| | | **authentication** string | **Choices:*** enable
* disable
| Enable/disable MD5 authentication. |
| | | **id** integer / required | | NTP server ID. |
| | | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | | **key** string | | Key for MD5 authentication. |
| | | **key\_id** integer | | Key ID for authentication. |
| | | **ntpv3** string | **Choices:*** enable
* disable
| Enable to use NTPv3 instead of NTPv4. |
| | | **server** string | | IP address or hostname of the NTP Server. |
| | **ntpsync** string | **Choices:*** enable
* disable
| Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. |
| | **server\_mode** string | **Choices:*** enable
* disable
| Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. |
| | **source\_ip** string | | Source IP address for communication to the NTP server. |
| | **source\_ip6** string | | Source IPv6 address for communication to the NTP server. |
| | **syncinterval** integer | | NTP synchronization interval (1 - 1440 min). |
| | **type** string | **Choices:*** fortiguard
* custom
| Use the FortiGuard NTP server or any other available NTP Server. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure system NTP information.
fortios_system_ntp:
vdom: "{{ vdom }}"
system_ntp:
authentication: "enable"
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
key: "<your_own_value>"
key_id: "7"
key_type: "MD5"
ntpserver:
-
authentication: "enable"
id: "11"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
key: "<your_own_value>"
key_id: "15"
ntpv3: "enable"
server: "192.168.100.40"
ntpsync: "enable"
server_mode: "enable"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
syncinterval: "22"
type: "fortiguard"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_certificate_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_certificate_crl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_certificate feature and crl 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_certificate\_crl** dictionary | | Certificate Revocation List as a PEM file. |
| | **crl** string | | Certificate Revocation List as a PEM file. |
| | **http\_url** string | | HTTP server URL for CRL auto-update. |
| | **last\_updated** integer | | Time at which CRL was last updated. |
| | **ldap\_password** string | | LDAP server user password. |
| | **ldap\_server** string | | LDAP server name for CRL auto-update. |
| | **ldap\_username** string | | LDAP server user name. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either global or VDOM IP address range for the certificate. |
| | **scep\_cert** string | | Local certificate for SCEP communication for CRL auto-update. Source vpn.certificate.local.name. |
| | **scep\_url** string | | SCEP server URL for CRL auto-update. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Certificate source type. |
| | **source\_ip** string | | Source IP address for communications to a HTTP or SCEP CA server. |
| | **update\_interval** integer | | Time in seconds before the FortiGate checks for an updated CRL. Set to 0 to update only when it expires. |
| | **update\_vdom** string | | VDOM for CRL update. Source system.vdom.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Certificate Revocation List as a PEM file.
fortios_vpn_certificate_crl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_crl:
crl: "<your_own_value>"
http_url: "<your_own_value>"
last_updated: "5"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value>"
ldap_username: "<your_own_value>"
name: "default_name_9"
range: "global"
scep_cert: "<your_own_value> (source vpn.certificate.local.name)"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
update_interval: "15"
update_vdom: "<your_own_value> (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_voip_profile – Configure VoIP profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_voip\_profile – Configure VoIP profiles in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_voip_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify voip 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **voip\_profile** dictionary | | Configure VoIP profiles. |
| | **comment** string | | Comment. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow or proxy inspection feature set. |
| | **name** string / required | | Profile name. |
| | **sccp** dictionary | | SCCP. |
| | | **block\_mcast** string | **Choices:*** disable
* enable
| Enable/disable block multicast RTP connections. |
| | | **log\_call\_summary** string | **Choices:*** disable
* enable
| Enable/disable log summary of SCCP calls. |
| | | **log\_violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SCCP violations. |
| | | **max\_calls** integer | | Maximum calls per minute per SCCP client (max 65535). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable SCCP. |
| | | **verify\_header** string | **Choices:*** disable
* enable
| Enable/disable verify SCCP header content. |
| | **sip** dictionary | | SIP. |
| | | **ack\_rate** integer | | ACK request rate limit (per second, per policy). |
| | | **ack\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **block\_ack** string | **Choices:*** disable
* enable
| Enable/disable block ACK requests. |
| | | **block\_bye** string | **Choices:*** disable
* enable
| Enable/disable block BYE requests. |
| | | **block\_cancel** string | **Choices:*** disable
* enable
| Enable/disable block CANCEL requests. |
| | | **block\_geo\_red\_options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests, but OPTIONS requests still notify for redundancy. |
| | | **block\_info** string | **Choices:*** disable
* enable
| Enable/disable block INFO requests. |
| | | **block\_invite** string | **Choices:*** disable
* enable
| Enable/disable block INVITE requests. |
| | | **block\_long\_lines** string | **Choices:*** disable
* enable
| Enable/disable block requests with headers exceeding max-line-length. |
| | | **block\_message** string | **Choices:*** disable
* enable
| Enable/disable block MESSAGE requests. |
| | | **block\_notify** string | **Choices:*** disable
* enable
| Enable/disable block NOTIFY requests. |
| | | **block\_options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests and no OPTIONS as notifying message for redundancy either. |
| | | **block\_prack** string | **Choices:*** disable
* enable
| Enable/disable block prack requests. |
| | | **block\_publish** string | **Choices:*** disable
* enable
| Enable/disable block PUBLISH requests. |
| | | **block\_refer** string | **Choices:*** disable
* enable
| Enable/disable block REFER requests. |
| | | **block\_register** string | **Choices:*** disable
* enable
| Enable/disable block REGISTER requests. |
| | | **block\_subscribe** string | **Choices:*** disable
* enable
| Enable/disable block SUBSCRIBE requests. |
| | | **block\_unknown** string | **Choices:*** disable
* enable
| Block unrecognized SIP requests (enabled by default). |
| | | **block\_update** string | **Choices:*** disable
* enable
| Enable/disable block UPDATE requests. |
| | | **bye\_rate** integer | | BYE request rate limit (per second, per policy). |
| | | **bye\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **call\_keepalive** integer | | Continue tracking calls with no RTP for this many minutes. |
| | | **cancel\_rate** integer | | CANCEL request rate limit (per second, per policy). |
| | | **cancel\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **contact\_fixup** string | **Choices:*** disable
* enable
| Fixup contact anyway even if contact"s IP:port doesn"t match session"s IP:port. |
| | | **hnt\_restrict\_source\_ip** string | **Choices:*** disable
* enable
| Enable/disable restrict RTP source IP to be the same as SIP source IP when HNT is enabled. |
| | | **hosted\_nat\_traversal** string | **Choices:*** disable
* enable
| Hosted NAT Traversal (HNT). |
| | | **info\_rate** integer | | INFO request rate limit (per second, per policy). |
| | | **info\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **invite\_rate** integer | | INVITE request rate limit (per second, per policy). |
| | | **invite\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **ips\_rtp** string | **Choices:*** disable
* enable
| Enable/disable allow IPS on RTP. |
| | | **log\_call\_summary** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP call summary. |
| | | **log\_violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP violations. |
| | | **malformed\_header\_allow** string | **Choices:*** discard
* pass
* respond
| Action for malformed Allow header. |
| | | **malformed\_header\_call\_id** string | **Choices:*** discard
* pass
* respond
| Action for malformed Call-ID header. |
| | | **malformed\_header\_contact** string | **Choices:*** discard
* pass
* respond
| Action for malformed Contact header. |
| | | **malformed\_header\_content\_length** string | **Choices:*** discard
* pass
* respond
| Action for malformed Content-Length header. |
| | | **malformed\_header\_content\_type** string | **Choices:*** discard
* pass
* respond
| Action for malformed Content-Type header. |
| | | **malformed\_header\_cseq** string | **Choices:*** discard
* pass
* respond
| Action for malformed CSeq header. |
| | | **malformed\_header\_expires** string | **Choices:*** discard
* pass
* respond
| Action for malformed Expires header. |
| | | **malformed\_header\_from** string | **Choices:*** discard
* pass
* respond
| Action for malformed From header. |
| | | **malformed\_header\_max\_forwards** string | **Choices:*** discard
* pass
* respond
| Action for malformed Max-Forwards header. |
| | | **malformed\_header\_no\_proxy\_require** string | **Choices:*** discard
* pass
* respond
| Action for malformed SIP messages without Proxy-Require header. |
| | | **malformed\_header\_no\_require** string | **Choices:*** discard
* pass
* respond
| Action for malformed SIP messages without Require header. |
| | | **malformed\_header\_p\_asserted\_identity** string | **Choices:*** discard
* pass
* respond
| Action for malformed P-Asserted-Identity header. |
| | | **malformed\_header\_rack** string | **Choices:*** discard
* pass
* respond
| Action for malformed RAck header. |
| | | **malformed\_header\_record\_route** string | **Choices:*** discard
* pass
* respond
| Action for malformed Record-Route header. |
| | | **malformed\_header\_route** string | **Choices:*** discard
* pass
* respond
| Action for malformed Route header. |
| | | **malformed\_header\_rseq** string | **Choices:*** discard
* pass
* respond
| Action for malformed RSeq header. |
| | | **malformed\_header\_sdp\_a** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP a line. |
| | | **malformed\_header\_sdp\_b** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP b line. |
| | | **malformed\_header\_sdp\_c** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP c line. |
| | | **malformed\_header\_sdp\_i** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP i line. |
| | | **malformed\_header\_sdp\_k** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP k line. |
| | | **malformed\_header\_sdp\_m** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP m line. |
| | | **malformed\_header\_sdp\_o** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP o line. |
| | | **malformed\_header\_sdp\_r** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP r line. |
| | | **malformed\_header\_sdp\_s** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP s line. |
| | | **malformed\_header\_sdp\_t** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP t line. |
| | | **malformed\_header\_sdp\_v** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP v line. |
| | | **malformed\_header\_sdp\_z** string | **Choices:*** discard
* pass
* respond
| Action for malformed SDP z line. |
| | | **malformed\_header\_to** string | **Choices:*** discard
* pass
* respond
| Action for malformed To header. |
| | | **malformed\_header\_via** string | **Choices:*** discard
* pass
* respond
| Action for malformed VIA header. |
| | | **malformed\_request\_line** string | **Choices:*** discard
* pass
* respond
| Action for malformed request line. |
| | | **max\_body\_length** integer | | Maximum SIP message body length (0 meaning no limit). |
| | | **max\_dialogs** integer | | Maximum number of concurrent calls/dialogs (per policy). |
| | | **max\_idle\_dialogs** integer | | Maximum number established but idle dialogs to retain (per policy). |
| | | **max\_line\_length** integer | | Maximum SIP header line length (78-4096). |
| | | **message\_rate** integer | | MESSAGE request rate limit (per second, per policy). |
| | | **message\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **nat\_port\_range** string | | RTP NAT port range. |
| | | **nat\_trace** string | **Choices:*** disable
* enable
| Enable/disable preservation of original IP in SDP i line. |
| | | **no\_sdp\_fixup** string | **Choices:*** disable
* enable
| Enable/disable no SDP fix-up. |
| | | **notify\_rate** integer | | NOTIFY request rate limit (per second, per policy). |
| | | **notify\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **open\_contact\_pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for non-REGISTER Contact port. |
| | | **open\_record\_route\_pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Record-Route port. |
| | | **open\_register\_pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for REGISTER Contact port. |
| | | **open\_via\_pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Via port. |
| | | **options\_rate** integer | | OPTIONS request rate limit (per second, per policy). |
| | | **options\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **prack\_rate** integer | | PRACK request rate limit (per second, per policy). |
| | | **prack\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **preserve\_override** string | **Choices:*** disable
* enable
| Override i line to preserve original IPS . |
| | | **provisional\_invite\_expiry\_time** integer | | Expiry time for provisional INVITE (10 - 3600 sec). |
| | | **publish\_rate** integer | | PUBLISH request rate limit (per second, per policy). |
| | | **publish\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **refer\_rate** integer | | REFER request rate limit (per second, per policy). |
| | | **refer\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **register\_contact\_trace** string | **Choices:*** disable
* enable
| Enable/disable trace original IP/port within the contact header of REGISTER requests. |
| | | **register\_rate** integer | | REGISTER request rate limit (per second, per policy). |
| | | **register\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **rfc2543\_branch** string | **Choices:*** disable
* enable
| Enable/disable support via branch compliant with RFC 2543. |
| | | **rtp** string | **Choices:*** disable
* enable
| Enable/disable create pinholes for RTP traffic to traverse firewall. |
| | | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted in negotiation. |
| | | **ssl\_auth\_client** string | | Require a client certificate and authenticate it with the peer/peergrp. Source user.peer.name user.peergrp.name. |
| | | **ssl\_auth\_server** string | | Authenticate the server"s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name. |
| | | **ssl\_client\_certificate** string | | Name of Certificate to offer to server if requested. Source vpn.certificate.local.name. |
| | | **ssl\_client\_renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow/block client renegotiation by server. |
| | | **ssl\_max\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version to negotiate. |
| | | **ssl\_min\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version to negotiate. |
| | | **ssl\_mode** string | **Choices:*** False
* full
| SSL/TLS mode for encryption & decryption of traffic. |
| | | **ssl\_pfs** string | **Choices:*** require
* deny
* allow
| SSL Perfect Forward Secrecy. |
| | | **ssl\_send\_empty\_frags** string | **Choices:*** enable
* disable
| Send empty fragments to avoid attack on CBC IV (SSL 3.0 & TLS 1.0 only). |
| | | **ssl\_server\_certificate** string | | Name of Certificate return to the client in every SSL connection. Source vpn.certificate.local.name. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable SIP. |
| | | **strict\_register** string | **Choices:*** disable
* enable
| Enable/disable only allow the registrar to connect. |
| | | **subscribe\_rate** integer | | SUBSCRIBE request rate limit (per second, per policy). |
| | | **subscribe\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **unknown\_header** string | **Choices:*** discard
* pass
* respond
| Action for unknown SIP header. |
| | | **update\_rate** integer | | UPDATE request rate limit (per second, per policy). |
| | | **update\_rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VoIP profiles.
fortios_voip_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
voip_profile:
comment: "Comment."
feature_set: "flow"
name: "default_name_5"
sccp:
block_mcast: "disable"
log_call_summary: "disable"
log_violations: "disable"
max_calls: "10"
status: "disable"
verify_header: "disable"
sip:
ack_rate: "14"
ack_rate_track: "none"
block_ack: "disable"
block_bye: "disable"
block_cancel: "disable"
block_geo_red_options: "disable"
block_info: "disable"
block_invite: "disable"
block_long_lines: "disable"
block_message: "disable"
block_notify: "disable"
block_options: "disable"
block_prack: "disable"
block_publish: "disable"
block_refer: "disable"
block_register: "disable"
block_subscribe: "disable"
block_unknown: "disable"
block_update: "disable"
bye_rate: "33"
bye_rate_track: "none"
call_keepalive: "35"
cancel_rate: "36"
cancel_rate_track: "none"
contact_fixup: "disable"
hnt_restrict_source_ip: "disable"
hosted_nat_traversal: "disable"
info_rate: "41"
info_rate_track: "none"
invite_rate: "43"
invite_rate_track: "none"
ips_rtp: "disable"
log_call_summary: "disable"
log_violations: "disable"
malformed_header_allow: "discard"
malformed_header_call_id: "discard"
malformed_header_contact: "discard"
malformed_header_content_length: "discard"
malformed_header_content_type: "discard"
malformed_header_cseq: "discard"
malformed_header_expires: "discard"
malformed_header_from: "discard"
malformed_header_max_forwards: "discard"
malformed_header_no_proxy_require: "discard"
malformed_header_no_require: "discard"
malformed_header_p_asserted_identity: "discard"
malformed_header_rack: "discard"
malformed_header_record_route: "discard"
malformed_header_route: "discard"
malformed_header_rseq: "discard"
malformed_header_sdp_a: "discard"
malformed_header_sdp_b: "discard"
malformed_header_sdp_c: "discard"
malformed_header_sdp_i: "discard"
malformed_header_sdp_k: "discard"
malformed_header_sdp_m: "discard"
malformed_header_sdp_o: "discard"
malformed_header_sdp_r: "discard"
malformed_header_sdp_s: "discard"
malformed_header_sdp_t: "discard"
malformed_header_sdp_v: "discard"
malformed_header_sdp_z: "discard"
malformed_header_to: "discard"
malformed_header_via: "discard"
malformed_request_line: "discard"
max_body_length: "79"
max_dialogs: "80"
max_idle_dialogs: "81"
max_line_length: "82"
message_rate: "83"
message_rate_track: "none"
nat_port_range: "<your_own_value>"
nat_trace: "disable"
no_sdp_fixup: "disable"
notify_rate: "88"
notify_rate_track: "none"
open_contact_pinhole: "disable"
open_record_route_pinhole: "disable"
open_register_pinhole: "disable"
open_via_pinhole: "disable"
options_rate: "94"
options_rate_track: "none"
prack_rate: "96"
prack_rate_track: "none"
preserve_override: "disable"
provisional_invite_expiry_time: "99"
publish_rate: "100"
publish_rate_track: "none"
refer_rate: "102"
refer_rate_track: "none"
register_contact_trace: "disable"
register_rate: "105"
register_rate_track: "none"
rfc2543_branch: "disable"
rtp: "disable"
ssl_algorithm: "high"
ssl_auth_client: "<your_own_value> (source user.peer.name user.peergrp.name)"
ssl_auth_server: "<your_own_value> (source user.peer.name user.peergrp.name)"
ssl_client_certificate: "<your_own_value> (source vpn.certificate.local.name)"
ssl_client_renegotiation: "allow"
ssl_max_version: "ssl-3.0"
ssl_min_version: "ssl-3.0"
ssl_mode: "off"
ssl_pfs: "require"
ssl_send_empty_frags: "enable"
ssl_server_certificate: "<your_own_value> (source vpn.certificate.local.name)"
status: "disable"
strict_register: "disable"
subscribe_rate: "122"
subscribe_rate_track: "none"
unknown_header: "discard"
update_rate: "125"
update_rate_track: "none"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_vpn_ssl_settings – Configure SSL VPN in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_settings – Configure SSL VPN in Fortinet’s FortiOS and FortiGate.
=====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ssl_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ssl feature and settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **vpn\_ssl\_settings** dictionary | | Configure SSL VPN. |
| | **algorithm** string | **Choices:*** high
* medium
* default
* low
| Force the SSL-VPN security level. High allows only high. Medium allows medium and high. Low allows any. |
| | **auth\_session\_check\_source\_ip** string | **Choices:*** enable
* disable
| Enable/disable checking of source IP for authentication session. |
| | **auth\_timeout** integer | | SSL-VPN authentication timeout (1 - 259200 sec (3 days), 0 for no timeout). |
| | **authentication\_rule** list / elements=string | | Authentication rule for SSL VPN. |
| | | **auth** string | **Choices:*** any
* local
* radius
* tacacs+
* ldap
| SSL VPN authentication method restriction. |
| | | **cipher** string | **Choices:*** any
* high
* medium
| SSL VPN cipher strength. |
| | | **client\_cert** string | **Choices:*** enable
* disable
| Enable/disable SSL VPN client certificate restrictive. |
| | | **groups** list / elements=string | | User groups. |
| | | | **name** string / required | | Group name. Source user.group.name. |
| | | **id** integer / required | | ID (0 - 4294967295). |
| | | **portal** string | | SSL VPN portal. Source vpn.ssl.web.portal.name. |
| | | **realm** string | | SSL VPN realm. Source vpn.ssl.web.realm.url-path. |
| | | **source\_address** list / elements=string | | Source address of incoming traffic. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **source\_address6** list / elements=string | | IPv6 source address of incoming traffic. |
| | | | **name** string / required | | IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **source\_address6\_negate** string | **Choices:*** enable
* disable
| Enable/disable negated source IPv6 address match. |
| | | **source\_address\_negate** string | **Choices:*** enable
* disable
| Enable/disable negated source address match. |
| | | **source\_interface** list / elements=string | | SSL VPN source interface of incoming traffic. |
| | | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | | **user\_peer** string | | Name of user peer. Source user.peer.name. |
| | | **users** list / elements=string | | User name. |
| | | | **name** string / required | | User name. Source user.local.name. |
| | **auto\_tunnel\_static\_route** string | **Choices:*** enable
* disable
| Enable to auto-create static routes for the SSL-VPN tunnel IP addresses. |
| | **banned\_cipher** list / elements=string | **Choices:*** RSA
* DH
* DHE
* ECDH
* ECDHE
* DSS
* ECDSA
* AES
* AESGCM
* CAMELLIA
* 3DES
* SHA1
* SHA256
* SHA384
* STATIC
* CHACHA20
* ARIA
* AESCCM
| Select one or more cipher technologies that cannot be used in SSL-VPN negotiations. |
| | **check\_referer** string | **Choices:*** enable
* disable
| Enable/disable verification of referer field in HTTP request header. |
| | **ciphersuite** list / elements=string | **Choices:*** TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
* TLS-AES-128-CCM-SHA256
* TLS-AES-128-CCM-8-SHA256
| Select one or more TLS 1.3 ciphersuites to enable. Does not affect ciphers in TLS 1.2 and below. At least one must be enabled. To disable all, set ssl-max-proto-ver to tls1-2 or below. |
| | **client\_sigalgs** string | **Choices:*** no-rsa-pss
* all
| Set signature algorithms related to client authentication. Affects TLS version <= 1.2 only. |
| | **default\_portal** string | | Default SSL VPN portal. Source vpn.ssl.web.portal.name. |
| | **deflate\_compression\_level** integer | | Compression level (0~9). |
| | **deflate\_min\_data\_size** integer | | Minimum amount of data that triggers compression (200 - 65535 bytes). |
| | **dns\_server1** string | | DNS server 1. |
| | **dns\_server2** string | | DNS server 2. |
| | **dns\_suffix** string | | DNS suffix used for SSL-VPN clients. |
| | **dtls\_hello\_timeout** integer | | SSLVPN maximum DTLS hello timeout (10 - 60 sec). |
| | **dtls\_max\_proto\_ver** string | **Choices:*** dtls1-0
* dtls1-2
| DTLS maximum protocol version. |
| | **dtls\_min\_proto\_ver** string | **Choices:*** dtls1-0
* dtls1-2
| DTLS minimum protocol version. |
| | **dtls\_tunnel** string | **Choices:*** enable
* disable
| Enable DTLS to prevent eavesdropping, tampering, or message forgery. |
| | **dual\_stack\_mode** string | **Choices:*** enable
* disable
| Tunnel mode: enable parallel IPv4 and IPv6 tunnel. Web mode: support IPv4 and IPv6 bookmarks in the portal. |
| | **encode\_2f\_sequence** string | **Choices:*** enable
* disable
| Encode 2F sequence to forward slash in URLs. |
| | **encrypt\_and\_store\_password** string | **Choices:*** enable
* disable
| Encrypt and store user passwords for SSL VPN web sessions. |
| | **force\_two\_factor\_auth** string | **Choices:*** enable
* disable
| Enable to force two-factor authentication for all SSL-VPNs. |
| | **header\_x\_forwarded\_for** string | **Choices:*** pass
* add
* remove
| Forward the same, add, or remove HTTP header. |
| | **hsts\_include\_subdomains** string | **Choices:*** enable
* disable
| Add HSTS includeSubDomains response header. |
| | **http\_compression** string | **Choices:*** enable
* disable
| Enable to allow HTTP compression over SSL-VPN tunnels. |
| | **http\_only\_cookie** string | **Choices:*** enable
* disable
| Enable/disable SSL-VPN support for HttpOnly cookies. |
| | **http\_request\_body\_timeout** integer | | SSL-VPN session is disconnected if an HTTP request body is not received within this time (1 - 60 sec). |
| | **http\_request\_header\_timeout** integer | | SSL-VPN session is disconnected if an HTTP request header is not received within this time (1 - 60 sec). |
| | **https\_redirect** string | **Choices:*** enable
* disable
| Enable/disable redirect of port 80 to SSL-VPN port. |
| | **idle\_timeout** integer | | SSL VPN disconnects if idle for specified time in seconds. |
| | **ipv6\_dns\_server1** string | | IPv6 DNS server 1. |
| | **ipv6\_dns\_server2** string | | IPv6 DNS server 2. |
| | **ipv6\_wins\_server1** string | | IPv6 WINS server 1. |
| | **ipv6\_wins\_server2** string | | IPv6 WINS server 2. |
| | **login\_attempt\_limit** integer | | SSL VPN maximum login attempt times before block (0 - 10). |
| | **login\_block\_time** integer | | Time for which a user is blocked from logging in after too many failed login attempts (0 - 86400 sec). |
| | **login\_timeout** integer | | SSLVPN maximum login timeout (10 - 180 sec). |
| | **port** integer | | SSL-VPN access port (1 - 65535). |
| | **port\_precedence** string | **Choices:*** enable
* disable
| Enable means that if SSL-VPN connections are allowed on an interface admin GUI connections are blocked on that interface. |
| | **reqclientcert** string | **Choices:*** enable
* disable
| Enable to require client certificates for all SSL-VPN users. |
| | **route\_source\_interface** string | **Choices:*** enable
* disable
| Enable to allow SSL-VPN sessions to bypass routing and bind to the incoming interface. |
| | **servercert** string | | Name of the server certificate to be used for SSL-VPNs. Source vpn.certificate.local.name. |
| | **source\_address** list / elements=string | | Source address of incoming traffic. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **source\_address6** list / elements=string | | IPv6 source address of incoming traffic. |
| | | **name** string / required | | IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **source\_address6\_negate** string | **Choices:*** enable
* disable
| Enable/disable negated source IPv6 address match. |
| | **source\_address\_negate** string | **Choices:*** enable
* disable
| Enable/disable negated source address match. |
| | **source\_interface** list / elements=string | | SSL VPN source interface of incoming traffic. |
| | | **name** string / required | | Interface name. Source system.interface.name system.zone.name. |
| | **ssl\_client\_renegotiation** string | **Choices:*** disable
* enable
| Enable to allow client renegotiation by the server if the tunnel goes down. |
| | **ssl\_insert\_empty\_fragment** string | **Choices:*** enable
* disable
| Enable/disable insertion of empty fragment. |
| | **ssl\_max\_proto\_ver** string | **Choices:*** tls1-0
* tls1-1
* tls1-2
* tls1-3
| SSL maximum protocol version. |
| | **ssl\_min\_proto\_ver** string | **Choices:*** tls1-0
* tls1-1
* tls1-2
* tls1-3
| SSL minimum protocol version. |
| | **tlsv1\_0** string | **Choices:*** enable
* disable
| Enable/disable TLSv1.0. |
| | **tlsv1\_1** string | **Choices:*** enable
* disable
| Enable/disable TLSv1.1. |
| | **tlsv1\_2** string | **Choices:*** enable
* disable
| Enable/disable TLSv1.2. |
| | **tlsv1\_3** string | **Choices:*** enable
* disable
| tlsv1-3 |
| | **transform\_backward\_slashes** string | **Choices:*** enable
* disable
| Transform backward slashes to forward slashes in URLs. |
| | **tunnel\_addr\_assigned\_method** string | **Choices:*** first-available
* round-robin
| Method used for assigning address for tunnel. |
| | **tunnel\_connect\_without\_reauth** string | **Choices:*** enable
* disable
| Enable/disable tunnel connection without re-authorization if previous connection dropped. |
| | **tunnel\_ip\_pools** list / elements=string | | Names of the IPv4 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **tunnel\_ipv6\_pools** list / elements=string | | Names of the IPv6 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **tunnel\_user\_session\_timeout** integer | | Time out value to clean up user session after tunnel connection is dropped (1 - 255 sec). |
| | **unsafe\_legacy\_renegotiation** string | **Choices:*** enable
* disable
| Enable/disable unsafe legacy re-negotiation. |
| | **url\_obscuration** string | **Choices:*** enable
* disable
| Enable to obscure the host name of the URL of the web browser display. |
| | **user\_peer** string | | Name of user peer. Source user.peer.name. |
| | **wins\_server1** string | | WINS server 1. |
| | **wins\_server2** string | | WINS server 2. |
| | **x\_content\_type\_options** string | **Choices:*** enable
* disable
| Add HTTP X-Content-Type-Options header. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SSL VPN.
fortios_vpn_ssl_settings:
vdom: "{{ vdom }}"
vpn_ssl_settings:
algorithm: "high"
auth_session_check_source_ip: "enable"
auth_timeout: "5"
authentication_rule:
-
auth: "any"
cipher: "any"
client_cert: "enable"
groups:
-
name: "default_name_11 (source user.group.name)"
id: "12"
portal: "<your_own_value> (source vpn.ssl.web.portal.name)"
realm: "<your_own_value> (source vpn.ssl.web.realm.url-path)"
source_address:
-
name: "default_name_16 (source firewall.address.name firewall.addrgrp.name)"
source_address_negate: "enable"
source_address6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
source_address6_negate: "enable"
source_interface:
-
name: "default_name_22 (source system.interface.name system.zone.name)"
user_peer: "<your_own_value> (source user.peer.name)"
users:
-
name: "default_name_25 (source user.local.name)"
auto_tunnel_static_route: "enable"
banned_cipher: "RSA"
check_referer: "enable"
ciphersuite: "TLS-AES-128-GCM-SHA256"
client_sigalgs: "no-rsa-pss"
default_portal: "<your_own_value> (source vpn.ssl.web.portal.name)"
deflate_compression_level: "32"
deflate_min_data_size: "33"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_suffix: "<your_own_value>"
dtls_hello_timeout: "37"
dtls_max_proto_ver: "dtls1-0"
dtls_min_proto_ver: "dtls1-0"
dtls_tunnel: "enable"
dual_stack_mode: "enable"
encode_2f_sequence: "enable"
encrypt_and_store_password: "enable"
force_two_factor_auth: "enable"
header_x_forwarded_for: "pass"
hsts_include_subdomains: "enable"
http_compression: "enable"
http_only_cookie: "enable"
http_request_body_timeout: "49"
http_request_header_timeout: "50"
https_redirect: "enable"
idle_timeout: "52"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
ipv6_wins_server1: "<your_own_value>"
ipv6_wins_server2: "<your_own_value>"
login_attempt_limit: "57"
login_block_time: "58"
login_timeout: "59"
port: "60"
port_precedence: "enable"
reqclientcert: "enable"
route_source_interface: "enable"
servercert: "<your_own_value> (source vpn.certificate.local.name)"
source_address:
-
name: "default_name_66 (source firewall.address.name firewall.addrgrp.name)"
source_address_negate: "enable"
source_address6:
-
name: "default_name_69 (source firewall.address6.name firewall.addrgrp6.name)"
source_address6_negate: "enable"
source_interface:
-
name: "default_name_72 (source system.interface.name system.zone.name)"
ssl_client_renegotiation: "disable"
ssl_insert_empty_fragment: "enable"
ssl_max_proto_ver: "tls1-0"
ssl_min_proto_ver: "tls1-0"
tlsv1_0: "enable"
tlsv1_1: "enable"
tlsv1_2: "enable"
tlsv1_3: "enable"
transform_backward_slashes: "enable"
tunnel_addr_assigned_method: "first-available"
tunnel_connect_without_reauth: "enable"
tunnel_ip_pools:
-
name: "default_name_85 (source firewall.address.name firewall.addrgrp.name)"
tunnel_ipv6_pools:
-
name: "default_name_87 (source firewall.address6.name firewall.addrgrp6.name)"
tunnel_user_session_timeout: "88"
unsafe_legacy_renegotiation: "enable"
url_obscuration: "enable"
user_peer: "<your_own_value> (source user.peer.name)"
wins_server1: "<your_own_value>"
wins_server2: "<your_own_value>"
x_content_type_options: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer_cloud_override_setting – Override FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_cloud\_override\_setting – Override FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate.
===================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer_cloud_override_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer\_cloud feature and override\_setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer\_cloud\_override\_setting** dictionary | | Override FortiAnalyzer Cloud settings. |
| | **faz\_type** integer | | Hidden setting index of FortiAnalyzer. |
| | **override** string | **Choices:*** enable
* disable
| Enable/disable overriding FortiAnalyzer settings or use global settings. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiAnalyzer. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override FortiAnalyzer Cloud settings.
fortios_log_fortianalyzer_cloud_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_cloud_override_setting:
faz_type: "3"
override: "enable"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_sdwan – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sdwan – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.
================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_sdwan`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sdwan 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_sdwan** dictionary | | Configure redundant internet connections using SD-WAN (formerly virtual WAN link). |
| | **duplication** list / elements=string | | Create SD-WAN duplication rule. |
| | | **dstaddr** list / elements=string | | Destination address or address group names. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **dstaddr6** list / elements=string | | Destination address6 or address6 group names. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **dstintf** list / elements=string | | Outgoing (egress) interfaces or zones. |
| | | | **name** string / required | | Interface, zone or SDWAN zone name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
| | | **id** integer / required | | Duplication rule ID (1 - 255). |
| | | **packet\_de\_duplication** string | **Choices:*** enable
* disable
| Enable/disable discarding of packets that have been duplicated. |
| | | **packet\_duplication** string | **Choices:*** disable
* force
* on-demand
| Configure packet duplication method. |
| | | **service** list / elements=string | | Service and service group name. |
| | | | **name** string / required | | Service and service group name. Source firewall.service.custom.name firewall.service.group.name. |
| | | **service\_id** list / elements=string | | SD-WAN service rule ID list. |
| | | | **id** integer / required | | SD-WAN service rule ID. Source system.sdwan.service.id. |
| | | **srcaddr** list / elements=string | | Source address or address group names. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **srcaddr6** list / elements=string | | Source address6 or address6 group names. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **srcintf** list / elements=string | | Incoming (ingress) interfaces or zones. |
| | | | **name** string / required | | Interface, zone or SDWAN zone name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
| | **duplication\_max\_num** integer | | Maximum number of interface members a packet is duplicated in the SD-WAN zone (2 - 4). |
| | **fail\_alert\_interfaces** list / elements=string | | Physical interfaces that will be alerted. |
| | | **name** string / required | | Physical interface name. Source system.interface.name. |
| | **fail\_detect** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN Internet connection status checking (failure detection). |
| | **health\_check** list / elements=string | | SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can communicate with it. |
| | | **addr\_mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | | **detect\_mode** string | **Choices:*** active
* passive
* prefer-passive
| The mode determining how to detect the server. |
| | | **diffservcode** string | | Differentiated services code point (DSCP) in the IP header of the probe packet. |
| | | **dns\_match\_ip** string | | Response IP expected from DNS server if the protocol is DNS. |
| | | **dns\_request\_domain** string | | Fully qualified domain name to resolve for the DNS probe. |
| | | **failtime** integer | | Number of failures before server is considered lost (1 - 3600). |
| | | **ftp\_file** string | | Full path and file name on the FTP server to download for FTP health-check to probe. |
| | | **ftp\_mode** string | **Choices:*** passive
* port
| FTP mode. |
| | | **ha\_priority** integer | | HA election priority (1 - 50). |
| | | **http\_agent** string | | String in the http-agent field in the HTTP header. |
| | | **http\_get** string | | URL used to communicate with the server if the protocol if the protocol is HTTP. |
| | | **http\_match** string | | Response string expected from the server if the protocol is HTTP. |
| | | **interval** integer | | Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600\*1000 msec). |
| | | **members** list / elements=string | | Member sequence number list. |
| | | | **seq\_num** integer | | Member sequence number. Source system.sdwan.members.seq-num. |
| | | **name** string / required | | Status check or health check name. |
| | | **packet\_size** integer | | Packet size of a twamp test session, |
| | | **password** string | | Twamp controller password in authentication mode |
| | | **port** integer | | Port number used to communicate with the server over the selected protocol (0-65535). |
| | | **probe\_count** integer | | Number of most recent probes that should be used to calculate latency and jitter (5 - 30). |
| | | **probe\_packets** string | **Choices:*** disable
* enable
| Enable/disable transmission of probe packets. |
| | | **probe\_timeout** integer | | Time to wait before a probe packet is considered lost (500 - 3600\*1000 msec). |
| | | **protocol** string | **Choices:*** ping
* tcp-echo
* udp-echo
* http
* twamp
* dns
* tcp-connect
* ftp
* ping6
| Protocol used to determine if the FortiGate can communicate with the server. |
| | | **quality\_measured\_method** string | **Choices:*** half-open
* half-close
| Method to measure the quality of tcp-connect. |
| | | **recoverytime** integer | | Number of successful responses received before server is considered recovered (1 - 3600). |
| | | **security\_mode** string | **Choices:*** none
* authentication
| Twamp controller security mode. |
| | | **server** string | | IP address or FQDN name of the server. |
| | | **sla** list / elements=string | | Service level agreement (SLA). |
| | | | **id** integer / required | | SLA ID. |
| | | | **jitter\_threshold** integer | | Jitter for SLA to make decision in milliseconds. (0 - 10000000). |
| | | | **latency\_threshold** integer | | Latency for SLA to make decision in milliseconds. (0 - 10000000). |
| | | | **link\_cost\_factor** string | **Choices:*** latency
* jitter
* packet-loss
| Criteria on which to base link selection. |
| | | | **packetloss\_threshold** integer | | Packet loss for SLA to make decision in percentage. (0 - 100). |
| | | **sla\_fail\_log\_period** integer | | Time interval in seconds that SLA fail log messages will be generated (0 - 3600). |
| | | **sla\_pass\_log\_period** integer | | Time interval in seconds that SLA pass log messages will be generated (0 - 3600). |
| | | **system\_dns** string | **Choices:*** disable
* enable
| Enable/disable system DNS as the probe server. |
| | | **threshold\_alert\_jitter** integer | | Alert threshold for jitter (ms). |
| | | **threshold\_alert\_latency** integer | | Alert threshold for latency (ms). |
| | | **threshold\_alert\_packetloss** integer | | Alert threshold for packet loss (percentage). |
| | | **threshold\_warning\_jitter** integer | | Warning threshold for jitter (ms). |
| | | **threshold\_warning\_latency** integer | | Warning threshold for latency (ms). |
| | | **threshold\_warning\_packetloss** integer | | Warning threshold for packet loss (percentage). |
| | | **update\_cascade\_interface** string | **Choices:*** enable
* disable
| Enable/disable update cascade interface. |
| | | **update\_static\_route** string | **Choices:*** enable
* disable
| Enable/disable updating the static route. |
| | | **user** string | | The user name to access probe server. |
| | **load\_balance\_mode** string | **Choices:*** source-ip-based
* weight-based
* usage-based
* source-dest-ip-based
* measured-volume-based
| Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. |
| | **members** list / elements=string | | FortiGate interfaces added to the SD-WAN. |
| | | **comment** string | | Comments. |
| | | **cost** integer | | Cost of this interface for services in SLA mode (0 - 4294967295). |
| | | **gateway** string | | The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to. |
| | | **gateway6** string | | IPv6 gateway. |
| | | **ingress\_spillover\_threshold** integer | | Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
| | | **interface** string | | Interface name. Source system.interface.name. |
| | | **priority** integer | | Priority of the interface (0 - 65535). Used for SD-WAN rules or priority rules. |
| | | **priority6** integer | | Priority of the interface for IPv6 (1 - 65535). Used for SD-WAN rules or priority rules. |
| | | **seq\_num** integer | | Sequence number(1-512). |
| | | **source** string | | Source IP address used in the health-check packet to the server. |
| | | **source6** string | | Source IPv6 address used in the health-check packet to the server. |
| | | **spillover\_threshold** integer | | Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this interface in the SD-WAN. |
| | | **volume\_ratio** integer | | Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255). |
| | | **weight** integer | | Weight of this interface for weighted load balancing. (1 - 255) More traffic is directed to interfaces with higher weights. |
| | | **zone** string | | Zone name. Source system.sdwan.zone.name. |
| | **neighbor** list / elements=string | | Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status. |
| | | **health\_check** string | | SD-WAN health-check name. Source system.sdwan.health-check.name. |
| | | **ip** string / required | | IP/IPv6 address of neighbor. Source router.bgp.neighbor.ip. |
| | | **member** integer | | Member sequence number. Source system.sdwan.members.seq-num. |
| | | **role** string | **Choices:*** standalone
* primary
* secondary
| Role of neighbor. |
| | | **sla\_id** integer | | SLA ID. |
| | **neighbor\_hold\_boot\_time** integer | | Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. (0 - 10000000). |
| | **neighbor\_hold\_down** string | **Choices:*** enable
* disable
| Enable/disable hold switching from the secondary neighbor to the primary neighbor. |
| | **neighbor\_hold\_down\_time** integer | | Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. (0 - 10000000). |
| | **service** list / elements=string | | Create SD-WAN rules (also called services) to control how sessions are distributed to interfaces in the SD-WAN. |
| | | **addr\_mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | | **bandwidth\_weight** integer | | Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. |
| | | **default** string | **Choices:*** enable
* disable
| Enable/disable use of SD-WAN as default service. |
| | | **dscp\_forward** string | **Choices:*** enable
* disable
| Enable/disable forward traffic DSCP tag. |
| | | **dscp\_forward\_tag** string | | Forward traffic DSCP tag. |
| | | **dscp\_reverse** string | **Choices:*** enable
* disable
| Enable/disable reverse traffic DSCP tag. |
| | | **dscp\_reverse\_tag** string | | Reverse traffic DSCP tag. |
| | | **dst** list / elements=string | | Destination address name. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **dst6** list / elements=string | | Destination address6 name. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **dst\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of destination address match. |
| | | **end\_port** integer | | End destination port number. |
| | | **gateway** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN service gateway. |
| | | **groups** list / elements=string | | User groups. |
| | | | **name** string / required | | Group name. Source user.group.name. |
| | | **hash\_mode** string | **Choices:*** round-robin
* source-ip-based
* source-dest-ip-based
* inbandwidth
* outbandwidth
* bibandwidth
| Hash algorithm for selected priority members for load balance mode. |
| | | **health\_check** list / elements=string | | Health check list. |
| | | | **name** string / required | | Health check name. Source system.sdwan.health-check.name. |
| | | **hold\_down\_time** integer | | Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000). |
| | | **id** integer / required | | SD-WAN rule ID (1 - 4000). |
| | | **input\_device** list / elements=string | | Source interface name. |
| | | | **name** string / required | | Interface name. Source system.interface.name. |
| | | **input\_device\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of input device match. |
| | | **internet\_service** string | **Choices:*** enable
* disable
| Enable/disable use of Internet service for application-based load balancing. |
| | | **internet\_service\_app\_ctrl** list / elements=string | | Application control based Internet Service ID list. |
| | | | **id** integer / required | | Application control based Internet Service ID. |
| | | **internet\_service\_app\_ctrl\_group** list / elements=string | | Application control based Internet Service group list. |
| | | | **name** string / required | | Application control based Internet Service group name. Source application.group.name. |
| | | **internet\_service\_custom** list / elements=string | | Custom Internet service name list. |
| | | | **name** string / required | | Custom Internet service name. Source firewall.internet-service-custom.name. |
| | | **internet\_service\_custom\_group** list / elements=string | | Custom Internet Service group list. |
| | | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | | **internet\_service\_group** list / elements=string | | Internet Service group list. |
| | | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | | **internet\_service\_name** list / elements=string | | Internet service name list. |
| | | | **name** string / required | | Internet service name. Source firewall.internet-service-name.name. |
| | | **jitter\_weight** integer | | Coefficient of jitter in the formula of custom-profile-1. |
| | | **latency\_weight** integer | | Coefficient of latency in the formula of custom-profile-1. |
| | | **link\_cost\_factor** string | **Choices:*** latency
* jitter
* packet-loss
* inbandwidth
* outbandwidth
* bibandwidth
* custom-profile-1
| Link cost factor. |
| | | **link\_cost\_threshold** integer | | Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000). |
| | | **minimum\_sla\_meet\_members** integer | | Minimum number of members which meet SLA. |
| | | **mode** string | **Choices:*** auto
* manual
* priority
* sla
* load-balance
| Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN. |
| | | **name** string | | SD-WAN rule name. |
| | | **packet\_loss\_weight** integer | | Coefficient of packet-loss in the formula of custom-profile-1. |
| | | **priority\_members** list / elements=string | | Member sequence number list. |
| | | | **seq\_num** integer | | Member sequence number. Source system.sdwan.members.seq-num. |
| | | **protocol** integer | | Protocol number. |
| | | **quality\_link** integer | | Quality grade. |
| | | **role** string | **Choices:*** standalone
* primary
* secondary
| Service role to work with neighbor. |
| | | **route\_tag** integer | | IPv4 route map route-tag. |
| | | **sla** list / elements=string | | Service level agreement (SLA). |
| | | | **health\_check** string | | SD-WAN health-check. Source system.sdwan.health-check.name. |
| | | | **id** integer | | SLA ID. |
| | | **sla\_compare\_method** string | **Choices:*** order
* number
| Method to compare SLA value for SLA mode. |
| | | **src** list / elements=string | | Source address name. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **src6** list / elements=string | | Source address6 name. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **src\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of source address match. |
| | | **standalone\_action** string | **Choices:*** enable
* disable
| Enable/disable service when selected neighbor role is standalone while service role is not standalone. |
| | | **start\_port** integer | | Start destination port number. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN service. |
| | | **tie\_break** string | **Choices:*** zone
* cfg-order
* fib-best-match
| Method of selecting member if more than one meets the SLA. |
| | | **tos** string | | Type of service bit pattern. |
| | | **tos\_mask** string | | Type of service evaluated bits. |
| | | **use\_shortcut\_sla** string | **Choices:*** enable
* disable
| Enable/disable use of ADVPN shortcut for quality comparison. |
| | | **users** list / elements=string | | User name. |
| | | | **name** string / required | | User name. Source user.local.name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN. |
| | **zone** list / elements=string | | Configure SD-WAN zones. |
| | | **name** string / required | | Zone name. |
| | | **service\_sla\_tie\_break** string | **Choices:*** cfg-order
* fib-best-match
| Method of selecting member if more than one meets the SLA. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fortios_system_sdwan:
vdom: "{{ vdom }}"
system_sdwan:
duplication:
-
dstaddr:
-
name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_7 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_9 (source system.interface.name system.zone.name system.sdwan.zone.name)"
id: "10"
packet_de_duplication: "enable"
packet_duplication: "disable"
service:
-
name: "default_name_14 (source firewall.service.custom.name firewall.service.group.name)"
service_id:
-
id: "16 (source system.sdwan.service.id)"
srcaddr:
-
name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_22 (source system.interface.name system.zone.name system.sdwan.zone.name)"
duplication_max_num: "23"
fail_alert_interfaces:
-
name: "default_name_25 (source system.interface.name)"
fail_detect: "enable"
health_check:
-
addr_mode: "ipv4"
detect_mode: "active"
diffservcode: "<your_own_value>"
dns_match_ip: "<your_own_value>"
dns_request_domain: "<your_own_value>"
failtime: "33"
ftp_file: "<your_own_value>"
ftp_mode: "passive"
ha_priority: "36"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "40"
members:
-
seq_num: "42 (source system.sdwan.members.seq-num)"
name: "default_name_43"
packet_size: "44"
password: "<your_own_value>"
port: "46"
probe_count: "47"
probe_packets: "disable"
probe_timeout: "49"
protocol: "ping"
quality_measured_method: "half-open"
recoverytime: "52"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "56"
jitter_threshold: "57"
latency_threshold: "58"
link_cost_factor: "latency"
packetloss_threshold: "60"
sla_fail_log_period: "61"
sla_pass_log_period: "62"
system_dns: "disable"
threshold_alert_jitter: "64"
threshold_alert_latency: "65"
threshold_alert_packetloss: "66"
threshold_warning_jitter: "67"
threshold_warning_latency: "68"
threshold_warning_packetloss: "69"
update_cascade_interface: "enable"
update_static_route: "enable"
user: "<your_own_value>"
load_balance_mode: "source-ip-based"
members:
-
comment: "Comments."
cost: "76"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "79"
interface: "<your_own_value> (source system.interface.name)"
priority: "81"
priority6: "82"
seq_num: "83"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "86"
status: "disable"
volume_ratio: "88"
weight: "89"
zone: "<your_own_value> (source system.sdwan.zone.name)"
neighbor:
-
health_check: "<your_own_value> (source system.sdwan.health-check.name)"
ip: "<your_own_value> (source router.bgp.neighbor.ip)"
member: "94 (source system.sdwan.members.seq-num)"
role: "standalone"
sla_id: "96"
neighbor_hold_boot_time: "97"
neighbor_hold_down: "enable"
neighbor_hold_down_time: "99"
service:
-
addr_mode: "ipv4"
bandwidth_weight: "102"
default: "enable"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_109 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_112 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "113"
gateway: "enable"
groups:
-
name: "default_name_116 (source user.group.name)"
hash_mode: "round-robin"
health_check:
-
name: "default_name_119 (source system.sdwan.health-check.name)"
hold_down_time: "120"
id: "121"
input_device:
-
name: "default_name_123 (source system.interface.name)"
input_device_negate: "enable"
internet_service: "enable"
internet_service_app_ctrl:
-
id: "127"
internet_service_app_ctrl_group:
-
name: "default_name_129 (source application.group.name)"
internet_service_custom:
-
name: "default_name_131 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_133 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_135 (source firewall.internet-service-group.name)"
internet_service_name:
-
name: "default_name_137 (source firewall.internet-service-name.name)"
jitter_weight: "138"
latency_weight: "139"
link_cost_factor: "latency"
link_cost_threshold: "141"
minimum_sla_meet_members: "142"
mode: "auto"
name: "default_name_144"
packet_loss_weight: "145"
priority_members:
-
seq_num: "147 (source system.sdwan.members.seq-num)"
protocol: "148"
quality_link: "149"
role: "standalone"
route_tag: "151"
sla:
-
health_check: "<your_own_value> (source system.sdwan.health-check.name)"
id: "154"
sla_compare_method: "order"
src:
-
name: "default_name_157 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_160 (source firewall.address6.name firewall.addrgrp6.name)"
standalone_action: "enable"
start_port: "162"
status: "enable"
tie_break: "zone"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
use_shortcut_sla: "enable"
users:
-
name: "default_name_169 (source user.local.name)"
status: "disable"
zone:
-
name: "default_name_172"
service_sla_tie_break: "cfg-order"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_json_generic – Config Fortinet’s FortiOS and FortiGate with json generic method. fortinet.fortios.fortios\_json\_generic – Config Fortinet’s FortiOS and FortiGate with json generic method.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_json_generic`.
New in version 2.9: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify json feature and generic category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.4
Requirements
------------
The below requirements are needed on the host that executes this module.
* fortiosapi>=0.9.8
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **json\_generic** dictionary | | json generic |
| | **dictbody** dictionary | | Body with YAML list of key/value format |
| | **jsonbody** string | | Body with JSON string format, will always give priority to jsonbody |
| | **method** string | **Choices:*** GET
* PUT
* POST
* DELETE
| HTTP methods |
| | **path** string | | URL path, e.g./api/v2/cmdb/firewall/address |
| | **specialparams** string | | Extra URL parameters, e.g.start=1&count=10 |
| **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
--------
```
---
# host
# [fortigates]
# fortigate01 ansible_host=192.168.52.177 ansible_user="admin" ansible_password="admin"
# [fortigates:vars]
# ansible_network_os=fortinet.fortios.fortios
# sample1.yml
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: test add with string
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "POST"
path: "/api/v2/cmdb/firewall/address"
jsonbody: |
{
"name": "111",
"type": "geography",
"fqdn": "",
"country": "AL",
"comment": "ccc",
"visibility": "enable",
"associated-interface": "port1",
"allow-routing": "disable"
}
register: info
- name: display vars
debug: msg="{{info}}"
# sample2.yml
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: test delete
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "DELETE"
path: "/api/v2/cmdb/firewall/address/111"
register: info
- name: display vars
debug: msg="{{info}}"
- name: test add with dict
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "POST"
path: "/api/v2/cmdb/firewall/address"
dictbody:
name: "111"
type: "geography"
fqdn: ""
country: "AL"
comment: "ccc"
visibility: "enable"
associated-interface: "port1"
allow-routing: "disable"
register: info
- name: display vars
debug: msg="{{info}}"
- name: test delete
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "DELETE"
path: "/api/v2/cmdb/firewall/address/111"
register: info
- name: display vars
debug: msg="{{info}}"
- name: test add with string
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "POST"
path: "/api/v2/cmdb/firewall/address"
jsonbody: |
{
"name": "111",
"type": "geography",
"fqdn": "",
"country": "AL",
"comment": "ccc",
"visibility": "enable",
"associated-interface": "port1",
"allow-routing": "disable"
}
register: info
- name: display vars
debug: msg="{{info}}"
- name: test speical params
fortios_json_generic:
vdom: "{{ vdom }}"
json_generic:
method: "PUT"
path: "/api/v2/cmdb/firewall/policy/1"
specialparams: "action=move&after=2"
register: info
- name: display vars
debug: msg="{{info}}"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Frank Shen (@frankshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortios.fortios_extender_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_controller\_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_extender_controller_extender`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender\_controller feature and extender 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **extender\_controller\_extender** dictionary | | Extender controller configuration. |
| | **aaa\_shared\_secret** string | | AAA shared secret. |
| | **access\_point\_name** string | | Access point name(APN). |
| | **admin** string | **Choices:*** disable
* discovered
* enable
| FortiExtender Administration (enable or disable). |
| | **at\_dial\_script** string | | Initialization AT commands specific to the MODEM. |
| | **authorized** string | **Choices:*** disable
* enable
| FortiExtender Administration (enable or disable). |
| | **billing\_start\_day** integer | | Billing start day. |
| | **cdma\_aaa\_spi** string | | CDMA AAA SPI. |
| | **cdma\_ha\_spi** string | | CDMA HA SPI. |
| | **cdma\_nai** string | | NAI for CDMA MODEMS. |
| | **conn\_status** integer | | Connection status. |
| | **controller\_report** dictionary | | FortiExtender controller report configuration. |
| | | **interval** integer | | Controller report interval. |
| | | **signal\_threshold** integer | | Controller report signal threshold. |
| | | **status** string | **Choices:*** disable
* enable
| FortiExtender controller report status. |
| | **description** string | | Description. |
| | **dial\_mode** string | **Choices:*** dial-on-demand
* always-connect
| Dial mode (dial-on-demand or always-connect). |
| | **dial\_status** integer | | Dial status. |
| | **ext\_name** string | | FortiExtender name. |
| | **ha\_shared\_secret** string | | HA shared secret. |
| | **id** string / required | | FortiExtender serial number. |
| | **ifname** string | | FortiExtender interface name. Source system.interface.name. |
| | **initiated\_update** string | **Choices:*** enable
* disable
| Allow/disallow network initiated updates to the MODEM. |
| | **login\_password** string | | FortiExtender login password. |
| | **mode** string | **Choices:*** standalone
* redundant
| FortiExtender mode. |
| | **modem1** dictionary | | Configuration options for modem 1. |
| | | **auto\_switch** dictionary | | FortiExtender auto switch configuration. |
| | | | **dataplan** string | **Choices:*** disable
* enable
| Automatically switch based on data usage. |
| | | | **disconnect** string | **Choices:*** disable
* enable
| Auto switch by disconnect. |
| | | | **disconnect\_period** integer | | Automatically switch based on disconnect period. |
| | | | **disconnect\_threshold** integer | | Automatically switch based on disconnect threshold. |
| | | | **signal** string | **Choices:*** disable
* enable
| Automatically switch based on signal strength. |
| | | | **switch\_back** string | **Choices:*** time
* timer
| Auto switch with switch back multi-options. |
| | | | **switch\_back\_time** string | | Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
| | | | **switch\_back\_timer** integer | | Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
| | | **conn\_status** integer | | Connection status. |
| | | **default\_sim** string | **Choices:*** sim1
* sim2
* carrier
* cost
| Default SIM selection. |
| | | **gps** string | **Choices:*** disable
* enable
| FortiExtender GPS enable/disable. |
| | | **ifname** string | | FortiExtender interface name. Source system.interface.name. |
| | | **preferred\_carrier** string | | Preferred carrier. |
| | | **redundant\_intf** string | | Redundant interface. |
| | | **redundant\_mode** string | **Choices:*** disable
* enable
| FortiExtender mode. |
| | | **sim1\_pin** string | **Choices:*** disable
* enable
| SIM |
| | | **sim1\_pin\_code** string | | SIM |
| | | **sim2\_pin** string | **Choices:*** disable
* enable
| SIM |
| | | **sim2\_pin\_code** string | | SIM |
| | **modem2** dictionary | | Configuration options for modem 2. |
| | | **auto\_switch** dictionary | | FortiExtender auto switch configuration. |
| | | | **dataplan** string | **Choices:*** disable
* enable
| Automatically switch based on data usage. |
| | | | **disconnect** string | **Choices:*** disable
* enable
| Auto switch by disconnect. |
| | | | **disconnect\_period** integer | | Automatically switch based on disconnect period. |
| | | | **disconnect\_threshold** integer | | Automatically switch based on disconnect threshold. |
| | | | **signal** string | **Choices:*** disable
* enable
| Automatically switch based on signal strength. |
| | | | **switch\_back** string | **Choices:*** time
* timer
| Auto switch with switch back multi-options. |
| | | | **switch\_back\_time** string | | Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
| | | | **switch\_back\_timer** integer | | Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
| | | **conn\_status** integer | | Connection status. |
| | | **default\_sim** string | **Choices:*** sim1
* sim2
* carrier
* cost
| Default SIM selection. |
| | | **gps** string | **Choices:*** disable
* enable
| FortiExtender GPS enable/disable. |
| | | **ifname** string | | FortiExtender interface name. Source system.interface.name. |
| | | **preferred\_carrier** string | | Preferred carrier. |
| | | **redundant\_intf** string | | Redundant interface. |
| | | **redundant\_mode** string | **Choices:*** disable
* enable
| FortiExtender mode. |
| | | **sim1\_pin** string | **Choices:*** disable
* enable
| SIM |
| | | **sim1\_pin\_code** string | | SIM |
| | | **sim2\_pin** string | **Choices:*** disable
* enable
| SIM |
| | | **sim2\_pin\_code** string | | SIM |
| | **modem\_passwd** string | | MODEM password. |
| | **modem\_type** string | **Choices:*** cdma
* gsm/lte
* wimax
| MODEM type (CDMA, GSM/LTE or WIMAX). |
| | **multi\_mode** string | **Choices:*** auto
* auto-3g
* force-lte
* force-3g
* force-2g
| MODEM mode of operation(3G,LTE,etc). |
| | **name** string | | FortiExtender entry name. |
| | **ppp\_auth\_protocol** string | **Choices:*** auto
* pap
* chap
| PPP authentication protocol (PAP,CHAP or auto). |
| | **ppp\_echo\_request** string | **Choices:*** enable
* disable
| Enable/disable PPP echo request. |
| | **ppp\_password** string | | PPP password. |
| | **ppp\_username** string | | PPP username. |
| | **primary\_ha** string | | Primary HA. |
| | **quota\_limit\_mb** integer | | Monthly quota limit (MB). |
| | **redial** string | **Choices:*** none
* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10
| Number of redials allowed based on failed attempts. |
| | **redundant\_intf** string | | Redundant interface. |
| | **roaming** string | **Choices:*** enable
* disable
| Enable/disable MODEM roaming. |
| | **role** string | **Choices:*** none
* primary
* secondary
| FortiExtender work role(Primary, Secondary, None). |
| | **secondary\_ha** string | | Secondary HA. |
| | **sim\_pin** string | | SIM PIN. |
| | **vdom** integer | | VDOM |
| | **wimax\_auth\_protocol** string | **Choices:*** tls
* ttls
| WiMax authentication protocol(TLS or TTLS). |
| | **wimax\_carrier** string | | WiMax carrier. |
| | **wimax\_realm** string | | WiMax realm. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Extender controller configuration.
fortios_extender_controller_extender:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extender_controller_extender:
aaa_shared_secret: "<your_own_value>"
access_point_name: "<your_own_value>"
admin: "disable"
at_dial_script: "<your_own_value>"
authorized: "disable"
billing_start_day: "8"
cdma_aaa_spi: "<your_own_value>"
cdma_ha_spi: "<your_own_value>"
cdma_nai: "<your_own_value>"
conn_status: "12"
controller_report:
interval: "14"
signal_threshold: "15"
status: "disable"
description: "<your_own_value>"
dial_mode: "dial-on-demand"
dial_status: "19"
ext_name: "<your_own_value>"
ha_shared_secret: "<your_own_value>"
id: "22"
ifname: "<your_own_value> (source system.interface.name)"
initiated_update: "enable"
login_password: "<your_own_value>"
mode: "standalone"
modem_passwd: "<your_own_value>"
modem_type: "cdma"
modem1:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "33"
disconnect_threshold: "34"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "38"
conn_status: "39"
default_sim: "sim1"
gps: "disable"
ifname: "<your_own_value> (source system.interface.name)"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
modem2:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "54"
disconnect_threshold: "55"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "59"
conn_status: "60"
default_sim: "sim1"
gps: "disable"
ifname: "<your_own_value> (source system.interface.name)"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
multi_mode: "auto"
name: "default_name_72"
ppp_auth_protocol: "auto"
ppp_echo_request: "enable"
ppp_password: "<your_own_value>"
ppp_username: "<your_own_value>"
primary_ha: "<your_own_value>"
quota_limit_mb: "78"
redial: "none"
redundant_intf: "<your_own_value>"
roaming: "enable"
role: "none"
secondary_ha: "<your_own_value>"
sim_pin: "<your_own_value>"
vdom: "85"
wimax_auth_protocol: "tls"
wimax_carrier: "<your_own_value>"
wimax_realm: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_policy64 – Configure IPv6 to IPv4 policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_policy64 – Configure IPv6 to IPv4 policies in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_policy64`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy64 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_policy64** dictionary | | Configure IPv6 to IPv4 policies. |
| | **action** string | **Choices:*** accept
* deny
| Policy action. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address name. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip64.name firewall.vipgrp64.name. |
| | **dstintf** string | | Destination interface name. Source system.interface.name system.zone.name. |
| | **fixedport** string | **Choices:*** enable
* disable
| Enable/disable policy fixed port. |
| | **ippool** string | **Choices:*** enable
* disable
| Enable/disable policy64 IP pool. |
| | **logtraffic** string | **Choices:*** enable
* disable
| Enable/disable policy log traffic. |
| | **logtraffic\_start** string | **Choices:*** enable
* disable
| Record logs when a session starts and ends. |
| | **name** string | | Policy name. |
| | **per\_ip\_shaper** string | | Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
| | **permit\_any\_host** string | **Choices:*** enable
* disable
| Enable/disable permit any host in. |
| | **policyid** integer / required | | Policy ID. |
| | **poolname** list / elements=string | | Policy IP pool names. |
| | | **name** string / required | | IP pool name. Source firewall.ippool.name. |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **service** list / elements=string | | Service name. |
| | | **name** string / required | | Address name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address name. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **srcintf** string | | Source interface name. Source system.zone.name system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable policy status. |
| | **tcp\_mss\_receiver** integer | | TCP MSS value of receiver. |
| | **tcp\_mss\_sender** integer | | TCP MSS value of sender. |
| | **traffic\_shaper** string | | Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 to IPv4 policies.
fortios_firewall_policy64:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy64:
action: "accept"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_6 (source firewall.address.name firewall.addrgrp.name firewall.vip64.name firewall.vipgrp64.name)"
dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
fixedport: "enable"
ippool: "enable"
logtraffic: "enable"
logtraffic_start: "enable"
name: "default_name_12"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
policyid: "15"
poolname:
-
name: "default_name_17 (source firewall.ippool.name)"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_20 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
status: "enable"
tcp_mss_receiver: "25"
tcp_mss_sender: "26"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_automation_destination – Automation destinations in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_automation\_destination – Automation destinations in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_automation_destination`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and automation\_destination 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_automation\_destination** dictionary | | Automation destinations. |
| | **destination** list / elements=string | | Destinations. |
| | | **name** string / required | | Destination. |
| | **ha\_group\_id** integer | | Cluster group ID set for this destination . |
| | **name** string / required | | Name. |
| | **type** string | **Choices:*** fortigate
* ha-cluster
| Destination type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Automation destinations.
fortios_system_automation_destination:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_automation_destination:
destination:
-
name: "default_name_4"
ha_group_id: "5"
name: "default_name_6"
type: "fortigate"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ssl_web_realm – Realm in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_web\_realm – Realm in Fortinet’s FortiOS and FortiGate.
===========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ssl_web_realm`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ssl\_web feature and realm 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ssl\_web\_realm** dictionary | | Realm. |
| | **login\_page** string | | Replacement HTML for SSL-VPN login page. |
| | **max\_concurrent\_user** integer | | Maximum concurrent users (0 - 65535, 0 means unlimited). |
| | **nas\_ip** string | | IP address used as a NAS-IP to communicate with the RADIUS server. |
| | **radius\_port** integer | | RADIUS service port number (0 - 65535, 0 means user.radius.radius-port). |
| | **radius\_server** string | | RADIUS server associated with realm. Source user.radius.name. |
| | **url\_path** string | | URL path to access SSL-VPN login page. |
| | **virtual\_host** string | | Virtual host name for realm. |
| | **virtual\_host\_only** string | **Choices:*** enable
* disable
| Enable/disable enforcement of virtual host method for SSL-VPN client access. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Realm.
fortios_vpn_ssl_web_realm:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_realm:
login_page: "<your_own_value>"
max_concurrent_user: "4"
nas_ip: "<your_own_value>"
radius_port: "6"
radius_server: "<your_own_value> (source user.radius.name)"
url_path: "<your_own_value>"
virtual_host: "<your_own_value>"
virtual_host_only: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wanopt_remote_storage – Configure a remote cache device as Web cache storage in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_remote\_storage – Configure a remote cache device as Web cache storage in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wanopt_remote_storage`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and remote\_storage 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wanopt\_remote\_storage** dictionary | | Configure a remote cache device as Web cache storage. |
| | **local\_cache\_id** string | | ID that this device uses to connect to the remote device. |
| | **remote\_cache\_id** string | | ID of the remote device to which the device connects. |
| | **remote\_cache\_ip** string | | IP address of the remote device to which the device connects. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable using remote device as Web cache storage. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure a remote cache device as Web cache storage.
fortios_wanopt_remote_storage:
vdom: "{{ vdom }}"
wanopt_remote_storage:
local_cache_id: "<your_own_value>"
remote_cache_id: "<your_own_value>"
remote_cache_ip: "<your_own_value>"
status: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_dhcp_server – Configure DHCP servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dhcp\_server – Configure DHCP servers in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_dhcp_server`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_dhcp feature and server 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_dhcp\_server** dictionary | | Configure DHCP servers. |
| | **auto\_configuration** string | **Choices:*** disable
* enable
| Enable/disable auto configuration. |
| | **auto\_managed\_status** string | **Choices:*** disable
* enable
| Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. |
| | **conflicted\_ip\_timeout** integer | | Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. |
| | **ddns\_auth** string | **Choices:*** disable
* tsig
| DDNS authentication mode. |
| | **ddns\_key** string | | DDNS update key (base 64 encoding). |
| | **ddns\_keyname** string | | DDNS update key name. |
| | **ddns\_server\_ip** string | | DDNS server IP. |
| | **ddns\_ttl** integer | | TTL. |
| | **ddns\_update** string | **Choices:*** disable
* enable
| Enable/disable DDNS update for DHCP. |
| | **ddns\_update\_override** string | **Choices:*** disable
* enable
| Enable/disable DDNS update override for DHCP. |
| | **ddns\_zone** string | | Zone of your domain name (ex. DDNS.com). |
| | **default\_gateway** string | | Default gateway IP address assigned by the DHCP server. |
| | **dhcp\_settings\_from\_fortiipam** string | **Choices:*** disable
* enable
| Enable/disable populating of DHCP server settings from FortiIPAM. |
| | **dns\_server1** string | | DNS server 1. |
| | **dns\_server2** string | | DNS server 2. |
| | **dns\_server3** string | | DNS server 3. |
| | **dns\_server4** string | | DNS server 4. |
| | **dns\_service** string | **Choices:*** local
* default
* specify
| Options for assigning DNS servers to DHCP clients. |
| | **domain** string | | Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
| | **exclude\_range** list / elements=string | | Exclude one or more ranges of IP addresses from being assigned to clients. |
| | | **end\_ip** string | | End of IP range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IP range. |
| | **filename** string | | Name of the boot file on the TFTP server. |
| | **forticlient\_on\_net\_status** string | **Choices:*** disable
* enable
| Enable/disable FortiClient-On-Net service for this DHCP server. |
| | **id** integer / required | | ID. |
| | **interface** string | | DHCP server can assign IP configurations to clients connected to this interface. Source system.interface.name. |
| | **ip\_mode** string | **Choices:*** range
* usrgrp
| Method used to assign client IP. |
| | **ip\_range** list / elements=string | | DHCP IP range configuration. |
| | | **end\_ip** string | | End of IP range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IP range. |
| | **ipsec\_lease\_hold** integer | | DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). |
| | **lease\_time** integer | | Lease time in seconds, 0 means unlimited. |
| | **mac\_acl\_default\_action** string | **Choices:*** assign
* block
| MAC access control default action (allow or block assigning IP settings). |
| | **netmask** string | | Netmask assigned by the DHCP server. |
| | **next\_server** string | | IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. |
| | **ntp\_server1** string | | NTP server 1. |
| | **ntp\_server2** string | | NTP server 2. |
| | **ntp\_server3** string | | NTP server 3. |
| | **ntp\_service** string | **Choices:*** local
* default
* specify
| Options for assigning Network Time Protocol (NTP) servers to DHCP clients. |
| | **options** list / elements=string | | DHCP options. |
| | | **code** integer | | DHCP option code. |
| | | **id** integer / required | | ID. |
| | | **ip** string | | DHCP option IPs. |
| | | **type** string | **Choices:*** hex
* string
* ip
* fqdn
| DHCP option type. |
| | | **value** string | | DHCP option value. |
| | **reserved\_address** list / elements=string | | Options for the DHCP server to assign IP settings to specific MAC addresses. |
| | | **action** string | **Choices:*** assign
* block
* reserved
| Options for the DHCP server to configure the client with the reserved MAC address. |
| | | **circuit\_id** string | | Option 82 circuit-ID of the client that will get the reserved IP address. |
| | | **circuit\_id\_type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | **description** string | | Description. |
| | | **id** integer / required | | ID. |
| | | **ip** string | | IP address to be reserved for the MAC address. |
| | | **mac** string | | MAC address of the client that will get the reserved IP address. |
| | | **remote\_id** string | | Option 82 remote-ID of the client that will get the reserved IP address. |
| | | **remote\_id\_type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | **type** string | **Choices:*** mac
* option82
| DHCP reserved-address type. |
| | **server\_type** string | **Choices:*** regular
* ipsec
| DHCP server can be a normal DHCP server or an IPsec DHCP server. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this DHCP configuration. |
| | **tftp\_server** list / elements=string | | One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. |
| | | **tftp\_server** string | | TFTP server. |
| | **timezone** string | **Choices:*** 1
* 2
* 3
* 4
* 5
* 81
* 6
* 7
* 08
* 09
* 10
* 11
* 12
* 13
* 74
* 14
* 77
* 15
* 87
* 16
* 17
* 18
* 19
* 20
* 75
* 21
* 22
* 23
* 24
* 80
* 79
* 25
* 26
* 27
* 28
* 78
* 29
* 30
* 31
* 32
* 33
* 34
* 35
* 36
* 37
* 38
* 83
* 84
* 40
* 85
* 41
* 42
* 43
* 39
* 44
* 46
* 47
* 51
* 48
* 45
* 49
* 50
* 52
* 53
* 54
* 55
* 56
* 57
* 58
* 59
* 60
* 62
* 63
* 61
* 64
* 65
* 66
* 67
* 68
* 69
* 70
* 71
* 72
* 0
* 82
* 73
* 86
* 76
| Select the time zone to be assigned to DHCP clients. |
| | **timezone\_option** string | **Choices:*** disable
* default
* specify
| Options for the DHCP server to set the client"s time zone. |
| | **vci\_match** string | **Choices:*** disable
* enable
| Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. |
| | **vci\_string** list / elements=string | | One or more VCI strings in quotes separated by spaces. |
| | | **vci\_string** string | | VCI strings. |
| | **wifi\_ac1** string | | WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). |
| | **wifi\_ac2** string | | WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). |
| | **wifi\_ac3** string | | WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). |
| | **wifi\_ac\_service** string | **Choices:*** specify
* local
| Options for assigning WiFi Access Controllers to DHCP clients |
| | **wins\_server1** string | | WINS server 1. |
| | **wins\_server2** string | | WINS server 2. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure DHCP servers.
fortios_system_dhcp_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_dhcp_server:
auto_configuration: "disable"
auto_managed_status: "disable"
conflicted_ip_timeout: "5"
ddns_auth: "disable"
ddns_key: "<your_own_value>"
ddns_keyname: "<your_own_value>"
ddns_server_ip: "<your_own_value>"
ddns_ttl: "10"
ddns_update: "disable"
ddns_update_override: "disable"
ddns_zone: "<your_own_value>"
default_gateway: "<your_own_value>"
dhcp_settings_from_fortiipam: "disable"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_server3: "<your_own_value>"
dns_server4: "<your_own_value>"
dns_service: "local"
domain: "<your_own_value>"
exclude_range:
-
end_ip: "<your_own_value>"
id: "24"
start_ip: "<your_own_value>"
filename: "<your_own_value>"
forticlient_on_net_status: "disable"
id: "28"
interface: "<your_own_value> (source system.interface.name)"
ip_mode: "range"
ip_range:
-
end_ip: "<your_own_value>"
id: "33"
start_ip: "<your_own_value>"
ipsec_lease_hold: "35"
lease_time: "36"
mac_acl_default_action: "assign"
netmask: "<your_own_value>"
next_server: "<your_own_value>"
ntp_server1: "<your_own_value>"
ntp_server2: "<your_own_value>"
ntp_server3: "<your_own_value>"
ntp_service: "local"
options:
-
code: "45"
id: "46"
ip: "<your_own_value>"
type: "hex"
value: "<your_own_value>"
reserved_address:
-
action: "assign"
circuit_id: "<your_own_value>"
circuit_id_type: "hex"
description: "<your_own_value>"
id: "55"
ip: "<your_own_value>"
mac: "<your_own_value>"
remote_id: "<your_own_value>"
remote_id_type: "hex"
type: "mac"
server_type: "regular"
status: "disable"
tftp_server:
-
tftp_server: "<your_own_value>"
timezone: "01"
timezone_option: "disable"
vci_match: "disable"
vci_string:
-
vci_string: "<your_own_value>"
wifi_ac_service: "specify"
wifi_ac1: "<your_own_value>"
wifi_ac2: "<your_own_value>"
wifi_ac3: "<your_own_value>"
wins_server1: "<your_own_value>"
wins_server2: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_ips_settings – Configure IPS VDOM parameter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_settings – Configure IPS VDOM parameter in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_ips_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ips\_settings** dictionary | | Configure IPS VDOM parameter. |
| | **ips\_packet\_quota** integer | | Maximum amount of disk space in MB for logged packets when logging to disk. Range depends on disk size. |
| | **packet\_log\_history** integer | | Number of packets to capture before and including the one in which the IPS signature is detected (1 - 255). |
| | **packet\_log\_memory** integer | | Maximum memory can be used by packet log (64 - 8192 kB). |
| | **packet\_log\_post\_attack** integer | | Number of packets to log after the IPS signature is detected (0 - 255). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPS VDOM parameter.
fortios_ips_settings:
vdom: "{{ vdom }}"
ips_settings:
ips_packet_quota: "3"
packet_log_history: "4"
packet_log_memory: "5"
packet_log_post_attack: "6"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vip64 – Configure IPv6 to IPv4 virtual IPs in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vip64`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip64 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vip64** dictionary | | Configure IPv6 to IPv4 virtual IPs. |
| | **arp\_reply** string | **Choices:*** disable
* enable
| Enable ARP reply. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **extip** string | | Start-external-IP [-end-external-IP]. |
| | **extport** string | | External service port. |
| | **id** integer | | Custom defined id. |
| | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| Load balance method. |
| | **mappedip** string | | Start-mapped-IP [-end-mapped-IP]. |
| | **mappedport** string | | Mapped service port. |
| | **monitor** list / elements=string | | Health monitors. |
| | | **name** string / required | | Health monitor name. Source firewall.ldb-monitor.name. |
| | **name** string / required | | VIP64 name. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable port forwarding. |
| | **protocol** string | **Choices:*** tcp
* udp
| Mapped port protocol. |
| | **realservers** list / elements=string | | Real servers. |
| | | **client\_ip** string | | Restrict server to a client IP in this range. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | | **holddown\_interval** integer | | Hold down interval. |
| | | **id** integer / required | | Real server ID. |
| | | **ip** string | | Mapped server IP. |
| | | **max\_connections** integer | | Maximum number of connections allowed to server. |
| | | **monitor** string | | Health monitors. Source firewall.ldb-monitor.name. |
| | | **port** integer | | Mapped server port. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | | **weight** integer | | weight |
| | **server\_type** string | **Choices:*** http
* tcp
* udp
* ip
| Server type. |
| | **src\_filter** list / elements=string | | Source IP6 filter (x:x:x:x:x:x:x:x/x). |
| | | **range** string / required | | Src-filter range. |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| VIP type: static NAT or server load balance. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 to IPv4 virtual IPs.
fortios_firewall_vip64:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip64:
arp_reply: "disable"
color: "4"
comment: "Comment."
extip: "<your_own_value>"
extport: "<your_own_value>"
id: "8"
ldb_method: "static"
mappedip: "<your_own_value>"
mappedport: "<your_own_value>"
monitor:
-
name: "default_name_13 (source firewall.ldb-monitor.name)"
name: "default_name_14"
portforward: "disable"
protocol: "tcp"
realservers:
-
client_ip: "<your_own_value>"
healthcheck: "disable"
holddown_interval: "20"
id: "21"
ip: "<your_own_value>"
max_connections: "23"
monitor: "<your_own_value> (source firewall.ldb-monitor.name)"
port: "25"
status: "active"
weight: "27"
server_type: "http"
src_filter:
-
range: "<your_own_value>"
type: "static-nat"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_multicast_address6 – Configure IPv6 multicast address in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_multicast\_address6 – Configure IPv6 multicast address in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_multicast_address6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast\_address6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_multicast\_address6** dictionary | | Configure IPv6 multicast address. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **ip6** string | | IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). |
| | **name** string / required | | IPv6 multicast address name. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable visibility of the IPv6 multicast address on the GUI. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 multicast address.
fortios_firewall_multicast_address6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_multicast_address6:
color: "3"
comment: "Comment."
ip6: "<your_own_value>"
name: "default_name_6"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_9"
tags:
-
name: "default_name_11 (source system.object-tagging.tags.name)"
visibility: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_gtp_apn – Configure APN for GTP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_apn – Configure APN for GTP in Fortinet’s FortiOS and FortiGate.
===============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_gtp_apn`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and apn 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **gtp\_apn** dictionary | | Configure APN for GTP. |
| | **apn** string | | APN value. |
| | **name** string / required | | APN name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure APN for GTP.
fortios_gtp_apn:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_apn:
apn: "<your_own_value>"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_gui_display – Configure how log messages are displayed on the GUI in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_gui\_display – Configure how log messages are displayed on the GUI in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_gui_display`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and gui\_display 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_gui\_display** dictionary | | Configure how log messages are displayed on the GUI. |
| | **fortiview\_unscanned\_apps** string | **Choices:*** enable
* disable
| Enable/disable showing unscanned traffic in FortiView application charts. |
| | **resolve\_apps** string | **Choices:*** enable
* disable
| Resolve unknown applications on the GUI using Fortinet"s remote application database. |
| | **resolve\_hosts** string | **Choices:*** enable
* disable
| Enable/disable resolving IP addresses to hostname in log messages on the GUI using reverse DNS lookup |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure how log messages are displayed on the GUI.
fortios_log_gui_display:
vdom: "{{ vdom }}"
log_gui_display:
fortiview_unscanned_apps: "enable"
resolve_apps: "enable"
resolve_hosts: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortiguard_override_setting – Override global FortiCloud logging settings for this VDOM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortiguard\_override\_setting – Override global FortiCloud logging settings for this VDOM in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortiguard_override_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortiguard feature and override\_setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortiguard\_override\_setting** dictionary | | Override global FortiCloud logging settings for this VDOM. |
| | **max\_log\_rate** integer | | FortiCloud maximum log rate in MBps (0 = unlimited). |
| | **override** string | **Choices:*** enable
* disable
| Overriding FortiCloud settings for this VDOM or use global settings. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiCloud. |
| | **upload\_day** string | | Day of week to roll logs. |
| | **upload\_interval** string | **Choices:*** daily
* weekly
* monthly
| Frequency of uploading log files to FortiCloud. |
| | **upload\_option** string | **Choices:*** store-and-upload
* realtime
* 1-minute
* 5-minute
| Configure how log messages are sent to FortiCloud. |
| | **upload\_time** string | | Time of day to roll logs (hh:mm). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override global FortiCloud logging settings for this VDOM.
fortios_log_fortiguard_override_setting:
vdom: "{{ vdom }}"
log_fortiguard_override_setting:
max_log_rate: "3"
override: "enable"
priority: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_route_map – Configure route maps in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_route\_map – Configure route maps in Fortinet’s FortiOS and FortiGate.
========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_route_map`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and route\_map 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_route\_map** dictionary | | Configure route maps. |
| | **comments** string | | Optional comments. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | Rule. |
| | | **action** string | **Choices:*** permit
* deny
| Action. |
| | | **id** integer / required | | Rule ID. |
| | | **match\_as\_path** string | | Match BGP AS path list. Source router.aspath-list.name. |
| | | **match\_community** string | | Match BGP community list. Source router.community-list.name. |
| | | **match\_community\_exact** string | **Choices:*** enable
* disable
| Enable/disable exact matching of communities. |
| | | **match\_flags** integer | | BGP flag value to match (0 - 65535) |
| | | **match\_interface** string | | Match interface configuration. Source system.interface.name. |
| | | **match\_ip6\_address** string | | Match IPv6 address permitted by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. |
| | | **match\_ip6\_nexthop** string | | Match next hop IPv6 address passed by access-list6 or prefix-list6. Source router.access-list6.name router.prefix-list6.name. |
| | | **match\_ip\_address** string | | Match IP address permitted by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. |
| | | **match\_ip\_nexthop** string | | Match next hop IP address passed by access-list or prefix-list. Source router.access-list.name router.prefix-list.name. |
| | | **match\_metric** integer | | Match metric for redistribute routes. |
| | | **match\_origin** string | **Choices:*** none
* egp
* igp
* incomplete
| Match BGP origin code. |
| | | **match\_route\_type** string | **Choices:*** 1
* 2
* none
* external-type1
* external-type2
| Match route type. |
| | | **match\_tag** integer | | Match tag. |
| | | **match\_vrf** integer | | Match VRF ID. |
| | | **set\_aggregator\_as** integer | | BGP aggregator AS. |
| | | **set\_aggregator\_ip** string | | BGP aggregator IP. |
| | | **set\_aspath** list / elements=string | | Prepend BGP AS path attribute. |
| | | | **as** string / required | | AS number (0 - 42949672). NOTE: Use quotes for repeating numbers, e.g.: "1 1 2" |
| | | **set\_aspath\_action** string | **Choices:*** prepend
* replace
| Specify preferred action of set-aspath. |
| | | **set\_atomic\_aggregate** string | **Choices:*** enable
* disable
| Enable/disable BGP atomic aggregate attribute. |
| | | **set\_community** list / elements=string | | BGP community attribute. |
| | | | **community** string / required | | Attribute: AA|AA:NN|internet|local-AS|no-advertise|no-export. |
| | | **set\_community\_additive** string | **Choices:*** enable
* disable
| Enable/disable adding set-community to existing community. |
| | | **set\_community\_delete** string | | Delete communities matching community list. Source router.community-list.name. |
| | | **set\_dampening\_max\_suppress** integer | | Maximum duration to suppress a route (1 - 255 min, 0 = unset). |
| | | **set\_dampening\_reachability\_half\_life** integer | | Reachability half-life time for the penalty (1 - 45 min, 0 = unset). |
| | | **set\_dampening\_reuse** integer | | Value to start reusing a route (1 - 20000, 0 = unset). |
| | | **set\_dampening\_suppress** integer | | Value to start suppressing a route (1 - 20000, 0 = unset). |
| | | **set\_dampening\_unreachability\_half\_life** integer | | Unreachability Half-life time for the penalty (1 - 45 min, 0 = unset) |
| | | **set\_extcommunity\_rt** list / elements=string | | Route Target extended community. |
| | | | **community** string / required | | AA:NN. |
| | | **set\_extcommunity\_soo** list / elements=string | | Site-of-Origin extended community. |
| | | | **community** string / required | | AA:NN |
| | | **set\_flags** integer | | BGP flags value (0 - 65535) |
| | | **set\_ip6\_nexthop** string | | IPv6 global address of next hop. |
| | | **set\_ip6\_nexthop\_local** string | | IPv6 local address of next hop. |
| | | **set\_ip\_nexthop** string | | IP address of next hop. |
| | | **set\_local\_preference** integer | | BGP local preference path attribute. |
| | | **set\_metric** integer | | Metric value. |
| | | **set\_metric\_type** string | **Choices:*** 1
* 2
* none
* external-type1
* external-type2
| Metric type. |
| | | **set\_origin** string | **Choices:*** none
* egp
* igp
* incomplete
| BGP origin code. |
| | | **set\_originator\_id** string | | BGP originator ID attribute. |
| | | **set\_route\_tag** integer | | Route tag for routing table. |
| | | **set\_tag** integer | | Tag value. |
| | | **set\_weight** integer | | BGP weight for routing table. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure route maps.
fortios_router_route_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_route_map:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
id: "7"
match_as_path: "<your_own_value> (source router.aspath-list.name)"
match_community: "<your_own_value> (source router.community-list.name)"
match_community_exact: "enable"
match_flags: "11"
match_interface: "<your_own_value> (source system.interface.name)"
match_ip_address: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
match_ip_nexthop: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
match_ip6_nexthop: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
match_metric: "17"
match_origin: "none"
match_route_type: "1"
match_tag: "20"
match_vrf: "21"
set_aggregator_as: "22"
set_aggregator_ip: "<your_own_value>"
set_aspath:
-
as: "<your_own_value>"
set_aspath_action: "prepend"
set_atomic_aggregate: "enable"
set_community:
-
community: "<your_own_value>"
set_community_additive: "enable"
set_community_delete: "<your_own_value> (source router.community-list.name)"
set_dampening_max_suppress: "32"
set_dampening_reachability_half_life: "33"
set_dampening_reuse: "34"
set_dampening_suppress: "35"
set_dampening_unreachability_half_life: "36"
set_extcommunity_rt:
-
community: "<your_own_value>"
set_extcommunity_soo:
-
community: "<your_own_value>"
set_flags: "41"
set_ip_nexthop: "<your_own_value>"
set_ip6_nexthop: "<your_own_value>"
set_ip6_nexthop_local: "<your_own_value>"
set_local_preference: "45"
set_metric: "46"
set_metric_type: "1"
set_origin: "none"
set_originator_id: "<your_own_value>"
set_route_tag: "50"
set_tag: "51"
set_weight: "52"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_replacemsg_group – Configure replacement message groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_group – Configure replacement message groups in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and replacemsg\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_group** dictionary | | Configure replacement message groups. |
| | **admin** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **alertmail** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **auth** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **automation** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **comment** string | | Comment. |
| | **custom\_message** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **device\_detection\_portal** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **ec** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **fortiguard\_wf** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **ftp** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **group\_type** string | **Choices:*** default
* utm
* auth
* ec
| Group type. |
| | **http** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **icap** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **mail** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **mm1** list / elements=string | | Replacement message table entries. |
| | | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | | **class** string | **Choices:*** not-included
* personal
* advertisement
* information
* automatic
| message class |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **from** string | | from address |
| | | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **image** string | | Message string. Source system.replacemsg-image.name. |
| | | **message** string | | message text |
| | | **msg\_type** string | | Message type. |
| | | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | | **rsp\_status** string | **Choices:*** ok
* err-unspecified
* err-srv-denied
* err-msg-fmt-corrupt
* err-snd-addr-unresolv
* err-msg-not-found
* err-net-prob
* err-content-not-accept
* err-unsupp-msg
| response status code |
| | | **rsp\_text** string | | response text |
| | | **sender\_visibility** string | **Choices:*** not-specified
* show
* hide
| sender visibility |
| | | **smil\_part** string | | message encapsulation text |
| | | **subject** string | | subject text string |
| | **mm3** list / elements=string | | Replacement message table entries. |
| | | **add\_html** string | **Choices:*** enable
* disable
| add message encapsulation |
| | | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **from** string | | from address |
| | | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **html\_part** string | | message encapsulation text |
| | | **image** string | | Message string. Source system.replacemsg-image.name. |
| | | **message** string | | message text |
| | | **msg\_type** string | | Message type. |
| | | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | | **subject** string | | subject text string |
| | **mm4** list / elements=string | | Replacement message table entries. |
| | | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | | **class** string | **Choices:*** not-included
* personal
* informational
* advertisement
* auto
| message class |
| | | **domain** string | | from address domain |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **from** string | | from address |
| | | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **image** string | | Message string. Source system.replacemsg-image.name. |
| | | **message** string | | message text |
| | | **msg\_type** string | | Message type. |
| | | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | | **rsp\_status** string | **Choices:*** ok
* err-unspecified
* err-srv-denied
* err-msg-fmt-corrupt
* err-snd-addr-unresolv
* err-net-prob
* err-content-not-accept
* err-unsupp-msg
| response status |
| | | **smil\_part** string | | message encapsulation text |
| | | **subject** string | | subject text string |
| | **mm7** list / elements=string | | Replacement message table entries. |
| | | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | | **addr\_type** string | **Choices:*** rfc2822-addr
* number
* short-code
| from address type |
| | | **allow\_content\_adaptation** string | **Choices:*** enable
* disable
| allow content adaptations |
| | | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | | **class** string | **Choices:*** not-included
* personal
* informational
* advertisement
* auto
| message class |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **from** string | | from address |
| | | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **image** string | | Message string. Source system.replacemsg-image.name. |
| | | **message** string | | message text |
| | | **msg\_type** string | | Message type. |
| | | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | | **rsp\_status** string | **Choices:*** success
* partial-success
* client-err
* oper-restrict
* addr-err
* addr-not-found
* content-refused
* msg-id-not-found
* link-id-not-found
* msg-fmt-corrupt
* app-id-not-found
* repl-app-id-not-found
* srv-err
* not-possible
* msg-rejected
* multiple-addr-not-supp
* app-addr-not-supp
* gen-service-err
* improper-ident
* unsupp-ver
* unsupp-oper
* validation-err
* service-err
* service-unavail
* service-denied
* app-denied
| response status |
| | | **smil\_part** string | | message encapsulation text |
| | | **subject** string | | subject text string |
| | **mms** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **image** string | | Message string. Source system.replacemsg-image.name. |
| | | **msg\_type** string | | Message type. |
| | **nac\_quar** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **name** string / required | | Group name. |
| | **nntp** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **spam** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **sslvpn** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **traffic\_quota** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **utm** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| | **webproxy** list / elements=string | | Replacement message table entries. |
| | | **buffer** string | | Message string. |
| | | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure replacement message groups.
fortios_system_replacemsg_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_group:
admin:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
alertmail:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
auth:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
automation:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
comment: "Comment."
custom_message:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
device_detection_portal:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
ec:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
fortiguard_wf:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
ftp:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
group_type: "default"
http:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
icap:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
mail:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
mm1:
-
add_smil: "enable"
charset: "utf-8"
class: "not-included"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "ok"
rsp_text: "<your_own_value>"
sender_visibility: "not-specified"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
mm3:
-
add_html: "enable"
charset: "utf-8"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
html_part: "<your_own_value>"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
subject: "<your_own_value>"
mm4:
-
add_smil: "enable"
charset: "utf-8"
class: "not-included"
domain: "<your_own_value>"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "ok"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
mm7:
-
add_smil: "enable"
addr_type: "rfc2822-addr"
allow_content_adaptation: "enable"
charset: "utf-8"
class: "not-included"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "success"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
mms:
-
buffer: "<your_own_value>"
charset: "utf-8"
format: "none"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
msg_type: "<your_own_value>"
nac_quar:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
name: "default_name_140"
nntp:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
spam:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
sslvpn:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
traffic_quota:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
utm:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
webproxy:
-
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_wanopt_peer – Configure WAN optimization peers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_peer – Configure WAN optimization peers in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wanopt_peer`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and peer 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wanopt\_peer** dictionary | | Configure WAN optimization peers. |
| | **ip** string | | Peer IP address. |
| | **peer\_host\_id** string | | Peer host ID. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WAN optimization peers.
fortios_wanopt_peer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wanopt_peer:
ip: "<your_own_value>"
peer_host_id: "myhostname"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_file_filter_profile – Configure file-filter profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_file\_filter\_profile – Configure file-filter profiles in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_file_filter_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify file\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **file\_filter\_profile** dictionary | | Configure file-filter profiles. |
| | **comment** string | | Comment. |
| | **extended\_log** string | **Choices:*** disable
* enable
| Enable/disable file-filter extended logging. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow/proxy feature set. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable file-filter logging. |
| | **name** string / required | | Profile name. |
| | **replacemsg\_group** string | | Replacement message group Source system.replacemsg-group.name. |
| | **rules** list / elements=string | | File filter rules. |
| | | **action** string | **Choices:*** log-only
* block
| Action taken for matched file. |
| | | **comment** string | | Comment. |
| | | **direction** string | **Choices:*** incoming
* outgoing
* any
| Traffic direction. (HTTP, FTP, SSH, CIFS only) |
| | | **file\_type** list / elements=string | | Select file type. |
| | | | **name** string / required | | File type name. Source antivirus.filetype.name. |
| | | **name** string / required | | File-filter rule name. |
| | | **password\_protected** string | **Choices:*** True
* any
| Match password-protected files. |
| | | **protocol** list / elements=string | **Choices:*** http
* ftp
* smtp
* imap
* pop3
* mapi
* cifs
* ssh
| Protocols to apply rule to. |
| | **scan\_archive\_contents** string | **Choices:*** disable
* enable
| Enable/disable archive contents scan. (Not for CIFS) |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure file-filter profiles.
fortios_file_filter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
file_filter_profile:
comment: "Comment."
extended_log: "disable"
feature_set: "flow"
log: "disable"
name: "default_name_7"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
rules:
-
action: "log-only"
comment: "Comment."
direction: "incoming"
file_type:
-
name: "default_name_14 (source antivirus.filetype.name)"
name: "default_name_15"
password_protected: "yes"
protocol: "http"
scan_archive_contents: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_ha_monitor – Configure HA monitor in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ha\_monitor – Configure HA monitor in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ha_monitor`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ha\_monitor 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_ha\_monitor** dictionary | | Configure HA monitor. |
| | **monitor\_vlan** string | **Choices:*** enable
* disable
| Enable/disable monitor VLAN interfaces. |
| | **vlan\_hb\_interval** integer | | Configure heartbeat interval (seconds). |
| | **vlan\_hb\_lost\_threshold** integer | | VLAN lost heartbeat threshold (1 - 60). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure HA monitor.
fortios_system_ha_monitor:
vdom: "{{ vdom }}"
system_ha_monitor:
monitor_vlan: "enable"
vlan_hb_interval: "4"
vlan_hb_lost_threshold: "5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_mm4 – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mm4 – Replacement messages in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_mm4`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and mm4 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_mm4** dictionary | | Replacement messages. |
| | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | **class** string | **Choices:*** not-included
* personal
* informational
* advertisement
* auto
| message class |
| | **domain** string | | from address domain |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **from** string | | from address |
| | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. Source system.replacemsg-image.name. |
| | **message** string | | message text |
| | **msg\_type** string | | Message type. |
| | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | **rsp\_status** string | **Choices:*** ok
* err-unspecified
* err-srv-denied
* err-msg-fmt-corrupt
* err-snd-addr-unresolv
* err-net-prob
* err-content-not-accept
* err-unsupp-msg
| response status |
| | **smil\_part** string | | message encapsulation text |
| | **subject** string | | subject text string |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mm4:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mm4:
add_smil: "enable"
charset: "utf-8"
class: "not-included"
domain: "<your_own_value>"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "ok"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_domain_controller – Configure domain controller entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_domain\_controller – Configure domain controller entries in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_domain_controller`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and domain\_controller 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_domain\_controller** dictionary | | Configure domain controller entries. |
| | **ad\_mode** string | **Choices:*** none
* ds
* lds
| Set Active Directory mode. |
| | **adlds\_dn** string | | AD LDS distinguished name. |
| | **adlds\_ip6** string | | AD LDS IPv6 address. |
| | **adlds\_ip\_address** string | | AD LDS IPv4 address. |
| | **adlds\_port** integer | | Port number of AD LDS service . |
| | **dns\_srv\_lookup** string | **Choices:*** enable
* disable
| Enable/disable DNS service lookup. |
| | **domain\_name** string | | Domain DNS name. |
| | **extra\_server** list / elements=string | | extra servers. |
| | | **id** integer / required | | Server ID. |
| | | **ip\_address** string | | Domain controller IP address. |
| | | **port** integer | | Port to be used for communication with the domain controller . |
| | | **source\_ip\_address** string | | FortiGate IPv4 address to be used for communication with the domain controller. |
| | | **source\_port** integer | | Source port to be used for communication with the domain controller. |
| | **hostname** string | | Hostname of the server to connect to. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ip6** string | | Domain controller IPv6 address. |
| | **ip\_address** string | | Domain controller IP address. |
| | **ldap\_server** string | | LDAP server name. Source user.ldap.name. |
| | **name** string / required | | Domain controller entry name. |
| | **password** string | | Password for specified username. |
| | **port** integer | | Port to be used for communication with the domain controller . |
| | **replication\_port** integer | | Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discovery. |
| | **source\_ip6** string | | FortiGate IPv6 address to be used for communication with the domain controller. |
| | **source\_ip\_address** string | | FortiGate IPv4 address to be used for communication with the domain controller. |
| | **source\_port** integer | | Source port to be used for communication with the domain controller. |
| | **username** string | | User name to sign in with. Must have proper permissions for service. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure domain controller entries.
fortios_user_domain_controller:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_domain_controller:
ad_mode: "none"
adlds_dn: "<your_own_value>"
adlds_ip_address: "<your_own_value>"
adlds_ip6: "<your_own_value>"
adlds_port: "7"
dns_srv_lookup: "enable"
domain_name: "<your_own_value>"
extra_server:
-
id: "11"
ip_address: "<your_own_value>"
port: "13"
source_ip_address: "<your_own_value>"
source_port: "15"
hostname: "myhostname"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip_address: "<your_own_value>"
ip6: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_22"
password: "<your_own_value>"
port: "24"
replication_port: "25"
source_ip_address: "<your_own_value>"
source_ip6: "<your_own_value>"
source_port: "28"
username: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_internet_service_ipbl_vendor – IP blacklist vendor in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_ipbl\_vendor – IP blacklist vendor in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_internet_service_ipbl_vendor`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet\_service\_ipbl\_vendor 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_internet\_service\_ipbl\_vendor** dictionary | | IP blacklist vendor. |
| | **id** integer / required | | IP blacklist vendor ID. |
| | **name** string | | IP blacklist vendor name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: IP blacklist vendor.
fortios_firewall_internet_service_ipbl_vendor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_ipbl_vendor:
id: "3"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_mms – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mms – Replacement messages in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_mms`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and mms 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_mms** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. Source system.replacemsg-image.name. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mms:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mms:
buffer: "<your_own_value>"
charset: "utf-8"
format: "none"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_pop3 – POP3 server entry configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_pop3 – POP3 server entry configuration in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_pop3`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and pop3 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_pop3** dictionary | | POP3 server entry configuration. |
| | **name** string / required | | POP3 server entry name. |
| | **port** integer | | POP3 service port number. |
| | **secure** string | **Choices:*** none
* starttls
* pop3s
| SSL connection. |
| | **server** string | | {<name\_str|ip\_str>} server domain name or IP. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: POP3 server entry configuration.
fortios_user_pop3:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_pop3:
name: "default_name_3"
port: "4"
secure: "none"
server: "192.168.100.40"
ssl_min_proto_version: "default"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_vip6 – Configure virtual IP for IPv6 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vip6 – Configure virtual IP for IPv6 in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vip6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vip6** dictionary | | Configure virtual IP for IPv6. |
| | **arp\_reply** string | **Choices:*** disable
* enable
| Enable to respond to ARP requests for this virtual IP address. Enabled by default. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **extip** string | | IP address or address range on the external interface that you want to map to an address or address range on the destination network. |
| | **extport** string | | Incoming port number range that you want to map to a port number range on the destination network. |
| | **http\_cookie\_age** integer | | Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit. |
| | **http\_cookie\_domain** string | | Domain that HTTP cookie persistence should apply to. |
| | **http\_cookie\_domain\_from\_host** string | **Choices:*** disable
* enable
| Enable/disable use of HTTP cookie domain from host field in HTTP. |
| | **http\_cookie\_generation** integer | | Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. |
| | **http\_cookie\_path** string | | Limit HTTP cookie persistence to the specified path. |
| | **http\_cookie\_share** string | **Choices:*** disable
* same-ip
| Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disable stops cookie sharing. |
| | **http\_ip\_header** string | **Choices:*** enable
* disable
| For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. |
| | **http\_ip\_header\_name** string | | For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-Forwarded-For is used. |
| | **http\_multiplex** string | **Choices:*** enable
* disable
| Enable/disable HTTP multiplexing. |
| | **http\_redirect** string | **Choices:*** enable
* disable
| Enable/disable redirection of HTTP to HTTPS |
| | **https\_cookie\_secure** string | **Choices:*** disable
* enable
| Enable/disable verification that inserted HTTPS cookies are secure. |
| | **id** integer | | Custom defined ID. |
| | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
* http-host
| Method used to distribute sessions to real servers. |
| | **mappedip** string | | Mapped IP address range in the format startIP-endIP. |
| | **mappedport** string | | Port number range on the destination network to which the external port number range is mapped. |
| | **max\_embryonic\_connections** integer | | Maximum number of incomplete connections. |
| | **monitor** list / elements=string | | Name of the health check monitor to use when polling to determine a virtual server"s connectivity status. |
| | | **name** string / required | | Health monitor name. Source firewall.ldb-monitor.name. |
| | **name** string / required | | Virtual ip6 name. |
| | **nat\_source\_vip** string | **Choices:*** disable
* enable
| Enable to perform SNAT on traffic from mappedip to the extip for all egress interfaces. |
| | **outlook\_web\_access** string | **Choices:*** disable
* enable
| Enable to add the Front-End-Https header for Microsoft Outlook Web Access. |
| | **persistence** string | **Choices:*** none
* http-cookie
* ssl-session-id
| Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable port forwarding. |
| | **protocol** string | **Choices:*** tcp
* udp
* sctp
| Protocol to use when forwarding packets. |
| | **realservers** list / elements=string | | Select the real servers that this server load balancing VIP will distribute traffic to. |
| | | **client\_ip** string | | Only clients in this IP range can connect to this real server. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Enable to check the responsiveness of the real server before forwarding traffic. |
| | | **holddown\_interval** integer | | Time in seconds that the health check monitor continues to monitor an unresponsive server that should be active. |
| | | **http\_host** string | | HTTP server domain name in HTTP header. |
| | | **id** integer / required | | Real server ID. |
| | | **ip** string | | IPv6 address of the real server. |
| | | **max\_connections** integer | | Max number of active connections that can directed to the real server. When reached, sessions are sent to other real servers. |
| | | **monitor** string | | Name of the health check monitor to use when polling to determine a virtual server"s connectivity status. Source firewall .ldb-monitor.name. |
| | | **port** integer | | Port for communicating with the real server. Required if port forwarding is enabled. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. |
| | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| | **server\_type** string | **Choices:*** http
* https
* imaps
* pop3s
* smtps
* ssl
* tcp
* udp
* ip
| Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). |
| | **src\_filter** list / elements=string | | Source IP6 filter (x:x:x:x:x:x:x:x/x). Separate addresses with spaces. |
| | | **range** string / required | | Source-filter range. |
| | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
* custom
| Permitted encryption algorithms for SSL sessions according to encryption strength. |
| | **ssl\_certificate** string | | The name of the SSL certificate to use for SSL acceleration. Source vpn.certificate.local.name. |
| | **ssl\_cipher\_suites** list / elements=string | | SSL/TLS cipher suites acceptable from a client, ordered by priority. |
| | | **cipher** string | **Choices:*** TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-128-GCM-SHA256
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-AES-128-CBC-SHA
* TLS-RSA-WITH-AES-256-CBC-SHA
* TLS-RSA-WITH-AES-128-CBC-SHA256
* TLS-RSA-WITH-AES-128-GCM-SHA256
* TLS-RSA-WITH-AES-256-CBC-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384
* TLS-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer / required | | SSL/TLS cipher suites priority. |
| | | **versions** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| SSL/TLS versions that the cipher suite can be used with. |
| | **ssl\_client\_fallback** string | **Choices:*** disable
* enable
| Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). |
| | **ssl\_client\_rekey\_count** integer | | Maximum length of data in MB before triggering a client rekey (0 = disable). |
| | **ssl\_client\_renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. |
| | **ssl\_client\_session\_state\_max** integer | | Maximum number of client to FortiGate SSL session states to keep. |
| | **ssl\_client\_session\_state\_timeout** integer | | Number of minutes to keep client to FortiGate SSL session state. |
| | **ssl\_client\_session\_state\_type** string | **Choices:*** disable
* time
* count
* both
| How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. |
| | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
* 3072
* 4096
| Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. |
| | **ssl\_hpkp** string | **Choices:*** disable
* enable
* report-only
| Enable/disable including HPKP header in response. |
| | **ssl\_hpkp\_age** integer | | Number of minutes the web browser should keep HPKP. |
| | **ssl\_hpkp\_backup** string | | Certificate to generate backup HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
| | **ssl\_hpkp\_include\_subdomains** string | **Choices:*** disable
* enable
| Indicate that HPKP header applies to all subdomains. |
| | **ssl\_hpkp\_primary** string | | Certificate to generate primary HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
| | **ssl\_hpkp\_report\_uri** string | | URL to report HPKP violations to. |
| | **ssl\_hsts** string | **Choices:*** disable
* enable
| Enable/disable including HSTS header in response. |
| | **ssl\_hsts\_age** integer | | Number of seconds the client should honour the HSTS setting. |
| | **ssl\_hsts\_include\_subdomains** string | **Choices:*** disable
* enable
| Indicate that HSTS header applies to all subdomains. |
| | **ssl\_http\_location\_conversion** string | **Choices:*** enable
* disable
| Enable to replace HTTP with HTTPS in the reply"s Location HTTP header field. |
| | **ssl\_http\_match\_host** string | **Choices:*** enable
* disable
| Enable/disable HTTP host matching for location conversion. |
| | **ssl\_max\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version acceptable from a client. |
| | **ssl\_min\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version acceptable from a client. |
| | **ssl\_mode** string | **Choices:*** half
* full
| Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to the server (full). |
| | **ssl\_pfs** string | **Choices:*** require
* deny
* allow
| Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. |
| | **ssl\_send\_empty\_frags** string | **Choices:*** enable
* disable
| Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibility with older systems. |
| | **ssl\_server\_algorithm** string | **Choices:*** high
* medium
* low
* custom
* client
| Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. |
| | **ssl\_server\_cipher\_suites** list / elements=string | | SSL/TLS cipher suites to offer to a server, ordered by priority. |
| | | **cipher** string | **Choices:*** TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-128-GCM-SHA256
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-AES-128-CBC-SHA
* TLS-RSA-WITH-AES-256-CBC-SHA
* TLS-RSA-WITH-AES-128-CBC-SHA256
* TLS-RSA-WITH-AES-128-GCM-SHA256
* TLS-RSA-WITH-AES-256-CBC-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384
* TLS-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer / required | | SSL/TLS cipher suites priority. |
| | | **versions** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| SSL/TLS versions that the cipher suite can be used with. |
| | **ssl\_server\_max\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| Highest SSL/TLS version acceptable from a server. Use the client setting by default. |
| | **ssl\_server\_min\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| Lowest SSL/TLS version acceptable from a server. Use the client setting by default. |
| | **ssl\_server\_session\_state\_max** integer | | Maximum number of FortiGate to Server SSL session states to keep. |
| | **ssl\_server\_session\_state\_timeout** integer | | Number of minutes to keep FortiGate to Server SSL session state. |
| | **ssl\_server\_session\_state\_type** string | **Choices:*** disable
* time
* count
* both
| How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| Configure a static NAT or server load balance VIP. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **weblogic\_server** string | **Choices:*** disable
* enable
| Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. |
| | **websphere\_server** string | **Choices:*** disable
* enable
| Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure virtual IP for IPv6.
fortios_firewall_vip6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip6:
arp_reply: "disable"
color: "4"
comment: "Comment."
extip: "<your_own_value>"
extport: "<your_own_value>"
http_cookie_age: "8"
http_cookie_domain: "<your_own_value>"
http_cookie_domain_from_host: "disable"
http_cookie_generation: "11"
http_cookie_path: "<your_own_value>"
http_cookie_share: "disable"
http_ip_header: "enable"
http_ip_header_name: "<your_own_value>"
http_multiplex: "enable"
http_redirect: "enable"
https_cookie_secure: "disable"
id: "19"
ldb_method: "static"
mappedip: "<your_own_value>"
mappedport: "<your_own_value>"
max_embryonic_connections: "23"
monitor:
-
name: "default_name_25 (source firewall.ldb-monitor.name)"
name: "default_name_26"
nat_source_vip: "disable"
outlook_web_access: "disable"
persistence: "none"
portforward: "disable"
protocol: "tcp"
realservers:
-
client_ip: "<your_own_value>"
healthcheck: "disable"
holddown_interval: "35"
http_host: "myhostname"
id: "37"
ip: "<your_own_value>"
max_connections: "39"
monitor: "<your_own_value> (source firewall.ldb-monitor.name)"
port: "41"
status: "active"
weight: "43"
server_type: "http"
src_filter:
-
range: "<your_own_value>"
ssl_algorithm: "high"
ssl_certificate: "<your_own_value> (source vpn.certificate.local.name)"
ssl_cipher_suites:
-
cipher: "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
priority: "51"
versions: "ssl-3.0"
ssl_client_fallback: "disable"
ssl_client_rekey_count: "54"
ssl_client_renegotiation: "allow"
ssl_client_session_state_max: "56"
ssl_client_session_state_timeout: "57"
ssl_client_session_state_type: "disable"
ssl_dh_bits: "768"
ssl_hpkp: "disable"
ssl_hpkp_age: "61"
ssl_hpkp_backup: "<your_own_value> (source vpn.certificate.local.name vpn.certificate.ca.name)"
ssl_hpkp_include_subdomains: "disable"
ssl_hpkp_primary: "<your_own_value> (source vpn.certificate.local.name vpn.certificate.ca.name)"
ssl_hpkp_report_uri: "<your_own_value>"
ssl_hsts: "disable"
ssl_hsts_age: "67"
ssl_hsts_include_subdomains: "disable"
ssl_http_location_conversion: "enable"
ssl_http_match_host: "enable"
ssl_max_version: "ssl-3.0"
ssl_min_version: "ssl-3.0"
ssl_mode: "half"
ssl_pfs: "require"
ssl_send_empty_frags: "enable"
ssl_server_algorithm: "high"
ssl_server_cipher_suites:
-
cipher: "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
priority: "79"
versions: "ssl-3.0"
ssl_server_max_version: "ssl-3.0"
ssl_server_min_version: "ssl-3.0"
ssl_server_session_state_max: "83"
ssl_server_session_state_timeout: "84"
ssl_server_session_state_type: "disable"
type: "static-nat"
uuid: "<your_own_value>"
weblogic_server: "disable"
websphere_server: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_np6 – Configure NP6 attributes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_np6 – Configure NP6 attributes in Fortinet’s FortiOS and FortiGate.
=====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_np6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and np6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_np6** dictionary | | Configure NP6 attributes. |
| | **fastpath** string | **Choices:*** disable
* enable
| Enable/disable NP4 or NP6 offloading (also called fast path). |
| | **fp\_anomaly** dictionary | | NP6 IPv4 anomaly protection. trap-to-host forwards anomaly sessions to the CPU. |
| | | **icmp\_csum\_err** string | **Choices:*** drop
* trap-to-host
| Invalid IPv4 ICMP checksum anomalies. |
| | | **icmp\_frag** string | **Choices:*** allow
* drop
* trap-to-host
| Layer 3 fragmented packets that could be part of layer 4 ICMP anomalies. |
| | | **icmp\_land** string | **Choices:*** allow
* drop
* trap-to-host
| ICMP land anomalies. |
| | | **ipv4\_csum\_err** string | **Choices:*** drop
* trap-to-host
| Invalid IPv4 IP checksum anomalies. |
| | | **ipv4\_land** string | **Choices:*** allow
* drop
* trap-to-host
| Land anomalies. |
| | | **ipv4\_optlsrr** string | **Choices:*** allow
* drop
* trap-to-host
| Loose source record route option anomalies. |
| | | **ipv4\_optrr** string | **Choices:*** allow
* drop
* trap-to-host
| Record route option anomalies. |
| | | **ipv4\_optsecurity** string | **Choices:*** allow
* drop
* trap-to-host
| Security option anomalies. |
| | | **ipv4\_optssrr** string | **Choices:*** allow
* drop
* trap-to-host
| Strict source record route option anomalies. |
| | | **ipv4\_optstream** string | **Choices:*** allow
* drop
* trap-to-host
| Stream option anomalies. |
| | | **ipv4\_opttimestamp** string | **Choices:*** allow
* drop
* trap-to-host
| Timestamp option anomalies. |
| | | **ipv4\_proto\_err** string | **Choices:*** allow
* drop
* trap-to-host
| Invalid layer 4 protocol anomalies. |
| | | **ipv4\_unknopt** string | **Choices:*** allow
* drop
* trap-to-host
| Unknown option anomalies. |
| | | **ipv6\_daddr\_err** string | **Choices:*** allow
* drop
* trap-to-host
| Destination address as unspecified or loopback address anomalies. |
| | | **ipv6\_land** string | **Choices:*** allow
* drop
* trap-to-host
| Land anomalies. |
| | | **ipv6\_optendpid** string | **Choices:*** allow
* drop
* trap-to-host
| End point identification anomalies. |
| | | **ipv6\_opthomeaddr** string | **Choices:*** allow
* drop
* trap-to-host
| Home address option anomalies. |
| | | **ipv6\_optinvld** string | **Choices:*** allow
* drop
* trap-to-host
| Invalid option anomalies.Invalid option anomalies. |
| | | **ipv6\_optjumbo** string | **Choices:*** allow
* drop
* trap-to-host
| Jumbo options anomalies. |
| | | **ipv6\_optnsap** string | **Choices:*** allow
* drop
* trap-to-host
| Network service access point address option anomalies. |
| | | **ipv6\_optralert** string | **Choices:*** allow
* drop
* trap-to-host
| Router alert option anomalies. |
| | | **ipv6\_opttunnel** string | **Choices:*** allow
* drop
* trap-to-host
| Tunnel encapsulation limit option anomalies. |
| | | **ipv6\_proto\_err** string | **Choices:*** allow
* drop
* trap-to-host
| Layer 4 invalid protocol anomalies. |
| | | **ipv6\_saddr\_err** string | **Choices:*** allow
* drop
* trap-to-host
| Source address as multicast anomalies. |
| | | **ipv6\_unknopt** string | **Choices:*** allow
* drop
* trap-to-host
| Unknown option anomalies. |
| | | **tcp\_csum\_err** string | **Choices:*** drop
* trap-to-host
| Invalid IPv4 TCP checksum anomalies. |
| | | **tcp\_fin\_noack** string | **Choices:*** allow
* drop
* trap-to-host
| TCP SYN flood with FIN flag set without ACK setting anomalies. |
| | | **tcp\_fin\_only** string | **Choices:*** allow
* drop
* trap-to-host
| TCP SYN flood with only FIN flag set anomalies. |
| | | **tcp\_land** string | **Choices:*** allow
* drop
* trap-to-host
| TCP land anomalies. |
| | | **tcp\_no\_flag** string | **Choices:*** allow
* drop
* trap-to-host
| TCP SYN flood with no flag set anomalies. |
| | | **tcp\_syn\_data** string | **Choices:*** allow
* drop
* trap-to-host
| TCP SYN flood packets with data anomalies. |
| | | **tcp\_syn\_fin** string | **Choices:*** allow
* drop
* trap-to-host
| TCP SYN flood SYN/FIN flag set anomalies. |
| | | **tcp\_winnuke** string | **Choices:*** allow
* drop
* trap-to-host
| TCP WinNuke anomalies. |
| | | **udp\_csum\_err** string | **Choices:*** drop
* trap-to-host
| Invalid IPv4 UDP checksum anomalies. |
| | | **udp\_land** string | **Choices:*** allow
* drop
* trap-to-host
| UDP land anomalies. |
| | **garbage\_session\_collector** string | **Choices:*** disable
* enable
| Enable/disable garbage session collector. |
| | **hpe** string | | HPE configuration. |
| | | **arp\_max** integer | | Maximum ARP packet rate (10K - 4G pps). |
| | | **enable\_shaper** string | **Choices:*** disable
* enable
| Enable/Disable NPU host protection engine (HPE) shaper. |
| | | **esp\_max** integer | | Maximum ESP packet rate (10K - 4G pps). |
| | | **icmp\_max** integer | | Maximum ICMP packet rate (10K - 4G pps). |
| | | **ip\_frag\_max** integer | | Maximum fragmented IP packet rate (10K - 4G pps). |
| | | **ip\_others\_max** integer | | Maximum IP packet rate for other packets (packet types that cannot be set with other options) (10G - 4G pps). |
| | | **l2\_others\_max** integer | | Maximum L2 packet rate for L2 packets that are not ARP packets (10K - 4G pps). |
| | | **pri\_type\_max** integer | | Maximum overflow rate of priority type traffic(10K - 4G pps). Includes L2: HA, 802.3ad LACP, heartbeats. L3: OSPF. L4\_TCP: BGP. L4\_UDP: IKE, SLBC, BFD. |
| | | **sctp\_max** integer | | Maximum SCTP packet rate (10K - 4G pps). |
| | | **tcp\_max** integer | | Maximum TCP packet rate (10K - 4G pps). |
| | | **tcpfin\_rst\_max** integer | | Maximum TCP carries FIN or RST flags packet rate (1K - 1G pps). |
| | | **tcpsyn\_ack\_max** integer | | Maximum TCP carries SYN and ACK flags packet rate (1K - 1G pps). |
| | | **tcpsyn\_max** integer | | Maximum TCP SYN packet rate (10K - 4G pps). |
| | | **udp\_max** integer | | Maximum UDP packet rate (10K - 4G pps). |
| | **ipsec\_ob\_hash\_function** string | **Choices:*** global-hash
* round-robin-global
| Set hash function for IPSec outbound. |
| | **ipsec\_outbound\_hash** string | **Choices:*** disable
* enable
| Enable/disable hash function for IPsec outbound traffic. |
| | **low\_latency\_mode** string | **Choices:*** disable
* enable
| Enable/disable low latency mode. |
| | **name** string / required | | Device Name. |
| | **per\_session\_accounting** string | **Choices:*** disable
* traffic-log-only
* enable
| Enable/disable per-session accounting. |
| | **session\_collector\_interval** integer | | Set garbage session collection cleanup interval (1 - 100 sec). |
| | **session\_timeout\_fixed** string | **Choices:*** disable
* enable
| {disable | enable} Toggle between using fixed or random timeouts for refreshing NP6 sessions. |
| | **session\_timeout\_interval** integer | | Set the fixed timeout for refreshing NP6 sessions (0 - 1000 sec). |
| | **session\_timeout\_random\_range** integer | | Set the random timeout range for refreshing NP6 sessions (0 - 1000 sec). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NP6 attributes.
fortios_system_np6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_np6:
fastpath: "disable"
fp_anomaly:
icmp_csum_err: "drop"
icmp_frag: "allow"
icmp_land: "allow"
ipv4_csum_err: "drop"
ipv4_land: "allow"
ipv4_optlsrr: "allow"
ipv4_optrr: "allow"
ipv4_optsecurity: "allow"
ipv4_optssrr: "allow"
ipv4_optstream: "allow"
ipv4_opttimestamp: "allow"
ipv4_proto_err: "allow"
ipv4_unknopt: "allow"
ipv6_daddr_err: "allow"
ipv6_land: "allow"
ipv6_optendpid: "allow"
ipv6_opthomeaddr: "allow"
ipv6_optinvld: "allow"
ipv6_optjumbo: "allow"
ipv6_optnsap: "allow"
ipv6_optralert: "allow"
ipv6_opttunnel: "allow"
ipv6_proto_err: "allow"
ipv6_saddr_err: "allow"
ipv6_unknopt: "allow"
tcp_csum_err: "drop"
tcp_fin_noack: "allow"
tcp_fin_only: "allow"
tcp_land: "allow"
tcp_no_flag: "allow"
tcp_syn_data: "allow"
tcp_syn_fin: "allow"
tcp_winnuke: "allow"
udp_csum_err: "drop"
udp_land: "allow"
garbage_session_collector: "disable"
hpe:
arp_max: "42"
enable_shaper: "disable"
esp_max: "44"
icmp_max: "45"
ip_frag_max: "46"
ip_others_max: "47"
l2_others_max: "48"
pri_type_max: "49"
sctp_max: "50"
tcp_max: "51"
tcpfin_rst_max: "52"
tcpsyn_ack_max: "53"
tcpsyn_max: "54"
udp_max: "55"
ipsec_ob_hash_function: "global-hash"
ipsec_outbound_hash: "disable"
low_latency_mode: "disable"
name: "default_name_59"
per_session_accounting: "disable"
session_collector_interval: "61"
session_timeout_fixed: "disable"
session_timeout_interval: "63"
session_timeout_random_range: "64"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_switch_interface_tag – Configure switch object tags in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_switch\_interface\_tag – Configure switch object tags in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_switch_interface_tag`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and switch\_interface\_tag 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_switch\_interface\_tag** dictionary | | Configure switch object tags. |
| | **name** string / required | | Tag name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure switch object tags.
fortios_switch_controller_switch_interface_tag:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_switch_interface_tag:
name: "default_name_3"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ssl_web_host_check_software – SSL-VPN host check software in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_web\_host\_check\_software – SSL-VPN host check software in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ssl_web_host_check_software`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ssl\_web feature and host\_check\_software 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ssl\_web\_host\_check\_software** dictionary | | SSL-VPN host check software. |
| | **check\_item\_list** list / elements=string | | Check item list. |
| | | **action** string | **Choices:*** require
* deny
| Action. |
| | | **id** integer / required | | ID (0 - 4294967295). |
| | | **md5s** list / elements=string | | MD5 checksum. |
| | | | **id** string / required | | Hex string of MD5 checksum. |
| | | **target** string | | Target. |
| | | **type** string | **Choices:*** file
* registry
* process
| Type. |
| | | **version** string | | Version. |
| | **guid** string | | Globally unique ID. |
| | **name** string / required | | Name. |
| | **os\_type** string | **Choices:*** windows
* macos
| OS type. |
| | **type** string | **Choices:*** av
* fw
| Type. |
| | **version** string | | Version. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSL-VPN host check software.
fortios_vpn_ssl_web_host_check_software:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_host_check_software:
check_item_list:
-
action: "require"
id: "5"
md5s:
-
id: "7"
target: "<your_own_value>"
type: "file"
version: "<your_own_value>"
guid: "<your_own_value>"
name: "default_name_12"
os_type: "windows"
type: "av"
version: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_management_tunnel – Management tunnel configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_management\_tunnel – Management tunnel configuration in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_management_tunnel`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and management\_tunnel 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_management\_tunnel** dictionary | | Management tunnel configuration. |
| | **allow\_collect\_statistics** string | **Choices:*** enable
* disable
| Enable/disable collection of run time statistics. |
| | **allow\_config\_restore** string | **Choices:*** enable
* disable
| Enable/disable allow config restore. |
| | **allow\_push\_configuration** string | **Choices:*** enable
* disable
| Enable/disable push configuration. |
| | **allow\_push\_firmware** string | **Choices:*** enable
* disable
| Enable/disable push firmware. |
| | **authorized\_manager\_only** string | **Choices:*** enable
* disable
| Enable/disable restriction of authorized manager only. |
| | **serial\_number** string | | Serial number. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FGFM tunnel. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Management tunnel configuration.
fortios_system_management_tunnel:
vdom: "{{ vdom }}"
system_management_tunnel:
allow_collect_statistics: "enable"
allow_config_restore: "enable"
allow_push_configuration: "enable"
allow_push_firmware: "enable"
authorized_manager_only: "enable"
serial_number: "<your_own_value>"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_web_proxy_url_match – Exempt URLs from web proxy forwarding and caching in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_url\_match – Exempt URLs from web proxy forwarding and caching in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_web_proxy_url_match`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web\_proxy feature and url\_match 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **web\_proxy\_url\_match** dictionary | | Exempt URLs from web proxy forwarding and caching. |
| | **cache\_exemption** string | **Choices:*** enable
* disable
| Enable/disable exempting this URL pattern from caching. |
| | **comment** string | | Comment. |
| | **forward\_server** string | | Forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
| | **name** string / required | | Configure a name for the URL to be exempted. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. |
| | **url\_pattern** string | | URL pattern to be exempted from web proxy forwarding and caching. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Exempt URLs from web proxy forwarding and caching.
fortios_web_proxy_url_match:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_url_match:
cache_exemption: "enable"
comment: "Comment."
forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
name: "default_name_6"
status: "enable"
url_pattern: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ssh_host_key – SSH proxy host public keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssh\_host\_key – SSH proxy host public keys in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ssh_host_key`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_ssh feature and host\_key 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ssh\_host\_key** dictionary | | SSH proxy host public keys. |
| | **hostname** string | | Hostname of the SSH server. |
| | **ip** string | | IP address of the SSH server. |
| | **name** string / required | | SSH public key name. |
| | **nid** string | **Choices:*** 256
* 384
* 521
| Set the nid of the ECDSA key. |
| | **port** integer | | Port of the SSH server. |
| | **public\_key** string | | SSH public key. |
| | **status** string | **Choices:*** trusted
* revoked
| Set the trust status of the public key. |
| | **type** string | **Choices:*** RSA
* DSA
* ECDSA
* ED25519
* RSA-CA
* DSA-CA
* ECDSA-CA
* ED25519-CA
| Set the type of the public key. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSH proxy host public keys.
fortios_firewall_ssh_host_key:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ssh_host_key:
hostname: "myhostname"
ip: "<your_own_value>"
name: "default_name_5"
nid: "256"
port: "7"
public_key: "<your_own_value>"
status: "trusted"
type: "RSA"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_ips_decoder – Configure IPS decoder in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_decoder – Configure IPS decoder in Fortinet’s FortiOS and FortiGate.
===================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_ips_decoder`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and decoder 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ips\_decoder** dictionary | | Configure IPS decoder. |
| | **name** string / required | | Decoder name. |
| | **parameter** list / elements=string | | IPS group parameters. |
| | | **name** string / required | | Parameter name. |
| | | **value** string | | Parameter value. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPS decoder.
fortios_ips_decoder:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_decoder:
name: "default_name_3"
parameter:
-
name: "default_name_5"
value: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_snmp_community – Configure FortiSwitch SNMP v1/v2c communities globally in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_snmp\_community – Configure FortiSwitch SNMP v1/v2c communities globally in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_snmp_community`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and snmp\_community 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_snmp\_community** dictionary | | Configure FortiSwitch SNMP v1/v2c communities globally. |
| | **events** list / elements=string | **Choices:*** cpu-high
* mem-low
* log-full
* intf-ip
* ent-conf-change
| SNMP notifications (traps) to send. |
| | **hosts** list / elements=string | | Configure IPv4 SNMP managers (hosts). |
| | | **id** integer / required | | Host entry ID. |
| | | **ip** string | | IPv4 address of the SNMP manager (host). |
| | **id** integer / required | | SNMP community ID. |
| | **name** string | | SNMP community name. |
| | **query\_v1\_port** integer | | SNMP v1 query port . |
| | **query\_v1\_status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v1 queries. |
| | **query\_v2c\_port** integer | | SNMP v2c query port . |
| | **query\_v2c\_status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v2c queries. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this SNMP community. |
| | **trap\_v1\_lport** integer | | SNMP v2c trap local port . |
| | **trap\_v1\_rport** integer | | SNMP v2c trap remote port . |
| | **trap\_v1\_status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v1 traps. |
| | **trap\_v2c\_lport** integer | | SNMP v2c trap local port . |
| | **trap\_v2c\_rport** integer | | SNMP v2c trap remote port . |
| | **trap\_v2c\_status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v2c traps. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch SNMP v1/v2c communities globally.
fortios_switch_controller_snmp_community:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_snmp_community:
events: "cpu-high"
hosts:
-
id: "5"
ip: "<your_own_value>"
id: "7"
name: "default_name_8"
query_v1_port: "9"
query_v1_status: "disable"
query_v2c_port: "11"
query_v2c_status: "disable"
status: "disable"
trap_v1_lport: "14"
trap_v1_rport: "15"
trap_v1_status: "disable"
trap_v2c_lport: "17"
trap_v2c_rport: "18"
trap_v2c_status: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_web_proxy_explicit – Configure explicit Web proxy settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_explicit – Configure explicit Web proxy settings in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_web_proxy_explicit`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web\_proxy feature and explicit 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **web\_proxy\_explicit** dictionary | | Configure explicit Web proxy settings. |
| | **ftp\_incoming\_port** string | | Accept incoming FTP-over-HTTP requests on one or more ports (0 - 65535). |
| | **ftp\_over\_http** string | **Choices:*** enable
* disable
| Enable to proxy FTP-over-HTTP sessions sent from a web browser. |
| | **http\_incoming\_port** string | | Accept incoming HTTP requests on one or more ports (0 - 65535). |
| | **https\_incoming\_port** string | | Accept incoming HTTPS requests on one or more ports (0 - 65535). |
| | **https\_replacement\_message** string | **Choices:*** enable
* disable
| Enable/disable sending the client a replacement message for HTTPS requests. |
| | **incoming\_ip** string | | Restrict the explicit HTTP proxy to only accept sessions from this IP address. An interface must have this IP address. |
| | **incoming\_ip6** string | | Restrict the explicit web proxy to only accept sessions from this IPv6 address. An interface must have this IPv6 address. |
| | **ipv6\_status** string | **Choices:*** enable
* disable
| Enable/disable allowing an IPv6 web proxy destination in policies and all IPv6 related entries in this command. |
| | **message\_upon\_server\_error** string | **Choices:*** enable
* disable
| Enable/disable displaying a replacement message when a server error is detected. |
| | **outgoing\_ip** string | | Outgoing HTTP requests will have this IP address as their source address. An interface must have this IP address. |
| | **outgoing\_ip6** string | | Outgoing HTTP requests will leave this IPv6. Multiple interfaces can be specified. Interfaces must have these IPv6 addresses. |
| | **pac\_file\_data** string | | PAC file contents enclosed in quotes (maximum of 256K bytes). |
| | **pac\_file\_name** string | | Pac file name. |
| | **pac\_file\_server\_port** string | | Port number that PAC traffic from client web browsers uses to connect to the explicit web proxy (0 - 65535). |
| | **pac\_file\_server\_status** string | **Choices:*** enable
* disable
| Enable/disable Proxy Auto-Configuration (PAC) for users of this explicit proxy profile. |
| | **pac\_file\_url** string | | PAC file access URL. |
| | **pac\_policy** list / elements=string | | PAC policies. |
| | | **comments** string | | Optional comments. |
| | | **dstaddr** list / elements=string | | Destination address objects. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **pac\_file\_data** string | | PAC file contents enclosed in quotes (maximum of 256K bytes). |
| | | **pac\_file\_name** string | | Pac file name. |
| | | **policyid** integer / required | | Policy ID. |
| | | **srcaddr** list / elements=string | | Source address objects. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name. |
| | | **srcaddr6** list / elements=string | | Source address6 objects. |
| | | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable policy. |
| | **pref\_dns\_result** string | **Choices:*** ipv4
* ipv6
| Prefer resolving addresses using the configured IPv4 or IPv6 DNS server . |
| | **realm** string | | Authentication realm used to identify the explicit web proxy (maximum of 63 characters). |
| | **sec\_default\_action** string | **Choices:*** accept
* deny
| Accept or deny explicit web proxy sessions when no web proxy firewall policy exists. |
| | **socks** string | **Choices:*** enable
* disable
| Enable/disable the SOCKS proxy. |
| | **socks\_incoming\_port** string | | Accept incoming SOCKS proxy requests on one or more ports (0 - 65535). |
| | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted in HTTPS deep scan: high, medium, or low. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the explicit Web proxy for HTTP and HTTPS session. |
| | **strict\_guest** string | **Choices:*** enable
* disable
| Enable/disable strict guest user checking by the explicit web proxy. |
| | **trace\_auth\_no\_rsp** string | **Choices:*** enable
* disable
| Enable/disable logging timed-out authentication requests. |
| | **unknown\_http\_version** string | **Choices:*** reject
* best-effort
* tunnel
| Either reject unknown HTTP traffic as malformed or handle unknown HTTP traffic as best as the proxy server can. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure explicit Web proxy settings.
fortios_web_proxy_explicit:
vdom: "{{ vdom }}"
web_proxy_explicit:
ftp_incoming_port: "<your_own_value>"
ftp_over_http: "enable"
http_incoming_port: "<your_own_value>"
https_incoming_port: "<your_own_value>"
https_replacement_message: "enable"
incoming_ip: "<your_own_value>"
incoming_ip6: "<your_own_value>"
ipv6_status: "enable"
message_upon_server_error: "enable"
outgoing_ip: "<your_own_value>"
outgoing_ip6: "<your_own_value>"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
pac_file_server_port: "<your_own_value>"
pac_file_server_status: "enable"
pac_file_url: "<your_own_value>"
pac_policy:
-
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
policyid: "25"
srcaddr:
-
name: "default_name_27 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
srcaddr6:
-
name: "default_name_29 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
pref_dns_result: "ipv4"
realm: "<your_own_value>"
sec_default_action: "accept"
socks: "enable"
socks_incoming_port: "<your_own_value>"
ssl_algorithm: "high"
status: "enable"
strict_guest: "enable"
trace_auth_no_rsp: "enable"
unknown_http_version: "reject"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_snmp_trap_threshold – Configure FortiSwitch SNMP trap threshold values globally in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_snmp\_trap\_threshold – Configure FortiSwitch SNMP trap threshold values globally in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_snmp_trap_threshold`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and snmp\_trap\_threshold 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_snmp\_trap\_threshold** dictionary | | Configure FortiSwitch SNMP trap threshold values globally. |
| | **trap\_high\_cpu\_threshold** integer | | CPU usage when trap is sent. |
| | **trap\_log\_full\_threshold** integer | | Log disk usage when trap is sent. |
| | **trap\_low\_memory\_threshold** integer | | Memory usage when trap is sent. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch SNMP trap threshold values globally.
fortios_switch_controller_snmp_trap_threshold:
vdom: "{{ vdom }}"
switch_controller_snmp_trap_threshold:
trap_high_cpu_threshold: "3"
trap_log_full_threshold: "4"
trap_low_memory_threshold: "5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_ippool – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ippool – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ippool`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ippool** dictionary | | Configure IPv4 IP pools. |
| | **arp\_intf** string | | Select an interface from available options that will reply to ARP requests. (If blank, any is selected). Source system.interface.name. |
| | **arp\_reply** string | **Choices:*** disable
* enable
| Enable/disable replying to ARP requests when an IP Pool is added to a policy . |
| | **associated\_interface** string | | Associated interface name. Source system.interface.name. |
| | **block\_size** integer | | Number of addresses in a block (64 to 4096). |
| | **comments** string | | Comment. |
| | **endip** string | | Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). |
| | **endport** integer | | Final port number (inclusive) in the range for the address pool . |
| | **name** string / required | | IP pool name. |
| | **num\_blocks\_per\_user** integer | | Number of addresses blocks that can be used by a user (1 to 128). |
| | **pba\_timeout** integer | | Port block allocation timeout (seconds). |
| | **permit\_any\_host** string | **Choices:*** disable
* enable
| Enable/disable full cone NAT. |
| | **port\_per\_user** integer | | Number of port for each user (32 to 60416). |
| | **source\_endip** string | | Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx). |
| | **source\_startip** string | | First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx). |
| | **startip** string | | First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). |
| | **startport** integer | | First port number (inclusive) in the range for the address pool . |
| | **type** string | **Choices:*** overload
* one-to-one
* fixed-port-range
* port-block-allocation
| IP pool type (overload, one-to-one, fixed port range, or port block allocation). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 IP pools.
fortios_firewall_ippool:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ippool:
arp_intf: "<your_own_value> (source system.interface.name)"
arp_reply: "disable"
associated_interface: "<your_own_value> (source system.interface.name)"
block_size: "6"
comments: "<your_own_value>"
endip: "<your_own_value>"
endport: "9"
name: "default_name_10"
num_blocks_per_user: "11"
pba_timeout: "12"
permit_any_host: "disable"
port_per_user: "14"
source_endip: "<your_own_value>"
source_startip: "<your_own_value>"
startip: "<your_own_value>"
startport: "18"
type: "overload"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_dos_policy6 – Configure IPv6 DoS policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_dos\_policy6 – Configure IPv6 DoS policies in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_dos_policy6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and dos\_policy6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_dos\_policy6** dictionary | | Configure IPv6 DoS policies. |
| | **anomaly** list / elements=string | | Anomaly name. |
| | | **action** string | **Choices:*** pass
* block
* proxy
| Action taken when the threshold is reached. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | | **name** string / required | | Anomaly name. |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine method. |
| | | **quarantine\_expiry** string | | Duration of quarantine. (Format |
| | | **quarantine\_log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this anomaly. |
| | | **threshold** integer | | Anomaly threshold. Number of detected instances per minute that triggers the anomaly action. |
| | | **threshold(default)** integer | | Number of detected instances per minute which triggers action (1 - 2147483647). Note that each anomaly has a different threshold value assigned to it. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address name from available addresses. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **interface** string | | Incoming interface name from available interfaces. Source system.zone.name system.interface.name. |
| | **name** string | | Policy name. |
| | **policyid** integer / required | | Policy ID. |
| | **service** list / elements=string | | Service object from available options. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address name from available addresses. |
| | | **name** string / required | | Service name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 DoS policies.
fortios_firewall_dos_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_dos_policy6:
anomaly:
-
action: "pass"
log: "enable"
name: "default_name_6"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
status: "disable"
threshold: "11"
threshold(default): "12"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
name: "default_name_17"
policyid: "18"
service:
-
name: "default_name_20 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_nntp – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_nntp – Replacement messages in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_nntp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and nntp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_nntp** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_nntp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_nntp:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_sdn_connector fortinet.fortios.fortios\_system\_sdn\_connector
================================================
The documentation for the module plugin, fortinet.fortios.fortios\_system\_sdn\_connector, was malformed.
The errors were:
* ```
1 validation error for ModuleDocSchema
doc -> options -> system_sdn_connector -> suboptions -> vcenter_password -> type
string does not match regex "^(bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$)
```
File a bug with the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) in order to have it corrected.
ansible fortinet.fortios.fortios_router_ospf – Configure OSPF in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_ospf – Configure OSPF in Fortinet’s FortiOS and FortiGate.
============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_ospf`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ospf 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_ospf** dictionary | | Configure OSPF. |
| | **abr\_type** string | **Choices:*** cisco
* ibm
* shortcut
* standard
| Area border router type. |
| | **area** list / elements=string | | OSPF area configuration. |
| | | **authentication** string | **Choices:*** none
* text
* md5
| Authentication type. |
| | | **comments** string | | Comment. |
| | | **default\_cost** integer | | Summary default cost of stub or NSSA area. |
| | | **filter\_list** list / elements=string | | OSPF area filter-list configuration. |
| | | | **direction** string | **Choices:*** in
* out
| Direction. |
| | | | **id** integer / required | | Filter list entry ID. |
| | | | **list** string | | Access-list or prefix-list name. Source router.access-list.name router.prefix-list.name. |
| | | **id** string / required | | Area entry IP address. |
| | | **nssa\_default\_information\_originate** string | **Choices:*** enable
* always
* disable
| Redistribute, advertise, or do not originate Type-7 default route into NSSA area. |
| | | **nssa\_default\_information\_originate\_metric** integer | | OSPF default metric. |
| | | **nssa\_default\_information\_originate\_metric\_type** string | **Choices:*** 1
* 2
| OSPF metric type for default routes. |
| | | **nssa\_redistribution** string | **Choices:*** enable
* disable
| Enable/disable redistribute into NSSA area. |
| | | **nssa\_translator\_role** string | **Choices:*** candidate
* never
* always
| NSSA translator role type. |
| | | **range** list / elements=string | | OSPF area range configuration. |
| | | | **advertise** string | **Choices:*** disable
* enable
| Enable/disable advertise status. |
| | | | **id** integer / required | | Range entry ID. |
| | | | **prefix** string | | Prefix. |
| | | | **substitute** string | | Substitute prefix. |
| | | | **substitute\_status** string | **Choices:*** enable
* disable
| Enable/disable substitute status. |
| | | **shortcut** string | **Choices:*** disable
* enable
* default
| Enable/disable shortcut option. |
| | | **stub\_type** string | **Choices:*** no-summary
* summary
| Stub summary setting. |
| | | **type** string | **Choices:*** regular
* nssa
* stub
| Area type setting. |
| | | **virtual\_link** list / elements=string | | OSPF virtual link configuration. |
| | | | **authentication** string | **Choices:*** none
* text
* md5
| Authentication type. |
| | | | **authentication\_key** string | | Authentication key. |
| | | | **dead\_interval** integer | | Dead interval. |
| | | | **hello\_interval** integer | | Hello interval. |
| | | | **md5\_key** string | | MD5 key. |
| | | | **md5\_keychain** string | | Authentication MD5 key-chain name. Source router.key-chain.name. |
| | | | **md5\_keys** list / elements=string | | MD5 key. |
| | | | | **id** integer / required | | Key ID (1 - 255). |
| | | | | **key\_string** string | | Password for the key. |
| | | | **name** string / required | | Virtual link entry name. |
| | | | **peer** string | | Peer IP. |
| | | | **retransmit\_interval** integer | | Retransmit interval. |
| | | | **transmit\_delay** integer | | Transmit delay. |
| | **auto\_cost\_ref\_bandwidth** integer | | Reference bandwidth in terms of megabits per second. |
| | **bfd** string | **Choices:*** enable
* disable
| Bidirectional Forwarding Detection (BFD). |
| | **database\_overflow** string | **Choices:*** enable
* disable
| Enable/disable database overflow. |
| | **database\_overflow\_max\_lsas** integer | | Database overflow maximum LSAs. |
| | **database\_overflow\_time\_to\_recover** integer | | Database overflow time to recover (sec). |
| | **default\_information\_metric** integer | | Default information metric. |
| | **default\_information\_metric\_type** string | **Choices:*** 1
* 2
| Default information metric type. |
| | **default\_information\_originate** string | **Choices:*** enable
* always
* disable
| Enable/disable generation of default route. |
| | **default\_information\_route\_map** string | | Default information route map. Source router.route-map.name. |
| | **default\_metric** integer | | Default metric of redistribute routes. |
| | **distance** integer | | Distance of the route. |
| | **distance\_external** integer | | Administrative external distance. |
| | **distance\_inter\_area** integer | | Administrative inter-area distance. |
| | **distance\_intra\_area** integer | | Administrative intra-area distance. |
| | **distribute\_list** list / elements=string | | Distribute list configuration. |
| | | **access\_list** string | | Access list name. Source router.access-list.name. |
| | | **id** integer / required | | Distribute list entry ID. |
| | | **protocol** string | **Choices:*** connected
* static
* rip
| Protocol type. |
| | **distribute\_list\_in** string | | Filter incoming routes. Source router.access-list.name router.prefix-list.name. |
| | **distribute\_route\_map\_in** string | | Filter incoming external routes by route-map. Source router.route-map.name. |
| | **log\_neighbour\_changes** string | **Choices:*** enable
* disable
| Enable logging of OSPF neighbour"s changes |
| | **neighbor** list / elements=string | | OSPF neighbor configuration are used when OSPF runs on non-broadcast media |
| | | **cost** integer | | Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
| | | **id** integer / required | | Neighbor entry ID. |
| | | **ip** string | | Interface IP address of the neighbor. |
| | | **poll\_interval** integer | | Poll interval time in seconds. |
| | | **priority** integer | | Priority. |
| | **network** list / elements=string | | OSPF network configuration. |
| | | **area** string | | Attach the network to area. |
| | | **comments** string | | Comment. |
| | | **id** integer / required | | Network entry ID. |
| | | **prefix** string | | Prefix. |
| | **ospf\_interface** list / elements=string | | OSPF interface configuration. |
| | | **authentication** string | **Choices:*** none
* text
* md5
| Authentication type. |
| | | **authentication\_key** string | | Authentication key. |
| | | **bfd** string | **Choices:*** global
* enable
* disable
| Bidirectional Forwarding Detection (BFD). |
| | | **comments** string | | Comment. |
| | | **cost** integer | | Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
| | | **database\_filter\_out** string | **Choices:*** enable
* disable
| Enable/disable control of flooding out LSAs. |
| | | **dead\_interval** integer | | Dead interval. |
| | | **hello\_interval** integer | | Hello interval. |
| | | **hello\_multiplier** integer | | Number of hello packets within dead interval. |
| | | **interface** string | | Configuration interface name. Source system.interface.name. |
| | | **ip** string | | IP address. |
| | | **md5\_key** string | | MD5 key. |
| | | **md5\_keychain** string | | Authentication MD5 key-chain name. Source router.key-chain.name. |
| | | **md5\_keys** list / elements=string | | MD5 key. |
| | | | **id** integer / required | | Key ID (1 - 255). |
| | | | **key\_string** string | | Password for the key. |
| | | **mtu** integer | | MTU for database description packets. |
| | | **mtu\_ignore** string | **Choices:*** enable
* disable
| Enable/disable ignore MTU. |
| | | **name** string / required | | Interface entry name. |
| | | **network\_type** string | **Choices:*** broadcast
* non-broadcast
* point-to-point
* point-to-multipoint
* point-to-multipoint-non-broadcast
| Network type. |
| | | **prefix\_length** integer | | Prefix length. |
| | | **priority** integer | | Priority. |
| | | **resync\_timeout** integer | | Graceful restart neighbor resynchronization timeout. |
| | | **retransmit\_interval** integer | | Retransmit interval. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| | | **transmit\_delay** integer | | Transmit delay. |
| | **passive\_interface** list / elements=string | | Passive interface configuration. |
| | | **name** string / required | | Passive interface name. Source system.interface.name. |
| | **redistribute** list / elements=string | | Redistribute configuration. |
| | | **metric** integer | | Redistribute metric setting. |
| | | **metric\_type** string | **Choices:*** 1
* 2
| Metric type. |
| | | **name** string / required | | Redistribute name. |
| | | **routemap** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| status |
| | | **tag** integer | | Tag value. |
| | **restart\_mode** string | **Choices:*** none
* lls
* graceful-restart
| OSPF restart mode (graceful or LLS). |
| | **restart\_period** integer | | Graceful restart period. |
| | **rfc1583\_compatible** string | **Choices:*** enable
* disable
| Enable/disable RFC1583 compatibility. |
| | **router\_id** string | | Router ID. |
| | **spf\_timers** string | | SPF calculation frequency. |
| | **summary\_address** list / elements=string | | IP address summary configuration. |
| | | **advertise** string | **Choices:*** disable
* enable
| Enable/disable advertise status. |
| | | **id** integer / required | | Summary address entry ID. |
| | | **prefix** string | | Prefix. |
| | | **tag** integer | | Tag value. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure OSPF.
fortios_router_ospf:
vdom: "{{ vdom }}"
router_ospf:
abr_type: "cisco"
area:
-
authentication: "none"
comments: "<your_own_value>"
default_cost: "7"
filter_list:
-
direction: "in"
id: "10"
list: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
id: "12"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "14"
nssa_default_information_originate_metric_type: "1"
nssa_redistribution: "enable"
nssa_translator_role: "candidate"
range:
-
advertise: "disable"
id: "20"
prefix: "<your_own_value>"
substitute: "<your_own_value>"
substitute_status: "enable"
shortcut: "disable"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
authentication_key: "<your_own_value>"
dead_interval: "30"
hello_interval: "31"
md5_key: "<your_own_value>"
md5_keychain: "<your_own_value> (source router.key-chain.name)"
md5_keys:
-
id: "35"
key_string: "<your_own_value>"
name: "default_name_37"
peer: "<your_own_value>"
retransmit_interval: "39"
transmit_delay: "40"
auto_cost_ref_bandwidth: "41"
bfd: "enable"
database_overflow: "enable"
database_overflow_max_lsas: "44"
database_overflow_time_to_recover: "45"
default_information_metric: "46"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "50"
distance: "51"
distance_external: "52"
distance_inter_area: "53"
distance_intra_area: "54"
distribute_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
id: "57"
protocol: "connected"
distribute_list_in: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
distribute_route_map_in: "<your_own_value> (source router.route-map.name)"
log_neighbour_changes: "enable"
neighbor:
-
cost: "63"
id: "64"
ip: "<your_own_value>"
poll_interval: "66"
priority: "67"
network:
-
area: "<your_own_value>"
comments: "<your_own_value>"
id: "71"
prefix: "<your_own_value>"
ospf_interface:
-
authentication: "none"
authentication_key: "<your_own_value>"
bfd: "global"
comments: "<your_own_value>"
cost: "78"
database_filter_out: "enable"
dead_interval: "80"
hello_interval: "81"
hello_multiplier: "82"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
md5_key: "<your_own_value>"
md5_keychain: "<your_own_value> (source router.key-chain.name)"
md5_keys:
-
id: "88"
key_string: "<your_own_value>"
mtu: "90"
mtu_ignore: "enable"
name: "default_name_92"
network_type: "broadcast"
prefix_length: "94"
priority: "95"
resync_timeout: "96"
retransmit_interval: "97"
status: "disable"
transmit_delay: "99"
passive_interface:
-
name: "default_name_101 (source system.interface.name)"
redistribute:
-
metric: "103"
metric_type: "1"
name: "default_name_105"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
tag: "108"
restart_mode: "none"
restart_period: "110"
rfc1583_compatible: "enable"
router_id: "<your_own_value>"
spf_timers: "<your_own_value>"
summary_address:
-
advertise: "disable"
id: "116"
prefix: "<your_own_value>"
tag: "118"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_switch_profile – Configure FortiSwitch switch profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_switch\_profile – Configure FortiSwitch switch profile in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_switch_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and switch\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_switch\_profile** dictionary | | Configure FortiSwitch switch profile. |
| | **login\_passwd** string | | Login password of managed FortiSwitch. |
| | **login\_passwd\_override** string | **Choices:*** enable
* disable
| Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. |
| | **name** string / required | | FortiSwitch Profile name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch switch profile.
fortios_switch_controller_switch_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_switch_profile:
login_passwd: "<your_own_value>"
login_passwd_override: "enable"
name: "default_name_5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_certificate_local – Local keys and certificates in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_certificate\_local – Local keys and certificates in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_certificate_local`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify certificate feature and local 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **certificate\_local** dictionary | | Local keys and certificates. |
| | **acme\_ca\_url** string | | The URL for the ACME CA server (Let"s Encrypt is the ). |
| | **acme\_domain** string | | A valid domain that resolves to this Fortigate. |
| | **acme\_email** string | | Contact email address that is required by some CAs like LetsEncrypt. |
| | **acme\_renew\_window** integer | | Beginning of the renewal window (in days before certificate expiration, 30 by default). |
| | **acme\_rsa\_key\_size** integer | | Length of the RSA private key of the generated cert (Minimum 2048 bits). |
| | **auto\_regenerate\_days** integer | | Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). |
| | **auto\_regenerate\_days\_warning** integer | | Number of days to wait before an expiry warning message is generated (0 = disabled). |
| | **ca\_identifier** string | | CA identifier of the CA server for signing via SCEP. |
| | **certificate** string | | PEM format certificate. |
| | **cmp\_path** string | | Path location inside CMP server. |
| | **cmp\_regeneration\_method** string | **Choices:*** keyupate
* renewal
| CMP auto-regeneration method. |
| | **cmp\_server** string | | "ADDRESS:PORT" for CMP server. |
| | **cmp\_server\_cert** string | | CMP server certificate. Source certificate.ca.name. |
| | **comments** string | | Comment. |
| | **csr** string | | Certificate Signing Request. |
| | **enroll\_protocol** string | **Choices:*** none
* scep
* cmpv2
* acme2
| Certificate enrollment protocol. |
| | **ike\_localid** string | | Local ID the FortiGate uses for authentication as a VPN client. |
| | **ike\_localid\_type** string | **Choices:*** asn1dn
* fqdn
| IKE local ID type. |
| | **last\_updated** integer | | Time at which certificate was last updated. |
| | **name** string / required | | Name. |
| | **name\_encoding** string | **Choices:*** printable
* utf8
| Name encoding method for auto-regeneration. |
| | **password** string | | Password as a PEM file. |
| | **private\_key** string | | PEM format key, encrypted with a password. |
| | **range** string | **Choices:*** global
* vdom
| Either a global or VDOM IP address range for the certificate. |
| | **scep\_password** string | | SCEP server challenge password for auto-regeneration. |
| | **scep\_url** string | | SCEP server URL. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Certificate source type. |
| | **source\_ip** string | | Source IP address for communications to the SCEP server. |
| | **state** string | | Certificate Signing Request State. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Local keys and certificates.
fortios_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_local:
acme_ca_url: "<your_own_value>"
acme_domain: "<your_own_value>"
acme_email: "<your_own_value>"
acme_renew_window: "6"
acme_rsa_key_size: "7"
auto_regenerate_days: "8"
auto_regenerate_days_warning: "9"
ca_identifier: "myId_10"
certificate: "<your_own_value>"
cmp_path: "<your_own_value>"
cmp_regeneration_method: "keyupate"
cmp_server: "<your_own_value>"
cmp_server_cert: "<your_own_value> (source certificate.ca.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "21"
name: "default_name_22"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
range: "global"
scep_password: "<your_own_value>"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
state: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_fortiguard – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fortiguard – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_fortiguard`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortiguard 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_fortiguard** dictionary | | Configure FortiGuard services. |
| | **antispam\_cache** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance. |
| | **antispam\_cache\_mpercent** integer | | Maximum percent of FortiGate memory the antispam cache is allowed to use (1 - 15%). |
| | **antispam\_cache\_ttl** integer | | Time-to-live for antispam cache entries in seconds (300 - 86400). Lower times reduce the cache size. Higher times may improve performance since the cache will have more entries. |
| | **antispam\_expiration** integer | | Expiration date of the FortiGuard antispam contract. |
| | **antispam\_force\_off** string | **Choices:*** enable
* disable
| Enable/disable turning off the FortiGuard antispam service. |
| | **antispam\_license** integer | | Interval of time between license checks for the FortiGuard antispam contract. |
| | **antispam\_timeout** integer | | Antispam query time out (1 - 30 sec). |
| | **anycast\_sdns\_server\_ip** string | | IP address of the FortiGuard anycast DNS rating server. |
| | **anycast\_sdns\_server\_port** integer | | Port to connect to on the FortiGuard anycast DNS rating server. |
| | **auto\_join\_forticloud** string | **Choices:*** enable
* disable
| Automatically connect to and login to FortiCloud. |
| | **ddns\_server\_ip** string | | IP address of the FortiDDNS server. |
| | **ddns\_server\_port** integer | | Port used to communicate with FortiDDNS servers. |
| | **fortiguard\_anycast** string | **Choices:*** enable
* disable
| Enable/disable use of FortiGuard"s anycast network. |
| | **fortiguard\_anycast\_source** string | **Choices:*** fortinet
* aws
* debug
| Configure which of Fortinet"s servers to provide FortiGuard services in FortiGuard"s anycast network. Default is Fortinet. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **load\_balance\_servers** integer | | Number of servers to alternate between as first FortiGuard option. |
| | **outbreak\_prevention\_cache** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard Virus Outbreak Prevention cache. |
| | **outbreak\_prevention\_cache\_mpercent** integer | | Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%). |
| | **outbreak\_prevention\_cache\_ttl** integer | | Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec). |
| | **outbreak\_prevention\_expiration** integer | | Expiration date of FortiGuard Virus Outbreak Prevention contract. |
| | **outbreak\_prevention\_force\_off** string | **Choices:*** enable
* disable
| Turn off FortiGuard Virus Outbreak Prevention service. |
| | **outbreak\_prevention\_license** integer | | Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract. |
| | **outbreak\_prevention\_timeout** integer | | FortiGuard Virus Outbreak Prevention time out (1 - 30 sec). |
| | **persistent\_connection** string | **Choices:*** enable
* disable
| Enable/disable use of persistent connection to receive update notification from FortiGuard. |
| | **port** string | **Choices:*** 8888
* 53
* 80
* 443
| Port used to communicate with the FortiGuard servers. |
| | **protocol** string | **Choices:*** udp
* http
* https
| Protocol used to communicate with the FortiGuard servers. |
| | **proxy\_password** string | | Proxy user password. |
| | **proxy\_server\_ip** string | | IP address of the proxy server. |
| | **proxy\_server\_port** integer | | Port used to communicate with the proxy server. |
| | **proxy\_username** string | | Proxy user name. |
| | **sandbox\_region** string | | Cloud sandbox region. |
| | **sdns\_options** list / elements=string | **Choices:*** include-question-section
| Customization options for the FortiGuard DNS service. |
| | **sdns\_server\_ip** string | | IP address of the FortiDNS server. |
| | **sdns\_server\_port** integer | | Port used to communicate with FortiDNS servers. |
| | **service\_account\_id** string | | Service account ID. |
| | **source\_ip** string | | Source IPv4 address used to communicate with FortiGuard. |
| | **source\_ip6** string | | Source IPv6 address used to communicate with FortiGuard. |
| | **update\_build\_proxy** string | **Choices:*** enable
* disable
| Enable/disable proxy dictionary rebuild. |
| | **update\_extdb** string | **Choices:*** enable
* disable
| Enable/disable external resource update. |
| | **update\_ffdb** string | **Choices:*** enable
* disable
| Enable/disable Internet Service Database update. |
| | **update\_server\_location** string | **Choices:*** usa
* any
| Signature update server location. |
| | **update\_uwdb** string | **Choices:*** enable
* disable
| Enable/disable allowlist update. |
| | **videofilter\_expiration** integer | | Expiration date of the FortiGuard video filter contract. |
| | **videofilter\_license** integer | | Interval of time between license checks for the FortiGuard video filter contract. |
| | **webfilter\_cache** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard web filter caching. |
| | **webfilter\_cache\_ttl** integer | | Time-to-live for web filter cache entries in seconds (300 - 86400). |
| | **webfilter\_expiration** integer | | Expiration date of the FortiGuard web filter contract. |
| | **webfilter\_force\_off** string | **Choices:*** enable
* disable
| Enable/disable turning off the FortiGuard web filtering service. |
| | **webfilter\_license** integer | | Interval of time between license checks for the FortiGuard web filter contract. |
| | **webfilter\_timeout** integer | | Web filter query time out (1 - 30 sec). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiGuard services.
fortios_system_fortiguard:
vdom: "{{ vdom }}"
system_fortiguard:
antispam_cache: "enable"
antispam_cache_mpercent: "4"
antispam_cache_ttl: "5"
antispam_expiration: "6"
antispam_force_off: "enable"
antispam_license: "8"
antispam_timeout: "9"
anycast_sdns_server_ip: "<your_own_value>"
anycast_sdns_server_port: "11"
auto_join_forticloud: "enable"
ddns_server_ip: "<your_own_value>"
ddns_server_port: "14"
fortiguard_anycast: "enable"
fortiguard_anycast_source: "fortinet"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
load_balance_servers: "19"
outbreak_prevention_cache: "enable"
outbreak_prevention_cache_mpercent: "21"
outbreak_prevention_cache_ttl: "22"
outbreak_prevention_expiration: "23"
outbreak_prevention_force_off: "enable"
outbreak_prevention_license: "25"
outbreak_prevention_timeout: "26"
persistent_connection: "enable"
port: "8888"
protocol: "udp"
proxy_password: "<your_own_value>"
proxy_server_ip: "<your_own_value>"
proxy_server_port: "32"
proxy_username: "<your_own_value>"
sandbox_region: "<your_own_value>"
sdns_options: "include-question-section"
sdns_server_ip: "<your_own_value>"
sdns_server_port: "37"
service_account_id: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
update_build_proxy: "enable"
update_extdb: "enable"
update_ffdb: "enable"
update_server_location: "usa"
update_uwdb: "enable"
videofilter_expiration: "46"
videofilter_license: "47"
webfilter_cache: "enable"
webfilter_cache_ttl: "49"
webfilter_expiration: "50"
webfilter_force_off: "enable"
webfilter_license: "52"
webfilter_timeout: "53"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_ipmacbinding_table – Configure IP to MAC address pairs in the IP/MAC binding table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ipmacbinding\_table – Configure IP to MAC address pairs in the IP/MAC binding table in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_ipmacbinding_table`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_ipmacbinding feature and table 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_ipmacbinding\_table** dictionary | | Configure IP to MAC address pairs in the IP/MAC binding table. |
| | **ip** string | | IPv4 address portion of the pair (format: xxx.xxx.xxx.xxx). |
| | **mac** string | | MAC address portion of the pair (format: xx:xx:xx:xx:xx:xx in hexidecimal). |
| | **name** string | | Name of the pair (optional). |
| | **seq\_num** integer | | Entry number. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this IP-mac binding pair. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IP to MAC address pairs in the IP/MAC binding table.
fortios_firewall_ipmacbinding_table:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ipmacbinding_table:
ip: "<your_own_value>"
mac: "<your_own_value>"
name: "default_name_5"
seq_num: "6"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_device_category – Configure device categories in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_device\_category – Configure device categories in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_device_category`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device\_category 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_device\_category** dictionary | | Configure device categories. |
| | **comment** string | | Comment. |
| | **desc** string | | Device category description. |
| | **name** string / required | | Device category name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure device categories.
fortios_user_device_category:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device_category:
comment: "Comment."
desc: "<your_own_value>"
name: "default_name_5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_web_proxy_wisp – Configure Wireless Internet service provider (WISP) servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_wisp – Configure Wireless Internet service provider (WISP) servers in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_web_proxy_wisp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web\_proxy feature and wisp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **web\_proxy\_wisp** dictionary | | Configure Wireless Internet service provider (WISP) servers. |
| | **comment** string | | Comment. |
| | **max\_connections** integer | | Maximum number of web proxy WISP connections (4 - 4096). |
| | **name** string / required | | Server name. |
| | **outgoing\_ip** string | | WISP outgoing IP address. |
| | **server\_ip** string | | WISP server IP address. |
| | **server\_port** integer | | WISP server port (1 - 65535). |
| | **timeout** integer | | Period of time before WISP requests time out (1 - 15 sec). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Wireless Internet service provider (WISP) servers.
fortios_web_proxy_wisp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_wisp:
comment: "Comment."
max_connections: "4"
name: "default_name_5"
outgoing_ip: "<your_own_value>"
server_ip: "<your_own_value>"
server_port: "8"
timeout: "9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_qos_ip_dscp_map – Configure FortiSwitch QoS IP precedence/DSCP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_qos\_ip\_dscp\_map – Configure FortiSwitch QoS IP precedence/DSCP in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_qos_ip_dscp_map`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_qos feature and ip\_dscp\_map 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_qos\_ip\_dscp\_map** dictionary | | Configure FortiSwitch QoS IP precedence/DSCP. |
| | **description** string | | Description of the ip-dscp map name. |
| | **map** list / elements=string | | Maps between IP-DSCP value to COS queue. |
| | | **cos\_queue** integer | | COS queue number. |
| | | **diffserv** list / elements=string | **Choices:*** CS0
* CS1
* AF11
* AF12
* AF13
* CS2
* AF21
* AF22
* AF23
* CS3
* AF31
* AF32
* AF33
* CS4
* AF41
* AF42
* AF43
* CS5
* EF
* CS6
* CS7
| Differentiated service. |
| | | **ip\_precedence** list / elements=string | **Choices:*** network-control
* internetwork-control
* critic-ecp
* flashoverride
* flash
* immediate
* priority
* routine
| IP Precedence. |
| | | **name** string / required | | Dscp mapping entry name. |
| | | **value** string | | Raw values of DSCP (0 - 63). |
| | **name** string / required | | Dscp map name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch QoS IP precedence/DSCP.
fortios_switch_controller_qos_ip_dscp_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_qos_ip_dscp_map:
description: "<your_own_value>"
map:
-
cos_queue: "5"
diffserv: "CS0"
ip_precedence: "network-control"
name: "default_name_8"
value: "<your_own_value>"
name: "default_name_10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_application_rule_settings – Configure application rule settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_application\_rule\_settings – Configure application rule settings in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_application_rule_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and rule\_settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **application\_rule\_settings** dictionary | | Configure application rule settings. |
| | **id** integer / required | | Rule ID. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure application rule settings.
fortios_application_rule_settings:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_rule_settings:
id: "3"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_gtp_apn_shaper – Global per-APN shaper in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_apn\_shaper – Global per-APN shaper in Fortinet’s FortiOS and FortiGate.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_gtp_apn_shaper`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and apn\_shaper 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **gtp\_apn\_shaper** dictionary | | Global per-APN shaper. |
| | **action** string | **Choices:*** drop
* reject
| Action. |
| | **apn** string | | APN name to match. Leave empty to match ANY. Source gtp.apn.name. |
| | **back\_off\_time** integer | | Back off time in seconds (10 - 360). |
| | **id** integer / required | | Shaper ID. |
| | **rate\_limit** integer | | Rate limit in packets/s (0 - 1000000, 0 means unlimited). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global per-APN shaper.
fortios_gtp_apn_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_apn_shaper:
action: "drop"
apn: "<your_own_value> (source gtp.apn.name)"
back_off_time: "5"
id: "6"
rate_limit: "7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_console – Configure console in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_console – Configure console in Fortinet’s FortiOS and FortiGate.
==================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_console`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and console 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_console** dictionary | | Configure console. |
| | **baudrate** string | **Choices:*** 9600
* 19200
* 38400
* 57600
* 115200
| Console baud rate. |
| | **fortiexplorer** string | **Choices:*** enable
* disable
| Enable/disable access for FortiExplorer. |
| | **login** string | **Choices:*** enable
* disable
| Enable/disable serial console and FortiExplorer. |
| | **mode** string | **Choices:*** batch
* line
| Console mode. |
| | **output** string | **Choices:*** standard
* more
| Console output mode. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure console.
fortios_system_console:
vdom: "{{ vdom }}"
system_console:
baudrate: "9600"
fortiexplorer: "enable"
login: "enable"
mode: "batch"
output: "standard"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_traffic_class – Configure names for shaping classes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_traffic\_class – Configure names for shaping classes in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_traffic_class`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and traffic\_class 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_traffic\_class** dictionary | | Configure names for shaping classes. |
| | **class\_id** integer | | Class ID to be named. |
| | **class\_name** string | | Define the name for this class-id. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure names for shaping classes.
fortios_firewall_traffic_class:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_traffic_class:
class_id: "3"
class_name: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_syslogd_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd\_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd\_filter** dictionary | | Filters for remote system server. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | Syslog filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for remote system server.
fortios_log_syslogd_filter:
vdom: "{{ vdom }}"
log_syslogd_filter:
anomaly: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_acl6 – Configure IPv6 access control list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_acl6 – Configure IPv6 access control list in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_acl6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and acl6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_acl6** dictionary | | Configure IPv6 access control list. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address name. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **interface** string | | Interface name. Source system.zone.name system.interface.name. |
| | **name** string | | Policy name. |
| | **policyid** integer / required | | Policy ID. |
| | **service** list / elements=string | | Service name. |
| | | **name** string / required | | Address name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address name. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable access control list status. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 access control list.
fortios_firewall_acl6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_acl6:
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_5 (source firewall.address6.name firewall.addrgrp6.name)"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
name: "default_name_7"
policyid: "8"
service:
-
name: "default_name_10 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_12 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_vip – Configure virtual IP for IPv4 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vip – Configure virtual IP for IPv4 in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vip`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vip** dictionary | | Configure virtual IP for IPv4. |
| | **arp\_reply** string | **Choices:*** disable
* enable
| Enable to respond to ARP requests for this virtual IP address. Enabled by default. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **dns\_mapping\_ttl** integer | | DNS mapping TTL (Set to zero to use TTL in DNS response). |
| | **extaddr** list / elements=string | | External FQDN address name. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **extintf** string | | Interface connected to the source network that receives the packets that will be forwarded to the destination network. Source system .interface.name. |
| | **extip** string | | IP address or address range on the external interface that you want to map to an address or address range on the destination network. |
| | **extport** string | | Incoming port number range that you want to map to a port number range on the destination network. |
| | **gratuitous\_arp\_interval** integer | | Enable to have the VIP send gratuitous ARPs. 0=disabled. Set from 5 up to 8640000 seconds to enable. |
| | **http\_cookie\_age** integer | | Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit. |
| | **http\_cookie\_domain** string | | Domain that HTTP cookie persistence should apply to. |
| | **http\_cookie\_domain\_from\_host** string | **Choices:*** disable
* enable
| Enable/disable use of HTTP cookie domain from host field in HTTP. |
| | **http\_cookie\_generation** integer | | Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. |
| | **http\_cookie\_path** string | | Limit HTTP cookie persistence to the specified path. |
| | **http\_cookie\_share** string | **Choices:*** disable
* same-ip
| Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disable stops cookie sharing. |
| | **http\_ip\_header** string | **Choices:*** enable
* disable
| For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. |
| | **http\_ip\_header\_name** string | | For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-Forwarded-For is used. |
| | **http\_multiplex** string | **Choices:*** enable
* disable
| Enable/disable HTTP multiplexing. |
| | **http\_redirect** string | **Choices:*** enable
* disable
| Enable/disable redirection of HTTP to HTTPS |
| | **https\_cookie\_secure** string | **Choices:*** disable
* enable
| Enable/disable verification that inserted HTTPS cookies are secure. |
| | **id** integer | | Custom defined ID. |
| | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
* http-host
| Method used to distribute sessions to real servers. |
| | **mapped\_addr** string | | Mapped FQDN address name. Source firewall.address.name. |
| | **mappedip** list / elements=string | | IP address or address range on the destination network to which the external IP address is mapped. |
| | | **range** string / required | | Mapped IP range. |
| | **mappedport** string | | Port number range on the destination network to which the external port number range is mapped. |
| | **max\_embryonic\_connections** integer | | Maximum number of incomplete connections. |
| | **monitor** list / elements=string | | Name of the health check monitor to use when polling to determine a virtual server"s connectivity status. |
| | | **name** string / required | | Health monitor name. Source firewall.ldb-monitor.name. |
| | **name** string / required | | Virtual IP name. |
| | **nat\_source\_vip** string | **Choices:*** disable
* enable
| Enable/disable forcing the source NAT mapped IP to the external IP for all traffic. |
| | **outlook\_web\_access** string | **Choices:*** disable
* enable
| Enable to add the Front-End-Https header for Microsoft Outlook Web Access. |
| | **persistence** string | **Choices:*** none
* http-cookie
* ssl-session-id
| Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable/disable port forwarding. |
| | **portmapping\_type** string | **Choices:*** 1-to-1
* m-to-n
| Port mapping type. |
| | **protocol** string | **Choices:*** tcp
* udp
* sctp
* icmp
| Protocol to use when forwarding packets. |
| | **realservers** list / elements=string | | Select the real servers that this server load balancing VIP will distribute traffic to. |
| | | **address** string | | Dynamic address of the real server. Source firewall.address.name. |
| | | **client\_ip** string | | Only clients in this IP range can connect to this real server. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Enable to check the responsiveness of the real server before forwarding traffic. |
| | | **holddown\_interval** integer | | Time in seconds that the health check monitor continues to monitor and unresponsive server that should be active. |
| | | **http\_host** string | | HTTP server domain name in HTTP header. |
| | | **id** integer / required | | Real server ID. |
| | | **ip** string | | IP address of the real server. |
| | | **max\_connections** integer | | Max number of active connections that can be directed to the real server. When reached, sessions are sent to other real servers. |
| | | **monitor** string | | Name of the health check monitor to use when polling to determine a virtual server"s connectivity status. Source firewall .ldb-monitor.name. |
| | | **port** integer | | Port for communicating with the real server. Required if port forwarding is enabled. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. |
| | | **type** string | **Choices:*** ip
* address
| Type of address. |
| | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| | **server\_type** string | **Choices:*** http
* https
* imaps
* pop3s
* smtps
* ssl
* tcp
* udp
* ip
* ssh
| Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). |
| | **service** list / elements=string | | Service name. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **src\_filter** list / elements=string | | Source address filter. Each address must be either an IP/subnet (x.x.x.x/n) or a range (x.x.x.x-y.y.y.y). Separate addresses with spaces. |
| | | **range** string / required | | Source-filter range. |
| | **srcintf\_filter** list / elements=string | | Interfaces to which the VIP applies. Separate the names with spaces. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
* custom
| Permitted encryption algorithms for SSL sessions according to encryption strength. |
| | **ssl\_certificate** string | | The name of the SSL certificate to use for SSL acceleration. Source vpn.certificate.local.name. |
| | **ssl\_cipher\_suites** list / elements=string | | SSL/TLS cipher suites acceptable from a client, ordered by priority. |
| | | **cipher** string | **Choices:*** TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-128-GCM-SHA256
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-AES-128-CBC-SHA
* TLS-RSA-WITH-AES-256-CBC-SHA
* TLS-RSA-WITH-AES-128-CBC-SHA256
* TLS-RSA-WITH-AES-128-GCM-SHA256
* TLS-RSA-WITH-AES-256-CBC-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384
* TLS-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer / required | | SSL/TLS cipher suites priority. |
| | | **versions** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| SSL/TLS versions that the cipher suite can be used with. |
| | **ssl\_client\_fallback** string | **Choices:*** disable
* enable
| Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). |
| | **ssl\_client\_rekey\_count** integer | | Maximum length of data in MB before triggering a client rekey (0 = disable). |
| | **ssl\_client\_renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. |
| | **ssl\_client\_session\_state\_max** integer | | Maximum number of client to FortiGate SSL session states to keep. |
| | **ssl\_client\_session\_state\_timeout** integer | | Number of minutes to keep client to FortiGate SSL session state. |
| | **ssl\_client\_session\_state\_type** string | **Choices:*** disable
* time
* count
* both
| How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. |
| | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
* 3072
* 4096
| Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. |
| | **ssl\_hpkp** string | **Choices:*** disable
* enable
* report-only
| Enable/disable including HPKP header in response. |
| | **ssl\_hpkp\_age** integer | | Number of seconds the client should honour the HPKP setting. |
| | **ssl\_hpkp\_backup** string | | Certificate to generate backup HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
| | **ssl\_hpkp\_include\_subdomains** string | **Choices:*** disable
* enable
| Indicate that HPKP header applies to all subdomains. |
| | **ssl\_hpkp\_primary** string | | Certificate to generate primary HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
| | **ssl\_hpkp\_report\_uri** string | | URL to report HPKP violations to. |
| | **ssl\_hsts** string | **Choices:*** disable
* enable
| Enable/disable including HSTS header in response. |
| | **ssl\_hsts\_age** integer | | Number of seconds the client should honour the HSTS setting. |
| | **ssl\_hsts\_include\_subdomains** string | **Choices:*** disable
* enable
| Indicate that HSTS header applies to all subdomains. |
| | **ssl\_http\_location\_conversion** string | **Choices:*** enable
* disable
| Enable to replace HTTP with HTTPS in the reply"s Location HTTP header field. |
| | **ssl\_http\_match\_host** string | **Choices:*** enable
* disable
| Enable/disable HTTP host matching for location conversion. |
| | **ssl\_max\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version acceptable from a client. |
| | **ssl\_min\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version acceptable from a client. |
| | **ssl\_mode** string | **Choices:*** half
* full
| Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to the server (full). |
| | **ssl\_pfs** string | **Choices:*** require
* deny
* allow
| Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. |
| | **ssl\_send\_empty\_frags** string | **Choices:*** enable
* disable
| Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibility with older systems. |
| | **ssl\_server\_algorithm** string | **Choices:*** high
* medium
* low
* custom
* client
| Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. |
| | **ssl\_server\_cipher\_suites** list / elements=string | | SSL/TLS cipher suites to offer to a server, ordered by priority. |
| | | **cipher** string | **Choices:*** TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-128-GCM-SHA256
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-AES-128-CBC-SHA
* TLS-RSA-WITH-AES-256-CBC-SHA
* TLS-RSA-WITH-AES-128-CBC-SHA256
* TLS-RSA-WITH-AES-128-GCM-SHA256
* TLS-RSA-WITH-AES-256-CBC-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384
* TLS-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer / required | | SSL/TLS cipher suites priority. |
| | | **versions** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| SSL/TLS versions that the cipher suite can be used with. |
| | **ssl\_server\_max\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| Highest SSL/TLS version acceptable from a server. Use the client setting by default. |
| | **ssl\_server\_min\_version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| Lowest SSL/TLS version acceptable from a server. Use the client setting by default. |
| | **ssl\_server\_session\_state\_max** integer | | Maximum number of FortiGate to Server SSL session states to keep. |
| | **ssl\_server\_session\_state\_timeout** integer | | Number of minutes to keep FortiGate to Server SSL session state. |
| | **ssl\_server\_session\_state\_type** string | **Choices:*** disable
* time
* count
* both
| How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable VIP. |
| | **type** string | **Choices:*** static-nat
* load-balance
* server-load-balance
* dns-translation
* fqdn
* access-proxy
| Configure a static NAT, load balance, server load balance, DNS translation, or FQDN VIP. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **weblogic\_server** string | **Choices:*** disable
* enable
| Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. |
| | **websphere\_server** string | **Choices:*** disable
* enable
| Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure virtual IP for IPv4.
fortios_firewall_vip:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip:
arp_reply: "disable"
color: "4"
comment: "Comment."
dns_mapping_ttl: "6"
extaddr:
-
name: "default_name_8 (source firewall.address.name firewall.addrgrp.name)"
extintf: "<your_own_value> (source system.interface.name)"
extip: "<your_own_value>"
extport: "<your_own_value>"
gratuitous_arp_interval: "12"
http_cookie_age: "13"
http_cookie_domain: "<your_own_value>"
http_cookie_domain_from_host: "disable"
http_cookie_generation: "16"
http_cookie_path: "<your_own_value>"
http_cookie_share: "disable"
http_ip_header: "enable"
http_ip_header_name: "<your_own_value>"
http_multiplex: "enable"
http_redirect: "enable"
https_cookie_secure: "disable"
id: "24"
ldb_method: "static"
mapped_addr: "<your_own_value> (source firewall.address.name)"
mappedip:
-
range: "<your_own_value>"
mappedport: "<your_own_value>"
max_embryonic_connections: "30"
monitor:
-
name: "default_name_32 (source firewall.ldb-monitor.name)"
name: "default_name_33"
nat_source_vip: "disable"
outlook_web_access: "disable"
persistence: "none"
portforward: "disable"
portmapping_type: "1-to-1"
protocol: "tcp"
realservers:
-
address: "<your_own_value> (source firewall.address.name)"
client_ip: "<your_own_value>"
healthcheck: "disable"
holddown_interval: "44"
http_host: "myhostname"
id: "46"
ip: "<your_own_value>"
max_connections: "48"
monitor: "<your_own_value> (source firewall.ldb-monitor.name)"
port: "50"
status: "active"
type: "ip"
weight: "53"
server_type: "http"
service:
-
name: "default_name_56 (source firewall.service.custom.name firewall.service.group.name)"
src_filter:
-
range: "<your_own_value>"
srcintf_filter:
-
interface_name: "<your_own_value> (source system.interface.name)"
ssl_algorithm: "high"
ssl_certificate: "<your_own_value> (source vpn.certificate.local.name)"
ssl_cipher_suites:
-
cipher: "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
priority: "65"
versions: "ssl-3.0"
ssl_client_fallback: "disable"
ssl_client_rekey_count: "68"
ssl_client_renegotiation: "allow"
ssl_client_session_state_max: "70"
ssl_client_session_state_timeout: "71"
ssl_client_session_state_type: "disable"
ssl_dh_bits: "768"
ssl_hpkp: "disable"
ssl_hpkp_age: "75"
ssl_hpkp_backup: "<your_own_value> (source vpn.certificate.local.name vpn.certificate.ca.name)"
ssl_hpkp_include_subdomains: "disable"
ssl_hpkp_primary: "<your_own_value> (source vpn.certificate.local.name vpn.certificate.ca.name)"
ssl_hpkp_report_uri: "<your_own_value>"
ssl_hsts: "disable"
ssl_hsts_age: "81"
ssl_hsts_include_subdomains: "disable"
ssl_http_location_conversion: "enable"
ssl_http_match_host: "enable"
ssl_max_version: "ssl-3.0"
ssl_min_version: "ssl-3.0"
ssl_mode: "half"
ssl_pfs: "require"
ssl_send_empty_frags: "enable"
ssl_server_algorithm: "high"
ssl_server_cipher_suites:
-
cipher: "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
priority: "93"
versions: "ssl-3.0"
ssl_server_max_version: "ssl-3.0"
ssl_server_min_version: "ssl-3.0"
ssl_server_session_state_max: "97"
ssl_server_session_state_timeout: "98"
ssl_server_session_state_type: "disable"
status: "disable"
type: "static-nat"
uuid: "<your_own_value>"
weblogic_server: "disable"
websphere_server: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_shaper_per_ip_shaper – Configure per-IP traffic shaper in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_shaper\_per\_ip\_shaper – Configure per-IP traffic shaper in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_shaper_per_ip_shaper`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_shaper feature and per\_ip\_shaper 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_shaper\_per\_ip\_shaper** dictionary | | Configure per-IP traffic shaper. |
| | **bandwidth\_unit** string | **Choices:*** kbps
* mbps
* gbps
| Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps). |
| | **diffserv\_forward** string | **Choices:*** enable
* disable
| Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper. |
| | **diffserv\_reverse** string | **Choices:*** enable
* disable
| Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper. |
| | **diffservcode\_forward** string | | Forward (original) DiffServ setting to be applied to traffic accepted by this shaper. |
| | **diffservcode\_rev** string | | Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper. |
| | **max\_bandwidth** integer | | Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting. |
| | **max\_concurrent\_session** integer | | Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **max\_concurrent\_tcp\_session** integer | | Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **max\_concurrent\_udp\_session** integer | | Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **name** string / required | | Traffic shaper name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure per-IP traffic shaper.
fortios_firewall_shaper_per_ip_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaper_per_ip_shaper:
bandwidth_unit: "kbps"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
max_bandwidth: "8"
max_concurrent_session: "9"
max_concurrent_tcp_session: "10"
max_concurrent_udp_session: "11"
name: "default_name_12"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_internet_service – Show Internet Service application in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service – Show Internet Service application in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_internet_service`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet\_service 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_internet\_service** dictionary | | Show Internet Service application. |
| | **database** string | **Choices:*** isdb
* irdb
| Database name this Internet Service belongs to. |
| | **direction** string | **Choices:*** src
* dst
* both
| How this service may be used in a firewall policy (source, destination or both). |
| | **entry** list / elements=string | | Entries in the Internet Service database. |
| | | **id** integer / required | | Entry ID. |
| | | **ip\_number** integer | | Total number of IP addresses. |
| | | **ip\_range\_number** integer | | Total number of IP ranges. |
| | | **port** integer | | Integer value for the TCP/IP port (0 - 65535). |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **extra\_ip\_range\_number** integer | | Extra number of IP ranges. |
| | **icon\_id** integer | | Icon ID of Internet Service. |
| | **id** integer / required | | Internet Service ID. |
| | **ip\_number** integer | | Total number of IP addresses. |
| | **ip\_range\_number** integer | | Number of IP ranges. |
| | **name** string | | Internet Service name. |
| | **obsolete** integer | | Indicates whether the Internet Service can be used. |
| | **offset** integer | | Offset of Internet Service ID. |
| | **reputation** integer | | Reputation level of the Internet Service. |
| | **singularity** integer | | Singular level of the Internet Service. |
| | **sld\_id** integer | | Second Level Domain. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Show Internet Service application.
fortios_firewall_internet_service:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service:
database: "isdb"
direction: "src"
entry:
-
id: "6"
ip_number: "7"
ip_range_number: "8"
port: "9"
protocol: "10"
extra_ip_range_number: "11"
icon_id: "12"
id: "13"
ip_number: "14"
ip_range_number: "15"
name: "default_name_16"
obsolete: "17"
offset: "18"
reputation: "19"
singularity: "20"
sld_id: "21"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_conn_capability – Configure connection capability in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_h2qp\_conn\_capability – Configure connection capability in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_conn_capability`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller\_hotspot20 feature and h2qp\_conn\_capability 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_hotspot20\_h2qp\_conn\_capability** dictionary | | Configure connection capability. |
| | **esp\_port** string | **Choices:*** closed
* open
* unknown
| Set ESP port service (used by IPsec VPNs) status. |
| | **ftp\_port** string | **Choices:*** closed
* open
* unknown
| Set FTP port service status. |
| | **http\_port** string | **Choices:*** closed
* open
* unknown
| Set HTTP port service status. |
| | **icmp\_port** string | **Choices:*** closed
* open
* unknown
| Set ICMP port service status. |
| | **ikev2\_port** string | **Choices:*** closed
* open
* unknown
| Set IKEv2 port service for IPsec VPN status. |
| | **ikev2\_xx\_port** string | **Choices:*** closed
* open
* unknown
| Set UDP port 4500 (which may be used by IKEv2 for IPsec VPN) service status. |
| | **name** string / required | | Connection capability name. |
| | **pptp\_vpn\_port** string | **Choices:*** closed
* open
* unknown
| Set Point to Point Tunneling Protocol (PPTP) VPN port service status. |
| | **ssh\_port** string | **Choices:*** closed
* open
* unknown
| Set SSH port service status. |
| | **tls\_port** string | **Choices:*** closed
* open
* unknown
| Set TLS VPN (HTTPS) port service status. |
| | **voip\_tcp\_port** string | **Choices:*** closed
* open
* unknown
| Set VoIP TCP port service status. |
| | **voip\_udp\_port** string | **Choices:*** closed
* open
* unknown
| Set VoIP UDP port service status. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure connection capability.
fortios_wireless_controller_hotspot20_h2qp_conn_capability:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_h2qp_conn_capability:
esp_port: "closed"
ftp_port: "closed"
http_port: "closed"
icmp_port: "closed"
ikev2_port: "closed"
ikev2_xx_port: "closed"
name: "default_name_9"
pptp_vpn_port: "closed"
ssh_port: "closed"
tls_port: "closed"
voip_tcp_port: "closed"
voip_udp_port: "closed"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_webtrends_setting – Settings for WebTrends in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_webtrends\_setting – Settings for WebTrends in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_webtrends_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_webtrends feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_webtrends\_setting** dictionary | | Settings for WebTrends. |
| | **server** string | | Address of the remote WebTrends server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to WebTrends. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Settings for WebTrends.
fortios_log_webtrends_setting:
vdom: "{{ vdom }}"
log_webtrends_setting:
server: "192.168.100.40"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_country – Define country table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_country – Define country table in Fortinet’s FortiOS and FortiGate.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_country`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and country 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_country** dictionary | | Define country table. |
| | **id** integer / required | | Country ID. |
| | **name** string | | Country name. |
| | **region** list / elements=string | | Region ID list. |
| | | **id** integer / required | | Region ID. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Define country table.
fortios_firewall_country:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_country:
id: "3"
name: "default_name_4"
region:
-
id: "6"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wanopt_auth_group – Configure WAN optimization authentication groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_auth\_group – Configure WAN optimization authentication groups in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wanopt_auth_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and auth\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wanopt\_auth\_group** dictionary | | Configure WAN optimization authentication groups. |
| | **auth\_method** string | **Choices:*** cert
* psk
| Select certificate or pre-shared key authentication for this authentication group. |
| | **cert** string | | Name of certificate to identify this peer. Source vpn.certificate.local.name. |
| | **name** string / required | | Auth-group name. |
| | **peer** string | | If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command. Source wanopt.peer.peer-host-id. |
| | **peer\_accept** string | **Choices:*** any
* defined
* one
| Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. |
| | **psk** string | | Pre-shared key used by the peers in this authentication group. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WAN optimization authentication groups.
fortios_wanopt_auth_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wanopt_auth_group:
auth_method: "cert"
cert: "<your_own_value> (source vpn.certificate.local.name)"
name: "default_name_5"
peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
peer_accept: "any"
psk: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_nac_settings – Configure integrated NAC settings for FortiSwitch in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_nac\_settings – Configure integrated NAC settings for FortiSwitch in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_nac_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and nac\_settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_nac\_settings** dictionary | | Configure integrated NAC settings for FortiSwitch. |
| | **auto\_auth** string | **Choices:*** disable
* enable
| Enable/disable NAC device auto authorization when discovered and nac-policy matched. |
| | **bounce\_nac\_port** string | **Choices:*** disable
* enable
| Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. |
| | **inactive\_timer** integer | | Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval). |
| | **link\_down\_flush** string | **Choices:*** disable
* enable
| Clear NAC devices on switch ports on link down event. |
| | **mode** string | **Choices:*** local
* global
| Set NAC mode to be used on the FortiSwitch ports. |
| | **name** string / required | | NAC settings name. |
| | **onboarding\_vlan** string | | Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure integrated NAC settings for FortiSwitch.
fortios_switch_controller_nac_settings:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_nac_settings:
auto_auth: "disable"
bounce_nac_port: "disable"
inactive_timer: "5"
link_down_flush: "disable"
mode: "local"
name: "default_name_8"
onboarding_vlan: "<your_own_value> (source system.interface.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_ips_urlfilter_dns6 – Configure IPS URL filter IPv6 DNS servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ips\_urlfilter\_dns6 – Configure IPS URL filter IPv6 DNS servers in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ips_urlfilter_dns6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ips\_urlfilter\_dns6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_ips\_urlfilter\_dns6** dictionary | | Configure IPS URL filter IPv6 DNS servers. |
| | **address6** string / required | | IPv6 address of DNS server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this server for IPv6 DNS queries. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPS URL filter IPv6 DNS servers.
fortios_system_ips_urlfilter_dns6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ips_urlfilter_dns6:
address6: "<your_own_value>"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_object_tagging – Configure object tagging in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_object\_tagging – Configure object tagging in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_object_tagging`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and object\_tagging 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_object\_tagging** dictionary | | Configure object tagging. |
| | **address** string | **Choices:*** disable
* mandatory
* optional
| Address. |
| | **category** string / required | | Tag Category. |
| | **color** integer | | Color of icon on the GUI. |
| | **device** string | **Choices:*** disable
* mandatory
* optional
| Device. |
| | **interface** string | **Choices:*** disable
* mandatory
* optional
| Interface. |
| | **multiple** string | **Choices:*** enable
* disable
| Allow multiple tag selection. |
| | **tags** list / elements=string | | Tags. |
| | | **name** string / required | | Tag name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure object tagging.
fortios_system_object_tagging:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_object_tagging:
address: "disable"
category: "<your_own_value>"
color: "5"
device: "disable"
interface: "disable"
multiple: "enable"
tags:
-
name: "default_name_10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_internet_service_botnet – Show Internet Service botnet in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_botnet – Show Internet Service botnet in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_internet_service_botnet`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet\_service\_botnet 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_internet\_service\_botnet** dictionary | | Show Internet Service botnet. |
| | **id** integer / required | | Internet Service Botnet ID. |
| | **name** string | | Internet Service Botnet name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Show Internet Service botnet.
fortios_firewall_internet_service_botnet:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_botnet:
id: "3"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_icap_server – Configure ICAP servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_icap\_server – Configure ICAP servers in Fortinet’s FortiOS and FortiGate.
====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_icap_server`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify icap feature and server 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **icap\_server** dictionary | | Configure ICAP servers. |
| | **ip6\_address** string | | IPv6 address of the ICAP server. |
| | **ip\_address** string | | IPv4 address of the ICAP server. |
| | **ip\_version** string | **Choices:*** 4
* 6
| IP version. |
| | **max\_connections** integer | | Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count. |
| | **name** string / required | | Server name. |
| | **port** integer | | ICAP server port. |
| | **secure** string | **Choices:*** enable
* disable
| Enable/disable secure connection to ICAP server. |
| | **ssl\_cert** string | | CA certificate name. Source vpn.certificate.ca.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure ICAP servers.
fortios_icap_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_server:
ip_address: "<your_own_value>"
ip_version: "4"
ip6_address: "<your_own_value>"
max_connections: "6"
name: "default_name_7"
port: "8"
secure: "enable"
ssl_cert: "<your_own_value> (source vpn.certificate.ca.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_dos_policy – Configure IPv4 DoS policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_dos\_policy – Configure IPv4 DoS policies in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_dos_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and dos\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_dos\_policy** dictionary | | Configure IPv4 DoS policies. |
| | **anomaly** list / elements=string | | Anomaly name. |
| | | **action** string | **Choices:*** pass
* block
* proxy
| Action taken when the threshold is reached. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | | **name** string / required | | Anomaly name. |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine method. |
| | | **quarantine\_expiry** string | | Duration of quarantine. (Format |
| | | **quarantine\_log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this anomaly. |
| | | **threshold** integer | | Anomaly threshold. Number of detected instances per minute that triggers the anomaly action. |
| | | **threshold(default)** integer | | Number of detected instances per minute which triggers action (1 - 2147483647). Note that each anomaly has a different threshold value assigned to it. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address name from available addresses. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **interface** string | | Incoming interface name from available interfaces. Source system.zone.name system.interface.name. |
| | **name** string | | Policy name. |
| | **policyid** integer / required | | Policy ID. |
| | **service** list / elements=string | | Service object from available options. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address name from available addresses. |
| | | **name** string / required | | Service name. Source firewall.address.name firewall.addrgrp.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 DoS policies.
fortios_firewall_dos_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_dos_policy:
anomaly:
-
action: "pass"
log: "enable"
name: "default_name_6"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
status: "disable"
threshold: "11"
threshold(default): "12"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
name: "default_name_17"
policyid: "18"
service:
-
name: "default_name_20 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_virtual_wan_link – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_virtual\_wan\_link – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_virtual_wan_link`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and virtual\_wan\_link 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_virtual\_wan\_link** dictionary | | Configure redundant internet connections using SD-WAN (formerly virtual WAN link). |
| | **fail\_alert\_interfaces** list / elements=string | | Physical interfaces that will be alerted. |
| | | **name** string / required | | Physical interface name. Source system.interface.name. |
| | **fail\_detect** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN Internet connection status checking (failure detection). |
| | **health\_check** list / elements=string | | SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can communicate with it. |
| | | **addr\_mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | | **diffservcode** string | | Differentiated services code point (DSCP) in the IP header of the probe packet. |
| | | **failtime** integer | | Number of failures before server is considered lost (1 - 3600). |
| | | **ha\_priority** integer | | HA election priority (1 - 50). |
| | | **http\_agent** string | | String in the http-agent field in the HTTP header. |
| | | **http\_get** string | | URL used to communicate with the server if the protocol if the protocol is HTTP. |
| | | **http\_match** string | | Response string expected from the server if the protocol is HTTP. |
| | | **interval** integer | | Status check interval, or the time between attempting to connect to the server (1 - 3600 sec). |
| | | **members** list / elements=string | | Member sequence number list. |
| | | | **seq\_num** integer | | Member sequence number. Source system.virtual-wan-link.members.seq-num. |
| | | **name** string / required | | Status check or health check name. |
| | | **packet\_size** integer | | Packet size of a twamp test session, |
| | | **password** string | | Twamp controller password in authentication mode |
| | | **port** integer | | Port number used to communicate with the server over the selected protocol. |
| | | **probe\_packets** string | **Choices:*** disable
* enable
| Enable/disable transmission of probe packets. |
| | | **probe\_timeout** integer | | Time to wait before a probe packet is considered lost (500 - 5000 msec). |
| | | **protocol** string | **Choices:*** ping
* tcp-echo
* udp-echo
* http
* twamp
* ping6
| Protocol used to determine if the FortiGate can communicate with the server. |
| | | **recoverytime** integer | | Number of successful responses received before server is considered recovered (1 - 3600). |
| | | **security\_mode** string | **Choices:*** none
* authentication
| Twamp controller security mode. |
| | | **server** string | | IP address or FQDN name of the server. |
| | | **sla** list / elements=string | | Service level agreement (SLA). |
| | | | **id** integer / required | | SLA ID. |
| | | | **jitter\_threshold** integer | | Jitter for SLA to make decision in milliseconds. (0 - 10000000). |
| | | | **latency\_threshold** integer | | Latency for SLA to make decision in milliseconds. (0 - 10000000). |
| | | | **link\_cost\_factor** string | **Choices:*** latency
* jitter
* packet-loss
| Criteria on which to base link selection. |
| | | | **packetloss\_threshold** integer | | Packet loss for SLA to make decision in percentage. (0 - 100). |
| | | **sla\_fail\_log\_period** integer | | Time interval in seconds that SLA fail log messages will be generated (0 - 3600). |
| | | **sla\_pass\_log\_period** integer | | Time interval in seconds that SLA pass log messages will be generated (0 - 3600). |
| | | **threshold\_alert\_jitter** integer | | Alert threshold for jitter (ms). |
| | | **threshold\_alert\_latency** integer | | Alert threshold for latency (ms). |
| | | **threshold\_alert\_packetloss** integer | | Alert threshold for packet loss (percentage). |
| | | **threshold\_warning\_jitter** integer | | Warning threshold for jitter (ms). |
| | | **threshold\_warning\_latency** integer | | Warning threshold for latency (ms). |
| | | **threshold\_warning\_packetloss** integer | | Warning threshold for packet loss (percentage). |
| | | **update\_cascade\_interface** string | **Choices:*** enable
* disable
| Enable/disable update cascade interface. |
| | | **update\_static\_route** string | **Choices:*** enable
* disable
| Enable/disable updating the static route. |
| | **load\_balance\_mode** string | **Choices:*** source-ip-based
* weight-based
* usage-based
* source-dest-ip-based
* measured-volume-based
| Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. |
| | **members** list / elements=string | | Physical FortiGate interfaces added to the virtual-wan-link. |
| | | **comment** string | | Comments. |
| | | **cost** integer | | Cost of this interface for services in SLA mode (0 - 4294967295). |
| | | **gateway** string | | The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to. |
| | | **gateway6** string | | IPv6 gateway. |
| | | **ingress\_spillover\_threshold** integer | | Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
| | | **interface** string | | Interface name. Source system.interface.name. |
| | | **priority** integer | | Priority of the interface (0 - 4294967295). Used for SD-WAN rules or priority rules. |
| | | **seq\_num** integer | | Sequence number(1-255). |
| | | **source** string | | Source IP address used in the health-check packet to the server. |
| | | **source6** string | | Source IPv6 address used in the health-check packet to the server. |
| | | **spillover\_threshold** integer | | Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this interface in the SD-WAN. |
| | | **volume\_ratio** integer | | Measured volume ratio (this value / sum of all values = percentage of link volume, 0 - 255). |
| | | **weight** integer | | Weight of this interface for weighted load balancing. (0 - 255) More traffic is directed to interfaces with higher weights. |
| | **neighbor** list / elements=string | | Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status. |
| | | **health\_check** string | | SD-WAN health-check name. Source system.virtual-wan-link.health-check.name. |
| | | **ip** string / required | | IP address of neighbor. Source router.bgp.neighbor.ip. |
| | | **member** integer | | Member sequence number. Source system.virtual-wan-link.members.seq-num. |
| | | **role** string | **Choices:*** standalone
* primary
* secondary
| Role of neighbor. |
| | | **sla\_id** integer | | SLA ID. |
| | **neighbor\_hold\_boot\_time** integer | | Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. (0 - 10000000). |
| | **neighbor\_hold\_down** string | **Choices:*** enable
* disable
| Enable/disable hold switching from the secondary neighbor to the primary neighbor. |
| | **neighbor\_hold\_down\_time** integer | | Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. (0 - 10000000). |
| | **service** list / elements=string | | Create SD-WAN rules or priority rules (also called services) to control how sessions are distributed to physical interfaces in the SD-WAN. |
| | | **addr\_mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | | **bandwidth\_weight** integer | | Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. |
| | | **default** string | **Choices:*** enable
* disable
| Enable/disable use of SD-WAN as default service. |
| | | **dscp\_forward** string | **Choices:*** enable
* disable
| Enable/disable forward traffic DSCP tag. |
| | | **dscp\_forward\_tag** string | | Forward traffic DSCP tag. |
| | | **dscp\_reverse** string | **Choices:*** enable
* disable
| Enable/disable reverse traffic DSCP tag. |
| | | **dscp\_reverse\_tag** string | | Reverse traffic DSCP tag. |
| | | **dst** list / elements=string | | Destination address name. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **dst6** list / elements=string | | Destination address6 name. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **dst\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of destination address match. |
| | | **end\_port** integer | | End destination port number. |
| | | **gateway** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN service gateway. |
| | | **groups** list / elements=string | | User groups. |
| | | | **name** string / required | | Group name. Source user.group.name. |
| | | **health\_check** string | | Health check. Source system.virtual-wan-link.health-check.name. |
| | | **hold\_down\_time** integer | | Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000). |
| | | **id** integer / required | | Priority rule ID (1 - 4000). |
| | | **input\_device** list / elements=string | | Source interface name. |
| | | | **name** string / required | | Interface name. Source system.interface.name. |
| | | **input\_device\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of input device match. |
| | | **internet\_service** string | **Choices:*** enable
* disable
| Enable/disable use of Internet service for application-based load balancing. |
| | | **internet\_service\_app\_ctrl** list / elements=string | | Application control based Internet Service ID list. |
| | | | **id** integer / required | | Application control based Internet Service ID. |
| | | **internet\_service\_app\_ctrl\_group** list / elements=string | | Application control based Internet Service group list. |
| | | | **name** string / required | | Application control based Internet Service group name. Source application.group.name. |
| | | **internet\_service\_ctrl** list / elements=string | | Control-based Internet Service ID list. |
| | | | **id** integer / required | | Control-based Internet Service ID. |
| | | **internet\_service\_ctrl\_group** list / elements=string | | Control-based Internet Service group list. |
| | | | **name** string / required | | Control-based Internet Service group name. Source application.group.name. |
| | | **internet\_service\_custom** list / elements=string | | Custom Internet service name list. |
| | | | **name** string / required | | Custom Internet service name. Source firewall.internet-service-custom.name. |
| | | **internet\_service\_custom\_group** list / elements=string | | Custom Internet Service group list. |
| | | | **name** string / required | | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
| | | **internet\_service\_group** list / elements=string | | Internet Service group list. |
| | | | **name** string / required | | Internet Service group name. Source firewall.internet-service-group.name. |
| | | **internet\_service\_id** list / elements=string | | Internet service ID list. |
| | | | **id** integer / required | | Internet service ID. Source firewall.internet-service.id. |
| | | **jitter\_weight** integer | | Coefficient of jitter in the formula of custom-profile-1. |
| | | **latency\_weight** integer | | Coefficient of latency in the formula of custom-profile-1. |
| | | **link\_cost\_factor** string | **Choices:*** latency
* jitter
* packet-loss
* inbandwidth
* outbandwidth
* bibandwidth
* custom-profile-1
| Link cost factor. |
| | | **link\_cost\_threshold** integer | | Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000). |
| | | **member** integer | | Member sequence number. Source system.virtual-wan-link.members.seq-num. |
| | | **mode** string | **Choices:*** auto
* manual
* priority
* sla
* load-balance
| Control how the priority rule sets the priority of interfaces in the SD-WAN. |
| | | **name** string | | Priority rule name. |
| | | **packet\_loss\_weight** integer | | Coefficient of packet-loss in the formula of custom-profile-1. |
| | | **priority\_members** list / elements=string | | Member sequence number list. |
| | | | **seq\_num** integer | | Member sequence number. Source system.virtual-wan-link.members.seq-num. |
| | | **protocol** integer | | Protocol number. |
| | | **quality\_link** integer | | Quality grade. |
| | | **role** string | **Choices:*** standalone
* primary
* secondary
| Service role to work with neighbor. |
| | | **route\_tag** integer | | IPv4 route map route-tag. |
| | | **sla** list / elements=string | | Service level agreement (SLA). |
| | | | **health\_check** string | | Virtual WAN Link health-check. Source system.virtual-wan-link.health-check.name. |
| | | | **id** integer | | SLA ID. |
| | | **sla\_compare\_method** string | **Choices:*** order
* number
| Method to compare SLA value for sla and load balance mode. |
| | | **src** list / elements=string | | Source address name. |
| | | | **name** string / required | | Address or address group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **src6** list / elements=string | | Source address6 name. |
| | | | **name** string / required | | Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **src\_negate** string | **Choices:*** enable
* disable
| Enable/disable negation of source address match. |
| | | **standalone\_action** string | **Choices:*** enable
* disable
| Enable/disable service when selected neighbor role is standalone while service role is not standalone. |
| | | **start\_port** integer | | Start destination port number. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN service. |
| | | **tos** string | | Type of service bit pattern. |
| | | **tos\_mask** string | | Type of service evaluated bits. |
| | | **users** list / elements=string | | User name. |
| | | | **name** string / required | | User name. Source user.local.name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN. |
| | **zone** list / elements=string | | Configure SD-WAN zones. |
| | | **name** string / required | | Zone name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fortios_system_virtual_wan_link:
vdom: "{{ vdom }}"
system_virtual_wan_link:
fail_alert_interfaces:
-
name: "default_name_4 (source system.interface.name)"
fail_detect: "enable"
health_check:
-
addr_mode: "ipv4"
diffservcode: "<your_own_value>"
failtime: "9"
ha_priority: "10"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "14"
members:
-
seq_num: "16 (source system.virtual-wan-link.members.seq-num)"
name: "default_name_17"
packet_size: "18"
password: "<your_own_value>"
port: "20"
probe_packets: "disable"
probe_timeout: "22"
protocol: "ping"
recoverytime: "24"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "28"
jitter_threshold: "29"
latency_threshold: "30"
link_cost_factor: "latency"
packetloss_threshold: "32"
sla_fail_log_period: "33"
sla_pass_log_period: "34"
threshold_alert_jitter: "35"
threshold_alert_latency: "36"
threshold_alert_packetloss: "37"
threshold_warning_jitter: "38"
threshold_warning_latency: "39"
threshold_warning_packetloss: "40"
update_cascade_interface: "enable"
update_static_route: "enable"
load_balance_mode: "source-ip-based"
members:
-
comment: "Comments."
cost: "46"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "49"
interface: "<your_own_value> (source system.interface.name)"
priority: "51"
seq_num: "52"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "55"
status: "disable"
volume_ratio: "57"
weight: "58"
neighbor:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
ip: "<your_own_value> (source router.bgp.neighbor.ip)"
member: "62 (source system.virtual-wan-link.members.seq-num)"
role: "standalone"
sla_id: "64"
neighbor_hold_boot_time: "65"
neighbor_hold_down: "enable"
neighbor_hold_down_time: "67"
service:
-
addr_mode: "ipv4"
bandwidth_weight: "70"
default: "enable"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_77 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "81"
gateway: "enable"
groups:
-
name: "default_name_84 (source user.group.name)"
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
hold_down_time: "86"
id: "87"
input_device:
-
name: "default_name_89 (source system.interface.name)"
input_device_negate: "enable"
internet_service: "enable"
internet_service_app_ctrl:
-
id: "93"
internet_service_app_ctrl_group:
-
name: "default_name_95 (source application.group.name)"
internet_service_ctrl:
-
id: "97"
internet_service_ctrl_group:
-
name: "default_name_99 (source application.group.name)"
internet_service_custom:
-
name: "default_name_101 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_103 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_105 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "107 (source firewall.internet-service.id)"
jitter_weight: "108"
latency_weight: "109"
link_cost_factor: "latency"
link_cost_threshold: "111"
member: "112 (source system.virtual-wan-link.members.seq-num)"
mode: "auto"
name: "default_name_114"
packet_loss_weight: "115"
priority_members:
-
seq_num: "117 (source system.virtual-wan-link.members.seq-num)"
protocol: "118"
quality_link: "119"
role: "standalone"
route_tag: "121"
sla:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "124"
sla_compare_method: "order"
src:
-
name: "default_name_127 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_130 (source firewall.address6.name firewall.addrgrp6.name)"
standalone_action: "enable"
start_port: "132"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
users:
-
name: "default_name_137 (source user.local.name)"
status: "disable"
zone:
-
name: "default_name_140"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_sso_admin – Configure SSO admin users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sso\_admin – Configure SSO admin users in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_sso_admin`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sso\_admin 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_sso\_admin** dictionary | | Configure SSO admin users. |
| | **accprofile** string | | SSO admin user access profile. Source system.accprofile.name. |
| | **gui\_dashboard** list / elements=string | | GUI dashboards. |
| | | **columns** integer | | Number of columns. |
| | | **id** integer / required | | Dashboard ID. |
| | | **layout\_type** string | **Choices:*** responsive
* fixed
| Layout type. |
| | | **name** string | | Dashboard name. |
| | | **permanent** string | **Choices:*** disable
* enable
| Permanent dashboard (can"t be removed via the GUI). |
| | | **vdom** string | | Virtual domain. Source system.vdom.name. |
| | | **widget** list / elements=string | | Dashboard widgets. |
| | | | **fabric\_device** string | | Fabric device to monitor. |
| | | | **fabric\_device\_widget\_name** string | | Fabric device widget name. |
| | | | **fabric\_device\_widget\_visualization\_type** string | | Visualization type for fabric device widget. |
| | | | **fortiview\_device** string | | FortiView device. |
| | | | **fortiview\_filters** list / elements=string | | FortiView filters. |
| | | | | **id** integer / required | | FortiView Filter ID. |
| | | | | **key** string | | Filter key. |
| | | | | **value** string | | Filter value. |
| | | | **fortiview\_sort\_by** string | | FortiView sort by. |
| | | | **fortiview\_timeframe** string | | FortiView timeframe. |
| | | | **fortiview\_type** string | | FortiView type. |
| | | | **fortiview\_visualization** string | | FortiView visualization. |
| | | | **height** integer | | Height. |
| | | | **id** integer / required | | Widget ID. |
| | | | **industry** string | **Choices:*** default
* custom
| Security Audit Rating industry. |
| | | | **interface** string | | Interface to monitor. Source system.interface.name. |
| | | | **region** string | **Choices:*** default
* custom
| Security Audit Rating region. |
| | | | **title** string | | Widget title. |
| | | | **type** string | **Choices:*** sysinfo
* licinfo
* forticloud
* cpu-usage
* memory-usage
* disk-usage
* log-rate
* sessions
* session-rate
* tr-history
* analytics
* usb-modem
* admins
* security-fabric
* security-fabric-ranking
* sensor-info
* ha-status
* vulnerability-summary
* host-scan-summary
* fortiview
* botnet-activity
* fabric-device
| Widget type. |
| | | | **width** integer | | Width. |
| | | | **x\_pos** integer | | X position. |
| | | | **y\_pos** integer | | Y position. |
| | **gui\_global\_menu\_favorites** list / elements=string | | Favorite GUI menu IDs for the global VDOM. |
| | | **id** string / required | | Select menu ID. |
| | **gui\_ignore\_release\_overview\_version** string | | The FortiOS version to ignore release overview prompt for. |
| | **gui\_new\_feature\_acknowledge** list / elements=string | | Acknowledgement of new features. |
| | | **id** string / required | | Select menu ID. |
| | **gui\_vdom\_menu\_favorites** list / elements=string | | Favorite GUI menu IDs for VDOMs. |
| | | **id** string / required | | Select menu ID. |
| | **name** string / required | | SSO admin name. |
| | **vdom** list / elements=string | | Virtual domain(s) that the administrator can access. |
| | | **name** string / required | | Virtual domain name. Source system.vdom.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SSO admin users.
fortios_system_sso_admin:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sso_admin:
accprofile: "<your_own_value> (source system.accprofile.name)"
gui_dashboard:
-
columns: "5"
id: "6"
layout_type: "responsive"
name: "default_name_8"
permanent: "disable"
vdom: "<your_own_value> (source system.vdom.name)"
widget:
-
fabric_device: "<your_own_value>"
fabric_device_widget_name: "<your_own_value>"
fabric_device_widget_visualization_type: "<your_own_value>"
fortiview_device: "<your_own_value>"
fortiview_filters:
-
id: "17"
key: "<your_own_value>"
value: "<your_own_value>"
fortiview_sort_by: "<your_own_value>"
fortiview_timeframe: "<your_own_value>"
fortiview_type: "<your_own_value>"
fortiview_visualization: "<your_own_value>"
height: "24"
id: "25"
industry: "default"
interface: "<your_own_value> (source system.interface.name)"
region: "default"
title: "<your_own_value>"
type: "sysinfo"
width: "31"
x_pos: "32"
y_pos: "33"
gui_global_menu_favorites:
-
id: "35"
gui_ignore_release_overview_version: "<your_own_value>"
gui_new_feature_acknowledge:
-
id: "38"
gui_vdom_menu_favorites:
-
id: "40"
name: "default_name_41"
vdom:
-
name: "default_name_43 (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_policy46 – Configure IPv4 to IPv6 policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_policy46 – Configure IPv4 to IPv6 policies in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_policy46`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy46 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_policy46** dictionary | | Configure IPv4 to IPv6 policies. |
| | **action** string | **Choices:*** accept
* deny
| Accept or deny traffic matching the policy. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address objects. |
| | | **name** string / required | | Address name. Source firewall.vip46.name firewall.vipgrp46.name. |
| | **dstintf** string | | Destination interface name. Source system.interface.name system.zone.name. |
| | **fixedport** string | **Choices:*** enable
* disable
| Enable/disable fixed port for this policy. |
| | **ippool** string | **Choices:*** enable
* disable
| Enable/disable use of IP Pools for source NAT. |
| | **logtraffic** string | **Choices:*** enable
* disable
| Enable/disable traffic logging for this policy. |
| | **logtraffic\_start** string | **Choices:*** enable
* disable
| Record logs when a session starts and ends. |
| | **name** string | | Policy name. |
| | **per\_ip\_shaper** string | | Per IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
| | **permit\_any\_host** string | **Choices:*** enable
* disable
| Enable/disable allowing any host. |
| | **policyid** integer / required | | Policy ID. |
| | **poolname** list / elements=string | | IP Pool names. |
| | | **name** string / required | | IP pool name. Source firewall.ippool6.name. |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **service** list / elements=string | | Service name. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **srcaddr** list / elements=string | | Source address objects. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **srcintf** string | | Source interface name. Source system.zone.name system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| | **tcp\_mss\_receiver** integer | | TCP Maximum Segment Size value of receiver (0 - 65535) |
| | **tcp\_mss\_sender** integer | | TCP Maximum Segment Size value of sender (0 - 65535). |
| | **traffic\_shaper** string | | Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 to IPv6 policies.
fortios_firewall_policy46:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy46:
action: "accept"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_6 (source firewall.vip46.name firewall.vipgrp46.name)"
dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
fixedport: "enable"
ippool: "enable"
logtraffic: "enable"
logtraffic_start: "enable"
name: "default_name_12"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
policyid: "15"
poolname:
-
name: "default_name_17 (source firewall.ippool6.name)"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_20 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
status: "enable"
tcp_mss_receiver: "25"
tcp_mss_sender: "26"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_ftm_push – Configure FortiToken Mobile push services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ftm\_push – Configure FortiToken Mobile push services in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ftm_push`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ftm\_push 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_ftm\_push** dictionary | | Configure FortiToken Mobile push services. |
| | **server** string | | IPv4 address or domain name of FortiToken Mobile push services server. |
| | **server\_cert** string | | Name of the server certificate to be used for SSL . Source certificate.local.name. |
| | **server\_ip** string | | IPv4 address of FortiToken Mobile push services server (format: xxx.xxx.xxx.xxx). |
| | **server\_port** integer | | Port to communicate with FortiToken Mobile push services server (1 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the use of FortiToken Mobile push services. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiToken Mobile push services.
fortios_system_ftm_push:
vdom: "{{ vdom }}"
system_ftm_push:
server: "192.168.100.40"
server_cert: "<your_own_value> (source certificate.local.name)"
server_ip: "<your_own_value>"
server_port: "6"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_switch_log – Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_switch\_log – Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log) in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_switch_log`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and switch\_log 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_switch\_log** dictionary | | Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log). |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Severity of FortiSwitch logs that are added to the FortiGate event log. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable adding FortiSwitch logs to FortiGate event log. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log).
fortios_switch_controller_switch_log:
vdom: "{{ vdom }}"
switch_controller_switch_log:
severity: "emergency"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_replacemsg_automation – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_automation – Replacement messages in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_automation`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and automation 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_automation** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_automation:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_automation:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_lldp_settings – Configure FortiSwitch LLDP settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_lldp\_settings – Configure FortiSwitch LLDP settings in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_lldp_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and lldp\_settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_lldp\_settings** dictionary | | Configure FortiSwitch LLDP settings. |
| | **device\_detection** string | **Choices:*** disable
* enable
| Enable/disable dynamic detection of LLDP neighbor devices for VLAN assignment. |
| | **fast\_start\_interval** integer | | Frequency of LLDP PDU transmission from FortiSwitch for the first 4 packets when the link is up (2 - 5 sec). |
| | **management\_interface** string | **Choices:*** internal
* mgmt
| Primary management interface to be advertised in LLDP and CDP PDUs. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable LLDP global settings. |
| | **tx\_hold** integer | | Number of tx-intervals before local LLDP data expires (1 - 16). Packet TTL is tx-hold \* tx-interval. |
| | **tx\_interval** integer | | Frequency of LLDP PDU transmission from FortiSwitch (5 - 4095 sec). Packet TTL is tx-hold \* tx-interval. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch LLDP settings.
fortios_switch_controller_lldp_settings:
vdom: "{{ vdom }}"
switch_controller_lldp_settings:
device_detection: "disable"
fast_start_interval: "4"
management_interface: "internal"
status: "enable"
tx_hold: "7"
tx_interval: "8"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_geoip_country – Define geoip country name-ID table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_geoip\_country – Define geoip country name-ID table in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_geoip_country`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and geoip\_country 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_geoip\_country** dictionary | | Define geoip country name-ID table. |
| | **id** string / required | | Country ID. |
| | **name** string | | Country name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Define geoip country name-ID table.
fortios_system_geoip_country:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_geoip_country:
id: "3"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer\_filter** dictionary | | Filters for FortiAnalyzer. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | FortiAnalyzer log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for FortiAnalyzer.
fortios_log_fortianalyzer_filter:
vdom: "{{ vdom }}"
log_fortianalyzer_filter:
anomaly: "enable"
dlp_archive: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "13"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_router_rip – Configure RIP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_rip – Configure RIP in Fortinet’s FortiOS and FortiGate.
==========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_rip`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and rip 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_rip** dictionary | | Configure RIP. |
| | **default\_information\_originate** string | **Choices:*** enable
* disable
| Enable/disable generation of default route. |
| | **default\_metric** integer | | Default metric. |
| | **distance** list / elements=string | | distance |
| | | **access\_list** string | | Access list for route destination. Source router.access-list.name. |
| | | **distance** integer | | Distance (1 - 255). |
| | | **id** integer / required | | Distance ID. |
| | | **prefix** string | | Distance prefix. |
| | **distribute\_list** list / elements=string | | Distribute list. |
| | | **direction** string | **Choices:*** in
* out
| Distribute list direction. |
| | | **id** integer / required | | Distribute list ID. |
| | | **interface** string | | Distribute list interface name. Source system.interface.name. |
| | | **listname** string | | Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name. |
| | | **status** string | **Choices:*** enable
* disable
| status |
| | **garbage\_timer** integer | | Garbage timer in seconds. |
| | **interface** list / elements=string | | RIP interface configuration. |
| | | **auth\_keychain** string | | Authentication key-chain name. Source router.key-chain.name. |
| | | **auth\_mode** string | **Choices:*** none
* text
* md5
| Authentication mode. |
| | | **auth\_string** string | | Authentication string/password. |
| | | **flags** integer | | flags |
| | | **name** string / required | | Interface name. Source system.interface.name. |
| | | **receive\_version** list / elements=string | **Choices:*** 1
* 2
| Receive version. |
| | | **send\_version** list / elements=string | **Choices:*** 1
* 2
| Send version. |
| | | **send\_version2\_broadcast** string | **Choices:*** disable
* enable
| Enable/disable broadcast version 1 compatible packets. |
| | | **split\_horizon** string | **Choices:*** poisoned
* regular
| Enable/disable split horizon. |
| | | **split\_horizon\_status** string | **Choices:*** enable
* disable
| Enable/disable split horizon. |
| | **max\_out\_metric** integer | | Maximum metric allowed to output(0 means "not set"). |
| | **neighbor** list / elements=string | | neighbor |
| | | **id** integer / required | | Neighbor entry ID. |
| | | **ip** string | | IP address. |
| | **network** list / elements=string | | network |
| | | **id** integer / required | | Network entry ID. |
| | | **prefix** string | | Network prefix. |
| | **offset\_list** list / elements=string | | Offset list. |
| | | **access\_list** string | | Access list name. Source router.access-list.name. |
| | | **direction** string | **Choices:*** in
* out
| Offset list direction. |
| | | **id** integer / required | | Offset-list ID. |
| | | **interface** string | | Interface name. Source system.interface.name. |
| | | **offset** integer | | offset |
| | | **status** string | **Choices:*** enable
* disable
| status |
| | **passive\_interface** list / elements=string | | Passive interface configuration. |
| | | **name** string / required | | Passive interface name. Source system.interface.name. |
| | **recv\_buffer\_size** integer | | Receiving buffer size. |
| | **redistribute** list / elements=string | | Redistribute configuration. |
| | | **metric** integer | | Redistribute metric setting. |
| | | **name** string / required | | Redistribute name. |
| | | **routemap** string | | Route map name. Source router.route-map.name. |
| | | **status** string | **Choices:*** enable
* disable
| status |
| | **timeout\_timer** integer | | Timeout timer in seconds. |
| | **update\_timer** integer | | Update timer in seconds. |
| | **version** string | **Choices:*** 1
* 2
| RIP version. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure RIP.
fortios_router_rip:
vdom: "{{ vdom }}"
router_rip:
default_information_originate: "enable"
default_metric: "4"
distance:
-
access_list: "<your_own_value> (source router.access-list.name)"
distance: "7"
id: "8"
prefix: "<your_own_value>"
distribute_list:
-
direction: "in"
id: "12"
interface: "<your_own_value> (source system.interface.name)"
listname: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
status: "enable"
garbage_timer: "16"
interface:
-
auth_keychain: "<your_own_value> (source router.key-chain.name)"
auth_mode: "none"
auth_string: "<your_own_value>"
flags: "21"
name: "default_name_22 (source system.interface.name)"
receive_version: "1"
send_version: "1"
send_version2_broadcast: "disable"
split_horizon: "poisoned"
split_horizon_status: "enable"
max_out_metric: "28"
neighbor:
-
id: "30"
ip: "<your_own_value>"
network:
-
id: "33"
prefix: "<your_own_value>"
offset_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
direction: "in"
id: "38"
interface: "<your_own_value> (source system.interface.name)"
offset: "40"
status: "enable"
passive_interface:
-
name: "default_name_43 (source system.interface.name)"
recv_buffer_size: "44"
redistribute:
-
metric: "46"
name: "default_name_47"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout_timer: "50"
update_timer: "51"
version: "1"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_vlan – Configure VLANs for switch controller in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_vlan – Configure VLANs for switch controller in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_vlan`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and vlan 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_vlan** dictionary | | Configure VLANs for switch controller. |
| | **auth** string | **Choices:*** radius
* usergroup
| Authentication. |
| | **color** integer | | Color of icon on the GUI. |
| | **comments** string | | Comment. |
| | **name** string / required | | Switch VLAN name. |
| | **portal\_message\_override\_group** string | | Specify captive portal replacement message override group. |
| | **portal\_message\_overrides** dictionary | | Individual message overrides. |
| | | **auth\_disclaimer\_page** string | | Override auth-disclaimer-page message with message from portal-message-overrides group. |
| | | **auth\_login\_failed\_page** string | | Override auth-login-failed-page message with message from portal-message-overrides group. |
| | | **auth\_login\_page** string | | Override auth-login-page message with message from portal-message-overrides group. |
| | | **auth\_reject\_page** string | | Override auth-reject-page message with message from portal-message-overrides group. |
| | **radius\_server** string | | Authentication radius server. Source user.radius.name. |
| | **security** string | **Choices:*** open
* captive-portal
* 8021x
| Security. |
| | **selected\_usergroups** list / elements=string | | Selected user group. |
| | | **name** string / required | | User group name. Source user.group.name. |
| | **usergroup** string | | Authentication usergroup. Source user.group.name. |
| | **vdom** string | | Virtual domain, |
| | **vlanid** integer | | VLAN ID. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VLANs for switch controller.
fortios_switch_controller_vlan:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_vlan:
auth: "radius"
color: "4"
comments: "<your_own_value>"
name: "default_name_6"
portal_message_override_group: "<your_own_value>"
portal_message_overrides:
auth_disclaimer_page: "<your_own_value>"
auth_login_failed_page: "<your_own_value>"
auth_login_page: "<your_own_value>"
auth_reject_page: "<your_own_value>"
radius_server: "<your_own_value> (source user.radius.name)"
security: "open"
selected_usergroups:
-
name: "default_name_16 (source user.group.name)"
usergroup: "<your_own_value> (source user.group.name)"
vdom: "<your_own_value>"
vlanid: "19"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_geoip_override – Configure geographical location mapping for IP address(es) to override mappings from FortiGuard in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_geoip\_override – Configure geographical location mapping for IP address(es) to override mappings from FortiGuard in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_geoip_override`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and geoip\_override 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_geoip\_override** dictionary | | Configure geographical location mapping for IP address(es) to override mappings from FortiGuard. |
| | **country\_id** string | | Two character Country ID code. |
| | **description** string | | Description. |
| | **ip6\_range** list / elements=string | | Table of IPv6 ranges assigned to country. |
| | | **end\_ip** string | | Ending IP address, inclusive, of the address range (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | | **id** integer / required | | ID of individual entry in the IPv6 range table. |
| | | **start\_ip** string | | Starting IP address, inclusive, of the address range (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **ip\_range** list / elements=string | | Table of IP ranges assigned to country. |
| | | **end\_ip** string | | Final IP address, inclusive, of the address range (format: xxx.xxx.xxx.xxx). |
| | | **id** integer / required | | ID number for individual entry in the IP-Range table. |
| | | **start\_ip** string | | Starting IP address, inclusive, of the address range (format: xxx.xxx.xxx.xxx). |
| | **name** string / required | | Location name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure geographical location mapping for IP address(es) to override mappings from FortiGuard.
fortios_system_geoip_override:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_geoip_override:
country_id: "<your_own_value>"
description: "<your_own_value>"
ip_range:
-
end_ip: "<your_own_value>"
id: "7"
start_ip: "<your_own_value>"
ip6_range:
-
end_ip: "<your_own_value>"
id: "11"
start_ip: "<your_own_value>"
name: "default_name_13"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_initial_config_template – Configure template for auto-generated VLANs in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_initial\_config\_template – Configure template for auto-generated VLANs in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_initial_config_template`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_initial\_config feature and template 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_initial\_config\_template** dictionary | | Configure template for auto-generated VLANs. |
| | **allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* telnet
* fgfm
* radius-acct
* probe-response
* fabric
* ftm
| Permitted types of management access to this interface. |
| | **auto\_ip** string | **Choices:*** enable
* disable
| Automatically allocate interface address and subnet block. |
| | **dhcp\_server** string | **Choices:*** enable
* disable
| Enable/disable a DHCP server on this interface. |
| | **ip** string | | Interface IPv4 address and subnet mask. |
| | **name** string / required | | Initial config template name |
| | **vlanid** integer | | Unique VLAN ID. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure template for auto-generated VLANs.
fortios_switch_controller_initial_config_template:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_initial_config_template:
allowaccess: "ping"
auto_ip: "enable"
dhcp_server: "enable"
ip: "<your_own_value>"
name: "default_name_7"
vlanid: "8"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vip46 – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_vip46`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip46 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_vip46** dictionary | | Configure IPv4 to IPv6 virtual IPs. |
| | **arp\_reply** string | **Choices:*** disable
* enable
| Enable ARP reply. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **extip** string | | Start-external-IP [-end-external-IP]. |
| | **extport** string | | External service port. |
| | **id** integer | | Custom defined id. |
| | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| Load balance method. |
| | **mappedip** string | | Start-mapped-IP [-end mapped-IP]. |
| | **mappedport** string | | Mapped service port. |
| | **monitor** list / elements=string | | Health monitors. |
| | | **name** string / required | | Health monitor name. Source firewall.ldb-monitor.name. |
| | **name** string / required | | VIP46 name. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable port forwarding. |
| | **protocol** string | **Choices:*** tcp
* udp
| Mapped port protocol. |
| | **realservers** list / elements=string | | Real servers. |
| | | **client\_ip** string | | Restrict server to a client IP in this range. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | | **holddown\_interval** integer | | Hold down interval. |
| | | **id** integer / required | | Real server ID. |
| | | **ip** string | | Mapped server IPv6. |
| | | **max\_connections** integer | | Maximum number of connections allowed to server. |
| | | **monitor** string | | Health monitors. Source firewall.ldb-monitor.name. |
| | | **port** integer | | Mapped server port. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | | **weight** integer | | weight |
| | **server\_type** string | **Choices:*** http
* tcp
* udp
* ip
| Server type. |
| | **src\_filter** list / elements=string | | Source IP filter (x.x.x.x/x). |
| | | **range** string / required | | Src-filter range. |
| | **srcintf\_filter** list / elements=string | | Interfaces to which the VIP46 applies. Separate the names with spaces. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| VIP type: static NAT or server load balance. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 to IPv6 virtual IPs.
fortios_firewall_vip46:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip46:
arp_reply: "disable"
color: "4"
comment: "Comment."
extip: "<your_own_value>"
extport: "<your_own_value>"
id: "8"
ldb_method: "static"
mappedip: "<your_own_value>"
mappedport: "<your_own_value>"
monitor:
-
name: "default_name_13 (source firewall.ldb-monitor.name)"
name: "default_name_14"
portforward: "disable"
protocol: "tcp"
realservers:
-
client_ip: "<your_own_value>"
healthcheck: "disable"
holddown_interval: "20"
id: "21"
ip: "<your_own_value>"
max_connections: "23"
monitor: "<your_own_value> (source firewall.ldb-monitor.name)"
port: "25"
status: "active"
weight: "27"
server_type: "http"
src_filter:
-
range: "<your_own_value>"
srcintf_filter:
-
interface_name: "<your_own_value> (source system.interface.name)"
type: "static-nat"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_gtp_ie_white_list – IE white list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_ie\_white\_list – IE white list in Fortinet’s FortiOS and FortiGate.
===================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_gtp_ie_white_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and ie\_white\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **gtp\_ie\_white\_list** dictionary | | IE white list. |
| | **entries** list / elements=string | | Entries of white list (to allow) for unknown or out-of-state IEs. |
| | | **id** integer / required | | Entry ID. |
| | | **ie** integer | | IE ID (1 - 255). |
| | | **message** integer | | Message ID (1 - 255). |
| | **name** string / required | | IE white list name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: IE white list.
fortios_gtp_ie_white_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_ie_white_list:
entries:
-
id: "4"
ie: "5"
message: "6"
name: "default_name_7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_interface_policy – Configure IPv4 interface policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_interface\_policy – Configure IPv4 interface policies in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_interface_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and interface\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_interface\_policy** dictionary | | Configure IPv4 interface policies. |
| | **address\_type** string | **Choices:*** ipv4
* ipv6
| Policy address type (IPv4 or IPv6). |
| | **application\_list** string | | Application list name. Source application.list.name. |
| | **application\_list\_status** string | **Choices:*** enable
* disable
| Enable/disable application control. |
| | **av\_profile** string | | Antivirus profile. Source antivirus.profile.name. |
| | **av\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable antivirus. |
| | **comments** string | | Comments. |
| | **dlp\_sensor** string | | DLP sensor name. Source dlp.sensor.name. |
| | **dlp\_sensor\_status** string | **Choices:*** enable
* disable
| Enable/disable DLP. |
| | **dsri** string | **Choices:*** enable
* disable
| Enable/disable DSRI. |
| | **dstaddr** list / elements=string | | Address object to limit traffic monitoring to network traffic sent to the specified address or range. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **emailfilter\_profile** string | | Email filter profile. Source emailfilter.profile.name. |
| | **emailfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable email filter. |
| | **interface** string | | Monitored interface name from available interfaces. Source system.zone.name system.interface.name. |
| | **ips\_sensor** string | | IPS sensor name. Source ips.sensor.name. |
| | **ips\_sensor\_status** string | **Choices:*** enable
* disable
| Enable/disable IPS. |
| | **label** string | | Label. |
| | **logtraffic** string | **Choices:*** all
* utm
* disable
| Logging type to be used in this policy (Options: all | utm | disable). |
| | **policyid** integer / required | | Policy ID. |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Enable/disable scanning for connections to Botnet servers. |
| | **service** list / elements=string | | Service object from available options. |
| | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | **spamfilter\_profile** string | | Antispam profile. Source spamfilter.profile.name. |
| | **spamfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable antispam. |
| | **srcaddr** list / elements=string | | Address object to limit traffic monitoring to network traffic sent from the specified address or range. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| | **webfilter\_profile** string | | Web filter profile. Source webfilter.profile.name. |
| | **webfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable web filtering. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 interface policies.
fortios_firewall_interface_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_interface_policy:
address_type: "ipv4"
application_list: "<your_own_value> (source application.list.name)"
application_list_status: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
av_profile_status: "enable"
comments: "<your_own_value>"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dlp_sensor_status: "enable"
dsri: "enable"
dstaddr:
-
name: "default_name_13 (source firewall.address.name firewall.addrgrp.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
emailfilter_profile_status: "enable"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_sensor_status: "enable"
label: "<your_own_value>"
logtraffic: "all"
policyid: "21"
scan_botnet_connections: "disable"
service:
-
name: "default_name_24 (source firewall.service.custom.name firewall.service.group.name)"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
spamfilter_profile_status: "enable"
srcaddr:
-
name: "default_name_28 (source firewall.address.name firewall.addrgrp.name)"
status: "enable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webfilter_profile_status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_csf fortinet.fortios.fortios\_system\_csf
=====================================
The documentation for the module plugin, fortinet.fortios.fortios\_system\_csf, was malformed.
The errors were:
* ```
1 validation error for ModuleDocSchema
doc -> options -> system_csf -> suboptions -> fabric_device -> suboptions -> access_token -> type
string does not match regex "^(bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$)
```
File a bug with the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) in order to have it corrected.
ansible fortinet.fortios.fortios_wireless_controller_addrgrp – Configure the MAC address group in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_addrgrp – Configure the MAC address group in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_addrgrp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and addrgrp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_addrgrp** dictionary | | Configure the MAC address group. |
| | **addresses** list / elements=string | | Manually selected group of addresses. |
| | | **id** string / required | | Address ID. Source wireless-controller.address.id. |
| | **default\_policy** string | **Choices:*** allow
* deny
| Allow or block the clients with MAC addresses that are not in the group. |
| | **id** string / required | | ID. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure the MAC address group.
fortios_wireless_controller_addrgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_addrgrp:
addresses:
-
id: "4 (source wireless-controller.address.id)"
default_policy: "allow"
id: "6"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_arrp_profile – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_arrp\_profile – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_arrp_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and arrp\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_arrp\_profile** dictionary | | Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles. |
| | **comment** string | | Comment. |
| | **include\_dfs\_channel** string | **Choices:*** True
* False
* enable
* disable
| Enable/disable use of DFS channel in DARRP channel selection phase 1 . |
| | **include\_weather\_channel** string | **Choices:*** True
* False
* enable
* disable
| Enable/disable use of weather channel in DARRP channel selection phase 1 . |
| | **monitor\_period** integer | | Period in seconds to measure average transmit retries and receive errors . |
| | **name** string / required | | WiFi ARRP profile name. |
| | **selection\_period** integer | | Period in seconds to measure average channel load, noise floor, spectral RSSI . |
| | **threshold\_ap** integer | | Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500). |
| | **threshold\_channel\_load** integer | | Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100). |
| | **threshold\_noise\_floor** string | | Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20). |
| | **threshold\_rx\_errors** integer | | Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100). |
| | **threshold\_spectral\_rssi** string | | Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20). |
| | **threshold\_tx\_retries** integer | | Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000). |
| | **weight\_channel\_load** integer | | Weight in DARRP channel score calculation for channel load (0 - 2000). |
| | **weight\_dfs\_channel** integer | | Weight in DARRP channel score calculation for DFS channel (0 - 2000). |
| | **weight\_managed\_ap** integer | | Weight in DARRP channel score calculation for managed APs (0 - 2000). |
| | **weight\_noise\_floor** integer | | Weight in DARRP channel score calculation for noise floor (0 - 2000). |
| | **weight\_rogue\_ap** integer | | Weight in DARRP channel score calculation for rogue APs (0 - 2000). |
| | **weight\_spectral\_rssi** integer | | Weight in DARRP channel score calculation for spectral RSSI (0 - 2000). |
| | **weight\_weather\_channel** integer | | Weight in DARRP channel score calculation for weather channel (0 - 2000). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
fortios_wireless_controller_arrp_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_arrp_profile:
comment: "Comment."
include_dfs_channel: "yes"
include_weather_channel: "yes"
monitor_period: "6"
name: "default_name_7"
selection_period: "8"
threshold_ap: "9"
threshold_channel_load: "10"
threshold_noise_floor: "<your_own_value>"
threshold_rx_errors: "12"
threshold_spectral_rssi: "<your_own_value>"
threshold_tx_retries: "14"
weight_channel_load: "15"
weight_dfs_channel: "16"
weight_managed_ap: "17"
weight_noise_floor: "18"
weight_rogue_ap: "19"
weight_spectral_rssi: "20"
weight_weather_channel: "21"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_emailfilter_dnsbl – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_dnsbl – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate.
=================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_emailfilter_dnsbl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and dnsbl 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **emailfilter\_dnsbl** dictionary | | Configure AntiSpam DNSBL/ORBL. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter DNSBL and ORBL server. |
| | | **action** string | **Choices:*** reject
* spam
| Reject connection or mark as spam email. |
| | | **id** integer / required | | DNSBL/ORBL entry ID. |
| | | **server** string | | DNSBL or ORBL server name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam DNSBL/ORBL.
fortios_emailfilter_dnsbl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_dnsbl:
comment: "Optional comments."
entries:
-
action: "reject"
id: "6"
server: "192.168.100.40"
status: "enable"
id: "9"
name: "default_name_10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_setting – Configure general log settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_setting – Configure general log settings in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_setting** dictionary | | Configure general log settings. |
| | **brief\_traffic\_format** string | **Choices:*** enable
* disable
| Enable/disable brief format traffic logging. |
| | **custom\_log\_fields** list / elements=string | | Custom fields to append to all log messages. |
| | | **field\_id** string | | Custom log field. Source log.custom-field.id. |
| | **daemon\_log** string | **Choices:*** enable
* disable
| Enable/disable daemon logging. |
| | **expolicy\_implicit\_log** string | **Choices:*** enable
* disable
| Enable/disable explicit proxy firewall implicit policy logging. |
| | **faz\_override** string | **Choices:*** enable
* disable
| Enable/disable override FortiAnalyzer settings. |
| | **fortiview\_weekly\_data** string | **Choices:*** enable
* disable
| Enable/disable FortiView weekly data. |
| | **fwpolicy6\_implicit\_log** string | **Choices:*** enable
* disable
| Enable/disable implicit firewall policy6 logging. |
| | **fwpolicy\_implicit\_log** string | **Choices:*** enable
* disable
| Enable/disable implicit firewall policy logging. |
| | **local\_in\_allow** string | **Choices:*** enable
* disable
| Enable/disable local-in-allow logging. |
| | **local\_in\_deny\_broadcast** string | **Choices:*** enable
* disable
| Enable/disable local-in-deny-broadcast logging. |
| | **local\_in\_deny\_unicast** string | **Choices:*** enable
* disable
| Enable/disable local-in-deny-unicast logging. |
| | **local\_out** string | **Choices:*** enable
* disable
| Enable/disable local-out logging. |
| | **log\_invalid\_packet** string | **Choices:*** enable
* disable
| Enable/disable invalid packet traffic logging. |
| | **log\_policy\_comment** string | **Choices:*** enable
* disable
| Enable/disable inserting policy comments into traffic logs. |
| | **log\_policy\_name** string | **Choices:*** enable
* disable
| Enable/disable inserting policy name into traffic logs. |
| | **log\_user\_in\_upper** string | **Choices:*** enable
* disable
| Enable/disable logs with user-in-upper. |
| | **neighbor\_event** string | **Choices:*** enable
* disable
| Enable/disable neighbor event logging. |
| | **resolve\_ip** string | **Choices:*** enable
* disable
| Enable/disable adding resolved domain names to traffic logs if possible. |
| | **resolve\_port** string | **Choices:*** enable
* disable
| Enable/disable adding resolved service names to traffic logs. |
| | **syslog\_override** string | **Choices:*** enable
* disable
| Enable/disable override Syslog settings. |
| | **user\_anonymize** string | **Choices:*** enable
* disable
| Enable/disable anonymizing user names in log messages. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure general log settings.
fortios_log_setting:
vdom: "{{ vdom }}"
log_setting:
brief_traffic_format: "enable"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
daemon_log: "enable"
expolicy_implicit_log: "enable"
faz_override: "enable"
fortiview_weekly_data: "enable"
fwpolicy_implicit_log: "enable"
fwpolicy6_implicit_log: "enable"
local_in_allow: "enable"
local_in_deny_broadcast: "enable"
local_in_deny_unicast: "enable"
local_out: "enable"
log_invalid_packet: "enable"
log_policy_comment: "enable"
log_policy_name: "enable"
log_user_in_upper: "enable"
neighbor_event: "enable"
resolve_ip: "enable"
resolve_port: "enable"
syslog_override: "enable"
user_anonymize: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_service_category – Configure service categories in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_service\_category – Configure service categories in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_service_category`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_service feature and category 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_service\_category** dictionary | | Configure service categories. |
| | **comment** string | | Comment. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **name** string / required | | Service category name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure service categories.
fortios_firewall_service_category:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_service_category:
comment: "Comment."
fabric_object: "enable"
name: "default_name_5"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_report_setting – Report setting configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_setting – Report setting configuration in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_report_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **report\_setting** dictionary | | Report setting configuration. |
| | **fortiview** string | **Choices:*** enable
* disable
| Enable/disable historical FortiView. |
| | **pdf\_report** string | **Choices:*** enable
* disable
| Enable/disable PDF report. |
| | **report\_source** list / elements=string | **Choices:*** forward-traffic
* sniffer-traffic
* local-deny-traffic
| Report log source. |
| | **top\_n** integer | | Number of items to populate (100 - 4000). |
| | **web\_browsing\_threshold** integer | | Web browsing time calculation threshold (3 - 15 min). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Report setting configuration.
fortios_report_setting:
vdom: "{{ vdom }}"
report_setting:
fortiview: "enable"
pdf_report: "enable"
report_source: "forward-traffic"
top_n: "6"
web_browsing_threshold: "7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_decrypted_traffic_mirror – Configure decrypted traffic mirror in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_decrypted\_traffic\_mirror – Configure decrypted traffic mirror in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_decrypted_traffic_mirror`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and decrypted\_traffic\_mirror 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_decrypted\_traffic\_mirror** dictionary | | Configure decrypted traffic mirror. |
| | **dstmac** string | | Set destination MAC address for mirrored traffic. |
| | **interface** list / elements=string | | Decrypted traffic mirror interface |
| | | **name** string / required | | Decrypted traffic mirror interface. Source system.interface.name system.zone.name. |
| | **name** string / required | | Name. |
| | **traffic\_source** string | **Choices:*** client
* server
* both
| Source of decrypted traffic to be mirrored. |
| | **traffic\_type** list / elements=string | **Choices:*** ssl
* ssh
| Types of decrypted traffic to be mirrored. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure decrypted traffic mirror.
fortios_firewall_decrypted_traffic_mirror:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_decrypted_traffic_mirror:
dstmac: "<your_own_value>"
interface:
-
name: "default_name_5 (source system.interface.name system.zone.name)"
name: "default_name_6"
traffic_source: "client"
traffic_type: "ssl"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_syslogd2_override_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd2\_override\_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd2_override_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd2 feature and override\_setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd2\_override\_setting** dictionary | | Override settings for remote syslog server. |
| | **certificate** string | | Certificate used to communicate with Syslog server. Source certificate.local.name. |
| | **custom\_field\_name** list / elements=string | | Custom field name for CEF format logging. |
| | | **custom** string | | Field custom name. |
| | | **id** integer / required | | Entry ID. |
| | | **name** string | | Field name. |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
* disable
| Enable/disable reliable syslogging with TLS encryption. |
| | **facility** string | **Choices:*** kernel
* user
* mail
* daemon
* auth
* syslog
* lpr
* news
* uucp
* cron
* authpriv
* ftp
* ntp
* audit
* alert
* clock
* local0
* local1
* local2
* local3
* local4
* local5
* local6
* local7
| Remote syslog facility. |
| | **format** string | **Choices:*** default
* csv
* cef
* rfc5424
| Log format. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **max\_log\_rate** integer | | Syslog maximum log rate in MBps (0 = unlimited). |
| | **mode** string | **Choices:*** udp
* legacy-reliable
* reliable
| Remote syslog logging over UDP/Reliable TCP. |
| | **override** string | **Choices:*** enable
* disable
| Enable/disable override syslog settings. |
| | **port** integer | | Server listen port. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **server** string | | Address of remote syslog server. |
| | **source\_ip** string | | Source IP address of syslog. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable remote syslog logging. |
| | **syslog\_type** integer | | Hidden setting index of Syslog. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override settings for remote syslog server.
fortios_log_syslogd2_override_setting:
vdom: "{{ vdom }}"
log_syslogd2_override_setting:
certificate: "<your_own_value> (source certificate.local.name)"
custom_field_name:
-
custom: "<your_own_value>"
id: "6"
name: "default_name_7"
enc_algorithm: "high-medium"
facility: "kernel"
format: "default"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "13"
mode: "udp"
override: "enable"
port: "16"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "22"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_cluster_sync – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_cluster\_sync – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_cluster_sync`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and cluster\_sync 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_cluster\_sync** dictionary | | Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. |
| | **down\_intfs\_before\_sess\_sync** list / elements=string | | List of interfaces to be turned down before session synchronization is complete. |
| | | **name** string / required | | Interface name. Source system.interface.name. |
| | **hb\_interval** integer | | Heartbeat interval (1 - 10 sec). |
| | **hb\_lost\_threshold** integer | | Lost heartbeat threshold (1 - 10). |
| | **ike\_heartbeat\_interval** integer | | IKE heartbeat interval (1 - 60 secs). |
| | **ike\_monitor** string | **Choices:*** enable
* disable
| Enable/disable IKE HA monitor. |
| | **ike\_monitor\_interval** integer | | IKE HA monitor interval (10 - 300 secs). |
| | **ike\_seqjump\_speed** integer | | ESP jump ahead factor (1G - 10G pps equivalent). |
| | **ipsec\_tunnel\_sync** string | **Choices:*** enable
* disable
| Enable/disable IPsec tunnel synchronization. |
| | **peerip** string | | IP address of the interface on the peer unit that is used for the session synchronization link. |
| | **peervd** string | | VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd. Source system.vdom.name. |
| | **session\_sync\_filter** dictionary | | Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. |
| | | **custom\_service** list / elements=string | | Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. |
| | | | **dst\_port\_range** string | | Custom service destination port range. |
| | | | **id** integer / required | | Custom service ID. |
| | | | **src\_port\_range** string | | Custom service source port range. |
| | | **dstaddr** string | | Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters. |
| | | **dstaddr6** string | | Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters. |
| | | **dstintf** string | | Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters. Source system.interface.name. |
| | | **srcaddr** string | | Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters. |
| | | **srcaddr6** string | | Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters. |
| | | **srcintf** string | | Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters. Source system.interface.name. |
| | **slave\_add\_ike\_routes** string | **Choices:*** enable
* disable
| Enable/disable IKE route announcement on the backup unit. |
| | **sync\_id** integer | | Sync ID. |
| | **syncvd** list / elements=string | | Sessions from these VDOMs are synchronized using this session synchronization configuration. |
| | | **name** string / required | | VDOM name. Source system.vdom.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
fortios_system_cluster_sync:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_cluster_sync:
down_intfs_before_sess_sync:
-
name: "default_name_4 (source system.interface.name)"
hb_interval: "5"
hb_lost_threshold: "6"
ike_heartbeat_interval: "7"
ike_monitor: "enable"
ike_monitor_interval: "9"
ike_seqjump_speed: "10"
ipsec_tunnel_sync: "enable"
peerip: "<your_own_value>"
peervd: "<your_own_value> (source system.vdom.name)"
session_sync_filter:
custom_service:
-
dst_port_range: "<your_own_value>"
id: "17"
src_port_range: "<your_own_value>"
dstaddr: "<your_own_value>"
dstaddr6: "<your_own_value>"
dstintf: "<your_own_value> (source system.interface.name)"
srcaddr: "<your_own_value>"
srcaddr6: "<your_own_value>"
srcintf: "<your_own_value> (source system.interface.name)"
slave_add_ike_routes: "enable"
sync_id: "26"
syncvd:
-
name: "default_name_28 (source system.vdom.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_application_list – Configure application control lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_application\_list – Configure application control lists in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_application_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **application\_list** dictionary | | Configure application control lists. |
| | **app\_replacemsg** string | **Choices:*** disable
* enable
| Enable/disable replacement messages for blocked applications. |
| | **comment** string | | comments |
| | **control\_default\_network\_services** string | **Choices:*** disable
* enable
| Enable/disable enforcement of protocols over selected ports. |
| | **deep\_app\_inspection** string | **Choices:*** disable
* enable
| Enable/disable deep application inspection. |
| | **default\_network\_services** list / elements=string | | Default network service entries. |
| | | **id** integer / required | | Entry ID. |
| | | **port** integer | | Port number. |
| | | **services** string | **Choices:*** http
* ssh
* telnet
* ftp
* dns
* smtp
* pop3
* imap
* snmp
* nntp
* https
| Network protocols. |
| | | **violation\_action** string | **Choices:*** pass
* monitor
* block
| Action for protocols not white listed under selected port. |
| | **enforce\_default\_app\_port** string | **Choices:*** disable
* enable
| Enable/disable default application port enforcement for allowed applications. |
| | **entries** list / elements=string | | Application list entries. |
| | | **action** string | **Choices:*** pass
* block
* reset
| Pass or block traffic, or reset connection for traffic from this application. |
| | | **application** list / elements=string | | ID of allowed applications. |
| | | | **id** integer / required | | Application IDs. |
| | | **behavior** string | | Application behavior filter. |
| | | **category** list / elements=string | | Category ID list. |
| | | | **id** integer / required | | Application category ID. |
| | | **exclusion** list / elements=string | | ID of excluded applications. |
| | | | **id** integer / required | | Excluded application IDs. |
| | | **id** integer / required | | Entry ID. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging for this application list. |
| | | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | | **parameters** list / elements=string | | Application parameters. |
| | | | **id** integer / required | | Parameter ID. |
| | | | **members** list / elements=string | | Parameter tuple members. |
| | | | | **id** integer / required | | Parameter. |
| | | | | **name** string | | Parameter name. |
| | | | | **value** string | | Parameter value. |
| | | | **value** string | | Parameter value. |
| | | **per\_ip\_shaper** string | | Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
| | | **popularity** list / elements=string | **Choices:*** 1
* 2
* 3
* 4
* 5
| Application popularity filter (1 - 5, from least to most popular). |
| | | **protocols** string | | Application protocol filter. |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine method. |
| | | **quarantine\_expiry** string | | Duration of quarantine. (Format |
| | | **quarantine\_log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **rate\_count** integer | | Count of the rate. |
| | | **rate\_duration** integer | | Duration (sec) of the rate. |
| | | **rate\_mode** string | **Choices:*** periodical
* continuous
| Rate limit mode. |
| | | **rate\_track** string | **Choices:*** none
* src-ip
* dest-ip
* dhcp-client-mac
* dns-domain
| Track the packet protocol field. |
| | | **risk** list / elements=string | | Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). |
| | | | **level** integer / required | | Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). |
| | | **session\_ttl** integer | | Session TTL (0 = default). |
| | | **shaper** string | | Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | | **shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | | **sub\_category** list / elements=string | | Application Sub-category ID list. |
| | | | **id** integer / required | | Application sub-category ID. |
| | | **technology** string | | Application technology filter. |
| | | **vendor** string | | Application vendor filter. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging. |
| | **force\_inclusion\_ssl\_di\_sigs** string | **Choices:*** disable
* enable
| Enable/disable forced inclusion of SSL deep inspection signatures. |
| | **name** string / required | | List name. |
| | **options** list / elements=string | **Choices:*** allow-dns
* allow-icmp
* allow-http
* allow-ssl
* allow-quic
| Basic application protocol signatures allowed by default. |
| | **other\_application\_action** string | **Choices:*** pass
* block
| Action for other applications. |
| | **other\_application\_log** string | **Choices:*** disable
* enable
| Enable/disable logging for other applications. |
| | **p2p\_black\_list** list / elements=string | **Choices:*** skype
* edonkey
* bittorrent
| P2P applications to be black listed. |
| | **p2p\_block\_list** list / elements=string | **Choices:*** skype
* edonkey
* bittorrent
| P2P applications to be blocklisted. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **unknown\_application\_action** string | **Choices:*** pass
* block
| Pass or block traffic from unknown applications. |
| | **unknown\_application\_log** string | **Choices:*** disable
* enable
| Enable/disable logging for unknown applications. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure application control lists.
fortios_application_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_list:
app_replacemsg: "disable"
comment: "comments"
control_default_network_services: "disable"
deep_app_inspection: "disable"
default_network_services:
-
id: "8"
port: "9"
services: "http"
violation_action: "pass"
enforce_default_app_port: "disable"
entries:
-
action: "pass"
application:
-
id: "16"
behavior: "<your_own_value>"
category:
-
id: "19"
exclusion:
-
id: "21"
id: "22"
log: "disable"
log_packet: "disable"
parameters:
-
id: "26"
members:
-
id: "28"
name: "default_name_29"
value: "<your_own_value>"
value: "<your_own_value>"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
popularity: "1"
protocols: "<your_own_value>"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
rate_count: "38"
rate_duration: "39"
rate_mode: "periodical"
rate_track: "none"
risk:
-
level: "43"
session_ttl: "44"
shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
sub_category:
-
id: "48"
technology: "<your_own_value>"
vendor: "<your_own_value>"
extended_log: "enable"
force_inclusion_ssl_di_sigs: "disable"
name: "default_name_53"
options: "allow-dns"
other_application_action: "pass"
other_application_log: "disable"
p2p_black_list: "skype"
p2p_block_list: "skype"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
unknown_application_action: "pass"
unknown_application_log: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_admin – Configure admin users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_admin – Configure admin users in Fortinet’s FortiOS and FortiGate.
====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_admin`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and admin 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_admin** dictionary | | Configure admin users. |
| | **accprofile** string | | Access profile for this administrator. Access profiles control administrator access to FortiGate features. Source system.accprofile.name. |
| | **accprofile\_override** string | **Choices:*** enable
* disable
| Enable to use the name of an access profile provided by the remote authentication server to control the FortiGate features that this administrator can access. |
| | **allow\_remove\_admin\_session** string | **Choices:*** enable
* disable
| Enable/disable allow admin session to be removed by privileged admin users. |
| | **comments** string | | Comment. |
| | **email\_to** string | | This administrator"s email address. |
| | **force\_password\_change** string | **Choices:*** enable
* disable
| Enable/disable force password change on next login. |
| | **fortitoken** string | | This administrator"s FortiToken serial number. |
| | **guest\_auth** string | **Choices:*** disable
* enable
| Enable/disable guest authentication. |
| | **guest\_lang** string | | Guest management portal language. Source system.custom-language.name. |
| | **guest\_usergroups** list / elements=string | | Select guest user groups. |
| | | **name** string / required | | Select guest user groups. |
| | **gui\_dashboard** list / elements=string | | GUI dashboards. |
| | | **columns** integer | | Number of columns. |
| | | **id** integer / required | | Dashboard ID. |
| | | **layout\_type** string | **Choices:*** responsive
* fixed
| Layout type. |
| | | **name** string | | Dashboard name. |
| | | **permanent** string | **Choices:*** disable
* enable
| Permanent dashboard (can"t be removed via the GUI). |
| | | **scope** string | **Choices:*** global
* vdom
| Dashboard scope. |
| | | **vdom** string | | Virtual domain. Source system.vdom.name. |
| | | **widget** list / elements=string | | Dashboard widgets. |
| | | | **fabric\_device** string | | Fabric device to monitor. |
| | | | **fabric\_device\_widget\_name** string | | Fabric device widget name. |
| | | | **fabric\_device\_widget\_visualization\_type** string | | Visualization type for fabric device widget. |
| | | | **fortiview\_device** string | | FortiView device. |
| | | | **fortiview\_filters** list / elements=string | | FortiView filters. |
| | | | | **id** integer / required | | FortiView Filter ID. |
| | | | | **key** string | | Filter key. |
| | | | | **value** string | | Filter value. |
| | | | **fortiview\_sort\_by** string | | FortiView sort by. |
| | | | **fortiview\_timeframe** string | | FortiView timeframe. |
| | | | **fortiview\_type** string | | FortiView type. |
| | | | **fortiview\_visualization** string | | FortiView visualization. |
| | | | **height** integer | | Height. |
| | | | **id** integer / required | | Widget ID. |
| | | | **industry** string | **Choices:*** default
* custom
| Security Audit Rating industry. |
| | | | **interface** string | | Interface to monitor. Source system.interface.name. |
| | | | **region** string | **Choices:*** default
* custom
| Security Audit Rating region. |
| | | | **title** string | | Widget title. |
| | | | **type** string | **Choices:*** sysinfo
* licinfo
* forticloud
* cpu-usage
* memory-usage
* disk-usage
* log-rate
* sessions
* session-rate
* tr-history
* analytics
* usb-modem
* admins
* security-fabric
* security-fabric-ranking
* sensor-info
* ha-status
* vulnerability-summary
* host-scan-summary
* fortiview
* botnet-activity
* fortimail
* fabric-device
| Widget type. |
| | | | **width** integer | | Width. |
| | | | **x\_pos** integer | | X position. |
| | | | **y\_pos** integer | | Y position. |
| | **gui\_global\_menu\_favorites** list / elements=string | | Favorite GUI menu IDs for the global VDOM. |
| | | **id** string / required | | Select menu ID. |
| | **gui\_new\_feature\_acknowledge** list / elements=string | | Acknowledgement of new features. |
| | | **id** string / required | | Select menu ID. |
| | **gui\_vdom\_menu\_favorites** list / elements=string | | Favorite GUI menu IDs for VDOMs. |
| | | **id** string / required | | Select menu ID. |
| | **hidden** integer | | Admin user hidden attribute. |
| | **history0** string | | history0 |
| | **history1** string | | history1 |
| | **ip6\_trusthost1** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost10** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost2** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost3** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost4** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost5** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost6** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost7** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost8** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **ip6\_trusthost9** string | | Any IPv6 address from which the administrator can connect to the FortiGate unit. Default allows access from any IPv6 address. |
| | **login\_time** list / elements=string | | Record user login time. |
| | | **last\_failed\_login** string | | Last failed login time. |
| | | **last\_login** string | | Last successful login time. |
| | | **usr\_name** string | | User name. |
| | **name** string / required | | User name. |
| | **password** string | | Admin user password. |
| | **password\_expire** string | | Password expire time. |
| | **peer\_auth** string | **Choices:*** enable
* disable
| Set to enable peer certificate authentication (for HTTPS admin access). |
| | **peer\_group** string | | Name of peer group defined under config user group which has PKI members. Used for peer certificate authentication (for HTTPS admin access). |
| | **radius\_vdom\_override** string | **Choices:*** enable
* disable
| Enable to use the names of VDOMs provided by the remote authentication server to control the VDOMs that this administrator can access. |
| | **remote\_auth** string | **Choices:*** enable
* disable
| Enable/disable authentication using a remote RADIUS, LDAP, or TACACS+ server. |
| | **remote\_group** string | | User group name used for remote auth. |
| | **schedule** string | | Firewall schedule used to restrict when the administrator can log in. No schedule means no restrictions. |
| | **sms\_custom\_server** string | | Custom SMS server to send SMS messages to. Source system.sms-server.name. |
| | **sms\_phone** string | | Phone number on which the administrator receives SMS messages. |
| | **sms\_server** string | **Choices:*** fortiguard
* custom
| Send SMS messages using the FortiGuard SMS server or a custom server. |
| | **ssh\_certificate** string | | Select the certificate to be used by the FortiGate for authentication with an SSH client. Source certificate.local.name. |
| | **ssh\_public\_key1** string | | Public key of an SSH client. The client is authenticated without being asked for credentials. Create the public-private key pair in the SSH client application. |
| | **ssh\_public\_key2** string | | Public key of an SSH client. The client is authenticated without being asked for credentials. Create the public-private key pair in the SSH client application. |
| | **ssh\_public\_key3** string | | Public key of an SSH client. The client is authenticated without being asked for credentials. Create the public-private key pair in the SSH client application. |
| | **trusthost1** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost10** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost2** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost3** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost4** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost5** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost6** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost7** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost8** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **trusthost9** string | | Any IPv4 address or subnet address and netmask from which the administrator can connect to the FortiGate unit. Default allows access from any IPv4 address. |
| | **two\_factor** string | **Choices:*** disable
* fortitoken
* email
* sms
* fortitoken-cloud
| Enable/disable two-factor authentication. |
| | **two\_factor\_authentication** string | **Choices:*** fortitoken
* email
* sms
| Authentication method by FortiToken Cloud. |
| | **two\_factor\_notification** string | **Choices:*** email
* sms
| Notification method for user activation by FortiToken Cloud. |
| | **vdom** list / elements=string | | Virtual domain(s) that the administrator can access. |
| | | **name** string / required | | Virtual domain name. Source system.vdom.name. |
| | **wildcard** string | **Choices:*** enable
* disable
| Enable/disable wildcard RADIUS authentication. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure admin users.
fortios_system_admin:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_admin:
accprofile: "<your_own_value> (source system.accprofile.name)"
accprofile_override: "enable"
allow_remove_admin_session: "enable"
comments: "<your_own_value>"
email_to: "<your_own_value>"
force_password_change: "enable"
fortitoken: "<your_own_value>"
guest_auth: "disable"
guest_lang: "<your_own_value> (source system.custom-language.name)"
guest_usergroups:
-
name: "default_name_13"
gui_dashboard:
-
columns: "15"
id: "16"
layout_type: "responsive"
name: "default_name_18"
permanent: "disable"
scope: "global"
vdom: "<your_own_value> (source system.vdom.name)"
widget:
-
fabric_device: "<your_own_value>"
fabric_device_widget_name: "<your_own_value>"
fabric_device_widget_visualization_type: "<your_own_value>"
fortiview_device: "<your_own_value>"
fortiview_filters:
-
id: "28"
key: "<your_own_value>"
value: "<your_own_value>"
fortiview_sort_by: "<your_own_value>"
fortiview_timeframe: "<your_own_value>"
fortiview_type: "<your_own_value>"
fortiview_visualization: "<your_own_value>"
height: "35"
id: "36"
industry: "default"
interface: "<your_own_value> (source system.interface.name)"
region: "default"
title: "<your_own_value>"
type: "sysinfo"
width: "42"
x_pos: "43"
y_pos: "44"
gui_global_menu_favorites:
-
id: "46"
gui_new_feature_acknowledge:
-
id: "48"
gui_vdom_menu_favorites:
-
id: "50"
hidden: "51"
history0: "<your_own_value>"
history1: "<your_own_value>"
ip6_trusthost1: "<your_own_value>"
ip6_trusthost10: "<your_own_value>"
ip6_trusthost2: "<your_own_value>"
ip6_trusthost3: "<your_own_value>"
ip6_trusthost4: "<your_own_value>"
ip6_trusthost5: "<your_own_value>"
ip6_trusthost6: "<your_own_value>"
ip6_trusthost7: "<your_own_value>"
ip6_trusthost8: "<your_own_value>"
ip6_trusthost9: "<your_own_value>"
login_time:
-
last_failed_login: "<your_own_value>"
last_login: "<your_own_value>"
usr_name: "<your_own_value>"
name: "default_name_68"
password: "<your_own_value>"
password_expire: "<your_own_value>"
peer_auth: "enable"
peer_group: "<your_own_value>"
radius_vdom_override: "enable"
remote_auth: "enable"
remote_group: "<your_own_value>"
schedule: "<your_own_value>"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_phone: "<your_own_value>"
sms_server: "fortiguard"
ssh_certificate: "<your_own_value> (source certificate.local.name)"
ssh_public_key1: "<your_own_value>"
ssh_public_key2: "<your_own_value>"
ssh_public_key3: "<your_own_value>"
trusthost1: "<your_own_value>"
trusthost10: "<your_own_value>"
trusthost2: "<your_own_value>"
trusthost3: "<your_own_value>"
trusthost4: "<your_own_value>"
trusthost5: "<your_own_value>"
trusthost6: "<your_own_value>"
trusthost7: "<your_own_value>"
trusthost8: "<your_own_value>"
trusthost9: "<your_own_value>"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_notification: "email"
vdom:
-
name: "default_name_98 (source system.vdom.name)"
wildcard: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_ftp_proxy_explicit – Configure explicit FTP proxy settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ftp\_proxy\_explicit – Configure explicit FTP proxy settings in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_ftp_proxy_explicit`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ftp\_proxy feature and explicit 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ftp\_proxy\_explicit** dictionary | | Configure explicit FTP proxy settings. |
| | **incoming\_ip** string | | Accept incoming FTP requests from this IP address. An interface must have this IP address. |
| | **incoming\_port** string | | Accept incoming FTP requests on one or more ports. |
| | **outgoing\_ip** string | | Outgoing FTP requests will leave from this IP address. An interface must have this IP address. |
| | **sec\_default\_action** string | **Choices:*** accept
* deny
| Accept or deny explicit FTP proxy sessions when no FTP proxy firewall policy exists. |
| | **ssl** string | **Choices:*** enable
* disable
| Enable/disable the explicit FTPS proxy. |
| | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted in negotiation. |
| | **ssl\_cert** string | | Name of certificate for SSL connections to this server . Source certificate.local.name. |
| | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
| Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the explicit FTP proxy. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure explicit FTP proxy settings.
fortios_ftp_proxy_explicit:
vdom: "{{ vdom }}"
ftp_proxy_explicit:
incoming_ip: "<your_own_value>"
incoming_port: "<your_own_value>"
outgoing_ip: "<your_own_value>"
sec_default_action: "accept"
ssl: "enable"
ssl_algorithm: "high"
ssl_cert: "<your_own_value> (source certificate.local.name)"
ssl_dh_bits: "768"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_device – Configure devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_device – Configure devices in Fortinet’s FortiOS and FortiGate.
===============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_device`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_device** dictionary | | Configure devices. |
| | **alias** string / required | | Device alias. |
| | **avatar** string | | Image file for avatar (maximum 4K base64 encoded). |
| | **category** string | **Choices:*** none
* amazon-device
* android-device
* blackberry-device
* fortinet-device
* ios-device
* windows-device
| Device category. |
| | **comment** string | | Comment. |
| | **mac** string | | Device MAC address. |
| | **master\_device** string | | Master device (optional). Source user.device.alias. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| | **type** string | **Choices:*** unknown
* android-phone
* android-tablet
* blackberry-phone
* blackberry-playbook
* forticam
* fortifone
* fortinet-device
* gaming-console
* ip-phone
* ipad
* iphone
* linux-pc
* mac
* media-streaming
* printer
* router-nat-device
* windows-pc
* windows-phone
* windows-tablet
* other-network-device
| Device type. |
| | **user** string | | User name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure devices.
fortios_user_device:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device:
alias: "<your_own_value>"
avatar: "<your_own_value>"
category: "none"
comment: "Comment."
mac: "<your_own_value>"
master_device: "<your_own_value> (source user.device.alias)"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_11"
tags:
-
name: "default_name_13 (source system.object-tagging.tags.name)"
type: "unknown"
user: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_webtrends_filter – Filters for WebTrends in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_webtrends\_filter – Filters for WebTrends in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_webtrends_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_webtrends feature and filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_webtrends\_filter** dictionary | | Filters for WebTrends. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | Webtrends log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **netscan\_discovery** string | | Enable/disable netscan discovery event logging. |
| | **netscan\_vulnerability** string | | Enable/disable netscan vulnerability event logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log to WebTrends. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **ssh** string | **Choices:*** enable
* disable
| Enable/disable SSH logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Filters for WebTrends.
fortios_log_webtrends_filter:
vdom: "{{ vdom }}"
log_webtrends_filter:
anomaly: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_static6 – Configure IPv6 static routing tables in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_static6 – Configure IPv6 static routing tables in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_static6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and static6 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_static6** dictionary | | Configure IPv6 static routing tables. |
| | **bfd** string | **Choices:*** enable
* disable
| Enable/disable Bidirectional Forwarding Detection (BFD). |
| | **blackhole** string | **Choices:*** enable
* disable
| Enable/disable black hole. |
| | **comment** string | | Optional comments. |
| | **device** string | | Gateway out interface or tunnel. Source system.interface.name. |
| | **devindex** integer | | Device index (0 - 4294967295). |
| | **distance** integer | | Administrative distance (1 - 255). |
| | **dst** string | | Destination IPv6 prefix. |
| | **dynamic\_gateway** string | **Choices:*** enable
* disable
| Enable use of dynamic gateway retrieved from Router Advertisement (RA). |
| | **gateway** string | | IPv6 address of the gateway. |
| | **link\_monitor\_exempt** string | **Choices:*** enable
* disable
| Enable/disable withdrawal of this static route when link monitor or health check is down. |
| | **priority** integer | | Administrative priority (0 - 4294967295). |
| | **sdwan** string | **Choices:*** enable
* disable
| Enable/disable egress through the SD-WAN. |
| | **seq\_num** integer | | Sequence number. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this static route. |
| | **virtual\_wan\_link** string | **Choices:*** enable
* disable
| Enable/disable egress through the virtual-wan-link. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 static routing tables.
fortios_router_static6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_static6:
bfd: "enable"
blackhole: "enable"
comment: "Optional comments."
device: "<your_own_value> (source system.interface.name)"
devindex: "7"
distance: "8"
dst: "<your_own_value>"
dynamic_gateway: "enable"
gateway: "<your_own_value>"
link_monitor_exempt: "enable"
priority: "13"
sdwan: "enable"
seq_num: "15"
status: "enable"
virtual_wan_link: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_wccp – Configure WCCP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_wccp – Configure WCCP in Fortinet’s FortiOS and FortiGate.
============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_wccp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and wccp 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_wccp** dictionary | | Configure WCCP. |
| | **assignment\_bucket\_format** string | **Choices:*** wccp-v2
* cisco-implementation
| Assignment bucket format for the WCCP cache engine. |
| | **assignment\_dstaddr\_mask** string | | Assignment destination address mask. |
| | **assignment\_method** string | **Choices:*** HASH
* MASK
* any
| Hash key assignment preference. |
| | **assignment\_srcaddr\_mask** string | | Assignment source address mask. |
| | **assignment\_weight** integer | | Assignment of hash weight/ratio for the WCCP cache engine. |
| | **authentication** string | **Choices:*** enable
* disable
| Enable/disable MD5 authentication. |
| | **cache\_engine\_method** string | **Choices:*** GRE
* L2
| Method used to forward traffic to the routers or to return to the cache engine. |
| | **cache\_id** string | | IP address known to all routers. If the addresses are the same, use the default 0.0.0.0. |
| | **forward\_method** string | **Choices:*** GRE
* L2
* any
| Method used to forward traffic to the cache servers. |
| | **group\_address** string | | IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0. |
| | **password** string | | Password for MD5 authentication. |
| | **ports** string | | Service ports. |
| | **ports\_defined** string | **Choices:*** source
* destination
| Match method. |
| | **primary\_hash** list / elements=string | **Choices:*** src-ip
* dst-ip
* src-port
* dst-port
| Hash method. |
| | **priority** integer | | Service priority. |
| | **protocol** integer | | Service protocol. |
| | **return\_method** string | **Choices:*** GRE
* L2
* any
| Method used to decline a redirected packet and return it to the FortiGate. |
| | **router\_id** string | | IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0. |
| | **router\_list** string | | IP addresses of one or more WCCP routers. |
| | **server\_list** string | | IP addresses and netmasks for up to four cache servers. |
| | **server\_type** string | **Choices:*** forward
* proxy
| Cache server type. |
| | **service\_id** string | | Service ID. |
| | **service\_type** string | **Choices:*** auto
* standard
* dynamic
| WCCP service type used by the cache server for logical interception and redirection of traffic. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WCCP.
fortios_system_wccp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_wccp:
assignment_bucket_format: "wccp-v2"
assignment_dstaddr_mask: "<your_own_value>"
assignment_method: "HASH"
assignment_srcaddr_mask: "<your_own_value>"
assignment_weight: "7"
authentication: "enable"
cache_engine_method: "GRE"
cache_id: "<your_own_value>"
forward_method: "GRE"
group_address: "<your_own_value>"
password: "<your_own_value>"
ports: "<your_own_value>"
ports_defined: "source"
primary_hash: "src-ip"
priority: "17"
protocol: "18"
return_method: "GRE"
router_id: "<your_own_value>"
router_list: "<your_own_value>"
server_list: "<your_own_value>"
server_type: "forward"
service_id: "<your_own_value>"
service_type: "auto"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_log_syslogd3_override_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd3\_override\_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_syslogd3_override_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_syslogd3 feature and override\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_syslogd3\_override\_filter** dictionary | | Override filters for remote system server. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **filter** string | | Syslog 3 filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override filters for remote system server.
fortios_log_syslogd3_override_filter:
vdom: "{{ vdom }}"
log_syslogd3_override_filter:
anomaly: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "11"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
severity: "emergency"
sniffer_traffic: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_service_group – Configure service groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_service\_group – Configure service groups in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_service_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_service feature and group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_service\_group** dictionary | | Configure service groups. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **member** list / elements=string | | Service objects contained within the group. |
| | | **name** string / required | | Address name. Source firewall.service.custom.name firewall.service.group.name. |
| | **name** string / required | | Address group name. |
| | **proxy** string | **Choices:*** enable
* disable
| Enable/disable web proxy service group. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure service groups.
fortios_firewall_service_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_service_group:
color: "3"
comment: "Comment."
fabric_object: "enable"
member:
-
name: "default_name_7 (source firewall.service.custom.name firewall.service.group.name)"
name: "default_name_8"
proxy: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_vap_group – Configure virtual Access Point (VAP) groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_vap\_group – Configure virtual Access Point (VAP) groups in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_vap_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and vap\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_vap\_group** dictionary | | Configure virtual Access Point (VAP) groups. |
| | **comment** string | | Comment. |
| | **name** string / required | | Group Name |
| | **vaps** list / elements=string | | List of SSIDs to be included in the VAP group. |
| | | **name** string / required | | vap name Source wireless-controller.vap.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure virtual Access Point (VAP) groups.
fortios_wireless_controller_vap_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_vap_group:
comment: "Comment."
name: "default_name_4"
vaps:
-
name: "default_name_6 (source wireless-controller.vap.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_application_name – Configure application signatures in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_application\_name – Configure application signatures in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_application_name`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and name 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **application\_name** dictionary | | Configure application signatures. |
| | **behavior** string | | Application behavior. |
| | **category** integer | | Application category ID. |
| | **id** integer | | Application ID. |
| | **metadata** list / elements=string | | Meta data. |
| | | **id** integer / required | | ID. |
| | | **metaid** integer | | Meta ID. |
| | | **valueid** integer | | Value ID. |
| | **name** string / required | | Application name. |
| | **parameter** string | | Application parameter name. |
| | **parameters** list / elements=string | | Application parameters. |
| | | **default value** string | | Parameter default value. |
| | | **name** string / required | | Parameter name. |
| | **popularity** integer | | Application popularity. |
| | **protocol** string | | Application protocol. |
| | **risk** integer | | Application risk. |
| | **sub\_category** integer | | Application sub-category ID. |
| | **technology** string | | Application technology. |
| | **vendor** string | | Application vendor. |
| | **weight** integer | | Application weight. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure application signatures.
fortios_application_name:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_name:
behavior: "<your_own_value>"
category: "4"
id: "5"
metadata:
-
id: "7"
metaid: "8"
valueid: "9"
name: "default_name_10"
parameter: "<your_own_value>"
parameters:
-
default value: "<your_own_value>"
name: "default_name_14"
popularity: "15"
protocol: "<your_own_value>"
risk: "17"
sub_category: "18"
technology: "<your_own_value>"
vendor: "<your_own_value>"
weight: "21"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_replacemsg_icap – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_icap – Replacement messages in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_icap`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and icap 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_icap** dictionary | | Replacement messages. |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg\_type** string | | Message type. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_icap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_icap:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_alarm – Configure alarm in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_alarm – Configure alarm in Fortinet’s FortiOS and FortiGate.
==============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_alarm`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and alarm 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_alarm** dictionary | | Configure alarm. |
| | **audible** string | **Choices:*** enable
* disable
| Enable/disable audible alarm. |
| | **groups** list / elements=string | | Alarm groups. |
| | | **admin\_auth\_failure\_threshold** integer | | Admin authentication failure threshold. |
| | | **admin\_auth\_lockout\_threshold** integer | | Admin authentication lockout threshold. |
| | | **decryption\_failure\_threshold** integer | | Decryption failure threshold. |
| | | **encryption\_failure\_threshold** integer | | Encryption failure threshold. |
| | | **fw\_policy\_id** integer | | Firewall policy ID. |
| | | **fw\_policy\_id\_threshold** integer | | Firewall policy ID threshold. |
| | | **fw\_policy\_violations** list / elements=string | | Firewall policy violations. |
| | | | **dst\_ip** string | | Destination IP (0=all). |
| | | | **dst\_port** integer | | Destination port (0=all). |
| | | | **id** integer / required | | Firewall policy violations ID. |
| | | | **src\_ip** string | | Source IP (0=all). |
| | | | **src\_port** integer | | Source port (0=all). |
| | | | **threshold** integer | | Firewall policy violation threshold. |
| | | **id** integer / required | | Group ID. |
| | | **log\_full\_warning\_threshold** integer | | Log full warning threshold. |
| | | **period** integer | | Time period in seconds (0 = from start up). |
| | | **replay\_attempt\_threshold** integer | | Replay attempt threshold. |
| | | **self\_test\_failure\_threshold** integer | | Self-test failure threshold. |
| | | **user\_auth\_failure\_threshold** integer | | User authentication failure threshold. |
| | | **user\_auth\_lockout\_threshold** integer | | User authentication lockout threshold. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable alarm. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure alarm.
fortios_system_alarm:
vdom: "{{ vdom }}"
system_alarm:
audible: "enable"
groups:
-
admin_auth_failure_threshold: "5"
admin_auth_lockout_threshold: "6"
decryption_failure_threshold: "7"
encryption_failure_threshold: "8"
fw_policy_id: "9"
fw_policy_id_threshold: "10"
fw_policy_violations:
-
dst_ip: "<your_own_value>"
dst_port: "13"
id: "14"
src_ip: "<your_own_value>"
src_port: "16"
threshold: "17"
id: "18"
log_full_warning_threshold: "19"
period: "20"
replay_attempt_threshold: "21"
self_test_failure_threshold: "22"
user_auth_failure_threshold: "23"
user_auth_lockout_threshold: "24"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_client_info – Wireless controller client-info in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_client\_info – Wireless controller client-info in Fortinet’s FortiOS and FortiGate.
===================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_client_info`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and client\_info 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_client\_info** dictionary | | Wireless controller client-info. |
| | string | | VFID. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Wireless controller client-info.
fortios_wireless_controller_client_info:
vdom: "{{ vdom }}"
wireless_controller_client_info:
<vfid>: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_sms_server – Configure SMS server for sending SMS messages to support user authentication in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sms\_server – Configure SMS server for sending SMS messages to support user authentication in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_sms_server`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sms\_server 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_sms\_server** dictionary | | Configure SMS server for sending SMS messages to support user authentication. |
| | **mail\_server** string | | Email-to-SMS server domain name. |
| | **name** string / required | | Name of SMS server. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SMS server for sending SMS messages to support user authentication.
fortios_system_sms_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sms_server:
mail_server: "<your_own_value>"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_alertemail_setting – Configure alert email settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_alertemail\_setting – Configure alert email settings in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_alertemail_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify alertemail feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **alertemail\_setting** dictionary | | Configure alert email settings. |
| | **admin\_login\_logs** string | **Choices:*** enable
* disable
| Enable/disable administrator login/logout logs in alert email. |
| | **alert\_interval** integer | | Alert alert interval in minutes. |
| | **amc\_interface\_bypass\_mode** string | **Choices:*** enable
* disable
| Enable/disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email. |
| | **antivirus\_logs** string | **Choices:*** enable
* disable
| Enable/disable antivirus logs in alert email. |
| | **configuration\_changes\_logs** string | **Choices:*** enable
* disable
| Enable/disable configuration change logs in alert email. |
| | **critical\_interval** integer | | Critical alert interval in minutes. |
| | **debug\_interval** integer | | Debug alert interval in minutes. |
| | **email\_interval** integer | | Interval between sending alert emails (1 - 99999 min). |
| | **emergency\_interval** integer | | Emergency alert interval in minutes. |
| | **error\_interval** integer | | Error alert interval in minutes. |
| | **FDS\_license\_expiring\_days** integer | | Number of days to send alert email prior to FortiGuard license expiration (1 - 100 days). |
| | **FDS\_license\_expiring\_warning** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard license expiration warnings in alert email. |
| | **FDS\_update\_logs** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard update logs in alert email. |
| | **filter\_mode** string | **Choices:*** category
* threshold
| How to filter log messages that are sent to alert emails. |
| | **FIPS\_CC\_errors** string | **Choices:*** enable
* disable
| Enable/disable FIPS and Common Criteria error logs in alert email. |
| | **firewall\_authentication\_failure\_logs** string | **Choices:*** enable
* disable
| Enable/disable firewall authentication failure logs in alert email. |
| | **fortiguard\_log\_quota\_warning** string | **Choices:*** enable
* disable
| Enable/disable FortiCloud log quota warnings in alert email. |
| | **FSSO\_disconnect\_logs** string | **Choices:*** enable
* disable
| Enable/disable logging of FSSO collector agent disconnect. |
| | **HA\_logs** string | **Choices:*** enable
* disable
| Enable/disable HA logs in alert email. |
| | **information\_interval** integer | | Information alert interval in minutes. |
| | **IPS\_logs** string | **Choices:*** enable
* disable
| Enable/disable IPS logs in alert email. |
| | **IPsec\_errors\_logs** string | **Choices:*** enable
* disable
| Enable/disable IPsec error logs in alert email. |
| | **local\_disk\_usage** integer | | Disk usage percentage at which to send alert email (1 - 99 percent). |
| | **log\_disk\_usage\_warning** string | **Choices:*** enable
* disable
| Enable/disable disk usage warnings in alert email. |
| | **mailto1** string | | Email address to send alert email to (usually a system administrator) (max. 64 characters). |
| | **mailto2** string | | Optional second email address to send alert email to (max. 64 characters). |
| | **mailto3** string | | Optional third email address to send alert email to (max. 64 characters). |
| | **notification\_interval** integer | | Notification alert interval in minutes. |
| | **PPP\_errors\_logs** string | **Choices:*** enable
* disable
| Enable/disable PPP error logs in alert email. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **ssh\_logs** string | **Choices:*** enable
* disable
| Enable/disable SSH logs in alert email. |
| | **sslvpn\_authentication\_errors\_logs** string | **Choices:*** enable
* disable
| Enable/disable SSL-VPN authentication error logs in alert email. |
| | **username** string | | Name that appears in the From: field of alert emails (max. 36 characters). |
| | **violation\_traffic\_logs** string | **Choices:*** enable
* disable
| Enable/disable violation traffic logs in alert email. |
| | **warning\_interval** integer | | Warning alert interval in minutes. |
| | **webfilter\_logs** string | **Choices:*** enable
* disable
| Enable/disable web filter logs in alert email. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure alert email settings.
fortios_alertemail_setting:
vdom: "{{ vdom }}"
alertemail_setting:
admin_login_logs: "enable"
alert_interval: "4"
amc_interface_bypass_mode: "enable"
antivirus_logs: "enable"
configuration_changes_logs: "enable"
critical_interval: "8"
debug_interval: "9"
email_interval: "10"
emergency_interval: "11"
error_interval: "12"
FDS_license_expiring_days: "13"
FDS_license_expiring_warning: "enable"
FDS_update_logs: "enable"
filter_mode: "category"
FIPS_CC_errors: "enable"
firewall_authentication_failure_logs: "enable"
fortiguard_log_quota_warning: "enable"
FSSO_disconnect_logs: "enable"
HA_logs: "enable"
information_interval: "22"
IPS_logs: "enable"
IPsec_errors_logs: "enable"
local_disk_usage: "25"
log_disk_usage_warning: "enable"
mailto1: "<your_own_value>"
mailto2: "<your_own_value>"
mailto3: "<your_own_value>"
notification_interval: "30"
PPP_errors_logs: "enable"
severity: "emergency"
ssh_logs: "enable"
sslvpn_authentication_errors_logs: "enable"
username: "<your_own_value>"
violation_traffic_logs: "enable"
warning_interval: "37"
webfilter_logs: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_snmp_sysinfo – SNMP system info configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_snmp\_sysinfo – SNMP system info configuration in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_snmp_sysinfo`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_snmp feature and sysinfo 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_snmp\_sysinfo** dictionary | | SNMP system info configuration. |
| | **contact\_info** string | | Contact information. |
| | **description** string | | System description. |
| | **engine\_id** string | | Local SNMP engineID string (maximum 24 characters). |
| | **location** string | | System location. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable SNMP. |
| | **trap\_high\_cpu\_threshold** integer | | CPU usage when trap is sent. |
| | **trap\_log\_full\_threshold** integer | | Log disk usage when trap is sent. |
| | **trap\_low\_memory\_threshold** integer | | Memory usage when trap is sent. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SNMP system info configuration.
fortios_system_snmp_sysinfo:
vdom: "{{ vdom }}"
system_snmp_sysinfo:
contact_info: "<your_own_value>"
description: "<your_own_value>"
engine_id: "<your_own_value>"
location: "<your_own_value>"
status: "enable"
trap_high_cpu_threshold: "8"
trap_log_full_threshold: "9"
trap_low_memory_threshold: "10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_access_control_list – Configure WiFi bridge access control list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_access\_control\_list – Configure WiFi bridge access control list in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_access_control_list`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and access\_control\_list 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_access\_control\_list** dictionary | | Configure WiFi bridge access control list. |
| | **comment** string | | Description. |
| | **layer3\_ipv4\_rules** list / elements=string | | AP ACL layer3 ipv4 rule list. |
| | | **action** string | **Choices:*** allow
* deny
| Policy action (allow | deny). |
| | | **comment** string | | Description. |
| | | **dstaddr** string | | Destination IP address (any | local-LAN | IPv4 address[/<network mask | mask length>]). |
| | | **dstport** integer | | Destination port (0 - 65535). |
| | | **protocol** integer | | Protocol type as defined by IANA (0 - 255). |
| | | **rule\_id** integer | | Rule ID (1 - 65535). |
| | | **srcaddr** string | | Source IP address (any | local-LAN | IPv4 address[/<network mask | mask length>]). |
| | | **srcport** integer | | Source port (0 - 65535). |
| | **layer3\_ipv6\_rules** list / elements=string | | AP ACL layer3 ipv6 rule list. |
| | | **action** string | **Choices:*** allow
* deny
| Policy action (allow | deny). |
| | | **comment** string | | Description. |
| | | **dstaddr** string | | Destination IPv6 address (any | local-LAN | IPv6 address[/prefix length]), default = any. |
| | | **dstport** integer | | Destination port (0 - 65535). |
| | | **protocol** integer | | Protocol type as defined by IANA (0 - 255). |
| | | **rule\_id** integer | | Rule ID (1 - 65535). |
| | | **srcaddr** string | | Source IPv6 address (any | local-LAN | IPv6 address[/prefix length]), default = any. |
| | | **srcport** integer | | Source port (0 - 65535). |
| | **name** string / required | | AP access control list name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi bridge access control list.
fortios_wireless_controller_access_control_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_access_control_list:
comment: "Description."
layer3_ipv4_rules:
-
action: "allow"
comment: "Description."
dstaddr: "<your_own_value>"
dstport: "8"
protocol: "9"
rule_id: "10"
srcaddr: "<your_own_value>"
srcport: "12"
layer3_ipv6_rules:
-
action: "allow"
comment: "Description."
dstaddr: "<your_own_value>"
dstport: "17"
protocol: "18"
rule_id: "19"
srcaddr: "<your_own_value>"
srcport: "21"
name: "default_name_22"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_router_setting – Configure router settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_setting – Configure router settings in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_router_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **router\_setting** dictionary | | Configure router settings. |
| | **bgp\_debug\_flags** string | | bgp\_debug\_flags |
| | **hostname** string | | Hostname for this virtual domain router. |
| | **igmp\_debug\_flags** string | | igmp\_debug\_flags |
| | **imi\_debug\_flags** string | | imi\_debug\_flags |
| | **isis\_debug\_flags** string | | isis\_debug\_flags |
| | **ospf6\_debug\_events\_flags** string | | ospf6\_debug\_events\_flags |
| | **ospf6\_debug\_ifsm\_flags** string | | ospf6\_debug\_ifsm\_flags |
| | **ospf6\_debug\_lsa\_flags** string | | ospf6\_debug\_lsa\_flags |
| | **ospf6\_debug\_nfsm\_flags** string | | ospf6\_debug\_nfsm\_flags |
| | **ospf6\_debug\_nsm\_flags** string | | ospf6\_debug\_nsm\_flags |
| | **ospf6\_debug\_packet\_flags** string | | ospf6\_debug\_packet\_flags |
| | **ospf6\_debug\_route\_flags** string | | ospf6\_debug\_route\_flags |
| | **ospf\_debug\_events\_flags** string | | ospf\_debug\_events\_flags |
| | **ospf\_debug\_ifsm\_flags** string | | ospf\_debug\_ifsm\_flags |
| | **ospf\_debug\_lsa\_flags** string | | ospf\_debug\_lsa\_flags |
| | **ospf\_debug\_nfsm\_flags** string | | ospf\_debug\_nfsm\_flags |
| | **ospf\_debug\_nsm\_flags** string | | ospf\_debug\_nsm\_flags |
| | **ospf\_debug\_packet\_flags** string | | ospf\_debug\_packet\_flags |
| | **ospf\_debug\_route\_flags** string | | ospf\_debug\_route\_flags |
| | **pimdm\_debug\_flags** string | | pimdm\_debug\_flags |
| | **pimsm\_debug\_joinprune\_flags** string | | pimsm\_debug\_joinprune\_flags |
| | **pimsm\_debug\_simple\_flags** string | | pimsm\_debug\_simple\_flags |
| | **pimsm\_debug\_timer\_flags** string | | pimsm\_debug\_timer\_flags |
| | **rip\_debug\_flags** string | | rip\_debug\_flags |
| | **ripng\_debug\_flags** string | | ripng\_debug\_flags |
| | **show\_filter** string | | Prefix-list as filter for showing routes. Source router.prefix-list.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure router settings.
fortios_router_setting:
vdom: "{{ vdom }}"
router_setting:
bgp_debug_flags: "<your_own_value>"
hostname: "myhostname"
igmp_debug_flags: "<your_own_value>"
imi_debug_flags: "<your_own_value>"
isis_debug_flags: "<your_own_value>"
ospf6_debug_events_flags: "<your_own_value>"
ospf6_debug_ifsm_flags: "<your_own_value>"
ospf6_debug_lsa_flags: "<your_own_value>"
ospf6_debug_nfsm_flags: "<your_own_value>"
ospf6_debug_nsm_flags: "<your_own_value>"
ospf6_debug_packet_flags: "<your_own_value>"
ospf6_debug_route_flags: "<your_own_value>"
ospf_debug_events_flags: "<your_own_value>"
ospf_debug_ifsm_flags: "<your_own_value>"
ospf_debug_lsa_flags: "<your_own_value>"
ospf_debug_nfsm_flags: "<your_own_value>"
ospf_debug_nsm_flags: "<your_own_value>"
ospf_debug_packet_flags: "<your_own_value>"
ospf_debug_route_flags: "<your_own_value>"
pimdm_debug_flags: "<your_own_value>"
pimsm_debug_joinprune_flags: "<your_own_value>"
pimsm_debug_simple_flags: "<your_own_value>"
pimsm_debug_timer_flags: "<your_own_value>"
rip_debug_flags: "<your_own_value>"
ripng_debug_flags: "<your_own_value>"
show_filter: "<your_own_value> (source router.prefix-list.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_emailfilter_mheader – Configure AntiSpam MIME header in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_mheader – Configure AntiSpam MIME header in Fortinet’s FortiOS and FortiGate.
====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_emailfilter_mheader`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and mheader 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **emailfilter\_mheader** dictionary | | Configure AntiSpam MIME header. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter mime header content. |
| | | **action** string | **Choices:*** spam
* clear
| Mark spam or good. |
| | | **fieldbody** string | | Pattern for the header field body. |
| | | **fieldname** string | | Pattern for header field name. |
| | | **id** integer / required | | Mime header entry ID. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam MIME header.
fortios_emailfilter_mheader:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_mheader:
comment: "Optional comments."
entries:
-
action: "spam"
fieldbody: "<your_own_value>"
fieldname: "<your_own_value>"
id: "8"
pattern_type: "wildcard"
status: "enable"
id: "11"
name: "default_name_12"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_arp_table – Configure ARP table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_arp\_table – Configure ARP table in Fortinet’s FortiOS and FortiGate.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_arp_table`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and arp\_table 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_arp\_table** dictionary | | Configure ARP table. |
| | **id** integer / required | | Unique integer ID of the entry. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **ip** string | | IP address. |
| | **mac** string | | MAC address. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure ARP table.
fortios_system_arp_table:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_arp_table:
id: "3"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
mac: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_settings – Configure VDOM settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_settings – Configure VDOM settings in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_settings** dictionary | | Configure VDOM settings. |
| | **allow\_linkdown\_path** string | **Choices:*** enable
* disable
| Enable/disable link down path. |
| | **allow\_subnet\_overlap** string | **Choices:*** enable
* disable
| Enable/disable allowing interface subnets to use overlapping IP addresses. |
| | **application\_bandwidth\_tracking** string | **Choices:*** disable
* enable
| Enable/disable application bandwidth tracking. |
| | **asymroute** string | **Choices:*** enable
* disable
| Enable/disable IPv4 asymmetric routing. |
| | **asymroute6** string | **Choices:*** enable
* disable
| Enable/disable asymmetric IPv6 routing. |
| | **asymroute6\_icmp** string | **Choices:*** enable
* disable
| Enable/disable asymmetric ICMPv6 routing. |
| | **asymroute\_icmp** string | **Choices:*** enable
* disable
| Enable/disable ICMP asymmetric routing. |
| | **auxiliary\_session** string | **Choices:*** enable
* disable
| Enable/disable auxiliary session. |
| | **bfd** string | **Choices:*** enable
* disable
| Enable/disable Bi-directional Forwarding Detection (BFD) on all interfaces. |
| | **bfd\_desired\_min\_tx** integer | | BFD desired minimal transmit interval (1 - 100000 ms). |
| | **bfd\_detect\_mult** integer | | BFD detection multiplier (1 - 50). |
| | **bfd\_dont\_enforce\_src\_port** string | **Choices:*** enable
* disable
| Enable to not enforce verifying the source port of BFD Packets. |
| | **bfd\_required\_min\_rx** integer | | BFD required minimal receive interval (1 - 100000 ms). |
| | **block\_land\_attack** string | **Choices:*** disable
* enable
| Enable/disable blocking of land attacks. |
| | **central\_nat** string | **Choices:*** enable
* disable
| Enable/disable central NAT. |
| | **comments** string | | VDOM comments. |
| | **compliance\_check** string | **Choices:*** enable
* disable
| Enable/disable PCI DSS compliance checking. |
| | **consolidated\_firewall\_mode** string | **Choices:*** enable
* disable
| Consolidated firewall mode. |
| | **default\_voip\_alg\_mode** string | **Choices:*** proxy-based
* kernel-helper-based
| Configure how the FortiGate handles VoIP traffic when a policy that accepts the traffic doesn"t include a VoIP profile. |
| | **deny\_tcp\_with\_icmp** string | **Choices:*** enable
* disable
| Enable/disable denying TCP by sending an ICMP communication prohibited packet. |
| | **device** string | | Interface to use for management access for NAT mode. Source system.interface.name. |
| | **dhcp6\_server\_ip** string | | DHCPv6 server IPv6 address. |
| | **dhcp\_proxy** string | **Choices:*** enable
* disable
| Enable/disable the DHCP Proxy. |
| | **dhcp\_proxy\_interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **dhcp\_proxy\_interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **dhcp\_server\_ip** string | | DHCP Server IPv4 address. |
| | **discovered\_device\_timeout** integer | | Timeout for discovered devices (1 - 365 days). |
| | **ecmp\_max\_paths** integer | | Maximum number of Equal Cost Multi-Path (ECMP) next-hops. Set to 1 to disable ECMP routing (1 - 255). |
| | **email\_portal\_check\_dns** string | **Choices:*** disable
* enable
| Enable/disable using DNS to validate email addresses collected by a captive portal. |
| | **firewall\_session\_dirty** string | **Choices:*** check-all
* check-new
* check-policy-option
| Select how to manage sessions affected by firewall policy configuration changes. |
| | **fw\_session\_hairpin** string | **Choices:*** enable
* disable
| Enable/disable checking for a matching policy each time hairpin traffic goes through the FortiGate. |
| | **gateway** string | | Transparent mode IPv4 default gateway IP address. |
| | **gateway6** string | | Transparent mode IPv4 default gateway IP address. |
| | **gtp\_asym\_fgsp** string | **Choices:*** disable
* enable
| Enable/disable GTP asymmetric traffic handling on FGSP. |
| | **gtp\_monitor\_mode** string | **Choices:*** enable
* disable
| Enable/disable GTP monitor mode (VDOM level). |
| | **gui\_advanced\_policy** string | **Choices:*** enable
* disable
| Enable/disable advanced policy configuration on the GUI. |
| | **gui\_allow\_unnamed\_policy** string | **Choices:*** enable
* disable
| Enable/disable the requirement for policy naming on the GUI. |
| | **gui\_antivirus** string | **Choices:*** enable
* disable
| Enable/disable AntiVirus on the GUI. |
| | **gui\_ap\_profile** string | **Choices:*** enable
* disable
| Enable/disable FortiAP profiles on the GUI. |
| | **gui\_application\_control** string | **Choices:*** enable
* disable
| Enable/disable application control on the GUI. |
| | **gui\_default\_policy\_columns** list / elements=string | | Default columns to display for policy lists on GUI. |
| | | **name** string / required | | Select column name. |
| | **gui\_dhcp\_advanced** string | **Choices:*** enable
* disable
| Enable/disable advanced DHCP options on the GUI. |
| | **gui\_dlp** string | **Choices:*** enable
* disable
| Enable/disable DLP on the GUI. |
| | **gui\_dns\_database** string | **Choices:*** enable
* disable
| Enable/disable DNS database settings on the GUI. |
| | **gui\_dnsfilter** string | **Choices:*** enable
* disable
| Enable/disable DNS Filtering on the GUI. |
| | **gui\_domain\_ip\_reputation** string | **Choices:*** enable
* disable
| Enable/disable Domain and IP Reputation on the GUI. |
| | **gui\_dos\_policy** string | **Choices:*** enable
* disable
| Enable/disable DoS policies on the GUI. |
| | **gui\_dynamic\_profile\_display** string | **Choices:*** enable
* disable
| Enable/disable RADIUS Single Sign On (RSSO) on the GUI. |
| | **gui\_dynamic\_routing** string | **Choices:*** enable
* disable
| Enable/disable dynamic routing on the GUI. |
| | **gui\_email\_collection** string | **Choices:*** enable
* disable
| Enable/disable email collection on the GUI. |
| | **gui\_endpoint\_control** string | **Choices:*** enable
* disable
| Enable/disable endpoint control on the GUI. |
| | **gui\_endpoint\_control\_advanced** string | **Choices:*** enable
* disable
| Enable/disable advanced endpoint control options on the GUI. |
| | **gui\_explicit\_proxy** string | **Choices:*** enable
* disable
| Enable/disable the explicit proxy on the GUI. |
| | **gui\_file\_filter** string | **Choices:*** enable
* disable
| Enable/disable File-filter on the GUI. |
| | **gui\_fortiap\_split\_tunneling** string | **Choices:*** enable
* disable
| Enable/disable FortiAP split tunneling on the GUI. |
| | **gui\_fortiextender\_controller** string | **Choices:*** enable
* disable
| Enable/disable FortiExtender on the GUI. |
| | **gui\_icap** string | **Choices:*** enable
* disable
| Enable/disable ICAP on the GUI. |
| | **gui\_implicit\_policy** string | **Choices:*** enable
* disable
| Enable/disable implicit firewall policies on the GUI. |
| | **gui\_ips** string | **Choices:*** enable
* disable
| Enable/disable IPS on the GUI. |
| | **gui\_load\_balance** string | **Choices:*** enable
* disable
| Enable/disable server load balancing on the GUI. |
| | **gui\_local\_in\_policy** string | **Choices:*** enable
* disable
| Enable/disable Local-In policies on the GUI. |
| | **gui\_local\_reports** string | **Choices:*** enable
* disable
| Enable/disable local reports on the GUI. |
| | **gui\_multicast\_policy** string | **Choices:*** enable
* disable
| Enable/disable multicast firewall policies on the GUI. |
| | **gui\_multiple\_interface\_policy** string | **Choices:*** enable
* disable
| Enable/disable adding multiple interfaces to a policy on the GUI. |
| | **gui\_multiple\_utm\_profiles** string | **Choices:*** enable
* disable
| Enable/disable multiple UTM profiles on the GUI. |
| | **gui\_nat46\_64** string | **Choices:*** enable
* disable
| Enable/disable NAT46 and NAT64 settings on the GUI. |
| | **gui\_object\_colors** string | **Choices:*** enable
* disable
| Enable/disable object colors on the GUI. |
| | **gui\_per\_policy\_disclaimer** string | **Choices:*** enable
* disable
| Enable/disable policy disclaimer on the GUI. |
| | **gui\_policy\_based\_ipsec** string | **Choices:*** enable
* disable
| Enable/disable policy-based IPsec VPN on the GUI. |
| | **gui\_policy\_disclaimer** string | **Choices:*** enable
* disable
| Enable/disable policy disclaimer on the GUI. |
| | **gui\_policy\_learning** string | **Choices:*** enable
* disable
| Enable/disable firewall policy learning mode on the GUI. |
| | **gui\_replacement\_message\_groups** string | **Choices:*** enable
* disable
| Enable/disable replacement message groups on the GUI. |
| | **gui\_security\_profile\_group** string | **Choices:*** enable
* disable
| Enable/disable Security Profile Groups on the GUI. |
| | **gui\_spamfilter** string | **Choices:*** enable
* disable
| Enable/disable Antispam on the GUI. |
| | **gui\_sslvpn\_personal\_bookmarks** string | **Choices:*** enable
* disable
| Enable/disable SSL-VPN personal bookmark management on the GUI. |
| | **gui\_sslvpn\_realms** string | **Choices:*** enable
* disable
| Enable/disable SSL-VPN realms on the GUI. |
| | **gui\_switch\_controller** string | **Choices:*** enable
* disable
| Enable/disable the switch controller on the GUI. |
| | **gui\_threat\_weight** string | **Choices:*** enable
* disable
| Enable/disable threat weight on the GUI. |
| | **gui\_traffic\_shaping** string | **Choices:*** enable
* disable
| Enable/disable traffic shaping on the GUI. |
| | **gui\_videofilter** string | **Choices:*** enable
* disable
| Enable/disable Video filtering on the GUI. |
| | **gui\_voip\_profile** string | **Choices:*** enable
* disable
| Enable/disable VoIP profiles on the GUI. |
| | **gui\_vpn** string | **Choices:*** enable
* disable
| Enable/disable VPN tunnels on the GUI. |
| | **gui\_waf\_profile** string | **Choices:*** enable
* disable
| Enable/disable Web Application Firewall on the GUI. |
| | **gui\_wan\_load\_balancing** string | **Choices:*** enable
* disable
| Enable/disable SD-WAN on the GUI. |
| | **gui\_wanopt\_cache** string | **Choices:*** enable
* disable
| Enable/disable WAN Optimization and Web Caching on the GUI. |
| | **gui\_webfilter** string | **Choices:*** enable
* disable
| Enable/disable Web filtering on the GUI. |
| | **gui\_webfilter\_advanced** string | **Choices:*** enable
* disable
| Enable/disable advanced web filtering on the GUI. |
| | **gui\_wireless\_controller** string | **Choices:*** enable
* disable
| Enable/disable the wireless controller on the GUI. |
| | **gui\_ztna** string | **Choices:*** enable
* disable
| Enable/disable Zero Trust Network Access features on the GUI. |
| | **http\_external\_dest** string | **Choices:*** fortiweb
* forticache
| Offload HTTP traffic to FortiWeb or FortiCache. |
| | **ike\_dn\_format** string | **Choices:*** with-space
* no-space
| Configure IKE ASN.1 Distinguished Name format conventions. |
| | **ike\_port** integer | | UDP port for IKE/IPsec traffic . |
| | **ike\_quick\_crash\_detect** string | **Choices:*** enable
* disable
| Enable/disable IKE quick crash detection (RFC 6290). |
| | **ike\_session\_resume** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 session resumption (RFC 5723). |
| | **implicit\_allow\_dns** string | **Choices:*** enable
* disable
| Enable/disable implicitly allowing DNS traffic. |
| | **inspection\_mode** string | **Choices:*** proxy
* flow
| Inspection mode (proxy-based or flow-based). |
| | **ip** string | | IP address and netmask. |
| | **ip6** string | | IPv6 address prefix for NAT mode. |
| | **link\_down\_access** string | **Choices:*** enable
* disable
| Enable/disable link down access traffic. |
| | **lldp\_reception** string | **Choices:*** enable
* disable
* global
| Enable/disable Link Layer Discovery Protocol (LLDP) reception for this VDOM or apply global settings to this VDOM. |
| | **lldp\_transmission** string | **Choices:*** enable
* disable
* global
| Enable/disable Link Layer Discovery Protocol (LLDP) for this VDOM or apply global settings to this VDOM. |
| | **location\_id** string | | Local location ID in the form of an IPv4 address. |
| | **mac\_ttl** integer | | Duration of MAC addresses in Transparent mode (300 - 8640000 sec). |
| | **manageip** string | | Transparent mode IPv4 management IP address and netmask. |
| | **manageip6** string | | Transparent mode IPv6 management IP address and netmask. |
| | **multicast\_forward** string | **Choices:*** enable
* disable
| Enable/disable multicast forwarding. |
| | **multicast\_skip\_policy** string | **Choices:*** enable
* disable
| Enable/disable allowing multicast traffic through the FortiGate without a policy check. |
| | **multicast\_ttl\_notchange** string | **Choices:*** enable
* disable
| Enable/disable preventing the FortiGate from changing the TTL for forwarded multicast packets. |
| | **ngfw\_mode** string | **Choices:*** profile-based
* policy-based
| Next Generation Firewall (NGFW) mode. |
| | **opmode** string | **Choices:*** nat
* transparent
| Firewall operation mode (NAT or Transparent). |
| | **prp\_trailer\_action** string | **Choices:*** enable
* disable
| Enable/disable action to take on PRP trailer. |
| | **sccp\_port** integer | | TCP port the SCCP proxy monitors for SCCP traffic (0 - 65535). |
| | **sctp\_session\_without\_init** string | **Choices:*** enable
* disable
| Enable/disable SCTP session creation without SCTP INIT. |
| | **ses\_denied\_traffic** string | **Choices:*** enable
* disable
| Enable/disable including denied session in the session table. |
| | **sip\_expectation** string | **Choices:*** enable
* disable
| Enable/disable the SIP kernel session helper to create an expectation for port 5060. |
| | **sip\_helper** string | **Choices:*** enable
* disable
| Enable/disable the SIP session helper to process SIP sessions unless SIP sessions are accepted by the SIP application layer gateway (ALG). |
| | **sip\_nat\_trace** string | **Choices:*** enable
* disable
| Enable/disable recording the original SIP source IP address when NAT is used. |
| | **sip\_ssl\_port** integer | | TCP port the SIP proxy monitors for SIP SSL/TLS traffic (0 - 65535). |
| | **sip\_tcp\_port** integer | | TCP port the SIP proxy monitors for SIP traffic (0 - 65535). |
| | **sip\_udp\_port** integer | | UDP port the SIP proxy monitors for SIP traffic (0 - 65535). |
| | **snat\_hairpin\_traffic** string | **Choices:*** enable
* disable
| Enable/disable source NAT (SNAT) for hairpin traffic. |
| | **ssl\_ssh\_profile** string | | Profile for SSL/SSH inspection. Source firewall.ssl-ssh-profile.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this VDOM. |
| | **strict\_src\_check** string | **Choices:*** enable
* disable
| Enable/disable strict source verification. |
| | **tcp\_session\_without\_syn** string | **Choices:*** enable
* disable
| Enable/disable allowing TCP session without SYN flags. |
| | **utf8\_spam\_tagging** string | **Choices:*** enable
* disable
| Enable/disable converting antispam tags to UTF-8 for better non-ASCII character support. |
| | **v4\_ecmp\_mode** string | **Choices:*** source-ip-based
* weight-based
* usage-based
* source-dest-ip-based
| IPv4 Equal-cost multi-path (ECMP) routing and load balancing mode. |
| | **vpn\_stats\_log** list / elements=string | **Choices:*** ipsec
* pptp
* l2tp
* ssl
| Enable/disable periodic VPN log statistics for one or more types of VPN. Separate names with a space. |
| | **vpn\_stats\_period** integer | | Period to send VPN log statistics (60 - 86400 sec). |
| | **wccp\_cache\_engine** string | **Choices:*** enable
* disable
| Enable/disable WCCP cache engine. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VDOM settings.
fortios_system_settings:
vdom: "{{ vdom }}"
system_settings:
allow_linkdown_path: "enable"
allow_subnet_overlap: "enable"
application_bandwidth_tracking: "disable"
asymroute: "enable"
asymroute_icmp: "enable"
asymroute6: "enable"
asymroute6_icmp: "enable"
auxiliary_session: "enable"
bfd: "enable"
bfd_desired_min_tx: "12"
bfd_detect_mult: "13"
bfd_dont_enforce_src_port: "enable"
bfd_required_min_rx: "15"
block_land_attack: "disable"
central_nat: "enable"
comments: "<your_own_value>"
compliance_check: "enable"
consolidated_firewall_mode: "enable"
default_voip_alg_mode: "proxy-based"
deny_tcp_with_icmp: "enable"
device: "<your_own_value> (source system.interface.name)"
dhcp_proxy: "enable"
dhcp_proxy_interface: "<your_own_value> (source system.interface.name)"
dhcp_proxy_interface_select_method: "auto"
dhcp_server_ip: "<your_own_value>"
dhcp6_server_ip: "<your_own_value>"
discovered_device_timeout: "29"
ecmp_max_paths: "30"
email_portal_check_dns: "disable"
firewall_session_dirty: "check-all"
fw_session_hairpin: "enable"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
gtp_asym_fgsp: "disable"
gtp_monitor_mode: "enable"
gui_advanced_policy: "enable"
gui_allow_unnamed_policy: "enable"
gui_antivirus: "enable"
gui_ap_profile: "enable"
gui_application_control: "enable"
gui_default_policy_columns:
-
name: "default_name_44"
gui_dhcp_advanced: "enable"
gui_dlp: "enable"
gui_dns_database: "enable"
gui_dnsfilter: "enable"
gui_domain_ip_reputation: "enable"
gui_dos_policy: "enable"
gui_dynamic_profile_display: "enable"
gui_dynamic_routing: "enable"
gui_email_collection: "enable"
gui_endpoint_control: "enable"
gui_endpoint_control_advanced: "enable"
gui_explicit_proxy: "enable"
gui_file_filter: "enable"
gui_fortiap_split_tunneling: "enable"
gui_fortiextender_controller: "enable"
gui_icap: "enable"
gui_implicit_policy: "enable"
gui_ips: "enable"
gui_load_balance: "enable"
gui_local_in_policy: "enable"
gui_local_reports: "enable"
gui_multicast_policy: "enable"
gui_multiple_interface_policy: "enable"
gui_multiple_utm_profiles: "enable"
gui_nat46_64: "enable"
gui_object_colors: "enable"
gui_per_policy_disclaimer: "enable"
gui_policy_based_ipsec: "enable"
gui_policy_disclaimer: "enable"
gui_policy_learning: "enable"
gui_replacement_message_groups: "enable"
gui_security_profile_group: "enable"
gui_spamfilter: "enable"
gui_sslvpn_personal_bookmarks: "enable"
gui_sslvpn_realms: "enable"
gui_switch_controller: "enable"
gui_threat_weight: "enable"
gui_traffic_shaping: "enable"
gui_videofilter: "enable"
gui_voip_profile: "enable"
gui_vpn: "enable"
gui_waf_profile: "enable"
gui_wan_load_balancing: "enable"
gui_wanopt_cache: "enable"
gui_webfilter: "enable"
gui_webfilter_advanced: "enable"
gui_wireless_controller: "enable"
gui_ztna: "enable"
http_external_dest: "fortiweb"
ike_dn_format: "with-space"
ike_port: "95"
ike_quick_crash_detect: "enable"
ike_session_resume: "enable"
implicit_allow_dns: "enable"
inspection_mode: "proxy"
ip: "<your_own_value>"
ip6: "<your_own_value>"
link_down_access: "enable"
lldp_reception: "enable"
lldp_transmission: "enable"
location_id: "<your_own_value>"
mac_ttl: "106"
manageip: "<your_own_value>"
manageip6: "<your_own_value>"
multicast_forward: "enable"
multicast_skip_policy: "enable"
multicast_ttl_notchange: "enable"
ngfw_mode: "profile-based"
opmode: "nat"
prp_trailer_action: "enable"
sccp_port: "115"
sctp_session_without_init: "enable"
ses_denied_traffic: "enable"
sip_expectation: "enable"
sip_helper: "enable"
sip_nat_trace: "enable"
sip_ssl_port: "121"
sip_tcp_port: "122"
sip_udp_port: "123"
snat_hairpin_traffic: "enable"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
strict_src_check: "enable"
tcp_session_without_syn: "enable"
utf8_spam_tagging: "enable"
v4_ecmp_mode: "source-ip-based"
vpn_stats_log: "ipsec"
vpn_stats_period: "132"
wccp_cache_engine: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_venue_name – Configure venue name duple in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_venue\_name – Configure venue name duple in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_venue_name`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller\_hotspot20 feature and anqp\_venue\_name 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_hotspot20\_anqp\_venue\_name** dictionary | | Configure venue name duple. |
| | **name** string / required | | Name of venue name duple. |
| | **value\_list** list / elements=string | | Name list. |
| | | **index** integer / required | | Value index. |
| | | **lang** string | | Language code. |
| | | **value** string | | Venue name value. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure venue name duple.
fortios_wireless_controller_hotspot20_anqp_venue_name:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_venue_name:
name: "default_name_3"
value_list:
-
index: "5"
lang: "<your_own_value>"
value: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer\_setting** dictionary | | Global FortiAnalyzer settings. |
| | **\_\_change\_ip** integer | | Hidden attribute. |
| | **access\_config** string | **Choices:*** enable
* disable
| Enable/disable FortiAnalyzer access to configuration and data. |
| | **certificate** string | | Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. |
| | **certificate\_verification** string | **Choices:*** enable
* disable
| Enable/disable identity verification of FortiAnalyzer by use of certificate. |
| | **conn\_timeout** integer | | FortiAnalyzer connection time-out in seconds (for status and log buffer). |
| | **enc\_algorithm** string | **Choices:*** high-medium
* high
* low
| Enable/disable sending FortiAnalyzer log data with SSL encryption. |
| | **faz\_type** integer | | Hidden setting index of FortiAnalyzer. |
| | **hmac\_algorithm** string | **Choices:*** sha256
* sha1
| FortiAnalyzer IPsec tunnel HMAC algorithm. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **ips\_archive** string | **Choices:*** enable
* disable
| Enable/disable IPS packet archive logging. |
| | **max\_log\_rate** integer | | FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
| | **mgmt\_name** string | | Hidden management name of FortiAnalyzer. |
| | **monitor\_failure\_retry\_period** integer | | Time between FortiAnalyzer connection retries in seconds (for status and log buffer). |
| | **monitor\_keepalive\_period** integer | | Time between OFTP keepalives in seconds (for status and log buffer). |
| | **preshared\_key** string | | Preshared-key used for auto-authorization on FortiAnalyzer. |
| | **priority** string | **Choices:*** default
* low
| Set log transmission priority. |
| | **reliable** string | **Choices:*** enable
* disable
| Enable/disable reliable logging to FortiAnalyzer. |
| | **serial** list / elements=string | | Serial numbers of the FortiAnalyzer. |
| | | **name** string / required | | Serial Number. |
| | **server** string | | The remote FortiAnalyzer. |
| | **source\_ip** string | | Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to FortiAnalyzer. |
| | **upload\_day** string | | Day of week (month) to upload logs. |
| | **upload\_interval** string | **Choices:*** daily
* weekly
* monthly
| Frequency to upload log files to FortiAnalyzer. |
| | **upload\_option** string | **Choices:*** store-and-upload
* realtime
* 1-minute
* 5-minute
| Enable/disable logging to hard disk and then uploading to FortiAnalyzer. |
| | **upload\_time** string | | Time to upload logs (hh:mm). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global FortiAnalyzer settings.
fortios_log_fortianalyzer_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_setting:
__change_ip: "3"
access_config: "enable"
certificate: "<your_own_value> (source certificate.local.name)"
certificate_verification: "enable"
conn_timeout: "7"
enc_algorithm: "high-medium"
faz_type: "9"
hmac_algorithm: "sha256"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
max_log_rate: "14"
mgmt_name: "<your_own_value>"
monitor_failure_retry_period: "16"
monitor_keepalive_period: "17"
preshared_key: "<your_own_value>"
priority: "default"
reliable: "enable"
serial:
-
name: "default_name_22"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_threat_weight – Configure threat weight settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_threat\_weight – Configure threat weight settings in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_threat_weight`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and threat\_weight 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_threat\_weight** dictionary | | Configure threat weight settings. |
| | **application** list / elements=string | | Application-control threat weight settings. |
| | | **category** integer | | Application category. |
| | | **id** integer / required | | Entry ID. |
| | | **level** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for Application events. |
| | **blocked\_connection** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for blocked connections. |
| | **botnet\_connection\_detected** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for detected botnet connections. |
| | **failed\_connection** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for failed connections. |
| | **geolocation** list / elements=string | | Geolocation-based threat weight settings. |
| | | **country** string | | Country code. |
| | | **id** integer / required | | Entry ID. |
| | | **level** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for Geolocation-based events. |
| | **ips** dictionary | | IPS threat weight settings. |
| | | **critical\_severity** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for IPS critical severity events. |
| | | **high\_severity** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for IPS high severity events. |
| | | **info\_severity** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for IPS info severity events. |
| | | **low\_severity** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for IPS low severity events. |
| | | **medium\_severity** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for IPS medium severity events. |
| | **level** dictionary | | Score mapping for threat weight levels. |
| | | **critical** integer | | Critical level score value (1 - 100). |
| | | **high** integer | | High level score value (1 - 100). |
| | | **low** integer | | Low level score value (1 - 100). |
| | | **medium** integer | | Medium level score value (1 - 100). |
| | **malware** dictionary | | Anti-virus malware threat weight settings. |
| | | **botnet\_connection** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for detected botnet connections. |
| | | **command\_blocked** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for blocked command detected. |
| | | **content\_disarm** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (content disarm) detected. |
| | | **ems\_threat\_feed** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (EMS threat feed) detected. |
| | | **file\_blocked** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for blocked file detected. |
| | | **fsa\_high\_risk** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for FortiSandbox high risk malware detected. |
| | | **fsa\_malicious** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for FortiSandbox malicious malware detected. |
| | | **fsa\_medium\_risk** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for FortiSandbox medium risk malware detected. |
| | | **malware\_list** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (malware list) detected. |
| | | **mimefragmented** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for mimefragmented detected. |
| | | **oversized** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for oversized file detected. |
| | | **switch\_proto** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for switch proto detected. |
| | | **virus\_blocked** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (blocked) detected. |
| | | **virus\_file\_type\_executable** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (filetype executable) detected. |
| | | **virus\_infected** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (infected) detected. |
| | | **virus\_outbreak\_prevention** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (outbreak prevention) event. |
| | | **virus\_scan\_error** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for virus (scan error) detected. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the threat weight feature. |
| | **url\_block\_detected** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for URL blocking. |
| | **web** list / elements=string | | Web filtering threat weight settings. |
| | | **category** integer | | Threat weight score for web category filtering matches. |
| | | **id** integer / required | | Entry ID. |
| | | **level** string | **Choices:*** disable
* low
* medium
* high
* critical
| Threat weight score for web category filtering matches. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure threat weight settings.
fortios_log_threat_weight:
vdom: "{{ vdom }}"
log_threat_weight:
application:
-
category: "4"
id: "5"
level: "disable"
blocked_connection: "disable"
botnet_connection_detected: "disable"
failed_connection: "disable"
geolocation:
-
country: "<your_own_value>"
id: "12"
level: "disable"
ips:
critical_severity: "disable"
high_severity: "disable"
info_severity: "disable"
low_severity: "disable"
medium_severity: "disable"
level:
critical: "21"
high: "22"
low: "23"
medium: "24"
malware:
botnet_connection: "disable"
command_blocked: "disable"
content_disarm: "disable"
ems_threat_feed: "disable"
file_blocked: "disable"
fsa_high_risk: "disable"
fsa_malicious: "disable"
fsa_medium_risk: "disable"
malware_list: "disable"
mimefragmented: "disable"
oversized: "disable"
switch_proto: "disable"
virus_blocked: "disable"
virus_file_type_executable: "disable"
virus_infected: "disable"
virus_outbreak_prevention: "disable"
virus_scan_error: "disable"
status: "enable"
url_block_detected: "disable"
web:
-
category: "46"
id: "47"
level: "disable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_extender_extender_info – Display extender struct information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_extender\_info – Display extender struct information in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_extender_extender_info`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender feature and extender\_info 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **extender\_extender\_info** dictionary | | Display extender struct information. |
| | string | | extender serial number. Source extender-controller.extender.id. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Display extender struct information.
fortios_extender_extender_info:
vdom: "{{ vdom }}"
extender_extender_info:
<sn>: "<your_own_value> (source extender-controller.extender.id)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_nac_device – Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_nac\_device – Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_nac_device`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and nac\_device 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_nac\_device** dictionary | | Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. |
| | **description** string | | Description for the learned NAC device. |
| | **id** integer / required | | Device ID. |
| | **last\_known\_port** string | | Managed FortiSwitch port where NAC device is last learned. |
| | **last\_known\_switch** string | | Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id. |
| | **last\_seen** integer | | Device last seen. |
| | **mac** string | | MAC address of the learned NAC device. |
| | **mac\_policy** string | | MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name. |
| | **matched\_nac\_policy** string | | Matched NAC policy for the learned NAC device. Source user.nac-policy.name. |
| | **port\_policy** string | | Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name. |
| | **status** string | **Choices:*** enable
* disable
| Status of the learned NAC device. Set enable to authorize the NAC device. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy.
fortios_switch_controller_nac_device:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_nac_device:
description: "<your_own_value>"
id: "4"
last_known_port: "<your_own_value>"
last_known_switch: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
last_seen: "7"
mac: "<your_own_value>"
mac_policy: "<your_own_value> (source switch-controller.mac-policy.name)"
matched_nac_policy: "<your_own_value> (source user.nac-policy.name)"
port_policy: "<your_own_value> (source switch-controller.port-policy.name)"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_shaper_traffic_shaper – Configure shared traffic shaper in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_shaper\_traffic\_shaper – Configure shared traffic shaper in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_shaper_traffic_shaper`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall\_shaper feature and traffic\_shaper 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_shaper\_traffic\_shaper** dictionary | | Configure shared traffic shaper. |
| | **bandwidth\_unit** string | **Choices:*** kbps
* mbps
* gbps
| Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). |
| | **diffserv** string | **Choices:*** enable
* disable
| Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. |
| | **diffservcode** string | | DiffServ setting to be applied to traffic accepted by this shaper. |
| | **dscp\_marking\_method** string | **Choices:*** multi-stage
* static
| Select DSCP marking method. |
| | **exceed\_bandwidth** integer | | Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting. |
| | **exceed\_class\_id** integer | | Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth]. Source firewall.traffic-class.class-id. |
| | **exceed\_dscp** string | | DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. |
| | **guaranteed\_bandwidth** integer | | Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting. |
| | **maximum\_bandwidth** integer | | Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting. |
| | **maximum\_dscp** string | | DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth]. |
| | **name** string / required | | Traffic shaper name. |
| | **overhead** integer | | Per-packet size overhead used in rate computations. |
| | **per\_policy** string | **Choices:*** disable
* enable
| Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. |
| | **priority** string | **Choices:*** low
* medium
* high
| Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure shared traffic shaper.
fortios_firewall_shaper_traffic_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaper_traffic_shaper:
bandwidth_unit: "kbps"
diffserv: "enable"
diffservcode: "<your_own_value>"
dscp_marking_method: "multi-stage"
exceed_bandwidth: "7"
exceed_class_id: "8 (source firewall.traffic-class.class-id)"
exceed_dscp: "<your_own_value>"
guaranteed_bandwidth: "10"
maximum_bandwidth: "11"
maximum_dscp: "<your_own_value>"
name: "default_name_13"
overhead: "14"
per_policy: "disable"
priority: "low"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_auth_portal – Configure firewall authentication portals in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_auth\_portal – Configure firewall authentication portals in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_auth_portal`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and auth\_portal 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_auth\_portal** dictionary | | Configure firewall authentication portals. |
| | **groups** list / elements=string | | Firewall user groups permitted to authenticate through this portal. Separate group names with spaces. |
| | | **name** string / required | | Group name. Source user.group.name. |
| | **identity\_based\_route** string | | Name of the identity-based route that applies to this portal. Source firewall.identity-based-route.name. |
| | **portal\_addr** string | | Address (or FQDN) of the authentication portal. |
| | **portal\_addr6** string | | IPv6 address (or FQDN) of authentication portal. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure firewall authentication portals.
fortios_firewall_auth_portal:
vdom: "{{ vdom }}"
firewall_auth_portal:
groups:
-
name: "default_name_4 (source user.group.name)"
identity_based_route: "<your_own_value> (source firewall.identity-based-route.name)"
portal_addr: "<your_own_value>"
portal_addr6: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_device_group – Configure device groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_device\_group – Configure device groups in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_device_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_device\_group** dictionary | | Configure device groups. |
| | **comment** string | | Comment. |
| | **member** list / elements=string | | Device group member. |
| | | **name** string / required | | Device name. Source user.device.alias user.device-category.name. |
| | **name** string / required | | Device group name. |
| | **tagging** list / elements=string | | Config object tagging. |
| | | **category** string | | Tag category. Source system.object-tagging.category. |
| | | **name** string / required | | Tagging entry name. |
| | | **tags** list / elements=string | | Tags. |
| | | | **name** string / required | | Tag name. Source system.object-tagging.tags.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure device groups.
fortios_user_device_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device_group:
comment: "Comment."
member:
-
name: "default_name_5 (source user.device.alias user.device-category.name)"
name: "default_name_6"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_9"
tags:
-
name: "default_name_11 (source system.object-tagging.tags.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_ha – Configure HA in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ha – Configure HA in Fortinet’s FortiOS and FortiGate.
========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ha`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ha 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_ha** dictionary | | Configure HA. |
| | **arps** integer | | Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time. |
| | **arps\_interval** integer | | Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic. |
| | **authentication** string | **Choices:*** enable
* disable
| Enable/disable heartbeat message authentication. |
| | **cpu\_threshold** string | | Dynamic weighted load balancing CPU usage weight and high and low thresholds. |
| | **encryption** string | **Choices:*** enable
* disable
| Enable/disable heartbeat message encryption. |
| | **failover\_hold\_time** integer | | Time to wait before failover (0 - 300 sec), to avoid flip. |
| | **ftp\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of FTP proxy sessions. |
| | **gratuitous\_arps** string | **Choices:*** enable
* disable
| Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled. |
| | **group\_id** integer | | Cluster group ID (0 - 255). Must be the same for all members. |
| | **group\_name** string | | Cluster group name. Must be the same for all members. |
| | **ha\_direct** string | **Choices:*** enable
* disable
| Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox. |
| | **ha\_eth\_type** string | | HA heartbeat packet Ethertype (4-digit hex). |
| | **ha\_mgmt\_interfaces** list / elements=string | | Reserve interfaces to manage individual cluster units. |
| | | **dst** string | | Default route destination for reserved HA management interface. |
| | | **gateway** string | | Default route gateway for reserved HA management interface. |
| | | **gateway6** string | | Default IPv6 gateway for reserved HA management interface. |
| | | **id** integer / required | | Table ID. |
| | | **interface** string | | Interface to reserve for HA management. Source system.interface.name. |
| | **ha\_mgmt\_status** string | **Choices:*** enable
* disable
| Enable to reserve interfaces to manage individual cluster units. |
| | **ha\_uptime\_diff\_margin** integer | | Normally you would only reduce this value for failover testing. |
| | **hb\_interval** integer | | Time between sending heartbeat packets (1 - 20 (100\*ms)). Increase to reduce false positives. |
| | **hb\_interval\_in\_milliseconds** string | **Choices:*** 100ms
* 10ms
| Number of milliseconds for each heartbeat interval: 100ms or 10ms. |
| | **hb\_lost\_threshold** integer | | Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives. |
| | **hbdev** string | | Heartbeat interfaces. Must be the same for all members. |
| | **hc\_eth\_type** string | | Transparent mode HA heartbeat packet Ethertype (4-digit hex). |
| | **hello\_holddown** integer | | Time to wait before changing from hello to work state (5 - 300 sec). |
| | **http\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions. |
| | **imap\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions. |
| | **inter\_cluster\_session\_sync** string | **Choices:*** enable
* disable
| Enable/disable synchronization of sessions among HA clusters. |
| | **key** string | | key |
| | **l2ep\_eth\_type** string | | Telnet session HA heartbeat packet Ethertype (4-digit hex). |
| | **link\_failed\_signal** string | **Choices:*** enable
* disable
| Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network. |
| | **load\_balance\_all** string | **Choices:*** enable
* disable
| Enable to load balance TCP sessions. Disable to load balance proxy sessions only. |
| | **logical\_sn** string | **Choices:*** enable
* disable
| Enable/disable usage of the logical serial number. |
| | **memory\_based\_failover** string | **Choices:*** enable
* disable
| Enable/disable memory based failover. |
| | **memory\_compatible\_mode** string | **Choices:*** enable
* disable
| Enable/disable memory compatible mode. |
| | **memory\_failover\_flip\_timeout** integer | | Time to wait between subsequent memory based failovers in minutes (6 - 2147483647). |
| | **memory\_failover\_monitor\_period** integer | | Duration of high memory usage before memory based failover is triggered in seconds (1 - 300). |
| | **memory\_failover\_sample\_rate** integer | | Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60). |
| | **memory\_failover\_threshold** integer | | Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold). |
| | **memory\_threshold** string | | Dynamic weighted load balancing memory usage weight and high and low thresholds. |
| | **mode** string | **Choices:*** standalone
* a-a
* a-p
| HA mode. Must be the same for all members. FGSP requires standalone. |
| | **monitor** string | | Interfaces to check for port monitoring (or link failure). Source system.interface.name. |
| | **multicast\_ttl** integer | | HA multicast TTL on master (5 - 3600 sec). |
| | **nntp\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions. |
| | **override** string | **Choices:*** enable
* disable
| Enable and increase the priority of the unit that should always be primary (master). |
| | **override\_wait\_time** integer | | Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates. |
| | **password** string | | Cluster password. Must be the same for all members. |
| | **pingserver\_failover\_threshold** integer | | Remote IP monitoring failover threshold (0 - 50). |
| | **pingserver\_flip\_timeout** integer | | Time to wait in minutes before renegotiating after a remote IP monitoring failover. |
| | **pingserver\_monitor\_interface** string | | Interfaces to check for remote IP monitoring. Source system.interface.name. |
| | **pingserver\_secondary\_force\_reset** string | **Choices:*** enable
* disable
| Enable to force the cluster to negotiate after a remote IP monitoring failover. |
| | **pingserver\_slave\_force\_reset** string | **Choices:*** enable
* disable
| Enable to force the cluster to negotiate after a remote IP monitoring failover. |
| | **pop3\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions. |
| | **priority** integer | | Increase the priority to select the primary unit (0 - 255). |
| | **route\_hold** integer | | Time to wait between routing table updates to the cluster (0 - 3600 sec). |
| | **route\_ttl** integer | | TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover. |
| | **route\_wait** integer | | Time to wait before sending new routes to the cluster (0 - 3600 sec). |
| | **schedule** string | **Choices:*** none
* hub
* leastconnection
* round-robin
* weight-round-robin
* random
* ip
* ipport
| Type of A-A load balancing. Use none if you have external load balancers. |
| | **secondary\_vcluster** dictionary | | Configure virtual cluster 2. |
| | | **monitor** string | | Interfaces to check for port monitoring (or link failure). Source system.interface.name. |
| | | **override** string | **Choices:*** enable
* disable
| Enable and increase the priority of the unit that should always be primary (master). |
| | | **override\_wait\_time** integer | | Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates. |
| | | **pingserver\_failover\_threshold** integer | | Remote IP monitoring failover threshold (0 - 50). |
| | | **pingserver\_monitor\_interface** string | | Interfaces to check for remote IP monitoring. Source system.interface.name. |
| | | **pingserver\_secondary\_force\_reset** string | **Choices:*** enable
* disable
| Enable to force the cluster to negotiate after a remote IP monitoring failover. |
| | | **pingserver\_slave\_force\_reset** string | **Choices:*** enable
* disable
| Enable to force the cluster to negotiate after a remote IP monitoring failover. |
| | | **priority** integer | | Increase the priority to select the primary unit (0 - 255). |
| | | **vcluster\_id** integer | | Cluster ID. |
| | | **vdom** string | | VDOMs in virtual cluster 2. |
| | **session\_pickup** string | **Choices:*** enable
* disable
| Enable/disable session pickup. Enabling it can reduce session down time when fail over happens. |
| | **session\_pickup\_connectionless** string | **Choices:*** enable
* disable
| Enable/disable UDP and ICMP session sync for FGSP. |
| | **session\_pickup\_delay** string | **Choices:*** enable
* disable
| Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced. |
| | **session\_pickup\_expectation** string | **Choices:*** enable
* disable
| Enable/disable session helper expectation session sync for FGSP. |
| | **session\_pickup\_nat** string | **Choices:*** enable
* disable
| Enable/disable NAT session sync for FGSP. |
| | **session\_sync\_dev** string | | Offload session sync to one or more interfaces to distribute traffic and prevent delays if needed. Source system.interface.name. |
| | **smtp\_proxy\_threshold** string | | Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions. |
| | **ssd\_failover** string | **Choices:*** enable
* disable
| Enable/disable automatic HA failover on SSD disk failure. |
| | **standalone\_config\_sync** string | **Choices:*** enable
* disable
| Enable/disable FGSP configuration synchronization. |
| | **standalone\_mgmt\_vdom** string | **Choices:*** enable
* disable
| Enable/disable standalone management VDOM. |
| | **sync\_config** string | **Choices:*** enable
* disable
| Enable/disable configuration synchronization. |
| | **sync\_packet\_balance** string | **Choices:*** enable
* disable
| Enable/disable HA packet distribution to multiple CPUs. |
| | **unicast\_gateway** string | | Default route gateway for unicast interface. |
| | **unicast\_hb** string | **Choices:*** enable
* disable
| Enable/disable unicast heartbeat. |
| | **unicast\_hb\_netmask** string | | Unicast heartbeat netmask. |
| | **unicast\_hb\_peerip** string | | Unicast heartbeat peer IP. |
| | **unicast\_peers** list / elements=string | | Number of unicast peers. |
| | | **id** integer / required | | Table ID. |
| | | **peer\_ip** string | | Unicast peer IP. |
| | **unicast\_status** string | **Choices:*** enable
* disable
| Enable/disable unicast connection. |
| | **uninterruptible\_upgrade** string | **Choices:*** enable
* disable
| Enable to upgrade a cluster without blocking network traffic. |
| | **vcluster2** string | **Choices:*** enable
* disable
| Enable/disable virtual cluster 2 for virtual clustering. |
| | **vcluster\_id** integer | | Cluster ID. |
| | **vdom** string | | VDOMs in virtual cluster 1. |
| | **weight** string | | Weight-round-robin weight for each cluster unit. Syntax <priority> <weight>. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure HA.
fortios_system_ha:
vdom: "{{ vdom }}"
system_ha:
arps: "3"
arps_interval: "4"
authentication: "enable"
cpu_threshold: "<your_own_value>"
encryption: "enable"
failover_hold_time: "8"
ftp_proxy_threshold: "<your_own_value>"
gratuitous_arps: "enable"
group_id: "11"
group_name: "<your_own_value>"
ha_direct: "enable"
ha_eth_type: "<your_own_value>"
ha_mgmt_interfaces:
-
dst: "<your_own_value>"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
id: "19"
interface: "<your_own_value> (source system.interface.name)"
ha_mgmt_status: "enable"
ha_uptime_diff_margin: "22"
hb_interval: "23"
hb_interval_in_milliseconds: "100ms"
hb_lost_threshold: "25"
hbdev: "<your_own_value>"
hc_eth_type: "<your_own_value>"
hello_holddown: "28"
http_proxy_threshold: "<your_own_value>"
imap_proxy_threshold: "<your_own_value>"
inter_cluster_session_sync: "enable"
key: "<your_own_value>"
l2ep_eth_type: "<your_own_value>"
link_failed_signal: "enable"
load_balance_all: "enable"
logical_sn: "enable"
memory_based_failover: "enable"
memory_compatible_mode: "enable"
memory_failover_flip_timeout: "39"
memory_failover_monitor_period: "40"
memory_failover_sample_rate: "41"
memory_failover_threshold: "42"
memory_threshold: "<your_own_value>"
mode: "standalone"
monitor: "<your_own_value> (source system.interface.name)"
multicast_ttl: "46"
nntp_proxy_threshold: "<your_own_value>"
override: "enable"
override_wait_time: "49"
password: "<your_own_value>"
pingserver_failover_threshold: "51"
pingserver_flip_timeout: "52"
pingserver_monitor_interface: "<your_own_value> (source system.interface.name)"
pingserver_secondary_force_reset: "enable"
pingserver_slave_force_reset: "enable"
pop3_proxy_threshold: "<your_own_value>"
priority: "57"
route_hold: "58"
route_ttl: "59"
route_wait: "60"
schedule: "none"
secondary_vcluster:
monitor: "<your_own_value> (source system.interface.name)"
override: "enable"
override_wait_time: "65"
pingserver_failover_threshold: "66"
pingserver_monitor_interface: "<your_own_value> (source system.interface.name)"
pingserver_secondary_force_reset: "enable"
pingserver_slave_force_reset: "enable"
priority: "70"
vcluster_id: "71"
vdom: "<your_own_value>"
session_pickup: "enable"
session_pickup_connectionless: "enable"
session_pickup_delay: "enable"
session_pickup_expectation: "enable"
session_pickup_nat: "enable"
session_sync_dev: "<your_own_value> (source system.interface.name)"
smtp_proxy_threshold: "<your_own_value>"
ssd_failover: "enable"
standalone_config_sync: "enable"
standalone_mgmt_vdom: "enable"
sync_config: "enable"
sync_packet_balance: "enable"
unicast_gateway: "<your_own_value>"
unicast_hb: "enable"
unicast_hb_netmask: "<your_own_value>"
unicast_hb_peerip: "<your_own_value>"
unicast_peers:
-
id: "90"
peer_ip: "<your_own_value>"
unicast_status: "enable"
uninterruptible_upgrade: "enable"
vcluster_id: "94"
vcluster2: "enable"
vdom: "<your_own_value>"
weight: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_dlp_sensor – Configure DLP sensors in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dlp\_sensor – Configure DLP sensors in Fortinet’s FortiOS and FortiGate.
==================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dlp_sensor`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and sensor 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dlp\_sensor** dictionary | | Configure DLP sensors. |
| | **comment** string | | Comment. |
| | **dlp\_log** string | **Choices:*** enable
* disable
| Enable/disable DLP logging. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging for data leak prevention. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow/proxy feature set. |
| | **filter** list / elements=string | | Set up DLP filters for this sensor. |
| | | **action** string | **Choices:*** allow
* log-only
* block
* quarantine-ip
| Action to take with content that this DLP sensor matches. |
| | | **archive** string | **Choices:*** disable
* enable
| Enable/disable DLP archiving. |
| | | **company\_identifier** string | | Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched. |
| | | **expiry** string | | Quarantine duration in days, hours, minutes format (dddhhmm). |
| | | **file\_size** integer | | Match files this size or larger (0 - 4294967295 kbytes). |
| | | **file\_type** integer | | Select the number of a DLP file pattern table to match. Source dlp.filepattern.id. |
| | | **filter\_by** string | **Choices:*** credit-card
* ssn
* regexp
* file-type
* file-size
* fingerprint
* watermark
* encrypted
| Select the type of content to match. |
| | | **fp\_sensitivity** list / elements=string | | Select a DLP file pattern sensitivity to match. |
| | | | **name** string / required | | Select a DLP sensitivity. Source dlp.fp-sensitivity.name. |
| | | **id** integer / required | | ID. |
| | | **match\_percentage** integer | | Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match. |
| | | **name** string | | Filter name. |
| | | **proto** list / elements=string | **Choices:*** smtp
* pop3
* imap
* http-get
* http-post
* ftp
* nntp
* mapi
* mm1
* mm3
* mm4
* mm7
* ssh
* cifs
| Check messages or files over one or more of these protocols. |
| | | **regexp** string | | Enter a regular expression to match (max. 255 characters). |
| | | **sensitivity** list / elements=string | | Select a DLP file pattern sensitivity to match. |
| | | | **name** string / required | | Select a DLP sensitivity. Source dlp.sensitivity.name. |
| | | **severity** string | **Choices:*** info
* low
* medium
* high
* critical
| Select the severity or threat level that matches this filter. |
| | | **type** string | **Choices:*** file
* message
| Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). |
| | **flow\_based** string | **Choices:*** enable
* disable
| Enable/disable flow-based DLP. |
| | **full\_archive\_proto** list / elements=string | **Choices:*** smtp
* pop3
* imap
* http-get
* http-post
* ftp
* nntp
* mapi
* mm1
* mm3
* mm4
* mm7
* ssh
* cifs
| Protocols to always content archive. |
| | **nac\_quar\_log** string | **Choices:*** enable
* disable
| Enable/disable NAC quarantine logging. |
| | **name** string / required | | Name of the DLP sensor. |
| | **options** string | | Configure DLP options. |
| | **replacemsg\_group** string | | Replacement message group used by this DLP sensor. Source system.replacemsg-group.name. |
| | **summary\_proto** list / elements=string | **Choices:*** smtp
* pop3
* imap
* http-get
* http-post
* ftp
* nntp
* mapi
* mm1
* mm3
* mm4
* mm7
* ssh
* cifs
| Protocols to always log summary. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure DLP sensors.
fortios_dlp_sensor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_sensor:
comment: "Comment."
dlp_log: "enable"
extended_log: "enable"
feature_set: "flow"
filter:
-
action: "allow"
archive: "disable"
company_identifier: "myId_10"
expiry: "<your_own_value>"
file_size: "12"
file_type: "13 (source dlp.filepattern.id)"
filter_by: "credit-card"
fp_sensitivity:
-
name: "default_name_16 (source dlp.fp-sensitivity.name)"
id: "17"
match_percentage: "18"
name: "default_name_19"
proto: "smtp"
regexp: "<your_own_value>"
sensitivity:
-
name: "default_name_23 (source dlp.sensitivity.name)"
severity: "info"
type: "file"
flow_based: "enable"
full_archive_proto: "smtp"
nac_quar_log: "enable"
name: "default_name_29"
options: "<your_own_value>"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
summary_proto: "smtp"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ocvpn – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ocvpn – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ocvpn`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn feature and ocvpn 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **vpn\_ocvpn** dictionary | | Configure Overlay Controller VPN settings. |
| | **auto\_discovery** string | **Choices:*** enable
* disable
| Enable/disable auto-discovery shortcuts. |
| | **eap** string | **Choices:*** enable
* disable
| Enable/disable EAP client authentication. |
| | **eap\_users** string | | EAP authentication user group. Source user.group.name. |
| | **forticlient\_access** dictionary | | Configure FortiClient settings. |
| | | **auth\_groups** list / elements=string | | FortiClient user authentication groups. |
| | | | **auth\_group** string | | Authentication user group for FortiClient access. Source user.group.name. |
| | | | **name** string / required | | Group name. |
| | | | **overlays** list / elements=string | | OCVPN overlays to allow access to. |
| | | | | **overlay\_name** string | | Overlay name. Source vpn.ocvpn.overlays.overlay-name. |
| | | **psksecret** string | | Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable FortiClient to access OCVPN networks. |
| | **ha\_alias** string | | Hidden HA alias. |
| | **ip\_allocation\_block** string | | Class B subnet reserved for private IP address assignment. |
| | **multipath** string | **Choices:*** enable
* disable
| Enable/disable multipath redundancy. |
| | **nat** string | **Choices:*** enable
* disable
| Enable/disable inter-overlay source NAT. |
| | **overlays** list / elements=string | | Network overlays to register with Overlay Controller VPN service. |
| | | **assign\_ip** string | **Choices:*** enable
* disable
| Enable/disable client address assignment. |
| | | **id** integer / required | | ID. |
| | | **inter\_overlay** string | **Choices:*** allow
* deny
| Allow or deny traffic from other overlays. |
| | | **ipv4\_end\_ip** string | | End of client IPv4 range. |
| | | **ipv4\_start\_ip** string | | Start of client IPv4 range. |
| | | **name** string | | Overlay name. |
| | | **overlay\_name** string | | Overlay name. |
| | | **subnets** list / elements=string | | Internal subnets to register with OCVPN service. |
| | | | **id** integer / required | | ID. |
| | | | **interface** string | | LAN interface. Source system.interface.name. |
| | | | **subnet** string | | IPv4 address and subnet mask. |
| | | | **type** string | **Choices:*** subnet
* interface
| Subnet type. |
| | **poll\_interval** integer | | Overlay Controller VPN polling interval. |
| | **role** string | **Choices:*** spoke
* primary-hub
* secondary-hub
| Set device role. |
| | **sdwan** string | **Choices:*** enable
* disable
| Enable/disable adding OCVPN tunnels to SDWAN. |
| | **sdwan\_zone** string | | Set SD-WAN zone. Source system.sdwan.zone.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable Overlay Controller cloud assisted VPN. |
| | **subnets** list / elements=string | | Internal subnets to register with Overlay Controller VPN service. |
| | | **id** integer / required | | ID. |
| | | **interface** string | | LAN interface. Source system.interface.name. |
| | | **subnet** string | | IPv4 address and subnet mask. |
| | | **type** string | **Choices:*** subnet
* interface
| Subnet type. |
| | **wan\_interface** list / elements=string | | FortiGate WAN interfaces to use with OCVPN. |
| | | **name** string / required | | Interface name. Source system.interface.name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Overlay Controller VPN settings.
fortios_vpn_ocvpn:
vdom: "{{ vdom }}"
vpn_ocvpn:
auto_discovery: "enable"
eap: "enable"
eap_users: "<your_own_value> (source user.group.name)"
forticlient_access:
auth_groups:
-
auth_group: "<your_own_value> (source user.group.name)"
name: "default_name_9"
overlays:
-
overlay_name: "<your_own_value> (source vpn.ocvpn.overlays.overlay-name)"
psksecret: "<your_own_value>"
status: "enable"
ha_alias: "<your_own_value>"
ip_allocation_block: "<your_own_value>"
multipath: "enable"
nat: "enable"
overlays:
-
assign_ip: "enable"
id: "20"
inter_overlay: "allow"
ipv4_end_ip: "<your_own_value>"
ipv4_start_ip: "<your_own_value>"
name: "default_name_24"
overlay_name: "<your_own_value>"
subnets:
-
id: "27"
interface: "<your_own_value> (source system.interface.name)"
subnet: "<your_own_value>"
type: "subnet"
poll_interval: "31"
role: "spoke"
sdwan: "enable"
sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
status: "enable"
subnets:
-
id: "37"
interface: "<your_own_value> (source system.interface.name)"
subnet: "<your_own_value>"
type: "subnet"
wan_interface:
-
name: "default_name_42 (source system.interface.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_resource_limits – Configure resource limits in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_resource\_limits – Configure resource limits in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_resource_limits`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and resource\_limits 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_resource\_limits** dictionary | | Configure resource limits. |
| | **custom\_service** integer | | Maximum number of firewall custom services. |
| | **dialup\_tunnel** integer | | Maximum number of dial-up tunnels. |
| | **firewall\_address** integer | | Maximum number of firewall addresses (IPv4, IPv6, multicast). |
| | **firewall\_addrgrp** integer | | Maximum number of firewall address groups (IPv4, IPv6). |
| | **firewall\_policy** integer | | Maximum number of firewall policies (IPv4, IPv6, policy46, policy64, DoS-policy4, DoS-policy6, multicast). |
| | **ipsec\_phase1** integer | | Maximum number of VPN IPsec phase1 tunnels. |
| | **ipsec\_phase1\_interface** integer | | Maximum number of VPN IPsec phase1 interface tunnels. |
| | **ipsec\_phase2** integer | | Maximum number of VPN IPsec phase2 tunnels. |
| | **ipsec\_phase2\_interface** integer | | Maximum number of VPN IPsec phase2 interface tunnels. |
| | **log\_disk\_quota** integer | | Log disk quota in MB. |
| | **onetime\_schedule** integer | | Maximum number of firewall one-time schedules. |
| | **proxy** integer | | Maximum number of concurrent proxy users. |
| | **recurring\_schedule** integer | | Maximum number of firewall recurring schedules. |
| | **service\_group** integer | | Maximum number of firewall service groups. |
| | **session** integer | | Maximum number of sessions. |
| | **sslvpn** integer | | Maximum number of SSL-VPN. |
| | **user** integer | | Maximum number of local users. |
| | **user\_group** integer | | Maximum number of user groups. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure resource limits.
fortios_system_resource_limits:
vdom: "{{ vdom }}"
system_resource_limits:
custom_service: "3"
dialup_tunnel: "4"
firewall_address: "5"
firewall_addrgrp: "6"
firewall_policy: "7"
ipsec_phase1: "8"
ipsec_phase1_interface: "9"
ipsec_phase2: "10"
ipsec_phase2_interface: "11"
log_disk_quota: "12"
onetime_schedule: "13"
proxy: "14"
recurring_schedule: "15"
service_group: "16"
session: "17"
sslvpn: "18"
user: "19"
user_group: "20"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_vpn_ipsec_phase2_interface – Configure VPN autokey tunnel in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_phase2\_interface – Configure VPN autokey tunnel in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ipsec_phase2_interface`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ipsec feature and phase2\_interface 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ipsec\_phase2\_interface** dictionary | | Configure VPN autokey tunnel. |
| | **add\_route** string | **Choices:*** phase1
* enable
* disable
| Enable/disable automatic route addition. |
| | **auto\_discovery\_forwarder** string | **Choices:*** phase1
* enable
* disable
| Enable/disable forwarding short-cut messages. |
| | **auto\_discovery\_sender** string | **Choices:*** phase1
* enable
* disable
| Enable/disable sending short-cut messages. |
| | **auto\_negotiate** string | **Choices:*** enable
* disable
| Enable/disable IPsec SA auto-negotiation. |
| | **comments** string | | Comment. |
| | **dhcp\_ipsec** string | **Choices:*** enable
* disable
| Enable/disable DHCP-IPsec. |
| | **dhgrp** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
* 32
| Phase2 DH group. |
| | **diffserv** string | **Choices:*** enable
* disable
| Enable/disable applying DSCP value to the IPsec tunnel outer IP header. |
| | **diffservcode** string | | DSCP value to be applied to the IPsec tunnel outer IP header. |
| | **dst\_addr\_type** string | **Choices:*** subnet
* range
* ip
* name
* subnet6
* range6
* ip6
* name6
| Remote proxy ID type. |
| | **dst\_end\_ip** string | | Remote proxy ID IPv4 end. |
| | **dst\_end\_ip6** string | | Remote proxy ID IPv6 end. |
| | **dst\_name** string | | Remote proxy ID name. Source firewall.address.name firewall.addrgrp.name. |
| | **dst\_name6** string | | Remote proxy ID name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **dst\_port** integer | | Quick mode destination port (1 - 65535 or 0 for all). |
| | **dst\_start\_ip** string | | Remote proxy ID IPv4 start. |
| | **dst\_start\_ip6** string | | Remote proxy ID IPv6 start. |
| | **dst\_subnet** string | | Remote proxy ID IPv4 subnet. |
| | **dst\_subnet6** string | | Remote proxy ID IPv6 subnet. |
| | **encapsulation** string | **Choices:*** tunnel-mode
* transport-mode
| ESP encapsulation mode. |
| | **initiator\_ts\_narrow** string | **Choices:*** enable
* disable
| Enable/disable traffic selector narrowing for IKEv2 initiator. |
| | **ipv4\_df** string | **Choices:*** enable
* disable
| Enable/disable setting and resetting of IPv4 "Don"t Fragment" bit. |
| | **keepalive** string | **Choices:*** enable
* disable
| Enable/disable keep alive. |
| | **keylife\_type** string | **Choices:*** seconds
* kbs
* both
| Keylife type. |
| | **keylifekbs** integer | | Phase2 key life in number of bytes of traffic (5120 - 4294967295). |
| | **keylifeseconds** integer | | Phase2 key life in time in seconds (120 - 172800). |
| | **l2tp** string | **Choices:*** enable
* disable
| Enable/disable L2TP over IPsec. |
| | **name** string / required | | IPsec tunnel name. |
| | **pfs** string | **Choices:*** enable
* disable
| Enable/disable PFS feature. |
| | **phase1name** string | | Phase 1 determines the options required for phase 2. Source vpn.ipsec.phase1-interface.name. |
| | **proposal** list / elements=string | **Choices:*** null-md5
* null-sha1
* null-sha256
* null-sha384
* null-sha512
* des-null
* des-md5
* des-sha1
* des-sha256
* des-sha384
* des-sha512
* 3des-null
* 3des-md5
* 3des-sha1
* 3des-sha256
* 3des-sha384
* 3des-sha512
* aes128-null
* aes128-md5
* aes128-sha1
* aes128-sha256
* aes128-sha384
* aes128-sha512
* aes128gcm
* aes192-null
* aes192-md5
* aes192-sha1
* aes192-sha256
* aes192-sha384
* aes192-sha512
* aes256-null
* aes256-md5
* aes256-sha1
* aes256-sha256
* aes256-sha384
* aes256-sha512
* aes256gcm
* chacha20poly1305
* aria128-null
* aria128-md5
* aria128-sha1
* aria128-sha256
* aria128-sha384
* aria128-sha512
* aria192-null
* aria192-md5
* aria192-sha1
* aria192-sha256
* aria192-sha384
* aria192-sha512
* aria256-null
* aria256-md5
* aria256-sha1
* aria256-sha256
* aria256-sha384
* aria256-sha512
* seed-null
* seed-md5
* seed-sha1
* seed-sha256
* seed-sha384
* seed-sha512
| Phase2 proposal. |
| | **protocol** integer | | Quick mode protocol selector (1 - 255 or 0 for all). |
| | **replay** string | **Choices:*** enable
* disable
| Enable/disable replay detection. |
| | **route\_overlap** string | **Choices:*** use-old
* use-new
* allow
| Action for overlapping routes. |
| | **single\_source** string | **Choices:*** enable
* disable
| Enable/disable single source IP restriction. |
| | **src\_addr\_type** string | **Choices:*** subnet
* range
* ip
* name
* subnet6
* range6
* ip6
* name6
| Local proxy ID type. |
| | **src\_end\_ip** string | | Local proxy ID end. |
| | **src\_end\_ip6** string | | Local proxy ID IPv6 end. |
| | **src\_name** string | | Local proxy ID name. Source firewall.address.name firewall.addrgrp.name. |
| | **src\_name6** string | | Local proxy ID name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **src\_port** integer | | Quick mode source port (1 - 65535 or 0 for all). |
| | **src\_start\_ip** string | | Local proxy ID start. |
| | **src\_start\_ip6** string | | Local proxy ID IPv6 start. |
| | **src\_subnet** string | | Local proxy ID subnet. |
| | **src\_subnet6** string | | Local proxy ID IPv6 subnet. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VPN autokey tunnel.
fortios_vpn_ipsec_phase2_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_phase2_interface:
add_route: "phase1"
auto_discovery_forwarder: "phase1"
auto_discovery_sender: "phase1"
auto_negotiate: "enable"
comments: "<your_own_value>"
dhcp_ipsec: "enable"
dhgrp: "1"
diffserv: "enable"
diffservcode: "<your_own_value>"
dst_addr_type: "subnet"
dst_end_ip: "<your_own_value>"
dst_end_ip6: "<your_own_value>"
dst_name: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
dst_name6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
dst_port: "17"
dst_start_ip: "<your_own_value>"
dst_start_ip6: "<your_own_value>"
dst_subnet: "<your_own_value>"
dst_subnet6: "<your_own_value>"
encapsulation: "tunnel-mode"
initiator_ts_narrow: "enable"
ipv4_df: "enable"
keepalive: "enable"
keylife_type: "seconds"
keylifekbs: "27"
keylifeseconds: "28"
l2tp: "enable"
name: "default_name_30"
pfs: "enable"
phase1name: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
proposal: "null-md5"
protocol: "34"
replay: "enable"
route_overlap: "use-old"
single_source: "enable"
src_addr_type: "subnet"
src_end_ip: "<your_own_value>"
src_end_ip6: "<your_own_value>"
src_name: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
src_name6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
src_port: "43"
src_start_ip: "<your_own_value>"
src_start_ip6: "<your_own_value>"
src_subnet: "<your_own_value>"
src_subnet6: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_operator_name – Configure operator friendly name in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_h2qp\_operator\_name – Configure operator friendly name in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_operator_name`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller\_hotspot20 feature and h2qp\_operator\_name 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_hotspot20\_h2qp\_operator\_name** dictionary | | Configure operator friendly name. |
| | **name** string / required | | Friendly name ID. |
| | **value\_list** list / elements=string | | Name list. |
| | | **index** integer / required | | Value index. |
| | | **lang** string | | Language code. |
| | | **value** string | | Friendly name value. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure operator friendly name.
fortios_wireless_controller_hotspot20_h2qp_operator_name:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_h2qp_operator_name:
name: "default_name_3"
value_list:
-
index: "5"
lang: "<your_own_value>"
value: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_qos_dot1p_map – Configure FortiSwitch QoS 802.1p in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_qos\_dot1p\_map – Configure FortiSwitch QoS 802.1p in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_qos_dot1p_map`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_qos feature and dot1p\_map 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_qos\_dot1p\_map** dictionary | | Configure FortiSwitch QoS 802.1p. |
| | **description** string | | Description of the 802.1p name. |
| | **egress\_pri\_tagging** string | **Choices:*** disable
* enable
| Enable/disable egress priority-tag frame. |
| | **name** string / required | | Dot1p map name. |
| | **priority\_0** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_1** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_2** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_3** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_4** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_5** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_6** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| | **priority\_7** string | **Choices:*** queue-0
* queue-1
* queue-2
* queue-3
* queue-4
* queue-5
* queue-6
* queue-7
| COS queue mapped to dot1p priority number. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch QoS 802.1p.
fortios_switch_controller_qos_dot1p_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_qos_dot1p_map:
description: "<your_own_value>"
egress_pri_tagging: "disable"
name: "default_name_5"
priority_0: "queue-0"
priority_1: "queue-0"
priority_2: "queue-0"
priority_3: "queue-0"
priority_4: "queue-0"
priority_5: "queue-0"
priority_6: "queue-0"
priority_7: "queue-0"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_report_style – Report style configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_style – Report style configuration in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_report_style`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and style 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **report\_style** dictionary | | Report style configuration. |
| | **align** string | **Choices:*** left
* center
* right
* justify
| Alignment. |
| | **bg\_color** string | | Background color. |
| | **border\_bottom** string | | Border bottom. |
| | **border\_left** string | | Border left. |
| | **border\_right** string | | Border right. |
| | **border\_top** string | | Border top. |
| | **column\_gap** string | | Column gap. |
| | **column\_span** string | **Choices:*** none
* all
| Column span. |
| | **fg\_color** string | | Foreground color. |
| | **font\_family** string | **Choices:*** Verdana
* Arial
* Helvetica
* Courier
* Times
| Font family. |
| | **font\_size** string | | Font size. |
| | **font\_style** string | **Choices:*** normal
* italic
| Font style. |
| | **font\_weight** string | **Choices:*** normal
* bold
| Font weight. |
| | **height** string | | Height. |
| | **line\_height** string | | Text line height. |
| | **margin\_bottom** string | | Margin bottom. |
| | **margin\_left** string | | Margin left. |
| | **margin\_right** string | | Margin right. |
| | **margin\_top** string | | Margin top. |
| | **name** string / required | | Report style name. |
| | **options** list / elements=string | **Choices:*** font
* text
* color
* align
* size
* margin
* border
* padding
* column
| Report style options. |
| | **padding\_bottom** string | | Padding bottom. |
| | **padding\_left** string | | Padding left. |
| | **padding\_right** string | | Padding right. |
| | **padding\_top** string | | Padding top. |
| | **width** string | | Width. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Report style configuration.
fortios_report_style:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_style:
align: "left"
bg_color: "<your_own_value>"
border_bottom: "<your_own_value>"
border_left: "<your_own_value>"
border_right: "<your_own_value>"
border_top: "<your_own_value>"
column_gap: "<your_own_value>"
column_span: "none"
fg_color: "<your_own_value>"
font_family: "Verdana"
font_size: "<your_own_value>"
font_style: "normal"
font_weight: "normal"
height: "<your_own_value>"
line_height: "<your_own_value>"
margin_bottom: "<your_own_value>"
margin_left: "<your_own_value>"
margin_right: "<your_own_value>"
margin_top: "<your_own_value>"
name: "default_name_22"
options: "font"
padding_bottom: "<your_own_value>"
padding_left: "<your_own_value>"
padding_right: "<your_own_value>"
padding_top: "<your_own_value>"
width: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_fortianalyzer3_override_filter – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer3\_override\_filter – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_fortianalyzer3_override_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_fortianalyzer3 feature and override\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_fortianalyzer3\_override\_filter** dictionary | | Override filters for FortiAnalyzer. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **filter** string | | FortiAnalyzer 3 log filter. |
| | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | **forward\_traffic** string | **Choices:*** enable
* disable
| Enable/disable forward traffic logging. |
| | **free\_style** list / elements=string | | Free Style Filters |
| | | **category** string | **Choices:*** traffic
* event
* virus
* webfilter
* attack
* spam
* anomaly
* voip
* dlp
* app-ctrl
* waf
* gtp
* dns
* ssh
* ssl
* file-filter
* icap
| Log category. |
| | | **filter** string | | Free style filter string. |
| | | **filter\_type** string | **Choices:*** include
* exclude
| Include/exclude logs that match the filter. |
| | | **id** integer / required | | Entry ID. |
| | **gtp** string | **Choices:*** enable
* disable
| Enable/disable GTP messages logging. |
| | **local\_traffic** string | **Choices:*** enable
* disable
| Enable/disable local in or out traffic logging. |
| | **multicast\_traffic** string | **Choices:*** enable
* disable
| Enable/disable multicast traffic logging. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| | **sniffer\_traffic** string | **Choices:*** enable
* disable
| Enable/disable sniffer traffic logging. |
| | **voip** string | **Choices:*** enable
* disable
| Enable/disable VoIP logging. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Override filters for FortiAnalyzer.
fortios_log_fortianalyzer3_override_filter:
vdom: "{{ vdom }}"
log_fortianalyzer3_override_filter:
anomaly: "enable"
dlp_archive: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
severity: "emergency"
sniffer_traffic: "enable"
voip: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_videofilter_youtube_channel_filter – Configure YouTube channel filter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_videofilter\_youtube\_channel\_filter – Configure YouTube channel filter in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_videofilter_youtube_channel_filter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify videofilter feature and youtube\_channel\_filter 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **videofilter\_youtube\_channel\_filter** dictionary | | Configure YouTube channel filter. |
| | **comment** string | | Comment. |
| | **entries** list / elements=string | | YouTube filter entries. |
| | | **action** string | **Choices:*** bypass
* monitor
* block
| YouTube channel filter action. |
| | | **channel\_id** string | | Channel ID. |
| | | **comment** string | | Comment. |
| | | **id** integer / required | | ID. |
| | **id** integer / required | | ID. |
| | **name** string | | Name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure YouTube channel filter.
fortios_videofilter_youtube_channel_filter:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
videofilter_youtube_channel_filter:
comment: "Comment."
entries:
-
action: "bypass"
channel_id: "<your_own_value>"
comment: "Comment."
id: "8"
id: "9"
name: "default_name_10"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_lldp_network_policy – Configure LLDP network policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_lldp\_network\_policy – Configure LLDP network policy in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_lldp_network_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_lldp feature and network\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_lldp\_network\_policy** dictionary | | Configure LLDP network policy. |
| | **comment** string | | Comment. |
| | **guest** dictionary | | Guest. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **guest\_voice\_signaling** dictionary | | Guest Voice Signaling. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **name** string / required | | LLDP network policy name. |
| | **softphone** dictionary | | Softphone. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **streaming\_video** dictionary | | Streaming Video. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **video\_conferencing** dictionary | | Video Conferencing. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **video\_signaling** dictionary | | Video Signaling. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **voice** dictionary | | Voice. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| | **voice\_signaling** dictionary | | Voice signaling. |
| | | **dscp** integer | | Differentiated Services Code Point (DSCP) value to advertise. |
| | | **priority** integer | | 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable advertising this policy. |
| | | **tag** string | **Choices:*** none
* dot1q
* dot1p
| Advertise tagged or untagged traffic. |
| | | **vlan** integer | | 802.1Q VLAN ID to advertise (1 - 4094). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure LLDP network policy.
fortios_system_lldp_network_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_lldp_network_policy:
comment: "Comment."
guest:
dscp: "5"
priority: "6"
status: "disable"
tag: "none"
vlan: "9"
guest_voice_signaling:
dscp: "11"
priority: "12"
status: "disable"
tag: "none"
vlan: "15"
name: "default_name_16"
softphone:
dscp: "18"
priority: "19"
status: "disable"
tag: "none"
vlan: "22"
streaming_video:
dscp: "24"
priority: "25"
status: "disable"
tag: "none"
vlan: "28"
video_conferencing:
dscp: "30"
priority: "31"
status: "disable"
tag: "none"
vlan: "34"
video_signaling:
dscp: "36"
priority: "37"
status: "disable"
tag: "none"
vlan: "40"
voice:
dscp: "42"
priority: "43"
status: "disable"
tag: "none"
vlan: "46"
voice_signaling:
dscp: "48"
priority: "49"
status: "disable"
tag: "none"
vlan: "52"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_ike – Configure IKE global attributes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ike – Configure IKE global attributes in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_ike`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ike 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_ike** dictionary | | Configure IKE global attributes. |
| | **dh\_group\_1** dictionary | | Diffie-Hellman group 1 (MODP-768). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_14** dictionary | | Diffie-Hellman group 14 (MODP-2048). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_15** dictionary | | Diffie-Hellman group 15 (MODP-3072). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_16** dictionary | | Diffie-Hellman group 16 (MODP-4096). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_17** dictionary | | Diffie-Hellman group 17 (MODP-6144). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_18** dictionary | | Diffie-Hellman group 18 (MODP-8192). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_19** dictionary | | Diffie-Hellman group 19 (EC-P256). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_2** dictionary | | Diffie-Hellman group 2 (MODP-1024). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_20** dictionary | | Diffie-Hellman group 20 (EC-P384). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_21** dictionary | | Diffie-Hellman group 21 (EC-P521). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_27** dictionary | | Diffie-Hellman group 27 (EC-P224BP). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_28** dictionary | | Diffie-Hellman group 28 (EC-P256BP). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_29** dictionary | | Diffie-Hellman group 29 (EC-P384BP). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_30** dictionary | | Diffie-Hellman group 30 (EC-P512BP). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_31** dictionary | | Diffie-Hellman group 31 (EC-X25519). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_32** dictionary | | Diffie-Hellman group 32 (EC-X448). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_group\_5** dictionary | | Diffie-Hellman group 5 (MODP-1536). |
| | | **keypair\_cache** string | **Choices:*** global
* custom
| Configure custom key pair cache size for this Diffie-Hellman group. |
| | | **keypair\_count** integer | | Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). |
| | | **mode** string | **Choices:*** software
* hardware
* global
| Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. |
| | **dh\_keypair\_cache** string | **Choices:*** enable
* disable
| Enable/disable Diffie-Hellman key pair cache. |
| | **dh\_keypair\_count** integer | | Number of key pairs to pre-generate for each Diffie-Hellman group (per-worker). |
| | **dh\_keypair\_throttle** string | **Choices:*** enable
* disable
| Enable/disable Diffie-Hellman key pair cache CPU throttling. |
| | **dh\_mode** string | **Choices:*** software
* hardware
| Use software (CPU) or hardware (CPX) to perform Diffie-Hellman calculations. |
| | **dh\_multiprocess** string | **Choices:*** enable
* disable
| Enable/disable multiprocess Diffie-Hellman daemon for IKE. |
| | **dh\_worker\_count** integer | | Number of Diffie-Hellman workers to start. |
| | **embryonic\_limit** integer | | Maximum number of IPsec tunnels to negotiate simultaneously. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IKE global attributes.
fortios_system_ike:
vdom: "{{ vdom }}"
system_ike:
dh_group_1:
keypair_cache: "global"
keypair_count: "5"
mode: "software"
dh_group_14:
keypair_cache: "global"
keypair_count: "9"
mode: "software"
dh_group_15:
keypair_cache: "global"
keypair_count: "13"
mode: "software"
dh_group_16:
keypair_cache: "global"
keypair_count: "17"
mode: "software"
dh_group_17:
keypair_cache: "global"
keypair_count: "21"
mode: "software"
dh_group_18:
keypair_cache: "global"
keypair_count: "25"
mode: "software"
dh_group_19:
keypair_cache: "global"
keypair_count: "29"
mode: "software"
dh_group_2:
keypair_cache: "global"
keypair_count: "33"
mode: "software"
dh_group_20:
keypair_cache: "global"
keypair_count: "37"
mode: "software"
dh_group_21:
keypair_cache: "global"
keypair_count: "41"
mode: "software"
dh_group_27:
keypair_cache: "global"
keypair_count: "45"
mode: "software"
dh_group_28:
keypair_cache: "global"
keypair_count: "49"
mode: "software"
dh_group_29:
keypair_cache: "global"
keypair_count: "53"
mode: "software"
dh_group_30:
keypair_cache: "global"
keypair_count: "57"
mode: "software"
dh_group_31:
keypair_cache: "global"
keypair_count: "61"
mode: "software"
dh_group_32:
keypair_cache: "global"
keypair_count: "65"
mode: "software"
dh_group_5:
keypair_cache: "global"
keypair_count: "69"
mode: "software"
dh_keypair_cache: "enable"
dh_keypair_count: "72"
dh_keypair_throttle: "enable"
dh_mode: "software"
dh_multiprocess: "enable"
dh_worker_count: "76"
embryonic_limit: "77"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_dlp_settings – Designate logical storage for DLP fingerprint database in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dlp\_settings – Designate logical storage for DLP fingerprint database in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dlp_settings`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and settings 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dlp\_settings** dictionary | | Designate logical storage for DLP fingerprint database. |
| | **cache\_mem\_percent** integer | | Maximum percentage of available memory allocated to caching (1 - 15%). |
| | **chunk\_size** integer | | Maximum fingerprint chunk size. \*\*Changing will flush the entire database\*\*. |
| | **db\_mode** string | **Choices:*** stop-adding
* remove-modified-then-oldest
* remove-oldest
| Behaviour when the maximum size is reached. |
| | **size** integer | | Maximum total size of files within the storage (MB). |
| | **storage\_device** string | | Storage device name. Source system.storage.name. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Designate logical storage for DLP fingerprint database.
fortios_dlp_settings:
vdom: "{{ vdom }}"
dlp_settings:
cache_mem_percent: "3"
chunk_size: "4"
db_mode: "stop-adding"
size: "6"
storage_device: "<your_own_value> (source system.storage.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_profile_group – Configure profile groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_profile\_group – Configure profile groups in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_profile_group`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile\_group 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_profile\_group** dictionary | | Configure profile groups. |
| | **application\_list** string | | Name of an existing Application list. Source application.list.name. |
| | **av\_profile** string | | Name of an existing Antivirus profile. Source antivirus.profile.name. |
| | **cifs\_profile** string | | Name of an existing CIFS profile. Source cifs.profile.name. |
| | **dlp\_sensor** string | | Name of an existing DLP sensor. Source dlp.sensor.name. |
| | **dnsfilter\_profile** string | | Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **file\_filter\_profile** string | | Name of an existing file-filter profile. Source file-filter.profile.name. |
| | **icap\_profile** string | | Name of an existing ICAP profile. Source icap.profile.name. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **mms\_profile** string | | Name of an existing MMS profile. Source firewall.mms-profile.name. |
| | **name** string / required | | Profile group name. |
| | **profile\_protocol\_options** string | | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
| | **spamfilter\_profile** string | | Name of an existing Spam filter profile. Source spamfilter.profile.name. |
| | **ssh\_filter\_profile** string | | Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
| | **ssl\_ssh\_profile** string | | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
| | **videofilter\_profile** string | | Name of an existing VideoFilter profile. Source videofilter.profile.name. |
| | **voip\_profile** string | | Name of an existing VoIP profile. Source voip.profile.name. |
| | **waf\_profile** string | | Name of an existing Web application firewall profile. Source waf.profile.name. |
| | **webfilter\_profile** string | | Name of an existing Web filter profile. Source webfilter.profile.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure profile groups.
fortios_firewall_profile_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_profile_group:
application_list: "<your_own_value> (source application.list.name)"
av_profile: "<your_own_value> (source antivirus.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
icap_profile: "<your_own_value> (source icap.profile.name)"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_13"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
voip_profile: "<your_own_value> (source voip.profile.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_port_policy – Configure port policy to be applied on the managed FortiSwitch ports through NAC device in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_port\_policy – Configure port policy to be applied on the managed FortiSwitch ports through NAC device in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_port_policy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller feature and port\_policy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_port\_policy** dictionary | | Configure port policy to be applied on the managed FortiSwitch ports through NAC device. |
| | **802\_1x** string | | 802.1x security policy to be applied when using this port-policy. Source switch-controller.security-policy.802-1X.name switch-controller .security-policy.captive-portal.name. |
| | **bounce\_port\_link** string | **Choices:*** disable
* enable
| Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. |
| | **description** string | | Description for the port policy. |
| | **fortilink** string | | FortiLink interface for which this port policy belongs to. Source system.interface.name. |
| | **lldp\_profile** string | | LLDP profile to be applied when using this port-policy. Source switch-controller.lldp-profile.name. |
| | **name** string / required | | Port policy name. |
| | **qos\_policy** string | | QoS policy to be applied when using this port-policy. Source switch-controller.qos.qos-policy.name. |
| | **vlan\_policy** string | | VLAN policy to be applied when using this port-policy. Source switch-controller.vlan-policy.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure port policy to be applied on the managed FortiSwitch ports through NAC device.
fortios_switch_controller_port_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_port_policy:
802_1x: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name)"
bounce_port_link: "disable"
description: "<your_own_value>"
fortilink: "<your_own_value> (source system.interface.name)"
lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
name: "default_name_8"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
vlan_policy: "<your_own_value> (source switch-controller.vlan-policy.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_firewall_access_proxy – Configure Access Proxy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_access\_proxy – Configure Access Proxy in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_firewall_access_proxy`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and access\_proxy 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_access\_proxy** dictionary | | Configure Access Proxy. |
| | **api\_gateway** list / elements=string | | Set API Gateway. |
| | | **http\_cookie\_age** integer | | Time in minutes that client web browsers should keep a cookie. Default is 60 minutes. 0 = no time limit. |
| | | **http\_cookie\_domain** string | | Domain that HTTP cookie persistence should apply to. |
| | | **http\_cookie\_domain\_from\_host** string | **Choices:*** disable
* enable
| Enable/disable use of HTTP cookie domain from host field in HTTP. |
| | | **http\_cookie\_generation** integer | | Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. |
| | | **http\_cookie\_path** string | | Limit HTTP cookie persistence to the specified path. |
| | | **http\_cookie\_share** string | **Choices:*** disable
* same-ip
| Control sharing of cookies across API Gateway. same-ip means a cookie from one virtual server can be used by another. Disable stops cookie sharing. |
| | | **https\_cookie\_secure** string | **Choices:*** disable
* enable
| Enable/disable verification that inserted HTTPS cookies are secure. |
| | | **id** integer / required | | API Gateway ID. |
| | | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
* http-host
| Method used to distribute sessions to real servers. |
| | | **persistence** string | **Choices:*** none
* http-cookie
| Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. |
| | | **realservers** list / elements=string | | Select the real servers that this Access Proxy will distribute traffic to. |
| | | | **address** string | | Address or address group of the real server. Source firewall.address.name firewall.addrgrp.name. |
| | | | **health\_check** string | **Choices:*** disable
* enable
| Enable to check the responsiveness of the real server before forwarding traffic. |
| | | | **health\_check\_proto** string | **Choices:*** ping
* http
* tcp-connect
| Protocol of the health check monitor to use when polling to determine server"s connectivity status. |
| | | | **http\_host** string | | HTTP server domain name in HTTP header. |
| | | | **id** integer / required | | Real server ID. |
| | | | **ip** string | | IP address of the real server. |
| | | | **mappedport** string | | Port for communicating with the real server. |
| | | | **port** integer | | Port for communicating with the real server. |
| | | | **status** string | **Choices:*** active
* standby
* disable
| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. |
| | | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| | | **saml\_server** string | | SAML service provider configuration for VIP authentication. Source user.saml.name. |
| | | **service** string | **Choices:*** http
* https
* tcp-forwarding
* samlsp
| Service. |
| | | **ssl\_algorithm** string | **Choices:*** high
* medium
* low
* custom
| Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. |
| | | **ssl\_cipher\_suites** list / elements=string | | SSL/TLS cipher suites to offer to a server, ordered by priority. |
| | | | **cipher** string | **Choices:*** TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA
* TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
* TLS-DHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA
* TLS-DHE-DSS-WITH-AES-128-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-128-GCM-SHA256
* TLS-DHE-DSS-WITH-AES-256-CBC-SHA256
* TLS-DHE-DSS-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
* TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-AES-128-CBC-SHA
* TLS-RSA-WITH-AES-256-CBC-SHA
* TLS-RSA-WITH-AES-128-CBC-SHA256
* TLS-RSA-WITH-AES-128-GCM-SHA256
* TLS-RSA-WITH-AES-256-CBC-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384
* TLS-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256
* TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-RSA-WITH-DES-CBC-SHA
| Cipher suite name. |
| | | | **priority** integer / required | | SSL/TLS cipher suites priority. |
| | | | **versions** string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| SSL/TLS versions that the cipher suite can be used with. |
| | | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
* 3072
* 4096
| Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. |
| | | **ssl\_max\_version** string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version acceptable from a server. |
| | | **ssl\_min\_version** string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version acceptable from a server. |
| | | **url\_map** string | | URL pattern to match. |
| | | **url\_map\_type** string | **Choices:*** sub-string
* wildcard
* regex
| Type of url-map. |
| | | **virtual\_host** string | | Virtual host. Source firewall.access-proxy-virtual-host.name. |
| | **client\_cert** string | **Choices:*** disable
* enable
| Enable/disable to request client certificate. |
| | **empty\_cert\_action** string | **Choices:*** accept
* block
| Action of an empty client certificate. |
| | **ldb\_method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| Method used to distribute sessions to SSL real servers. |
| | **name** string / required | | Access Proxy name. |
| | **realservers** list / elements=string | | Select the SSL real servers that this Access Proxy will distribute traffic to. |
| | | **id** integer / required | | Real server ID. |
| | | **ip** string | | IP address of the real server. |
| | | **port** integer | | Port for communicating with the real server. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. |
| | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| | **server\_pubkey\_auth** string | **Choices:*** disable
* enable
| Enable/disable SSH real server public key authentication. |
| | **server\_pubkey\_auth\_settings** dictionary | | Server SSH public key authentication settings. |
| | | **auth\_ca** string | | Name of the SSH server public key authentication CA. Source firewall.ssh.local-ca.name. |
| | | **cert\_extension** list / elements=string | | Configure certificate extension for user certificate. |
| | | | **critical** string | **Choices:*** False
* True
| Critical option. |
| | | | **data** string | | Name of certificate extension. |
| | | | **name** string / required | | Name of certificate extension. |
| | | | **type** string | **Choices:*** fixed
* user
| Type of certificate extension. |
| | | **permit\_agent\_forwarding** string | **Choices:*** enable
* disable
| Enable/disable appending permit-agent-forwarding certificate extension. |
| | | **permit\_port\_forwarding** string | **Choices:*** enable
* disable
| Enable/disable appending permit-port-forwarding certificate extension. |
| | | **permit\_pty** string | **Choices:*** enable
* disable
| Enable/disable appending permit-pty certificate extension. |
| | | **permit\_user\_rc** string | **Choices:*** enable
* disable
| Enable/disable appending permit-user-rc certificate extension. |
| | | **permit\_x11\_forwarding** string | **Choices:*** enable
* disable
| Enable/disable appending permit-x11-forwarding certificate extension. |
| | | **source\_address** string | **Choices:*** enable
* disable
| Enable/disable appending source-address certificate critical option. This option ensure certificate only accepted from FortiGate source address. |
| | **vip** string | | Virtual IP name. Source firewall.vip.name. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Access Proxy.
fortios_firewall_access_proxy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_access_proxy:
api_gateway:
-
http_cookie_age: "4"
http_cookie_domain: "<your_own_value>"
http_cookie_domain_from_host: "disable"
http_cookie_generation: "7"
http_cookie_path: "<your_own_value>"
http_cookie_share: "disable"
https_cookie_secure: "disable"
id: "11"
ldb_method: "static"
persistence: "none"
realservers:
-
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
health_check: "disable"
health_check_proto: "ping"
http_host: "myhostname"
id: "19"
ip: "<your_own_value>"
mappedport: "<your_own_value>"
port: "22"
status: "active"
weight: "24"
saml_server: "<your_own_value> (source user.saml.name)"
service: "http"
ssl_algorithm: "high"
ssl_cipher_suites:
-
cipher: "TLS-AES-128-GCM-SHA256"
priority: "30"
versions: "tls-1.0"
ssl_dh_bits: "768"
ssl_max_version: "tls-1.0"
ssl_min_version: "tls-1.0"
url_map: "<your_own_value>"
url_map_type: "sub-string"
virtual_host: "myhostname (source firewall.access-proxy-virtual-host.name)"
client_cert: "disable"
empty_cert_action: "accept"
ldb_method: "static"
name: "default_name_41"
realservers:
-
id: "43"
ip: "<your_own_value>"
port: "45"
status: "active"
weight: "47"
server_pubkey_auth: "disable"
server_pubkey_auth_settings:
auth_ca: "<your_own_value> (source firewall.ssh.local-ca.name)"
cert_extension:
-
critical: "no"
data: "<your_own_value>"
name: "default_name_54"
type: "fixed"
permit_agent_forwarding: "enable"
permit_port_forwarding: "enable"
permit_pty: "enable"
permit_user_rc: "enable"
permit_x11_forwarding: "enable"
source_address: "enable"
vip: "<your_own_value> (source firewall.vip.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_user_local – Configure local users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_local – Configure local users in Fortinet’s FortiOS and FortiGate.
==================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_local`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and local 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_local** dictionary | | Configure local users. |
| | **auth\_concurrent\_override** string | **Choices:*** enable
* disable
| Enable/disable overriding the policy-auth-concurrent under config system global. |
| | **auth\_concurrent\_value** integer | | Maximum number of concurrent logins permitted from the same user. |
| | **authtimeout** integer | | Time in minutes before the authentication timeout for a user is reached. |
| | **email\_to** string | | Two-factor recipient"s email address. |
| | **fortitoken** string | | Two-factor recipient"s FortiToken serial number. Source user.fortitoken.serial-number. |
| | **id** integer | | User ID. |
| | **ldap\_server** string | | Name of LDAP server with which the user must authenticate. Source user.ldap.name. |
| | **name** string / required | | User name. |
| | **passwd** string | | User"s password. |
| | **passwd\_policy** string | | Password policy to apply to this user, as defined in config user password-policy. Source user.password-policy.name. |
| | **passwd\_time** string | | Time of the last password update. |
| | **ppk\_identity** string | | IKEv2 Postquantum Preshared Key Identity. |
| | **ppk\_secret** string | | IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). |
| | **radius\_server** string | | Name of RADIUS server with which the user must authenticate. Source user.radius.name. |
| | **sms\_custom\_server** string | | Two-factor recipient"s SMS server. Source system.sms-server.name. |
| | **sms\_phone** string | | Two-factor recipient"s mobile phone number. |
| | **sms\_server** string | **Choices:*** fortiguard
* custom
| Send SMS through FortiGuard or other external server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable allowing the local user to authenticate with the FortiGate unit. |
| | **tacacs+\_server** string | | Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name. |
| | **two\_factor** string | **Choices:*** disable
* fortitoken
* email
* sms
* fortitoken-cloud
| Enable/disable two-factor authentication. |
| | **two\_factor\_authentication** string | **Choices:*** fortitoken
* email
* sms
| Authentication method by FortiToken Cloud. |
| | **two\_factor\_notification** string | **Choices:*** email
* sms
| Notification method for user activation by FortiToken Cloud. |
| | **type** string | **Choices:*** password
* radius
* tacacs+
* ldap
| Authentication method. |
| | **username\_case\_sensitivity** string | **Choices:*** disable
* enable
| Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). |
| | **workstation** string | | Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure local users.
fortios_user_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_local:
auth_concurrent_override: "enable"
auth_concurrent_value: "4"
authtimeout: "5"
email_to: "<your_own_value>"
fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
id: "8"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_10"
passwd: "<your_own_value>"
passwd_policy: "<your_own_value> (source user.password-policy.name)"
passwd_time: "<your_own_value>"
ppk_identity: "<your_own_value>"
ppk_secret: "<your_own_value>"
radius_server: "<your_own_value> (source user.radius.name)"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_phone: "<your_own_value>"
sms_server: "fortiguard"
status: "enable"
tacacs+_server: "<your_own_value> (source user.tacacs+.name)"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_notification: "email"
type: "password"
username_case_sensitivity: "disable"
workstation: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_vpn_ipsec_manualkey – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_manualkey – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_vpn_ipsec_manualkey`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn\_ipsec feature and manualkey 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **vpn\_ipsec\_manualkey** dictionary | | Configure IPsec manual keys. |
| | **authentication** string | **Choices:*** **None** ←
* md5
* sha1
* sha256
* sha384
* sha512
| Authentication algorithm. Must be the same for both ends of the tunnel. |
| | **authkey** string | | Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens. |
| | **enckey** string | | Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens. |
| | **encryption** string | **Choices:*** **None** ←
* des
* 3des
* aes128
* aes192
* aes256
* aria128
* aria192
* aria256
* seed
| Encryption algorithm. Must be the same for both ends of the tunnel. |
| | **interface** string | | Name of the physical, aggregate, or VLAN interface. Source system.interface.name. |
| | **local\_gw** string | | Local gateway. |
| | **localspi** string | | Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules. |
| | **name** string / required | | IPsec tunnel name. |
| | **npu\_offload** string | **Choices:*** enable
* disable
| Enable/disable NPU offloading. |
| | **remote\_gw** string | | Peer gateway. |
| | **remotespi** string | | Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPsec manual keys.
fortios_vpn_ipsec_manualkey:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_manualkey:
authentication: "null"
authkey: "<your_own_value>"
enckey: "<your_own_value>"
encryption: "null"
interface: "<your_own_value> (source system.interface.name)"
local_gw: "<your_own_value>"
localspi: "<your_own_value>"
name: "default_name_10"
npu_offload: "enable"
remote_gw: "<your_own_value>"
remotespi: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_auto_config_custom – Policies which can override the ‘default’ for specific ISL/ICL/FortiLink interface in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_auto\_config\_custom – Policies which can override the ‘default’ for specific ISL/ICL/FortiLink interface in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_auto_config_custom`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_auto\_config feature and custom 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_auto\_config\_custom** dictionary | | Policies which can override the 'default' for specific ISL/ICL/FortiLink interface. |
| | **name** string / required | | Auto-Config FortiLink or ISL/ICL interface name. |
| | **switch\_binding** list / elements=string | | Switch binding list. |
| | | **policy** string | | Custom auto-config policy. Source switch-controller.auto-config.policy.name. |
| | | **switch\_id** string | | Switch name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Policies which can override the 'default' for specific ISL/ICL/FortiLink interface.
fortios_switch_controller_auto_config_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_auto_config_custom:
name: "default_name_3"
switch_binding:
-
policy: "<your_own_value> (source switch-controller.auto-config.policy.name)"
switch_id: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_federated_upgrade – Coordinate federated upgrades within the Security Fabric in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_federated\_upgrade – Coordinate federated upgrades within the Security Fabric in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_federated_upgrade`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and federated\_upgrade 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_federated\_upgrade** dictionary | | Coordinate federated upgrades within the Security Fabric. |
| | **node\_list** list / elements=string | | Nodes which will be included in the upgrade. |
| | | **coordinating\_fortigate** string | | The serial of the FortiGate that controls this device |
| | | **device\_type** string | **Choices:*** fortigate
* fortiswitch
* fortiap
| What type of device this node represents. |
| | | **serial** string / required | | Serial number of the node to include. |
| | | **setup\_time** string | | When the upgrade was configured. Format hh:mm yyyy/mm/dd UTC. |
| | | **time** string | | Scheduled time for the upgrade. Format hh:mm yyyy/mm/dd UTC. |
| | | **timing** string | **Choices:*** immediate
* scheduled
| Whether the upgrade should be run immediately, or at a scheduled time. |
| | | **upgrade\_path** string | | Image IDs to upgrade through. |
| | **status** string | **Choices:*** disabled
* initialized
* downloading
* download-failed
* device-disconnected
* ready
* staging
* cancelled
* confirmed
* done
* failed
| Current status of the upgrade. |
| | **upgrade\_id** integer | | Unique identifier for this upgrade. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Coordinate federated upgrades within the Security Fabric.
fortios_system_federated_upgrade:
vdom: "{{ vdom }}"
system_federated_upgrade:
node_list:
-
coordinating_fortigate: "<your_own_value>"
device_type: "fortigate"
serial: "<your_own_value>"
setup_time: "<your_own_value>"
time: "<your_own_value>"
timing: "immediate"
upgrade_path: "<your_own_value>"
status: "disabled"
upgrade_id: "12"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_waf_main_class – Hidden table for datasource in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_waf\_main\_class – Hidden table for datasource in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_waf_main_class`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf feature and main\_class 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **waf\_main\_class** dictionary | | Hidden table for datasource. |
| | **id** integer / required | | Main signature class ID. |
| | **name** string | | Main signature class name. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Hidden table for datasource.
fortios_waf_main_class:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
waf_main_class:
id: "3"
name: "default_name_4"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_switch_controller_initial_config_vlans – Configure initial template for auto-generated VLAN interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_initial\_config\_vlans – Configure initial template for auto-generated VLAN interfaces in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_switch_controller_initial_config_vlans`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch\_controller\_initial\_config feature and vlans 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **switch\_controller\_initial\_config\_vlans** dictionary | | Configure initial template for auto-generated VLAN interfaces. |
| | **default\_vlan** string | | Default VLAN (native) assigned to all switch ports upon discovery. Source switch-controller.initial-config.template.name. |
| | **nac** string | | VLAN for NAC onboarding devices. Source switch-controller.initial-config.template.name. |
| | **quarantine** string | | VLAN for quarantined traffic. Source switch-controller.initial-config.template.name. |
| | **rspan** string | | VLAN for RSPAN/ERSPAN mirrored traffic. Source switch-controller.initial-config.template.name. |
| | **video** string | | VLAN dedicated for video devices. Source switch-controller.initial-config.template.name. |
| | **voice** string | | VLAN dedicated for voice devices. Source switch-controller.initial-config.template.name. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure initial template for auto-generated VLAN interfaces.
fortios_switch_controller_initial_config_vlans:
vdom: "{{ vdom }}"
switch_controller_initial_config_vlans:
default_vlan: "<your_own_value> (source switch-controller.initial-config.template.name)"
nac: "<your_own_value> (source switch-controller.initial-config.template.name)"
quarantine: "<your_own_value> (source switch-controller.initial-config.template.name)"
rspan: "<your_own_value> (source switch-controller.initial-config.template.name)"
video: "<your_own_value> (source switch-controller.initial-config.template.name)"
voice: "<your_own_value> (source switch-controller.initial-config.template.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_wtp_status – Wireless controller WTP-status in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wtp\_status – Wireless controller WTP-status in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_wtp_status`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and wtp\_status 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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. |
| **wireless\_controller\_wtp\_status** dictionary | | Wireless controller WTP-status. |
| | string | | WTP ID. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Wireless controller WTP-status.
fortios_wireless_controller_wtp_status:
vdom: "{{ vdom }}"
wireless_controller_wtp_status:
<wtp_id>: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_user_saml – SAML server entry configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_saml – SAML server entry configuration in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_user_saml`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and saml 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_saml** dictionary | | SAML server entry configuration. |
| | **adfs\_claim** string | **Choices:*** enable
* disable
| Enable/disable ADFS Claim for user/group attribute in assertion statement . |
| | **cert** string | | Certificate to sign SAML messages. Source vpn.certificate.local.name. |
| | **digest\_method** string | **Choices:*** sha1
* sha256
| Digest Method Algorithm. . |
| | **entity\_id** string | | SP entity ID. |
| | **group\_claim\_type** string | **Choices:*** email
* given-name
* name
* upn
* common-name
* email-adfs-1x
* group
* upn-adfs-1x
* role
* sur-name
* ppid
* name-identifier
* authentication-method
* deny-only-group-sid
* deny-only-primary-sid
* deny-only-primary-group-sid
* group-sid
* primary-group-sid
* primary-sid
* windows-account-name
| Group claim in assertion statement. |
| | **group\_name** string | | Group name in assertion statement. |
| | **idp\_cert** string | | IDP Certificate name. Source vpn.certificate.remote.name. |
| | **idp\_entity\_id** string | | IDP entity ID. |
| | **idp\_single\_logout\_url** string | | IDP single logout url. |
| | **idp\_single\_sign\_on\_url** string | | IDP single sign-on URL. |
| | **limit\_relaystate** string | **Choices:*** enable
* disable
| Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). |
| | **name** string / required | | SAML server entry name. |
| | **single\_logout\_url** string | | SP single logout URL. |
| | **single\_sign\_on\_url** string | | SP single sign-on URL. |
| | **user\_claim\_type** string | **Choices:*** email
* given-name
* name
* upn
* common-name
* email-adfs-1x
* group
* upn-adfs-1x
* role
* sur-name
* ppid
* name-identifier
* authentication-method
* deny-only-group-sid
* deny-only-primary-sid
* deny-only-primary-group-sid
* group-sid
* primary-group-sid
* primary-sid
* windows-account-name
| User name claim in assertion statement. |
| | **user\_name** string | | User name in assertion statement. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SAML server entry configuration.
fortios_user_saml:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_saml:
adfs_claim: "enable"
cert: "<your_own_value> (source vpn.certificate.local.name)"
digest_method: "sha1"
entity_id: "<your_own_value>"
group_claim_type: "email"
group_name: "<your_own_value>"
idp_cert: "<your_own_value> (source vpn.certificate.remote.name)"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
limit_relaystate: "enable"
name: "default_name_14"
single_logout_url: "<your_own_value>"
single_sign_on_url: "<your_own_value>"
user_claim_type: "email"
user_name: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_dpdk_cpus – Configure CPUs enabled to run engines in each DPDK stage in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dpdk\_cpus – Configure CPUs enabled to run engines in each DPDK stage in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_dpdk_cpus`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dpdk feature and cpus 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **dpdk\_cpus** dictionary | | Configure CPUs enabled to run engines in each DPDK stage. |
| | **ips\_cpus** string | | CPUs enabled to run DPDK IPS engines. |
| | **rx\_cpus** string | | CPUs enabled to run DPDK RX engines. |
| | **tx\_cpus** string | | CPUs enabled to run DPDK TX engines. |
| | **vnp\_cpus** string | | CPUs enabled to run DPDK VNP engines. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure CPUs enabled to run engines in each DPDK stage.
fortios_dpdk_cpus:
vdom: "{{ vdom }}"
dpdk_cpus:
ips_cpus: "<your_own_value>"
rx_cpus: "<your_own_value>"
tx_cpus: "<your_own_value>"
vnp_cpus: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_netflow – Configure NetFlow in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_netflow – Configure NetFlow in Fortinet’s FortiOS and FortiGate.
==================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_netflow`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and netflow 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **system\_netflow** dictionary | | Configure NetFlow. |
| | **active\_flow\_timeout** integer | | Timeout to report active flows (1 - 60 min). |
| | **collector\_ip** string | | Collector IP. |
| | **collector\_port** integer | | NetFlow collector port number. |
| | **inactive\_flow\_timeout** integer | | Timeout for periodic report of finished flows (10 - 600 sec). |
| | **source\_ip** string | | Source IP address for communication with the NetFlow agent. |
| | **template\_tx\_counter** integer | | Counter of flowset records before resending a template flowset record. |
| | **template\_tx\_timeout** integer | | Timeout for periodic template flowset transmission (1 - 1440 min). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure NetFlow.
fortios_system_netflow:
vdom: "{{ vdom }}"
system_netflow:
active_flow_timeout: "3"
collector_ip: "<your_own_value>"
collector_port: "5"
inactive_flow_timeout: "6"
source_ip: "84.230.14.43"
template_tx_counter: "8"
template_tx_timeout: "9"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_wireless_controller_bonjour_profile – Configure Bonjour profiles. Bonjour is Apple’s zero configuration networking protocol. Bonjour profiles allow APs and FortiAPs to connnect to networks using Bonjour in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_bonjour\_profile – Configure Bonjour profiles. Bonjour is Apple’s zero configuration networking protocol. Bonjour profiles allow APs and FortiAPs to connnect to networks using Bonjour in Fortinet’s FortiOS and FortiGate.
============================================================================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_wireless_controller_bonjour_profile`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless\_controller feature and bonjour\_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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **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. |
| **wireless\_controller\_bonjour\_profile** dictionary | | Configure Bonjour profiles. Bonjour is Apple's zero configuration networking protocol. Bonjour profiles allow APs and FortiAPs to connnect to networks using Bonjour. |
| | **comment** string | | Comment. |
| | **name** string / required | | Bonjour profile name. |
| | **policy\_list** list / elements=string | | Bonjour policy list. |
| | | **description** string | | Description. |
| | | **from\_vlan** string | | VLAN ID from which the Bonjour service is advertised (0 - 4094). |
| | | **policy\_id** integer | | Policy ID. |
| | | **services** string | **Choices:*** all
* airplay
* afp
* bit-torrent
* ftp
* ichat
* itunes
* printers
* samba
* scanners
* ssh
* chromecast
| Bonjour services for the VLAN connecting to the Bonjour network. |
| | | **to\_vlan** string | | VLAN ID to which the Bonjour service is made available (0 - 4094). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Bonjour profiles. Bonjour is Apple's zero configuration networking protocol. Bonjour profiles allow APs and FortiAPs to connnect to
networks using Bonjour.
fortios_wireless_controller_bonjour_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_bonjour_profile:
comment: "Comment."
name: "default_name_4"
policy_list:
-
description: "<your_own_value>"
from_vlan: "<your_own_value>"
policy_id: "8"
services: "all"
to_vlan: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_system_external_resource – Configure external resource in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_external\_resource – Configure external resource in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_external_resource`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and external\_resource 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_external\_resource** dictionary | | Configure external resource. |
| | **category** integer | | User resource category. |
| | **comments** string | | Comment. |
| | **interface** string | | Specify outgoing interface to reach server. Source system.interface.name. |
| | **interface\_select\_method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **name** string / required | | External resource name. |
| | **password** string | | HTTP basic authentication password. |
| | **refresh\_rate** integer | | Time interval to refresh external resource (1 - 43200 min). |
| | **resource** string | | URI of external resource. |
| | **source\_ip** string | | Source IPv4 address used to communicate with server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable user resource. |
| | **type** string | **Choices:*** category
* address
* domain
* malware
| User resource type. |
| | **user\_agent** string | | Override HTTP User-Agent header used when retrieving this external resource. |
| | **username** string | | HTTP basic authentication user name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure external resource.
fortios_system_external_resource:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_external_resource:
category: "3"
comments: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
name: "default_name_7"
password: "<your_own_value>"
refresh_rate: "9"
resource: "<your_own_value>"
source_ip: "84.230.14.43"
status: "enable"
type: "category"
user_agent: "<your_own_value>"
username: "<your_own_value>"
uuid: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
| programming_docs |
ansible fortinet.fortios.fortios_system_replacemsg_mm1 – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mm1 – Replacement messages in Fortinet’s FortiOS and FortiGate.
=============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_system_replacemsg_mm1`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system\_replacemsg feature and mm1 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_mm1** dictionary | | Replacement messages. |
| | **add\_smil** string | **Choices:*** enable
* disable
| add message encapsulation |
| | **charset** string | **Choices:*** utf-8
* us-ascii
| character encoding used for replacement message |
| | **class** string | **Choices:*** not-included
* personal
* advertisement
* information
* automatic
| message class |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **from** string | | from address |
| | **from\_sender** string | **Choices:*** enable
* disable
| notification message sent from recipient |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. Source system.replacemsg-image.name. |
| | **message** string | | message text |
| | **msg\_type** string | | Message type. |
| | **priority** string | **Choices:*** not-included
* low
* normal
* high
| message priority |
| | **rsp\_status** string | **Choices:*** ok
* err-unspecified
* err-srv-denied
* err-msg-fmt-corrupt
* err-snd-addr-unresolv
* err-msg-not-found
* err-net-prob
* err-content-not-accept
* err-unsupp-msg
| response status code |
| | **rsp\_text** string | | response text |
| | **sender\_visibility** string | **Choices:*** not-specified
* show
* hide
| sender visibility |
| | **smil\_part** string | | message encapsulation text |
| | **subject** string | | subject text string |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mm1:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mm1:
add_smil: "enable"
charset: "utf-8"
class: "not-included"
format: "none"
from: "<your_own_value>"
from_sender: "enable"
header: "none"
image: "<your_own_value> (source system.replacemsg-image.name)"
message: "<your_own_value>"
msg_type: "<your_own_value>"
priority: "not-included"
rsp_status: "ok"
rsp_text: "<your_own_value>"
sender_visibility: "not-specified"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible fortinet.fortios.fortios_log_memory_setting – Settings for memory buffer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_memory\_setting – Settings for memory buffer in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_log_memory_setting`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log\_memory feature and setting 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.9.0
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access\_token** string | | Token-based authentication. Generated from GUI of Fortigate. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **log\_memory\_setting** dictionary | | Settings for memory buffer. |
| | **diskfull** string | **Choices:*** overwrite
| Action to take when memory is full. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging to the FortiGate"s memory. |
| **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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Settings for memory buffer.
fortios_log_memory_setting:
vdom: "{{ vdom }}"
log_memory_setting:
diskfull: "overwrite"
status: "enable"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), 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 |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Hongbin Lu (@fgtdev-hblu)
* Frank Shen (@frankshen01)
* Miguel Angel Munoz (@mamunozgonzalez)
* Nicolas Thomas (@thomnico)
ansible Collections in the T_systems_mms Namespace Collections in the T\_systems\_mms Namespace
============================================
These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the **t\_systems\_mms** namespace.
* [t\_systems\_mms.icinga\_director](icinga_director/index#plugins-in-t-systems-mms-icinga-director)
ansible t_systems_mms.icinga_director.icinga_endpoint – Manage endpoints in Icinga2 t\_systems\_mms.icinga\_director.icinga\_endpoint – Manage endpoints in Icinga2
===============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_endpoint`.
New in version 1.5.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove an endpoint to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **host** string | | The hostname/IP address of the remote Icinga 2 instance. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **log\_duration** string | | Duration for keeping replay logs on connection loss. Defaults to 1d (86400 seconds). Attribute is specified in seconds. If log\_duration is set to 0, replaying logs is disabled. You could also specify the value in human readable format like 10m for 10 minutes or 1h for one hour. |
| **object\_name** string / required | | Icinga object name for this endpoint. This is usually a fully qualified host name but it could basically be any kind of string. To make things easier for your users we strongly suggest to use meaningful names for templates. For example "generic-endpoint" is ugly, "Standard Linux Server" is easier to understand.
aliases: name |
| **port** integer | | The service name/port of the remote Icinga 2 instance. Defaults to 5665. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **zone** string | | The name of the zone this endpoint is part of. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create an endpoint in icinga
t_systems_mms.icinga_director.icinga_endpoint:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "fooendpoint"
host: "127.0.0.1"
zone: "foozone"
```
### Authors
* Aaron Bulmahn (@arbu)
ansible t_systems_mms.icinga_director.icinga_servicegroup – Manage servicegroups in Icinga2 t\_systems\_mms.icinga\_director.icinga\_servicegroup – Manage servicegroups in Icinga2
=======================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_servicegroup`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a servicegroup to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **assign\_filter** string | | This allows you to configure an assignment filter. Please feel free to combine as many nested operators as you want. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **display\_name** string | | An alternative display name for this group. If you wonder how this could be helpful just leave it blank. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **object\_name** string / required | | Name for the Icinga servicegroup.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create servicegroup
t_systems_mms.icinga_director.icinga_servicegroup:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: fooservicegroup
display_name: fooservicegroup
assign_filter: 'host.name="foo"'
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_service_template_info – Query service templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service\_template\_info – Query service templates in Icinga2
=====================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service_template_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of service template objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a service template in icinga
t_systems_mms.icinga_director.icinga_service_template_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "fooservicetemplate"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_command_template_info – Query command templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_command\_template\_info – Query command templates in Icinga2
=====================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_command_template_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of command template objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a command template in icinga
t_systems_mms.icinga_director.icinga_command_template_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "centreon-plugins-template"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_user_info – Query users in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user\_info – Query users in Icinga2
============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of user objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a user in icinga
t_systems_mms.icinga_director.icinga_user_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "rb"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_host – Manage hosts in Icinga2 t\_systems\_mms.icinga\_director.icinga\_host – Manage hosts in Icinga2
=======================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_host`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a host to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **accept\_config** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether the agent is configured to accept config. |
| **address** string | | Host address. Usually an IPv4 address, but may be any kind of address your check plugin is able to deal with. |
| **address6** string added in 1.4.0 of t\_systems\_mms.icinga\_director | | Host IPv6 address. Usually an IPv6 address, but may be any kind of address your check plugin is able to deal with. |
| **check\_command** string | | The name of the check command. Though this is not required to be defined in the director, you still have to supply a check\_command in a host or host-template. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **command\_endpoint** string | | The endpoint where commands are executed on. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **display\_name** string | | Alternative name for this host. Might be a host alias or and kind of string helping your users to identify this host. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | **Default:**[] | Hostgroups that should be directly assigned to this node. Hostgroups can be useful for various reasons. You might assign service checks based on assigned hostgroup. They are also often used as an instrument to enforce restricted views in Icinga Web 2. Hostgroups can be directly assigned to single hosts or to host templates. You might also want to consider assigning hostgroups using apply rules. |
| **has\_agent** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether this host has the Icinga 2 Agent installed. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Choose a Host Template. Required when state is `present`. |
| **master\_should\_connect** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether the parent (master) node should actively try to connect to this agent. |
| **notes** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | Additional notes for this object. |
| **notes\_url** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | An URL pointing to additional notes for this object. Separate multiple urls like this "'http://url1' 'http://url2'". The maximum length is 255 characters. |
| **object\_name** string / required | | Icinga object name for this host. This is usually a fully qualified host name but it could basically be any kind of string. To make things easier for your users we strongly suggest to use meaningful names for templates. For example "generic-host" is ugly, "Standard Linux Server" is easier to understand.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | | Custom properties of the host. |
| **zone** string | | Set the zone. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create a host in icinga
t_systems_mms.icinga_director.icinga_host:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
disabled: false
object_name: "foohost"
address: "127.0.0.1"
address6: "::1"
display_name: "foohost"
groups:
- "foohostgroup"
imports:
- "foohosttemplate"
vars:
dnscheck: "no"
check_command: hostalive
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
has_agent: true
master_should_connect: true
accept_config: true
command_endpoint: fooendpoint
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
| programming_docs |
ansible T_Systems_Mms.Icinga_Director T\_Systems\_Mms.Icinga\_Director
================================
Collection version 1.23.0
Plugin Index
------------
These are the plugins in the t\_systems\_mms.icinga\_director collection
### Inventory Plugins
* [icinga\_director\_inventory](icinga_director_inventory_inventory#ansible-collections-t-systems-mms-icinga-director-icinga-director-inventory-inventory) – Returns Ansible inventory from Icinga
### Modules
* [icinga\_command](icinga_command_module#ansible-collections-t-systems-mms-icinga-director-icinga-command-module) – Manage commands in Icinga2
* [icinga\_command\_info](icinga_command_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-command-info-module) – Query commands in Icinga2
* [icinga\_command\_template](icinga_command_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-command-template-module) – Manage command templates in Icinga2
* [icinga\_command\_template\_info](icinga_command_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-command-template-info-module) – Query command templates in Icinga2
* [icinga\_endpoint](icinga_endpoint_module#ansible-collections-t-systems-mms-icinga-director-icinga-endpoint-module) – Manage endpoints in Icinga2
* [icinga\_endpoint\_info](icinga_endpoint_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-endpoint-info-module) – Query endpoints in Icinga2
* [icinga\_host](icinga_host_module#ansible-collections-t-systems-mms-icinga-director-icinga-host-module) – Manage hosts in Icinga2
* [icinga\_host\_info](icinga_host_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-host-info-module) – Query hosts in Icinga2
* [icinga\_host\_template](icinga_host_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-host-template-module) – Manage host templates in Icinga2
* [icinga\_host\_template\_info](icinga_host_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-host-template-info-module) – Query host templates in Icinga2
* [icinga\_hostgroup](icinga_hostgroup_module#ansible-collections-t-systems-mms-icinga-director-icinga-hostgroup-module) – Manage hostgroups in Icinga2
* [icinga\_hostgroup\_info](icinga_hostgroup_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-hostgroup-info-module) – Query hostgroups in Icinga2
* [icinga\_notification](icinga_notification_module#ansible-collections-t-systems-mms-icinga-director-icinga-notification-module) – Manage notifications in Icinga2
* [icinga\_notification\_info](icinga_notification_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-notification-info-module) – Query notifications in Icinga2
* [icinga\_notification\_template](icinga_notification_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-notification-template-module) – Manage notification templates in Icinga2
* [icinga\_notification\_template\_info](icinga_notification_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-notification-template-info-module) – Query notification templates in Icinga2
* [icinga\_service](icinga_service_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-module) – Manage services in Icinga2
* [icinga\_service\_apply](icinga_service_apply_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-apply-module) – Manage service apply rules in Icinga2
* [icinga\_service\_apply\_info](icinga_service_apply_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-apply-info-module) – Query service apply rules in Icinga2
* [icinga\_service\_info](icinga_service_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-info-module) – Query services in Icinga2
* [icinga\_service\_template](icinga_service_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-template-module) – Manage service templates in Icinga2
* [icinga\_service\_template\_info](icinga_service_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-service-template-info-module) – Query service templates in Icinga2
* [icinga\_servicegroup](icinga_servicegroup_module#ansible-collections-t-systems-mms-icinga-director-icinga-servicegroup-module) – Manage servicegroups in Icinga2
* [icinga\_servicegroup\_info](icinga_servicegroup_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-servicegroup-info-module) – Query servicegroups in Icinga2
* [icinga\_timeperiod](icinga_timeperiod_module#ansible-collections-t-systems-mms-icinga-director-icinga-timeperiod-module) – Manage timeperiods in Icinga2
* [icinga\_timeperiod\_info](icinga_timeperiod_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-timeperiod-info-module) – Query timeperiods in Icinga2
* [icinga\_timeperiod\_template](icinga_timeperiod_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-timeperiod-template-module) – Manage timeperiod templates in Icinga2
* [icinga\_timeperiod\_template\_info](icinga_timeperiod_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-timeperiod-template-info-module) – Query timeperiod templates in Icinga2
* [icinga\_user](icinga_user_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-module) – Manage users in Icinga2
* [icinga\_user\_group](icinga_user_group_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-group-module) – Manage users groups in Icinga2
* [icinga\_user\_group\_info](icinga_user_group_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-group-info-module) – Query user groups in Icinga2
* [icinga\_user\_info](icinga_user_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-info-module) – Query users in Icinga2
* [icinga\_user\_template](icinga_user_template_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-template-module) – Manage user templates in Icinga2
* [icinga\_user\_template\_info](icinga_user_template_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-user-template-info-module) – Query user templates in Icinga2
* [icinga\_zone](icinga_zone_module#ansible-collections-t-systems-mms-icinga-director-icinga-zone-module) – Manage zones in Icinga2
* [icinga\_zone\_info](icinga_zone_info_module#ansible-collections-t-systems-mms-icinga-director-icinga-zone-info-module) – Query zones in Icinga2
See also
List of [collections](../../index#list-of-collections) with docs hosted here.
ansible t_systems_mms.icinga_director.icinga_command – Manage commands in Icinga2 t\_systems\_mms.icinga\_director.icinga\_command – Manage commands in Icinga2
=============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_command`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a command to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **arguments** dictionary | | Arguments of the command. Each argument can take either a string, a json or a dict When using a dict as argument value, the following properties are supported. `skip_key`, `repeat_key`, `required`, `order`, `description`), `set_if`, `value`. The `value` property can be either a string, a json or a dict. When used as a dict, you can define its `type` as `Function` and set its `body` property as an Icinga DSL piece of config. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **command** string | | The command Icinga should run. Required when state is `present`. Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed. Spaces will lead to separation of command path and standalone arguments. Please note that this means that we do not support spaces in plugin names and paths right now. |
| **command\_type** string | **Choices:*** **PluginCheck** ←
* PluginNotification
* PluginEvent
| Plugin Check commands are what you need when running checks against your infrastructure. Notification commands will be used when it comes to notify your users. Event commands allow you to trigger specific actions when problems occur. Some people use them for auto-healing mechanisms, like restarting services or rebooting systems at specific thresholds. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **object\_name** string / required | | Name of the command.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **timeout** string | | Optional command timeout. Allowed values are seconds or durations postfixed with a specific unit (for example 1m or also 3m 30s). |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | | Custom properties of the command. |
| **zone** string | | Icinga cluster zone. Allows to manually override Directors decisions of where to deploy your config to. You should consider not doing so unless you gained deep understanding of how an Icinga Cluster stack works. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create command
t_systems_mms.icinga_director.icinga_command:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
arguments:
'--authpassphrase':
value: $snmpv3_priv_key$
'--authprotocol':
value: $snmpv3_auth_protocol$
'--critical':
value: $centreon_critical$
'--filter':
value: $centreon_filter$
'--hostname':
value: $snmp_address$
'--maxrepetitions':
value: $centreon_maxrepetitions$
'--mode':
value: $centreon_mode$
'--plugin':
value: $centreon_plugin$
'--privpassphrase':
value: $snmpv3_auth_key$
'--privprotocol':
value: $snmpv3_priv_protocol$
'--snmp-community':
value: $snmp_community$
'--snmp-timeout':
value: $snmp_timeout$
'--snmp-username':
value: $snmpv3_user$
'--snmp-version':
value: $snmp_version$
'--subsetleef':
value: $centreon_subsetleef$
'--verbose':
set_if: $centreon_verbose$
'--warning':
value: $centreon_warning$
'--dummy-arg':
description: "dummy arg using Icinga DSL code"
value:
type: "Function"
body: 'return macro("$dummy_var$")'
command: "/opt/centreon-plugins/centreon_plugins.pl"
command_type: "PluginCheck"
disabled: false
object_name: centreon-plugins
imports:
- centreon-plugins-template
timeout: "1m"
vars:
centreon_maxrepetitions: 20
centreon_subsetleef: 20
centreon_verbose: false
snmp_address: $address$
snmp_timeout: 60
snmp_version: '2'
snmpv3_auth_key: authkey
snmpv3_priv_key: privkey
snmpv3_user: user
- name: Create command
t_systems_mms.icinga_director.icinga_command:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
command: "/opt/centreon-plugins/centreon_plugins_2.pl"
object_name: centreon-plugins_2
- name: Create event command
t_systems_mms.icinga_director.icinga_command:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
command: "/opt/scripts/restart_httpd"
object_name: "restart_httpd"
arguments:
'-s':
value: $service.state$
'-t':
value: $service.state_type$
'-a':
set_if: $service.check_attempt$
value: $restart_service$
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_user_group_info – Query user groups in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user\_group\_info – Query user groups in Icinga2
=========================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user_group_info`.
New in version 1.16.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of user group objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a user group in icinga
t_systems_mms.icinga_director.icinga_user_group_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "onCall"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_hostgroup_info – Query hostgroups in Icinga2 t\_systems\_mms.icinga\_director.icinga\_hostgroup\_info – Query hostgroups in Icinga2
======================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_hostgroup_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of hostgroup objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a hostgroup in icinga
t_systems_mms.icinga_director.icinga_hostgroup_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foohostgroup"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_notification – Manage notifications in Icinga2 t\_systems\_mms.icinga\_director.icinga\_notification – Manage notifications in Icinga2
=======================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_notification`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a notification to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **apply\_to** string / required | **Choices:*** host
* service
| Whether this notification should affect hosts or services. |
| **assign\_filter** string | | The filter where the notification will take effect. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Required when state is `present`. Please note that order matters when importing properties from multiple templates - last one wins. |
| **notification\_interval** string | | The notification interval (in seconds). This interval is used for active notifications. Defaults to 30 minutes. If set to 0, re-notifications are disabled. |
| **object\_name** string / required | | Name of the notification.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **states** list / elements=string added in 1.9.0 of t\_systems\_mms.icinga\_director | | The host or service states you want to get notifications for. |
| **time\_period** string added in 1.15.0 of t\_systems\_mms.icinga\_director | | The name of a time period which determines when this notification should be triggered.
aliases: period |
| **times\_begin** integer added in 1.15.0 of t\_systems\_mms.icinga\_director | | First notification delay. Delay unless the first notification should be sent. |
| **times\_end** integer added in 1.15.0 of t\_systems\_mms.icinga\_director | | Last notification. When the last notification should be sent. |
| **types** list / elements=string | | The state transition types you want to get notifications for. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **user\_groups** list / elements=string added in 1.16.0 of t\_systems\_mms.icinga\_director | | User Groups that should be notified by this notification. |
| **users** list / elements=string | | Users that should be notified by this notification. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary added in 1.9.0 of t\_systems\_mms.icinga\_director | | Custom properties of the notification. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create notification
t_systems_mms.icinga_director.icinga_notification:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
apply_to: host
assign_filter: 'host.name="foohost"'
imports:
- foonotificationtemplate
notification_interval: '0'
object_name: E-Mail_host
states:
- Up
- Down
types:
- Problem
- Recovery
users:
- rb
user_groups:
- OnCall
disabled: false
vars:
foo: bar
time_period: "24/7"
times_begin: 20
times_end: 120
```
### Authors
* Sebastian Gumprich (@rndmh3ro) / Sebastian Gruber (sgruber94)
ansible t_systems_mms.icinga_director.icinga_user_template – Manage user templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user\_template – Manage user templates in Icinga2
==========================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user_template`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a user template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **enable\_notifications** boolean | **Choices:*** no
* yes
| Whether to send notifications for this user. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **object\_name** string / required | | Name of the user template.
aliases: name |
| **period** string | | The name of a time period which determines when notifications to this User should be triggered. Not set by default. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create user template
t_systems_mms.icinga_director.icinga_user_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "foousertemplate"
enable_notifications: true
period: '24/7'
```
### Authors
* Lars Krahl (@mmslkr)
ansible t_systems_mms.icinga_director.icinga_host_info – Query hosts in Icinga2 t\_systems\_mms.icinga\_director.icinga\_host\_info – Query hosts in Icinga2
============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_host_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of host objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a host in icinga
t_systems_mms.icinga_director.icinga_host_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foohost"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_zone_info – Query zones in Icinga2 t\_systems\_mms.icinga\_director.icinga\_zone\_info – Query zones in Icinga2
============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_zone_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of zone objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **external** boolean | **Choices:*** **no** ←
* yes
| Also include external objects in output. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a zone in icinga
t_systems_mms.icinga_director.icinga_zone_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foozone"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_user – Manage users in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user – Manage users in Icinga2
=======================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a user to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **display\_name** string | | Alternative name for this user. In case your object name is a username, this could be the full name of the corresponding person. |
| **email** string | | The Email address of the user. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | | User groups that should be directly assigned to this user. Groups can be useful for various reasons. You might prefer to send notifications to groups instead of single users. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **object\_name** string / required | | Name of the user.
aliases: name |
| **pager** string | | The pager address of the user. |
| **period** string | | The name of a time period which determines when notifications to this User should be triggered. Not set by default. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create user
t_systems_mms.icinga_director.icinga_user:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "rb"
display_name: "Rufbereitschaft"
pager: 'SIP/emergency'
period: '24/7'
email: "[email protected]"
imports:
- foousertemplate
groups:
- onCall
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_timeperiod_template_info – Query timeperiod templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_timeperiod\_template\_info – Query timeperiod templates in Icinga2
===========================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_timeperiod_template_info`.
New in version 1.17.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of timeperiod template objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a timeperiod template in icinga
t_systems_mms.icinga_director.icinga_timeperiod_template_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "timeperiod_template"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_command_template – Manage command templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_command\_template – Manage command templates in Icinga2
================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_command_template`.
New in version 1.1.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a command template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **arguments** dictionary | | Arguments of the command template. Each argument can take either a string, a json or a dict When using a dict as argument value, the following properties are supported. `skip_key`, `repeat_key`, `required`, `order`, `description`), `set_if`, `value`. The `value` property can be either a string, a json or a dict. When used as a dict, you can define its `type` as `Function` and set its `body` property as an Icinga DSL piece of config. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **command** string | | The command Icinga should run. Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed. Spaces will lead to separation of command path and standalone arguments. Please note that this means that we do not support spaces in plugin names and paths right now. |
| **command\_type** string | **Choices:*** **PluginCheck** ←
* PluginNotification
* PluginEvent
| Plugin Check commands are what you need when running checks against your infrastructure. Notification commands will be used when it comes to notify your users. Event commands allow you to trigger specific actions when problems occur. Some people use them for auto-healing mechanisms, like restarting services or rebooting systems at specific thresholds. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **object\_name** string / required | | Name of the command template.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **timeout** string | | Optional command timeout. Allowed values are seconds or durations postfixed with a specific unit (for example 1m or also 3m 30s). |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | | Custom properties of the command template. |
| **zone** string | | Icinga cluster zone. Allows to manually override Directors decisions of where to deploy your config to. You should consider not doing so unless you gained deep understanding of how an Icinga Cluster stack works. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create command template
t_systems_mms.icinga_director.icinga_command_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
arguments:
'--authpassphrase':
value: $snmpv3_priv_key$
'--authprotocol':
value: $snmpv3_auth_protocol$
'--critical':
value: $centreon_critical$
'--filter':
value: $centreon_filter$
'--hostname':
value: $snmp_address$
'--maxrepetitions':
value: $centreon_maxrepetitions$
'--mode':
value: $centreon_mode$
'--plugin':
value: $centreon_plugin$
'--privpassphrase':
value: $snmpv3_auth_key$
'--privprotocol':
value: $snmpv3_priv_protocol$
'--snmp-community':
value: $snmp_community$
'--snmp-timeout':
value: $snmp_timeout$
'--snmp-username':
value: $snmpv3_user$
'--snmp-version':
value: $snmp_version$
'--subsetleef':
value: $centreon_subsetleef$
'--verbose':
set_if: $centreon_verbose$
'--warning':
value: $centreon_warning$
'--dummy-arg':
description: "dummy arg using Icinga DSL code"
value:
type: "Function"
body: 'return macro("$dummy_var$")'
command: "/opt/centreon-plugins/centreon_plugins.pl"
command_type: "PluginCheck"
object_name: centreon-plugins-template
timeout: "2m"
disabled: false
vars:
centreon_maxrepetitions: 20
centreon_subsetleef: 20
centreon_verbose: false
snmp_address: $address$
snmp_timeout: 60
snmp_version: '2'
snmpv3_auth_key: authkey
snmpv3_priv_key: privkey
snmpv3_user: user
- name: Create command template
t_systems_mms.icinga_director.icinga_command_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
command: "/opt/centreon-plugins/centreon_plugins_2.pl"
object_name: centreon-plugins-template-2
```
### Authors
* Lars Krahl (@mmslkr)
ansible t_systems_mms.icinga_director.icinga_service_apply_info – Query service apply rules in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service\_apply\_info – Query service apply rules in Icinga2
====================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service_apply_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of service apply rule objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a service apply rule in icinga
t_systems_mms.icinga_director.icinga_service_apply_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "SERVICE_dummy"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_notification_info – Query notifications in Icinga2 t\_systems\_mms.icinga\_director.icinga\_notification\_info – Query notifications in Icinga2
============================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_notification_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of notification objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a notification in icinga
t_systems_mms.icinga_director.icinga_notification_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "E-Mail_host"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_timeperiod_template – Manage timeperiod templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_timeperiod\_template – Manage timeperiod templates in Icinga2
======================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_timeperiod_template`.
New in version 1.17.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a timeperiod template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **display\_name** string | | Alternative name for this timeperiod template. |
| **exclude\_period** list / elements=string | | Exclude other time periods from this. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **include\_period** list / elements=string | | Include other time periods into this. |
| **object\_name** string / required | | Name of the time period.
aliases: name |
| **prefer\_includes** boolean | **Choices:*** no
* **yes** ←
| Whether to prefer timeperiods includes or excludes. Default to true. |
| **ranges** dictionary | | A dict of days and timeperiods. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **update\_method** string | **Default:**"LegacyTimePeriod" | Define the update method. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **zone** string | | Set the zone. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create timeperiod template
t_systems_mms.icinga_director.icinga_timeperiod_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "timeperiod_template"
display_name: "timeperiod template"
imports: []
disabled: false
prefer_includes: false
ranges:
monday: "00:00-23:59"
tuesday: "00:00-23:59"
wednesday: "00:00-23:59"
thursday: "00:00-23:59"
friday: "00:00-23:59"
saturday: "00:00-23:59"
sunday: "00:00-23:59"
update_method: "LegacyTimePeriod"
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_director_inventory – Returns Ansible inventory from Icinga t\_systems\_mms.icinga\_director.icinga\_director\_inventory – Returns Ansible inventory from Icinga
====================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_director_inventory`.
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Examples](#examples)
Synopsis
--------
* Returns Ansible inventory from Icinga
Parameters
----------
| Parameter | Choices/Defaults | Configuration | Comments |
| --- | --- | --- | --- |
| **client\_cert** path | | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| | If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| | Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | | Header to identify as, generally appears in web server logs. |
| **plugin** string / required | **Choices:*** t\_systems\_mms.icinga\_director.icinga\_director\_inventory
| | Name of the plugin |
| **url** string / required | | | Icinga URL to connect to |
| **url\_password** string | | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| | Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| | If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| | If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Examples
--------
```
plugin: t_systems_mms.icinga_director.icinga_director_inventory
url: 'https://example.com'
url_username: foo
url_password: bar
force_basic_auth: False
```
ansible t_systems_mms.icinga_director.icinga_hostgroup – Manage hostgroups in Icinga2 t\_systems\_mms.icinga\_director.icinga\_hostgroup – Manage hostgroups in Icinga2
=================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_hostgroup`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a hostgroup to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **assign\_filter** string | | This allows you to configure an assignment filter. Please feel free to combine as many nested operators as you want. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **display\_name** string | | An alternative display name for this group. If you wonder how this could be helpful just leave it blank. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **object\_name** string / required | | Icinga object name for this hostgroup.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create hostgroup
t_systems_mms.icinga_director.icinga_hostgroup:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: foohostgroup
display_name: foohostgroup
assign_filter: 'host.name="foohost"'
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_command_info – Query commands in Icinga2 t\_systems\_mms.icinga\_director.icinga\_command\_info – Query commands in Icinga2
==================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_command_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of command objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **external** boolean | **Choices:*** **no** ←
* yes
| Also include external objects in output. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a command in icinga
t_systems_mms.icinga_director.icinga_command_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "centreon-plugins_2"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_service_apply – Manage service apply rules in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service\_apply – Manage service apply rules in Icinga2
===============================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service_apply`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a service apply rule to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **apply\_for** string | | Evaluates the apply for rule for all objects with the custom attribute specified. For example selecting "host.vars.custom\_attr" will generate "for (config in host.vars.array\_var)" where "config" will be accessible through "$config$". Note - only custom variables of type "Array" are eligible. |
| **assign\_filter** string | | The filter where the service apply rule will take effect. |
| **check\_command** string added in 1.7.0 of t\_systems\_mms.icinga\_director | | Check command definition. |
| **check\_interval** string | | Your regular check interval. |
| **check\_period** string | | The name of a time period which determines when this object should be monitored. Not limited by default. |
| **check\_timeout** string | | Check command timeout in seconds. Overrides the CheckCommand's timeout attribute. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **command\_endpoint** string | | The host where the service should be executed on. |
| **display\_name** string | | Alternative displayed name of the service apply rule. |
| **enable\_active\_checks** boolean | **Choices:*** no
* yes
| Whether to actively check this object. |
| **enable\_event\_handler** boolean | **Choices:*** no
* yes
| Whether to enable event handlers this object. |
| **enable\_notifications** boolean | **Choices:*** no
* yes
| Whether to send notifications for this object. |
| **enable\_passive\_checks** boolean | **Choices:*** no
* yes
| Whether to accept passive check results for this object. |
| **enable\_perfdata** boolean | **Choices:*** no
* yes
| Whether to process performance data provided by this object. |
| **event\_command** string | | Event command for service which gets called on every check execution if one of these conditions matches The service is in a soft state The service state changes into a hard state The service state recovers from a soft or hard state to OK/Up |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | | Service groups that should be directly assigned to this service. Servicegroups can be useful for various reasons. They are helpful to provided service-type specific view in Icinga Web 2, either for custom dashboards or as an instrument to enforce restrictions. Service groups can be directly assigned to single services or to service templates. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **max\_check\_attempts** string | | Defines after how many check attempts a new hard state is reached. |
| **notes** string | | Additional notes for this object. |
| **notes\_url** string | | An URL pointing to additional notes for this object. Separate multiple urls like this "'http://url1' 'http://url2'". Maximum length is 255 characters. |
| **object\_name** string / required | | Name for the Icinga service apply rule.
aliases: name |
| **retry\_interval** string | | Retry interval, will be applied after a state change unless the next hard state is reached. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | | Custom properties of the service apply rule. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Add service apply rule to icinga
t_systems_mms.icinga_director.icinga_service_apply:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "SERVICE_dummy"
assign_filter: 'host.name="foohost"'
check_command: hostalive
display_name: "dummy process"
check_interval: "10m"
check_period: "24/7"
check_timeout: "1m"
enable_active_checks: true
enable_event_handler: true
enable_notifications: true
enable_passive_checks: false
enable_perfdata: false
event_command: restart_httpd
max_check_attempts: "5"
retry_interval: "3m"
imports:
- fooservicetemplate
groups:
- fooservicegroup
vars:
http_address: "$address$"
http_port: "9080"
http_uri: "/ready"
http_string: "Ready"
http_expect: "Yes"
- name: Add service apply rule with command_endpoint
t_systems_mms.icinga_director.icinga_service_apply:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "SERVICE_dummy"
assign_filter: 'host.name="foohost"'
check_command: hostalive
display_name: "dummy process"
check_interval: "10m"
check_period: "24/7"
check_timeout: "1m"
enable_active_checks: true
enable_event_handler: true
enable_notifications: true
enable_passive_checks: false
enable_perfdata: false
event_command: restart_httpd
max_check_attempts: "5"
retry_interval: "3m"
command_endpoint: "fooendpoint"
imports:
- fooservicetemplate
groups:
- fooservicegroup
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_user_template_info – Query user templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user\_template\_info – Query user templates in Icinga2
===============================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user_template_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of user template objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a user template in icinga
t_systems_mms.icinga_director.icinga_user_template_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foousertemplate"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_host_template_info – Query host templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_host\_template\_info – Query host templates in Icinga2
===============================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_host_template_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of host template objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a host template in icinga
t_systems_mms.icinga_director.icinga_host_template_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foohosttemplate"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_service – Manage services in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service – Manage services in Icinga2
=============================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a service to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **check\_command** string | | Check command definition. |
| **check\_interval** string | | Your regular check interval. |
| **check\_period** string | | The name of a time period which determines when this object should be monitored. Not limited by default. |
| **check\_timeout** string | | Check command timeout in seconds. Overrides the CheckCommand's timeout attribute. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **enable\_active\_checks** boolean | **Choices:*** no
* yes
| Whether to actively check this object. |
| **enable\_event\_handler** boolean | **Choices:*** no
* yes
| Whether to enable event handlers this object. |
| **enable\_notifications** boolean | **Choices:*** no
* yes
| Whether to send notifications for this object. |
| **enable\_passive\_checks** boolean | **Choices:*** no
* yes
| Whether to accept passive check results for this object. |
| **enable\_perfdata** boolean | **Choices:*** no
* yes
| Whether to process performance data provided by this object. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | **Default:**[] | Service groups that should be directly assigned to this service. Servicegroups can be useful for various reasons. They are helpful to provided service-type specific view in Icinga Web 2, either for custom dashboards or as an instrument to enforce restrictions. Service groups can be directly assigned to single services or to service templates. |
| **host** string / required | | Choose the host this single service should be assigned to. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | **Default:**[] | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **max\_check\_attempts** string | | Defines after how many check attempts a new hard state is reached. |
| **notes** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | Additional notes for this object. |
| **notes\_url** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | An URL pointing to additional notes for this object. Separate multiple urls like this "'http://url1' 'http://url2'". Maximum length is 255 characters. |
| **object\_name** string / required | | Name of the service.
aliases: name |
| **retry\_interval** string | | Retry interval, will be applied after a state change unless the next hard state is reached. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_agent** boolean | **Choices:*** no
* yes
| Whether the check command for this service should be executed on the Icinga agent. |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | **Default:**{} | Custom properties of the service. |
| **volatile** boolean | **Choices:*** no
* yes
| Whether this check is volatile. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create service
tags: service
t_systems_mms.icinga_director.icinga_service:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "foo service"
check_command: hostalive
use_agent: false
host: foohost
vars:
procs_argument: consul
procs_critical: '1:'
procs_warning: '1:'
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_timeperiod – Manage timeperiods in Icinga2 t\_systems\_mms.icinga\_director.icinga\_timeperiod – Manage timeperiods in Icinga2
===================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_timeperiod`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a timeperiod to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **display\_name** string | | Alternative name for this timeperiod. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **object\_name** string / required | | Name of the time period.
aliases: name |
| **ranges** dictionary | | A dict of days and timeperiods. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create timeperiod
t_systems_mms.icinga_director.icinga_timeperiod:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: '24/7'
imports:
- "timeperiod_template"
ranges:
monday: "00:00-23:59"
tuesday: "00:00-23:59"
wednesday: "00:00-23:59"
thursday: "00:00-23:59"
friday: "00:00-23:59"
saturday: "00:00-23:59"
sunday: "00:00-23:59"
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_service_info – Query services in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service\_info – Query services in Icinga2
==================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of service objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a service in icinga
t_systems_mms.icinga_director.icinga_service_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foo service"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_timeperiod_info – Query timeperiods in Icinga2 t\_systems\_mms.icinga\_director.icinga\_timeperiod\_info – Query timeperiods in Icinga2
========================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_timeperiod_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of timeperiod objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query a timeperiod in icinga
t_systems_mms.icinga_director.icinga_timeperiod_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "24/7"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
ansible t_systems_mms.icinga_director.icinga_user_group – Manage users groups in Icinga2 t\_systems\_mms.icinga\_director.icinga\_user\_group – Manage users groups in Icinga2
=====================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_user_group`.
New in version 1.16.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a user group to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **display\_name** string | | Alternative name for this user group. In case your object name is a username, this could be the full name of the corresponding person. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **object\_name** string / required | | Name of the user group.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create user group
t_systems_mms.icinga_director.icinga_user_group:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "onCall"
display_name: "on call group"
disabled: false
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_endpoint_info – Query endpoints in Icinga2 t\_systems\_mms.icinga\_director.icinga\_endpoint\_info – Query endpoints in Icinga2
====================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_endpoint_info`.
New in version 1.13.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Get a list of endpoint objects from Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **query** string | **Default:**"" | Text to filter search results. The text is matched on object\_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| **resolved** boolean | **Choices:*** **no** ←
* yes
| Resolve all inherited object properties and omit templates in output. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Query an endpoint in icinga
t_systems_mms.icinga_director.icinga_endpoint_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "fooendpoint"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **objects** list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
### Authors
* Martin Schurz (@schurzi)
| programming_docs |
ansible t_systems_mms.icinga_director.icinga_service_template – Manage service templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_service\_template – Manage service templates in Icinga2
================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_service_template`.
New in version 1.0.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a service template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **check\_command** string | | Check command definition. |
| **check\_interval** string | | Your regular check interval. |
| **check\_period** string | | The name of a time period which determines when this object should be monitored. Not limited by default. |
| **check\_timeout** string | | Check command timeout in seconds. Overrides the CheckCommand's timeout attribute. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **enable\_active\_checks** boolean | **Choices:*** no
* yes
| Whether to actively check this object. |
| **enable\_event\_handler** boolean | **Choices:*** no
* yes
| Whether to enable event handlers this object. |
| **enable\_notifications** boolean | **Choices:*** no
* yes
| Whether to send notifications for this object. |
| **enable\_passive\_checks** boolean | **Choices:*** no
* yes
| Whether to accept passive check results for this object. |
| **enable\_perfdata** boolean | **Choices:*** no
* yes
| Whether to process performance data provided by this object. |
| **event\_command** string | | Event command for service which gets called on every check execution if one of these conditions matches The service is in a soft state The service state changes into a hard state The service state recovers from a soft or hard state to OK/Up |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | **Default:**[] | Service groups that should be directly assigned to this service. Servicegroups can be useful for various reasons. They are helpful to provided service-type specific view in Icinga Web 2, either for custom dashboards or as an instrument to enforce restrictions. Service groups can be directly assigned to single services or to service templates. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | **Default:**[] | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
| **max\_check\_attempts** string | | Defines after how many check attempts a new hard state is reached. |
| **notes** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | Additional notes for this object. |
| **notes\_url** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | An URL pointing to additional notes for this object. Separate multiple urls like this "'http://url1' 'http://url2'". Maximum length is 255 characters. |
| **object\_name** string / required | | Name of the service template.
aliases: name |
| **retry\_interval** string | | Retry interval, will be applied after a state change unless the next hard state is reached. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_agent** boolean | **Choices:*** no
* yes
| Whether the check commmand for this service should be executed on the Icinga agent. |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | **Default:**{} | Custom properties of the service template. |
| **volatile** boolean | **Choices:*** no
* yes
| Whether this check is volatile. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create servicetemplate
t_systems_mms.icinga_director.icinga_service_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: fooservicetemplate
use_agent: false
vars:
procs_argument: consul
procs_critical: '1:'
procs_warning: '1:'
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
- name: Create servicetemplate with event command
t_systems_mms.icinga_director.icinga_service_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: apache_check_servicetemplate
use_agent: false
event_command: restart_httpd
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
```
### Authors
* Sebastian Gumprich (@rndmh3ro)
ansible t_systems_mms.icinga_director.icinga_host_template – Manage host templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_host\_template – Manage host templates in Icinga2
==========================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_host_template`.
New in version 1.2.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a host template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **accept\_config** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether the agent is configured to accept config. |
| **address** string | | Host address. Usually an IPv4 address, but may be any kind of address your check plugin is able to deal with. |
| **address6** string | | Host IPv6 address. Usually an IPv64 address, but may be any kind of address your check plugin is able to deal with. |
| **check\_command** string | | The name of the check command. Though this is not required to be defined in the director, you still have to supply a check\_command in a host or host-template. |
| **check\_interval** string | | Your regular check interval. |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **command\_endpoint** string | | The endpoint where commands are executed on. |
| **disabled** boolean | **Choices:*** **no** ←
* yes
| Disabled objects will not be deployed. |
| **display\_name** string | | Alternative name for this host. Might be a host alias or and kind of string helping your users to identify this host. |
| **event\_command** string | | Event command for host which gets called on every check execution if one of these conditions matches The host is in a soft state The host state changes into a hard state The host state recovers from a soft or hard state to OK/Up |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **groups** list / elements=string | **Default:**[] | Hostgroups that should be directly assigned to this node. Hostgroups can be useful for various reasons. You might assign service checks based on assigned hostgroup. They are also often used as an instrument to enforce restricted views in Icinga Web 2. Hostgroups can be directly assigned to single hosts or to host templates. You might also want to consider assigning hostgroups using apply rules. |
| **has\_agent** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether this host has the Icinga 2 Agent installed. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **imports** list / elements=string | | Choose a host-template. |
| **master\_should\_connect** boolean added in 1.9.0 of t\_systems\_mms.icinga\_director | **Choices:*** no
* yes
| Whether the parent (master) node should actively try to connect to this agent. |
| **max\_check\_attempts** string | | Defines after how many check attempts a new hard state is reached. |
| **notes** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | Additional notes for this object. |
| **notes\_url** string added in 1.8.0 of t\_systems\_mms.icinga\_director | | An URL pointing to additional notes for this object. Separate multiple urls like this "'http://url1' 'http://url2'". Maximum length is 255 characters. |
| **object\_name** string / required | | Icinga object name for this host template. This is usually a fully qualified host name but it could basically be any kind of string. To make things easier for your users we strongly suggest to use meaningful names for templates. For example "generic-host" is ugly, "Standard Linux Server" is easier to understand.
aliases: name |
| **retry\_interval** string | | Retry interval, will be applied after a state change unless the next hard state is reached. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **vars** dictionary | | Custom properties of the host. |
| **zone** string | | Set the zone. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create host template
t_systems_mms.icinga_director.icinga_host_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: foohosttemplate
display_name: foohosttemplate
disabled: false
check_command: dummy
check_interval: 90s
retry_interval: 30s
groups:
- "foohostgroup"
imports:
- ''
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
has_agent: true
master_should_connect: true
max_check_attempts: 3
accept_config: true
command_endpoint: fooendpoint
```
### Authors
* Michaela Mattes (@michaelamattes)
ansible t_systems_mms.icinga_director.icinga_zone – Manage zones in Icinga2 t\_systems\_mms.icinga\_director.icinga\_zone – Manage zones in Icinga2
=======================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_zone`.
New in version 1.5.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a zone to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **is\_global** boolean | **Choices:*** **no** ←
* yes
| Whether configuration files for this zone should be synced to all endpoints. |
| **object\_name** string / required | | Icinga object name for this zone. This is usually a fully qualified host name but it could basically be any kind of string. To make things easier for your users we strongly suggest to use meaningful names for templates. For example "generic-zone" is ugly, "Standard Linux Server" is easier to understand.
aliases: name |
| **parent** string | | The name of the parent zone. |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create a zone in icinga
t_systems_mms.icinga_director.icinga_zone:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "foozone"
parent: "master"
```
### Authors
* Aaron Bulmahn (@arbu)
ansible t_systems_mms.icinga_director.icinga_notification_template – Manage notification templates in Icinga2 t\_systems\_mms.icinga\_director.icinga\_notification\_template – Manage notification templates in Icinga2
==========================================================================================================
Note
This plugin is part of the [t\_systems\_mms.icinga\_director collection](https://galaxy.ansible.com/t_systems_mms/icinga_director) (version 1.23.0).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install t_systems_mms.icinga_director`.
To use it in a playbook, specify: `t_systems_mms.icinga_director.icinga_notification_template`.
New in version 1.9.0: of t\_systems\_mms.icinga\_director
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
Synopsis
--------
* Add or remove a notification template to Icinga2 through the director API.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **client\_cert** path | | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required. |
| **client\_key** path | | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required. |
| **force** boolean | **Choices:*** **no** ←
* yes
| If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13.
aliases: thirsty |
| **force\_basic\_auth** boolean | **Choices:*** **no** ←
* yes
| Credentials specified with *url\_username* and *url\_password* should be passed in HTTP Header. |
| **http\_agent** string | **Default:**"ansible-httpget" | Header to identify as, generally appears in web server logs. |
| **notification\_command** string added in 1.15.0 of t\_systems\_mms.icinga\_director | | Check command definition
aliases: command |
| **notification\_interval** string | | The notification interval (in seconds). This interval is used for active notifications. Defaults to 30 minutes. If set to 0, re-notifications are disabled. |
| **object\_name** string / required | | Name of the notification template.
aliases: name |
| **state** string | **Choices:*** **present** ←
* absent
| Apply feature state. |
| **states** list / elements=string | | The host or service states you want to get notifications for. |
| **time\_period** string added in 1.15.0 of t\_systems\_mms.icinga\_director | | The name of a time period which determines when this notification should be triggered.
aliases: period |
| **times\_begin** integer | | First notification delay. Delay unless the first notification should be sent. |
| **times\_end** integer | | Last notification. When the last notification should be sent. |
| **types** list / elements=string | | The state transition types you want to get notifications for. |
| **url** string / required | | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
| **url\_password** string | | The password for use in HTTP basic authentication. If the *url\_username* parameter is not specified, the *url\_password* parameter will not be used. |
| **url\_username** string | | The username for use in HTTP basic authentication. This parameter can be used without *url\_password* for sites that allow empty passwords |
| **use\_gssapi** boolean added in 2.11 of ansible.builtin | **Choices:*** **no** ←
* yes
| Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library [gssapi](https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with *url\_username*/*url\_password* or with the GSSAPI env var `KRB5CCNAME` that specified a custom Kerberos credential cache. NTLM authentication is `not` supported even if the GSSAPI mech for NTLM has been installed. |
| **use\_proxy** boolean | **Choices:*** no
* **yes** ←
| If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| **user\_groups** list / elements=string added in 1.16.0 of t\_systems\_mms.icinga\_director | | User Groups that should be notified by this notification. |
| **users** list / elements=string added in 1.15.0 of t\_systems\_mms.icinga\_director | | Users that should be notified by this notification |
| **validate\_certs** boolean | **Choices:*** no
* **yes** ←
| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
| **zone** string | | Set the zone. |
Notes
-----
Note
* This module supports check mode.
Examples
--------
```
- name: Create notification template
t_systems_mms.icinga_director.icinga_notification_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
notification_interval: '0'
object_name: foonotificationtemplate
states:
- Up
- Down
types:
- Problem
- Recovery
times_begin: 20
times_end: 120
time_period: "24/7"
notification_command: "mail-host-notification"
users:
- "rb"
user_groups:
- "OnCall"
```
### Authors
* Sebastian Gumprich (@rndmh3ro) / Sebastian Gruber (sgruber94)
| programming_docs |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.