code
stringlengths 2.5k
150k
| kind
stringclasses 1
value |
|---|---|
ansible fortinet.fortimanager.fmgr_waf_profile_urlaccess – URL access list fortinet.fortimanager.fmgr\_waf\_profile\_urlaccess – URL access list
=====================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_waf_profile_urlaccess`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **waf\_profile\_urlaccess** dictionary | | the top level parameters set |
| | **access-pattern** list / elements=string | | no description |
| | | **id** integer | | URL access pattern ID. |
| | | **negate** string | **Choices:*** disable
* enable
| Enable/disable match negation. |
| | | **pattern** string | | URL pattern. |
| | | **regex** string | **Choices:*** disable
* enable
| Enable/disable regular expression based pattern match. |
| | | **srcaddr** string | | Source address. |
| | **action** string | **Choices:*** bypass
* permit
* block
| Action. |
| | **address** string | | Host address. |
| | **id** integer | | URL access ID. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: URL access list
fmgr_waf_profile_urlaccess:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
state: <value in [present, absent]>
waf_profile_urlaccess:
access-pattern:
-
id: <value of integer>
negate: <value in [disable, enable]>
pattern: <value of string>
regex: <value in [disable, enable]>
srcaddr: <value of string>
action: <value in [bypass, permit, block]>
address: <value of string>
id: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_proxyaddrgrp – Web proxy address group configuration. fortinet.fortimanager.fmgr\_firewall\_proxyaddrgrp – Web proxy address group configuration.
===========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_proxyaddrgrp`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_proxyaddrgrp** dictionary | | the top level parameters set |
| | **\_image-base64** string | | no description |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). |
| | **comment** string | | Optional comments. |
| | **member** string | | Members of address group. |
| | **name** string | | Address group name. |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **type** string | **Choices:*** src
* dst
| Source or destination address group type. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable visibility of the object in the GUI. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Web proxy address group configuration.
fmgr_firewall_proxyaddrgrp:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_proxyaddrgrp:
color: <value of integer>
comment: <value of string>
member: <value of string>
name: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
type: <value in [src, dst]>
uuid: <value of string>
visibility: <value in [disable, enable]>
_image-base64: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_dvmdb_workflow_repair – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_repair – no description
====================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvmdb_workflow_repair`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **dvmdb\_workflow\_repair** dictionary | | the top level parameters set |
| | **desc** string | | no description |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **session\_id** string / required | | the parameter (session\_id) in requested url |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_dvmdb_workflow_repair:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
session_id: <your own value>
dvmdb_workflow_repair:
desc: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_vpnsslweb_portal_macaddrcheckrule – Client MAC address check rule. fortinet.fortimanager.fmgr\_vpnsslweb\_portal\_macaddrcheckrule – Client MAC address check rule.
================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_vpnsslweb_portal_macaddrcheckrule`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **portal** string / required | | the parameter (portal) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **vpnsslweb\_portal\_macaddrcheckrule** dictionary | | the top level parameters set |
| | **mac-addr-list** string | | no description |
| | **mac-addr-mask** integer | | Client MAC address mask. |
| | **name** string | | Client MAC address check rule name. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Client MAC address check rule.
fmgr_vpnsslweb_portal_macaddrcheckrule:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
portal: <your own value>
state: <value in [present, absent]>
vpnsslweb_portal_macaddrcheckrule:
mac-addr-list: <value of string>
mac-addr-mask: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_fmupdate_avips_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates. fortinet.fortimanager.fmgr\_fmupdate\_avips\_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_fmupdate_avips_webproxy`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fmupdate\_avips\_webproxy** dictionary | | the top level parameters set |
| | **address** string | | web proxy address. |
| | **ip** string | **Default:**"0.0.0.0" | IPv4 address of the web proxy. |
| | **ip6** string | **Default:**"::" | IPv6 address of the web proxy. |
| | **mode** string | **Choices:*** **proxy** ←
* tunnel
| Web proxy mode: proxy - http proxy, tunnel - http tunnel (default = proxy). proxy - HTTP proxy. tunnel - HTTP tunnel. |
| | **password** string | | no description |
| | **port** integer | **Default:**80 | The port number of the web proxy (1 - 65535, default = 80). |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable connections through the web proxy (default = disable). disable - Disable setting. enable - Enable setting. |
| | **username** string | | The user name used for authentication. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure the web proxy for use with FortiGuard antivirus and IPS updates.
fmgr_fmupdate_avips_webproxy:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
fmupdate_avips_webproxy:
ip: <value of string>
ip6: <value of string>
mode: <value in [proxy, tunnel]>
password: <value of string>
port: <value of integer>
status: <value in [disable, enable]>
username: <value of string>
address: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_replacemsggroup_mm1 – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mm1 – Replacement message table entries.
=============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_replacemsggroup_mm1`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **replacemsg-group** string / required | | the parameter (replacemsg-group) in requested url |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_replacemsggroup\_mm1** dictionary | | the top level parameters set |
| | **add-smil** string | **Choices:*** disable
* enable
| add message encapsulation |
| | **charset** string | **Choices:*** us-ascii
* utf-8
| character encoding used for replacement message |
| | **class** string | **Choices:*** personal
* advertisement
* information
* automatic
* not-included
| message class |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **from** string | | from address |
| | **from-sender** string | **Choices:*** disable
* enable
| notification message sent from recipient |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. |
| | **message** string | | message text |
| | **msg-type** string | | Message type. |
| | **priority** string | **Choices:*** low
* normal
* high
* not-included
| 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:*** hide
* show
* not-specified
| sender visibility |
| | **smil-part** string | | message encapsulation text |
| | **subject** string | | subject text string |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Replacement message table entries.
fmgr_system_replacemsggroup_mm1:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
replacemsg-group: <your own value>
state: <value in [present, absent]>
system_replacemsggroup_mm1:
add-smil: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, information, ...]>
format: <value in [none, text, html, ...]>
from: <value of string>
from-sender: <value in [disable, enable]>
header: <value in [none, http, 8bit]>
image: <value of string>
message: <value of string>
msg-type: <value of string>
priority: <value in [low, normal, high, ...]>
rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]>
rsp-text: <value of string>
sender-visibility: <value in [hide, show, not-specified]>
smil-part: <value of string>
subject: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_wanprof_system_sdwan_members – FortiGate interfaces added to the SD-WAN. fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_members – FortiGate interfaces added to the SD-WAN.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_wanprof_system_sdwan_members`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_sdwan\_members** dictionary | | the top level parameters set |
| | **\_dynamic-member** string | | no description |
| | **comment** string | | Comments. |
| | **cost** integer | | Cost of this interface for services in SLA mode (0 - 4294967295, default = 0). |
| | **gateway** string | | The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is co... |
| | **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 sessi... |
| | **interface** string | | 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, default = 1024). 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 sessio... |
| | **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. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: FortiGate interfaces added to the SD-WAN.
fmgr_wanprof_system_sdwan_members:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_sdwan_members:
_dynamic-member: <value of string>
comment: <value of string>
cost: <value of integer>
gateway: <value of string>
gateway6: <value of string>
ingress-spillover-threshold: <value of integer>
interface: <value of string>
priority: <value of integer>
seq-num: <value of integer>
source: <value of string>
source6: <value of string>
spillover-threshold: <value of integer>
status: <value in [disable, enable]>
volume-ratio: <value of integer>
weight: <value of integer>
zone: <value of string>
priority6: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_emailfilter_bword – Configure AntiSpam banned word list. fortinet.fortimanager.fmgr\_emailfilter\_bword – Configure AntiSpam banned word list.
=====================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_bword`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **emailfilter\_bword** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** spam
* clear
| Mark spam or good. |
| | | **id** integer | | Banned word entry ID. |
| | | **language** string | **Choices:*** western
* simch
* trach
* japanese
* korean
* french
* thai
* spanish
| Language for the banned word. |
| | | **pattern** string | | Pattern for the banned word. |
| | | **pattern-type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **score** integer | | Score value. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| | | **where** string | **Choices:*** all
* subject
* body
| Component of the email to be scanned. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam banned word list.
fmgr_emailfilter_bword:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
emailfilter_bword:
comment: <value of string>
entries:
-
action: <value in [spam, clear]>
id: <value of integer>
language: <value in [western, simch, trach, ...]>
pattern: <value of string>
pattern-type: <value in [wildcard, regexp]>
score: <value of integer>
status: <value in [disable, enable]>
where: <value in [all, subject, body]>
id: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_wanprof_system_sdwan_zone – Configure SD-WAN zones. fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_zone – Configure SD-WAN zones.
==================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_wanprof_system_sdwan_zone`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_sdwan\_zone** dictionary | | the top level parameters set |
| | **name** string | | Zone name. |
| | **service-sla-tie-break** string | **Choices:*** cfg-order
* fib-best-match
| Method of selecting member if more than one meets the SLA. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure SD-WAN zones.
fmgr_wanprof_system_sdwan_zone:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_sdwan_zone:
name: <value of string>
service-sla-tie-break: <value in [cfg-order, fib-best-match]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_shapingprofile – Configure shaping profiles. fortinet.fortimanager.fmgr\_firewall\_shapingprofile – Configure shaping profiles.
==================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_shapingprofile`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_shapingprofile** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **default-class-id** integer | | Default class ID to handle unclassified packets (including all local traffic). |
| | **profile-name** string | | Shaping profile name. |
| | **shaping-entries** list / elements=string | | no description |
| | | **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... |
| | | **class-id** integer | | Class ID. |
| | | **guaranteed-bandwidth-percentage** integer | | Guaranteed bandwith in percentage. |
| | | **id** integer | | 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:*** low
* medium
* high
* critical
* top
| Priority. |
| | | **red-probability** integer | | Maximum probability (in percentage) for RED marking. |
| | **type** string | **Choices:*** policing
* queuing
| Select shaping profile type: policing / queuing. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure shaping profiles.
fmgr_firewall_shapingprofile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_shapingprofile:
comment: <value of string>
default-class-id: <value of integer>
profile-name: <value of string>
shaping-entries:
-
class-id: <value of integer>
guaranteed-bandwidth-percentage: <value of integer>
id: <value of integer>
maximum-bandwidth-percentage: <value of integer>
priority: <value in [low, medium, high, ...]>
burst-in-msec: <value of integer>
cburst-in-msec: <value of integer>
limit: <value of integer>
max: <value of integer>
min: <value of integer>
red-probability: <value of integer>
type: <value in [policing, queuing]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_vip – Configure virtual IP for IPv4. fortinet.fortimanager.fmgr\_firewall\_vip – Configure virtual IP for IPv4.
==========================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_vip`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_vip** dictionary | | the top level parameters set |
| | **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, default = 0). |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **arp-reply** string | **Choices:*** disable
* enable
| no description |
| | | **color** integer | | no description |
| | | **comment** string | | no description |
| | | **dns-mapping-ttl** integer | | no description |
| | | **extaddr** string | | no description |
| | | **extintf** string | | no description |
| | | **extip** string | | no description |
| | | **extport** string | | no description |
| | | **gratuitous-arp-interval** integer | | no description |
| | | **http-cookie-age** integer | | no description |
| | | **http-cookie-domain** string | | no description |
| | | **http-cookie-domain-from-host** string | **Choices:*** disable
* enable
| no description |
| | | **http-cookie-generation** integer | | no description |
| | | **http-cookie-path** string | | no description |
| | | **http-cookie-share** string | **Choices:*** disable
* same-ip
| no description |
| | | **http-ip-header** string | **Choices:*** disable
* enable
| no description |
| | | **http-ip-header-name** string | | no description |
| | | **http-multiplex** string | **Choices:*** disable
* enable
| no description |
| | | **http-redirect** string | **Choices:*** disable
* enable
| no description |
| | | **https-cookie-secure** string | **Choices:*** disable
* enable
| no description |
| | | **id** integer | | no description |
| | | **ldb-method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
* http-host
| no description |
| | | **mapped-addr** string | | no description |
| | | **mappedip** string | | no description |
| | | **mappedport** string | | no description |
| | | **max-embryonic-connections** integer | | no description |
| | | **monitor** string | | no description |
| | | **nat-source-vip** string | **Choices:*** disable
* enable
| no description |
| | | **outlook-web-access** string | **Choices:*** disable
* enable
| no description |
| | | **persistence** string | **Choices:*** none
* http-cookie
* ssl-session-id
| no description |
| | | **portforward** string | **Choices:*** disable
* enable
| no description |
| | | **portmapping-type** string | **Choices:*** 1-to-1
* m-to-n
| no description |
| | | **protocol** string | **Choices:*** tcp
* udp
* sctp
* icmp
| no description |
| | | **realservers** list / elements=string | | no description |
| | | | **address** string | | no description |
| | | | **client-ip** string | | no description |
| | | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| no description |
| | | | **holddown-interval** integer | | no description |
| | | | **http-host** string | | no description |
| | | | **id** integer | | no description |
| | | | **ip** string | | no description |
| | | | **max-connections** integer | | no description |
| | | | **monitor** string | | no description |
| | | | **port** integer | | no description |
| | | | **seq** integer | | no description |
| | | | **status** string | **Choices:*** active
* standby
* disable
| no description |
| | | | **type** string | **Choices:*** ip
* address
| no description |
| | | | **weight** integer | | no description |
| | | **server-type** string | **Choices:*** http
* https
* ssl
* tcp
* udp
* ip
* imaps
* pop3s
* smtps
* ssh
| no description |
| | | **service** string | | no description |
| | | **src-filter** string | | no description |
| | | **srcintf-filter** string | | no description |
| | | **ssl-algorithm** string | **Choices:*** high
* medium
* low
* custom
| no description |
| | | **ssl-certificate** string | | no description |
| | | **ssl-cipher-suites** list / elements=string | | no description |
| | | | **cipher** string | **Choices:*** TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* 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-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* 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-GCM-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-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* 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-GCM-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-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-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| no description |
| | | | **id** integer | | no description |
| | | | **priority** integer | | no description |
| | | | **versions** list / elements=string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | | **ssl-client-fallback** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-client-rekey-count** integer | | no description |
| | | **ssl-client-renegotiation** string | **Choices:*** deny
* allow
* secure
| no description |
| | | **ssl-client-session-state-max** integer | | no description |
| | | **ssl-client-session-state-timeout** integer | | no description |
| | | **ssl-client-session-state-type** string | **Choices:*** disable
* time
* count
* both
| no description |
| | | **ssl-dh-bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
* 3072
* 4096
| no description |
| | | **ssl-hpkp** string | **Choices:*** disable
* enable
* report-only
| no description |
| | | **ssl-hpkp-age** integer | | no description |
| | | **ssl-hpkp-backup** string | | no description |
| | | **ssl-hpkp-include-subdomains** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-hpkp-primary** string | | no description |
| | | **ssl-hpkp-report-uri** string | | no description |
| | | **ssl-hsts** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-hsts-age** integer | | no description |
| | | **ssl-hsts-include-subdomains** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-http-location-conversion** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-http-match-host** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-max-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | | **ssl-min-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | | **ssl-mode** string | **Choices:*** half
* full
| no description |
| | | **ssl-pfs** string | **Choices:*** require
* deny
* allow
| no description |
| | | **ssl-send-empty-frags** string | **Choices:*** disable
* enable
| no description |
| | | **ssl-server-algorithm** string | **Choices:*** high
* low
* medium
* custom
* client
| no description |
| | | **ssl-server-max-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| no description |
| | | **ssl-server-min-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* client
* tls-1.3
| no description |
| | | **ssl-server-session-state-max** integer | | no description |
| | | **ssl-server-session-state-timeout** integer | | no description |
| | | **ssl-server-session-state-type** string | **Choices:*** disable
* time
* count
* both
| no description |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable VIP. |
| | | **type** string | **Choices:*** static-nat
* load-balance
* server-load-balance
* dns-translation
* fqdn
* access-proxy
| no description |
| | | **uuid** string | | no description |
| | | **weblogic-server** string | **Choices:*** disable
* enable
| no description |
| | | **websphere-server** string | **Choices:*** disable
* enable
| no description |
| | **extaddr** string | | External FQDN address name. |
| | **extintf** string | | Interface connected to the source network that receives the packets that will be forwarded to the destination network. |
| | **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 n... |
| | **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. Disa... |
| | **http-ip-header** string | **Choices:*** disable
* enable
| 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-F... |
| | **http-multiplex** string | **Choices:*** disable
* enable
| Enable/disable HTTP multiplexing. |
| | **http-redirect** string | **Choices:*** disable
* enable
| 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. |
| | **mappedip** string | | no description |
| | **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** string | | Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
| | **name** string | | 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 ses... |
| | **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 | | no description |
| | | **address** string | | Dynamic address of the real server. |
| | | **client-ip** string | | no description |
| | | **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 | | 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 rea... |
| | | **monitor** string | | Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
| | | **port** integer | | Port for communicating with the real server. Required if port forwarding is enabled. |
| | | **seq** integer | | no description |
| | | **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 ... |
| | | **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 connect... |
| | **server-type** string | **Choices:*** http
* https
* ssl
* tcp
* udp
* ip
* imaps
* pop3s
* smtps
* ssh
| Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). |
| | **service** string | | Service name. |
| | **src-filter** string | | no description |
| | **srcintf-filter** string | | Interfaces to which the VIP applies. Separate the names with spaces. |
| | **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. |
| | **ssl-cipher-suites** list / elements=string | | no description |
| | | **cipher** string | **Choices:*** TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* 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-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* 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-GCM-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-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* 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-GCM-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-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-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **id** integer | | no description |
| | | **priority** integer | | SSL/TLS cipher suites priority. |
| | | **versions** list / elements=string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | **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:*** deny
* allow
* 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. |
| | **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. |
| | **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:*** disable
* enable
| Enable to replace HTTP with HTTPS in the replys Location HTTP header field. |
| | **ssl-http-match-host** string | **Choices:*** disable
* enable
| 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... |
| | **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:*** disable
* enable
| Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibi... |
| | **ssl-server-algorithm** string | **Choices:*** high
* low
* medium
* 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 | | no description |
| | | **cipher** string | **Choices:*** TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* 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-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* 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-GCM-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-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* 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-GCM-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-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-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer | | SSL/TLS cipher suites priority. |
| | | **versions** list / elements=string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | **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, 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. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure virtual IP for IPv4.
fmgr_firewall_vip:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_vip:
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
dns-mapping-ttl: <value of integer>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
dns-mapping-ttl: <value of integer>
extaddr: <value of string>
extintf: <value of string>
extip: <value of string>
extport: <value of string>
gratuitous-arp-interval: <value of integer>
http-cookie-age: <value of integer>
http-cookie-domain: <value of string>
http-cookie-domain-from-host: <value in [disable, enable]>
http-cookie-generation: <value of integer>
http-cookie-path: <value of string>
http-cookie-share: <value in [disable, same-ip]>
http-ip-header: <value in [disable, enable]>
http-ip-header-name: <value of string>
http-multiplex: <value in [disable, enable]>
https-cookie-secure: <value in [disable, enable]>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mapped-addr: <value of string>
mappedip: <value of string>
mappedport: <value of string>
max-embryonic-connections: <value of integer>
monitor: <value of string>
nat-source-vip: <value in [disable, enable]>
outlook-web-access: <value in [disable, enable]>
persistence: <value in [none, http-cookie, ssl-session-id]>
portforward: <value in [disable, enable]>
portmapping-type: <value in [1-to-1, m-to-n]>
protocol: <value in [tcp, udp, sctp, ...]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
http-host: <value of string>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
seq: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
address: <value of string>
id: <value of integer>
type: <value in [ip, address]>
server-type: <value in [http, https, ssl, ...]>
service: <value of string>
src-filter: <value of string>
srcintf-filter: <value of string>
ssl-algorithm: <value in [high, medium, low, ...]>
ssl-certificate: <value of string>
ssl-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
id: <value of integer>
versions:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
priority: <value of integer>
ssl-client-fallback: <value in [disable, enable]>
ssl-client-renegotiation: <value in [deny, allow, secure]>
ssl-client-session-state-max: <value of integer>
ssl-client-session-state-timeout: <value of integer>
ssl-client-session-state-type: <value in [disable, time, count, ...]>
ssl-dh-bits: <value in [768, 1024, 1536, ...]>
ssl-hpkp: <value in [disable, enable, report-only]>
ssl-hpkp-age: <value of integer>
ssl-hpkp-backup: <value of string>
ssl-hpkp-include-subdomains: <value in [disable, enable]>
ssl-hpkp-primary: <value of string>
ssl-hpkp-report-uri: <value of string>
ssl-hsts: <value in [disable, enable]>
ssl-hsts-age: <value of integer>
ssl-hsts-include-subdomains: <value in [disable, enable]>
ssl-http-location-conversion: <value in [disable, enable]>
ssl-http-match-host: <value in [disable, enable]>
ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-mode: <value in [half, full]>
ssl-pfs: <value in [require, deny, allow]>
ssl-send-empty-frags: <value in [disable, enable]>
ssl-server-algorithm: <value in [high, low, medium, ...]>
ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-session-state-max: <value of integer>
ssl-server-session-state-timeout: <value of integer>
ssl-server-session-state-type: <value in [disable, time, count, ...]>
type: <value in [static-nat, load-balance, server-load-balance, ...]>
uuid: <value of string>
weblogic-server: <value in [disable, enable]>
websphere-server: <value in [disable, enable]>
http-redirect: <value in [disable, enable]>
ssl-client-rekey-count: <value of integer>
status: <value in [disable, enable]>
extaddr: <value of string>
extintf: <value of string>
extip: <value of string>
extport: <value of string>
gratuitous-arp-interval: <value of integer>
http-cookie-age: <value of integer>
http-cookie-domain: <value of string>
http-cookie-domain-from-host: <value in [disable, enable]>
http-cookie-generation: <value of integer>
http-cookie-path: <value of string>
http-cookie-share: <value in [disable, same-ip]>
http-ip-header: <value in [disable, enable]>
http-ip-header-name: <value of string>
http-multiplex: <value in [disable, enable]>
https-cookie-secure: <value in [disable, enable]>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mapped-addr: <value of string>
mappedip: <value of string>
mappedport: <value of string>
max-embryonic-connections: <value of integer>
monitor: <value of string>
name: <value of string>
nat-source-vip: <value in [disable, enable]>
outlook-web-access: <value in [disable, enable]>
persistence: <value in [none, http-cookie, ssl-session-id]>
portforward: <value in [disable, enable]>
portmapping-type: <value in [1-to-1, m-to-n]>
protocol: <value in [tcp, udp, sctp, ...]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
http-host: <value of string>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
seq: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
address: <value of string>
id: <value of integer>
type: <value in [ip, address]>
server-type: <value in [http, https, ssl, ...]>
service: <value of string>
src-filter: <value of string>
srcintf-filter: <value of string>
ssl-algorithm: <value in [high, medium, low, ...]>
ssl-certificate: <value of string>
ssl-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
id: <value of integer>
versions:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
priority: <value of integer>
ssl-client-fallback: <value in [disable, enable]>
ssl-client-renegotiation: <value in [deny, allow, secure]>
ssl-client-session-state-max: <value of integer>
ssl-client-session-state-timeout: <value of integer>
ssl-client-session-state-type: <value in [disable, time, count, ...]>
ssl-dh-bits: <value in [768, 1024, 1536, ...]>
ssl-hpkp: <value in [disable, enable, report-only]>
ssl-hpkp-age: <value of integer>
ssl-hpkp-backup: <value of string>
ssl-hpkp-include-subdomains: <value in [disable, enable]>
ssl-hpkp-primary: <value of string>
ssl-hpkp-report-uri: <value of string>
ssl-hsts: <value in [disable, enable]>
ssl-hsts-age: <value of integer>
ssl-hsts-include-subdomains: <value in [disable, enable]>
ssl-http-location-conversion: <value in [disable, enable]>
ssl-http-match-host: <value in [disable, enable]>
ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-mode: <value in [half, full]>
ssl-pfs: <value in [require, deny, allow]>
ssl-send-empty-frags: <value in [disable, enable]>
ssl-server-algorithm: <value in [high, low, medium, ...]>
ssl-server-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
priority: <value of integer>
versions:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-session-state-max: <value of integer>
ssl-server-session-state-timeout: <value of integer>
ssl-server-session-state-type: <value in [disable, time, count, ...]>
type: <value in [static-nat, load-balance, server-load-balance, ...]>
uuid: <value of string>
weblogic-server: <value in [disable, enable]>
websphere-server: <value in [disable, enable]>
http-redirect: <value in [disable, enable]>
ssl-client-rekey-count: <value of integer>
status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_firewall_accessproxy – Configure Access Proxy. fortinet.fortimanager.fmgr\_firewall\_accessproxy – Configure Access Proxy.
===========================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_accessproxy`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_accessproxy** dictionary | | the top level parameters set |
| | **api-gateway** list / elements=string | | no description |
| | | **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. ... |
| | | **https-cookie-secure** string | **Choices:*** disable
* enable
| Enable/disable verification that inserted HTTPS cookies are secure. |
| | | **id** integer | | 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 ... |
| | | **realservers** list / elements=string | | no description |
| | | | **address** string | | Address or address group of the real server. |
| | | | **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 servers connectivity status. |
| | | | **http-host** string | | HTTP server domain name in HTTP header. |
| | | | **id** integer | | 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 tra... |
| | | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more... |
| | | **saml-server** string | | SAML service provider configuration for VIP authentication. |
| | | **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 | | no description |
| | | | **cipher** string | **Choices:*** TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* 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-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* 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-GCM-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-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* 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-GCM-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-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-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | | **priority** integer | | SSL/TLS cipher suites priority. |
| | | | **versions** list / elements=string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | | **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. |
| | **client-cert** string | **Choices:*** disable
* enable
| Enable/disable to request client certificate. |
| | **empty-cert-action** string | **Choices:*** block
* accept
| 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 | | Access Proxy name. |
| | **realservers** list / elements=string | | no description |
| | | **id** integer | | 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 ... |
| | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connect... |
| | **server-pubkey-auth** string | **Choices:*** disable
* enable
| Enable/disable SSH real server public key authentication. |
| | **server-pubkey-auth-settings** dictionary | | no description |
| | | **auth-ca** string | | Name of the SSH server public key authentication CA. |
| | | **cert-extension** list / elements=string | | no description |
| | | | **critical** string | **Choices:*** no
* yes
| Critical option. |
| | | | **data** string | | Name of certificate extension. |
| | | | **name** string | | Name of certificate extension. |
| | | | **type** string | **Choices:*** fixed
* user
| Type of certificate extension. |
| | | **permit-agent-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-agent-forwarding certificate extension. |
| | | **permit-port-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-port-forwarding certificate extension. |
| | | **permit-pty** string | **Choices:*** disable
* enable
| Enable/disable appending permit-pty certificate extension. |
| | | **permit-user-rc** string | **Choices:*** disable
* enable
| Enable/disable appending permit-user-rc certificate extension. |
| | | **permit-x11-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-x11-forwarding certificate extension. |
| | | **source-address** string | **Choices:*** disable
* enable
| Enable/disable appending source-address certificate critical option. This option ensure certificate only accepted from... |
| | **vip** string | | Virtual IP name. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure Access Proxy.
fmgr_firewall_accessproxy:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_accessproxy:
api-gateway:
-
http-cookie-age: <value of integer>
http-cookie-domain: <value of string>
http-cookie-domain-from-host: <value in [disable, enable]>
http-cookie-generation: <value of integer>
http-cookie-path: <value of string>
http-cookie-share: <value in [disable, same-ip]>
https-cookie-secure: <value in [disable, enable]>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
persistence: <value in [none, http-cookie]>
realservers:
-
address: <value of string>
health-check: <value in [disable, enable]>
health-check-proto: <value in [ping, http, tcp-connect]>
http-host: <value of string>
id: <value of integer>
ip: <value of string>
mappedport: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
saml-server: <value of string>
service: <value in [http, https, tcp-forwarding, ...]>
ssl-algorithm: <value in [high, medium, low, ...]>
ssl-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
priority: <value of integer>
versions:
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
ssl-dh-bits: <value in [768, 1024, 1536, ...]>
ssl-max-version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl-min-version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
url-map: <value of string>
url-map-type: <value in [sub-string, wildcard, regex]>
virtual-host: <value of string>
client-cert: <value in [disable, enable]>
empty-cert-action: <value in [block, accept]>
ldb-method: <value in [static, round-robin, weighted, ...]>
name: <value of string>
realservers:
-
id: <value of integer>
ip: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
server-pubkey-auth: <value in [disable, enable]>
server-pubkey-auth-settings:
auth-ca: <value of string>
cert-extension:
-
critical: <value in [no, yes]>
data: <value of string>
name: <value of string>
type: <value in [fixed, user]>
permit-agent-forwarding: <value in [disable, enable]>
permit-port-forwarding: <value in [disable, enable]>
permit-pty: <value in [disable, enable]>
permit-user-rc: <value in [disable, enable]>
permit-x11-forwarding: <value in [disable, enable]>
source-address: <value in [disable, enable]>
vip: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry_portrange – Port ranges in the custom entry. fortinet.fortimanager.fmgr\_firewall\_internetserviceaddition\_entry\_portrange – Port ranges in the custom entry.
==================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry_portrange`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **entry** string / required | | the parameter (entry) in requested url |
| **firewall\_internetserviceaddition\_entry\_portrange** dictionary | | the top level parameters set |
| | **end-port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535). |
| | **id** integer | | Custom entry port range ID. |
| | **start-port** integer | | Integer value for starting TCP/UDP/SCTP destination port in range (1 to 65535). |
| **internet-service-addition** string / required | | the parameter (internet-service-addition) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Port ranges in the custom entry.
fmgr_firewall_internetserviceaddition_entry_portrange:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
internet-service-addition: <your own value>
entry: <your own value>
state: <value in [present, absent]>
firewall_internetserviceaddition_entry_portrange:
end-port: <value of integer>
id: <value of integer>
start-port: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_user_securityexemptlist – Configure security exemption list. fortinet.fortimanager.fmgr\_user\_securityexemptlist – Configure security exemption list.
=========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_user_securityexemptlist`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **user\_securityexemptlist** dictionary | | the top level parameters set |
| | **description** string | | Description. |
| | **name** string | | Name of the exempt list. |
| | **rule** list / elements=string | | no description |
| | | **devices** string | | Devices or device groups. |
| | | **dstaddr** string | | Destination addresses or address groups. |
| | | **id** integer | | ID. |
| | | **service** string | | Destination services. |
| | | **srcaddr** string | | Source addresses or address groups. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure security exemption list.
fmgr_user_securityexemptlist:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_securityexemptlist:
description: <value of string>
name: <value of string>
rule:
-
devices: <value of string>
dstaddr: <value of string>
id: <value of integer>
service: <value of string>
srcaddr: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_webfilter_profile_override – Web Filter override settings. fortinet.fortimanager.fmgr\_webfilter\_profile\_override – Web Filter override settings.
========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webfilter_profile_override`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **webfilter\_profile\_override** dictionary | | the top level parameters set |
| | **ovrd-cookie** string | **Choices:*** deny
* allow
| Allow/deny browser-based (cookie) overrides. |
| | **ovrd-dur** string | | Override duration. |
| | **ovrd-dur-mode** string | **Choices:*** constant
* ask
| Override duration mode. |
| | **ovrd-scope** string | **Choices:*** user
* user-group
* ip
* ask
* browser
| Override scope. |
| | **ovrd-user-group** string | | User groups with permission to use the override. |
| | **profile** string | | Web filter profile with permission to create overrides. |
| | **profile-attribute** string | **Choices:*** User-Name
* User-Password
* CHAP-Password
* NAS-IP-Address
* NAS-Port
* Service-Type
* Framed-Protocol
* Framed-IP-Address
* Framed-IP-Netmask
* Framed-Routing
* Filter-Id
* Framed-MTU
* Framed-Compression
* Login-IP-Host
* Login-Service
* Login-TCP-Port
* Reply-Message
* Callback-Number
* Callback-Id
* Framed-Route
* Framed-IPX-Network
* State
* Class
* Vendor-Specific
* Session-Timeout
* Idle-Timeout
* Termination-Action
* Called-Station-Id
* Calling-Station-Id
* NAS-Identifier
* Proxy-State
* Login-LAT-Service
* Login-LAT-Node
* Login-LAT-Group
* Framed-AppleTalk-Link
* Framed-AppleTalk-Network
* Framed-AppleTalk-Zone
* Acct-Status-Type
* Acct-Delay-Time
* Acct-Input-Octets
* Acct-Output-Octets
* Acct-Session-Id
* Acct-Authentic
* Acct-Session-Time
* Acct-Input-Packets
* Acct-Output-Packets
* Acct-Terminate-Cause
* Acct-Multi-Session-Id
* Acct-Link-Count
* CHAP-Challenge
* NAS-Port-Type
* Port-Limit
* Login-LAT-Port
| Profile attribute to retrieve from the RADIUS server. |
| | **profile-type** string | **Choices:*** list
* radius
| Override profile type. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Web Filter override settings.
fmgr_webfilter_profile_override:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
webfilter_profile_override:
ovrd-cookie: <value in [deny, allow]>
ovrd-dur: <value of string>
ovrd-dur-mode: <value in [constant, ask]>
ovrd-scope: <value in [user, user-group, ip, ...]>
ovrd-user-group: <value of string>
profile: <value of string>
profile-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
profile-type: <value in [list, radius]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings – Server SSH public key authentication settings. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_serverpubkeyauthsettings – Server SSH public key authentication settings.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access-proxy** string / required | | the parameter (access-proxy) in requested url |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_accessproxy\_serverpubkeyauthsettings** dictionary | | the top level parameters set |
| | **auth-ca** string | | Name of the SSH server public key authentication CA. |
| | **cert-extension** list / elements=string | | no description |
| | | **critical** string | **Choices:*** no
* yes
| Critical option. |
| | | **data** string | | Name of certificate extension. |
| | | **name** string | | Name of certificate extension. |
| | | **type** string | **Choices:*** fixed
* user
| Type of certificate extension. |
| | **permit-agent-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-agent-forwarding certificate extension. |
| | **permit-port-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-port-forwarding certificate extension. |
| | **permit-pty** string | **Choices:*** disable
* enable
| Enable/disable appending permit-pty certificate extension. |
| | **permit-user-rc** string | **Choices:*** disable
* enable
| Enable/disable appending permit-user-rc certificate extension. |
| | **permit-x11-forwarding** string | **Choices:*** disable
* enable
| Enable/disable appending permit-x11-forwarding certificate extension. |
| | **source-address** string | **Choices:*** disable
* enable
| Enable/disable appending source-address certificate critical option. This option ensure certificate only accepted from FortiGa... |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Server SSH public key authentication settings.
fmgr_firewall_accessproxy_serverpubkeyauthsettings:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
access-proxy: <your own value>
firewall_accessproxy_serverpubkeyauthsettings:
auth-ca: <value of string>
cert-extension:
-
critical: <value in [no, yes]>
data: <value of string>
name: <value of string>
type: <value in [fixed, user]>
permit-agent-forwarding: <value in [disable, enable]>
permit-port-forwarding: <value in [disable, enable]>
permit-pty: <value in [disable, enable]>
permit-user-rc: <value in [disable, enable]>
permit-x11-forwarding: <value in [disable, enable]>
source-address: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_devprof_log_syslogd_filter – Filters for remote system server. fortinet.fortimanager.fmgr\_devprof\_log\_syslogd\_filter – Filters for remote system server.
=============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_devprof_log_syslogd_filter`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **devprof** string / required | | the parameter (devprof) in requested url |
| **devprof\_log\_syslogd\_filter** dictionary | | the top level parameters set |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Lowest severity level to log. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Filters for remote system server.
fmgr_devprof_log_syslogd_filter:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
devprof_log_syslogd_filter:
severity: <value in [emergency, alert, critical, ...]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_emailfilter_blockallowlist – Configure anti-spam block/allow list. fortinet.fortimanager.fmgr\_emailfilter\_blockallowlist – Configure anti-spam block/allow list.
===============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_blockallowlist`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **emailfilter\_blockallowlist** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** spam
* clear
* reject
| Reject, mark as spam or good email. |
| | | **addr-type** string | **Choices:*** ipv4
* ipv6
| IP address type. |
| | | **email-pattern** string | | Email address pattern. |
| | | **id** integer | | Entry ID. |
| | | **ip4-subnet** string | | IPv4 network address/subnet mask bits. |
| | | **ip6-subnet** string | | IPv6 network address/subnet mask bits. |
| | | **pattern-type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| | | **type** string | **Choices:*** ip
* email
| Entry type. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure anti-spam block/allow list.
fmgr_emailfilter_blockallowlist:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
emailfilter_blockallowlist:
comment: <value of string>
entries:
-
action: <value in [spam, clear, reject]>
addr-type: <value in [ipv4, ipv6]>
email-pattern: <value of string>
id: <value of integer>
ip4-subnet: <value of string>
ip6-subnet: <value of string>
pattern-type: <value in [wildcard, regexp]>
status: <value in [disable, enable]>
type: <value in [ip, email]>
id: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_addrgrp6_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_addrgrp6\_tagging – Config object tagging.
================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_addrgrp6_tagging`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **addrgrp6** string / required | | the parameter (addrgrp6) in requested url |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_addrgrp6\_tagging** dictionary | | the top level parameters set |
| | **category** string | | Tag category. |
| | **name** string | | Tagging entry name. |
| | **tags** string | | no description |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Config object tagging.
fmgr_firewall_addrgrp6_tagging:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
addrgrp6: <your own value>
state: <value in [present, absent]>
firewall_addrgrp6_tagging:
category: <value of string>
name: <value of string>
tags: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_devprof_system_replacemsg_utm – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_utm – Replacement messages.
====================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_devprof_system_replacemsg_utm`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **devprof** string / required | | the parameter (devprof) in requested url |
| **devprof\_system\_replacemsg\_utm** dictionary | | the top level parameters set |
| | **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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fmgr_devprof_system_replacemsg_utm:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
devprof_system_replacemsg_utm:
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_emailfilter_iptrust – Configure AntiSpam IP trust. fortinet.fortimanager.fmgr\_emailfilter\_iptrust – Configure AntiSpam IP trust.
===============================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_iptrust`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **emailfilter\_iptrust** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **addr-type** string | **Choices:*** ipv4
* ipv6
| Type of address. |
| | | **id** integer | | 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:*** disable
* enable
| Enable/disable status. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam IP trust.
fmgr_emailfilter_iptrust:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
emailfilter_iptrust:
comment: <value of string>
entries:
-
addr-type: <value in [ipv4, ipv6]>
id: <value of integer>
ip4-subnet: <value of string>
ip6-subnet: <value of string>
status: <value in [disable, enable]>
id: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_devprof_system_replacemsg_ftp – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_ftp – Replacement messages.
====================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_devprof_system_replacemsg_ftp`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **devprof** string / required | | the parameter (devprof) in requested url |
| **devprof\_system\_replacemsg\_ftp** dictionary | | the top level parameters set |
| | **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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fmgr_devprof_system_replacemsg_ftp:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
devprof_system_replacemsg_ftp:
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_dvmdb_workflow_drop – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_drop – no description
==================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvmdb_workflow_drop`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **session\_id** string / required | | the parameter (session\_id) in requested url |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_dvmdb_workflow_drop:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
session_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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_fmupdate_fdssetting_pushoverride – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for… fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_pushoverride – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for…
==========================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_fmupdate_fdssetting_pushoverride`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fmupdate\_fdssetting\_pushoverride** dictionary | | the top level parameters set |
| | **ip** string | **Default:**"0.0.0.0" | External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. |
| | **port** integer | **Default:**9443 | Receiving port number on the NAT device (1 - 65535, default = 9443). |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable push updates for clients (default = disable). disable - Disable setting. enable - Enable setting. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for...
fmgr_fmupdate_fdssetting_pushoverride:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
fmupdate_fdssetting_pushoverride:
ip: <value of string>
port: <value of integer>
status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_profileprotocoloptions – Configure protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions – Configure protocol options.
==========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_profileprotocoloptions`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_profileprotocoloptions** dictionary | | the top level parameters set |
| | **cifs** dictionary | | no description |
| | | **domain-controller** string | | Domain for which to decrypt CIFS traffic. |
| | | **file-filter** dictionary | | no description |
| | | | **entries** list / elements=string | | no description |
| | | | | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | | | | **comment** string | | Comment. |
| | | | | **direction** string | **Choices:*** any
* incoming
* outgoing
| Match files transmitted in the sessions originating or reply direction. |
| | | | | **file-type** string | | no description |
| | | | | **filter** string | | Add a file filter. |
| | | | | **protocol** list / elements=string | **Choices:*** cifs
| no description |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable file filter logging. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable file filter. |
| | | **options** list / elements=string | **Choices:*** oversize
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **server-credential-type** string | **Choices:*** none
* credential-replication
* credential-keytab
| CIFS server credential type. |
| | | **server-keytab** list / elements=string | | no description |
| | | | **keytab** string | | Base64 encoded keytab file containing credential of the server. |
| | | | **password** string | | no description |
| | | | **principal** string | | Service principal. For example, "host/[email protected]". |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the active status of scanning for this protocol. |
| | | **tcp-window-maximum** integer | | Maximum dynamic TCP window size (default = 8MB). |
| | | **tcp-window-minimum** integer | | Minimum dynamic TCP window size (default = 128KB). |
| | | **tcp-window-size** integer | | Set TCP static window size (default = 256KB). |
| | | **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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **comment** string | | Optional comments. |
| | **dns** dictionary | | no description |
| | | **ports** integer | | no description |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the active status of scanning for this protocol. |
| | **feature-set** string | **Choices:*** proxy
* flow
| Flow/proxy feature set. |
| | **ftp** dictionary | | no description |
| | | **comfort-amount** integer | | Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
| | | **comfort-interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def... |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** clientcomfort
* no-content-summary
* oversize
* splice
* bypass-rest-command
* bypass-mode-command
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** disable
* enable
| 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 uncompres... |
| | | **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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **http** dictionary | | no description |
| | | **block-page-status-code** integer | | Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599, default = 403). |
| | | **comfort-amount** integer | | Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
| | | **comfort-interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def... |
| | | **fortinet-bar** string | **Choices:*** disable
* enable
| no description |
| | | **fortinet-bar-port** integer | | no description |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* chunkedbypass
* clientcomfort
* no-content-summary
* servercomfort
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **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
| no description |
| | | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| 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, default = 0). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** disable
* enable
| 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 uncompres... |
| | | **streaming-content-bypass** string | **Choices:*** disable
* enable
| 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 (default = 8MB). |
| | | **tcp-window-minimum** integer | | Minimum dynamic TCP window size (default = 128KB). |
| | | **tcp-window-size** integer | | Set TCP static window size (default = 256KB). |
| | | **tcp-window-type** string | **Choices:*** system
* static
* dynamic
| Specify type of TCP window to use for this protocol. |
| | | **tunnel-non-http** string | **Choices:*** disable
* enable
| Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can o... |
| | | **uncompressed-nest-limit** integer | | Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | | **unknown-http-version** string | **Choices:*** best-effort
* reject
* tunnel
| How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. |
| | **imap** dictionary | | no description |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* fragmail
* no-content-summary
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** disable
* enable
| 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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **mail-signature** dictionary | | no description |
| | | **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 | | no description |
| | | **options** list / elements=string | **Choices:*** fragmail
* oversize
* no-content-summary
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **status** string | **Choices:*** disable
* enable
| 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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **name** string | | Name. |
| | **nntp** dictionary | | no description |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* no-content-summary
* splice
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **status** string | **Choices:*** disable
* enable
| 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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **oversize-log** string | **Choices:*** disable
* enable
| Enable/disable logging for antivirus oversize file blocking. |
| | **pop3** dictionary | | no description |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* fragmail
* no-content-summary
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** disable
* enable
| 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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **replacemsg-group** string | | Name of the replacement message group to be used |
| | **rpc-over-http** string | **Choices:*** disable
* enable
| Enable/disable inspection of RPC over HTTP. |
| | **smtp** dictionary | | no description |
| | | **inspect-all** string | **Choices:*** disable
* enable
| Enable/disable the inspection of all ports for the protocol. |
| | | **options** list / elements=string | **Choices:*** oversize
* fragmail
* no-content-summary
* splice
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **ports** integer | | no description |
| | | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **server-busy** string | **Choices:*** disable
* enable
| Enable/disable SMTP server busy when server not available. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| SSL decryption and encryption performed by an external device. |
| | | **status** string | **Choices:*** disable
* enable
| 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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **ssh** dictionary | | no description |
| | | **comfort-amount** integer | | Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
| | | **comfort-interval** integer | | Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def... |
| | | **options** list / elements=string | **Choices:*** oversize
* clientcomfort
* servercomfort
| no description |
| | | **oversize-limit** integer | | Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
| | | **scan-bzip2** string | **Choices:*** disable
* enable
| Enable/disable scanning of BZip2 compressed files. |
| | | **ssl-offloaded** string | **Choices:*** no
* yes
| 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 uncompres... |
| | | **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, default = 12). |
| | | **uncompressed-oversize-limit** integer | | Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
| | **switching-protocols-log** string | **Choices:*** disable
* enable
| Enable/disable logging for HTTP/HTTPS switching protocols. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure protocol options.
fmgr_firewall_profileprotocoloptions:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_profileprotocoloptions:
comment: <value of string>
name: <value of string>
oversize-log: <value in [disable, enable]>
replacemsg-group: <value of string>
rpc-over-http: <value in [disable, enable]>
switching-protocols-log: <value in [disable, enable]>
feature-set: <value in [proxy, flow]>
cifs:
domain-controller: <value of string>
file-filter:
entries:
-
action: <value in [log, block]>
comment: <value of string>
direction: <value in [any, incoming, outgoing]>
file-type: <value of string>
filter: <value of string>
protocol:
- cifs
log: <value in [disable, enable]>
status: <value in [disable, enable]>
options:
- oversize
oversize-limit: <value of integer>
ports: <value of integer>
scan-bzip2: <value in [disable, enable]>
server-credential-type: <value in [none, credential-replication, credential-keytab]>
server-keytab:
-
keytab: <value of string>
password: <value of string>
principal: <value of string>
status: <value in [disable, enable]>
tcp-window-maximum: <value of integer>
tcp-window-minimum: <value of integer>
tcp-window-size: <value of integer>
tcp-window-type: <value in [system, static, dynamic]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
dns:
ports: <value of integer>
status: <value in [disable, enable]>
ftp:
comfort-amount: <value of integer>
comfort-interval: <value of integer>
inspect-all: <value in [disable, enable]>
options:
- clientcomfort
- no-content-summary
- oversize
- splice
- bypass-rest-command
- bypass-mode-command
oversize-limit: <value of integer>
ports: <value of integer>
scan-bzip2: <value in [disable, enable]>
ssl-offloaded: <value in [no, yes]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
stream-based-uncompressed-limit: <value of integer>
tcp-window-maximum: <value of integer>
tcp-window-minimum: <value of integer>
tcp-window-size: <value of integer>
tcp-window-type: <value in [system, static, dynamic]>
http:
block-page-status-code: <value of integer>
comfort-amount: <value of integer>
comfort-interval: <value of integer>
fortinet-bar: <value in [disable, enable]>
fortinet-bar-port: <value of integer>
inspect-all: <value in [disable, enable]>
options:
- oversize
- chunkedbypass
- clientcomfort
- no-content-summary
- servercomfort
oversize-limit: <value of integer>
ports: <value of integer>
post-lang:
- 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
proxy-after-tcp-handshake: <value in [disable, enable]>
range-block: <value in [disable, enable]>
retry-count: <value of integer>
scan-bzip2: <value in [disable, enable]>
ssl-offloaded: <value in [no, yes]>
status: <value in [disable, enable]>
stream-based-uncompressed-limit: <value of integer>
streaming-content-bypass: <value in [disable, enable]>
strip-x-forwarded-for: <value in [disable, enable]>
switching-protocols: <value in [bypass, block]>
tcp-window-maximum: <value of integer>
tcp-window-minimum: <value of integer>
tcp-window-size: <value of integer>
tcp-window-type: <value in [system, static, dynamic]>
tunnel-non-http: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
unknown-http-version: <value in [best-effort, reject, tunnel]>
imap:
inspect-all: <value in [disable, enable]>
options:
- oversize
- fragmail
- no-content-summary
oversize-limit: <value of integer>
ports: <value of integer>
proxy-after-tcp-handshake: <value in [disable, enable]>
scan-bzip2: <value in [disable, enable]>
ssl-offloaded: <value in [no, yes]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
mail-signature:
signature: <value of string>
status: <value in [disable, enable]>
mapi:
options:
- fragmail
- oversize
- no-content-summary
oversize-limit: <value of integer>
ports: <value of integer>
scan-bzip2: <value in [disable, enable]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
nntp:
inspect-all: <value in [disable, enable]>
options:
- oversize
- no-content-summary
- splice
oversize-limit: <value of integer>
ports: <value of integer>
proxy-after-tcp-handshake: <value in [disable, enable]>
scan-bzip2: <value in [disable, enable]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
pop3:
inspect-all: <value in [disable, enable]>
options:
- oversize
- fragmail
- no-content-summary
oversize-limit: <value of integer>
ports: <value of integer>
proxy-after-tcp-handshake: <value in [disable, enable]>
scan-bzip2: <value in [disable, enable]>
ssl-offloaded: <value in [no, yes]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
smtp:
inspect-all: <value in [disable, enable]>
options:
- oversize
- fragmail
- no-content-summary
- splice
oversize-limit: <value of integer>
ports: <value of integer>
proxy-after-tcp-handshake: <value in [disable, enable]>
scan-bzip2: <value in [disable, enable]>
server-busy: <value in [disable, enable]>
ssl-offloaded: <value in [no, yes]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
ssh:
comfort-amount: <value of integer>
comfort-interval: <value of integer>
options:
- oversize
- clientcomfort
- servercomfort
oversize-limit: <value of integer>
scan-bzip2: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
ssl-offloaded: <value in [no, yes]>
stream-based-uncompressed-limit: <value of integer>
tcp-window-maximum: <value of integer>
tcp-window-minimum: <value of integer>
tcp-window-size: <value of integer>
tcp-window-type: <value in [system, static, dynamic]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members – Physical FortiGate interfaces added to the virtual-wan-link. fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_members – Physical FortiGate interfaces added to the virtual-wan-link.
===================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_virtualwanlink\_members** dictionary | | the top level parameters set |
| | **\_dynamic-member** string | | no description |
| | **comment** string | | Comments. |
| | **cost** integer | | Cost of this interface for services in SLA mode (0 - 4294967295, default = 0). |
| | **gateway** string | | The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is co... |
| | **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 sessi... |
| | **interface** string | | 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 sessio... |
| | **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. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Physical FortiGate interfaces added to the virtual-wan-link.
fmgr_wanprof_system_virtualwanlink_members:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_members:
_dynamic-member: <value of string>
comment: <value of string>
gateway: <value of string>
gateway6: <value of string>
ingress-spillover-threshold: <value of integer>
interface: <value of string>
priority: <value of integer>
seq-num: <value of integer>
source: <value of string>
source6: <value of string>
spillover-threshold: <value of integer>
status: <value in [disable, enable]>
volume-ratio: <value of integer>
weight: <value of integer>
cost: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_user_group_guest – Guest User. fortinet.fortimanager.fmgr\_user\_group\_guest – Guest User.
============================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_user_group_guest`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **group** string / required | | the parameter (group) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **user\_group\_guest** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **company** string | | Set the action for the company guest user field. |
| | **email** string | | Email. |
| | **expiration** string | | Expire time. |
| | **id** integer | | Guest ID. |
| | **mobile-phone** string | | Mobile phone. |
| | **name** string | | Guest name. |
| | **password** string | | no description |
| | **sponsor** string | | Set the action for the sponsor guest user field. |
| | **user-id** string | | Guest ID. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Guest User.
fmgr_user_group_guest:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
group: <your own value>
state: <value in [present, absent]>
user_group_guest:
comment: <value of string>
company: <value of string>
email: <value of string>
expiration: <value of string>
mobile-phone: <value of string>
name: <value of string>
password: <value of string>
sponsor: <value of string>
user-id: <value of string>
id: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_dvm_cmd_import_devlist – Import a list of ADOMs and devices. fortinet.fortimanager.fmgr\_dvm\_cmd\_import\_devlist – Import a list of ADOMs and devices.
===========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvm_cmd_import_devlist`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **dvm\_cmd\_import\_devlist** dictionary | | the top level parameters set |
| | **adom** string | | Name or ID of the ADOM where the command is to be executed on. |
| | **flags** list / elements=string | **Choices:*** none
* create\_task
* nonblocking
* log\_dev
| no description |
| | **import-adom-members** list / elements=string | | no description |
| | | **adom** string | | Target ADOM to associate device VDOM with. |
| | | **dev** string | | no description |
| | | **vdom** string | | no description |
| | **import-adoms** list / elements=string | | no description |
| | | **create\_time** integer | | no description |
| | | **desc** string | | no description |
| | | **flags** list / elements=string | **Choices:*** migration
* db\_export
* no\_vpn\_console
* backup
* other\_devices
* central\_sdwan
* is\_autosync
* per\_device\_wtp
* policy\_check\_on\_install
* install\_on\_policy\_check\_fail
* auto\_push\_cfg
* per\_device\_fsw
| no description |
| | | **log\_db\_retention\_hours** integer | **Default:**1440 | no description |
| | | **log\_disk\_quota** integer | | no description |
| | | **log\_disk\_quota\_alert\_thres** integer | **Default:**90 | no description |
| | | **log\_disk\_quota\_split\_ratio** integer | **Default:**70 | no description |
| | | **log\_file\_retention\_hours** integer | **Default:**8760 | no description |
| | | **meta fields** dictionary | | no description |
| | | **mig\_mr** integer | **Default:**2 | no description |
| | | **mig\_os\_ver** string | **Choices:*** unknown
* 0.0
* 1.0
* 2.0
* 3.0
* 4.0
* 5.0
* **6.0** ←
* 7.0
* 8.0
| no description |
| | | **mode** string | **Choices:*** ems
* **gms** ←
* provider
| ems - (Value no longer used as of 4.3) provider - Global database. |
| | | **mr** integer | **Default:**2 | no description |
| | | **name** string | | no description |
| | | **os\_ver** string | **Choices:*** unknown
* 0.0
* 1.0
* 2.0
* 3.0
* 4.0
* 5.0
* **6.0** ←
* 7.0
* 8.0
| no description |
| | | **restricted\_prds** list / elements=string | **Choices:*** fos
* foc
* fml
* fch
* fwb
* log
* fct
* faz
* fsa
* fsw
* fmg
* fdd
* fac
* fpx
* fna
* fdc
* ffw
* fsr
* fad
* fap
* fxt
| no description |
| | | **state** integer | **Default:**1 | no description |
| | | **uuid** string | | no description |
| | | **workspace\_mode** integer | | no description |
| | **import-devices** list / elements=string | | no description |
| | | **adm\_pass** string | | no description |
| | | **adm\_usr** string | | no description |
| | | **app\_ver** string | | no description |
| | | **av\_ver** string | | no description |
| | | **beta** integer | | no description |
| | | **branch\_pt** integer | | no description |
| | | **build** integer | | no description |
| | | **checksum** string | | no description |
| | | **conf\_status** string | **Choices:*** **unknown** ←
* insync
* outofsync
| no description |
| | | **conn\_mode** string | **Choices:*** active
* **passive** ←
| no description |
| | | **conn\_status** string | **Choices:*** **UNKNOWN** ←
* up
* down
| no description |
| | | **db\_status** string | **Choices:*** **unknown** ←
* nomod
* mod
| no description |
| | | **desc** string | | no description |
| | | **dev\_status** string | **Choices:*** none
* **unknown** ←
* checkedin
* inprogress
* installed
* aborted
* sched
* retry
* canceled
* pending
* retrieved
* changed\_conf
* sync\_fail
* timeout
* rev\_revert
* auto\_updated
| no description |
| | | **fap\_cnt** integer | | no description |
| | | **faz.full\_act** integer | | no description |
| | | **faz.perm** integer | | no description |
| | | **faz.quota** integer | | no description |
| | | **faz.used** integer | | no description |
| | | **fex\_cnt** integer | | no description |
| | | **flags** list / elements=string | **Choices:*** has\_hdd
* vdom\_enabled
* discover
* reload
* interim\_build
* offline\_mode
* is\_model
* fips\_mode
* linked\_to\_model
* ip-conflict
* faz-autosync
| no description |
| | | **foslic\_cpu** integer | | VM Meter vCPU count. |
| | | **foslic\_dr\_site** string | **Choices:*** **disable** ←
* enable
| VM Meter DR Site status. |
| | | **foslic\_inst\_time** integer | | VM Meter first deployment time (in UNIX timestamp). |
| | | **foslic\_last\_sync** integer | | VM Meter last synchronized time (in UNIX timestamp). |
| | | **foslic\_ram** integer | | VM Meter device RAM size (in MB). |
| | | **foslic\_type** string | **Choices:*** **temporary** ←
* trial
* regular
* trial\_expired
| VM Meter license type. |
| | | **foslic\_utm** list / elements=string | **Choices:*** fw
* av
* ips
* app
* url
* utm
* fwb
| no description |
| | | **fsw\_cnt** integer | | no description |
| | | **ha\_group\_id** integer | | no description |
| | | **ha\_group\_name** string | | no description |
| | | **ha\_mode** string | **Choices:*** **standalone** ←
* AP
* AA
* ELBC
* DUAL
* enabled
* unknown
* fmg-enabled
* autoscale
| enabled - Value reserved for non-FOS HA devices. |
| | | **ha\_slave** list / elements=string | | no description |
| | | | **idx** integer | | no description |
| | | | **name** string | | no description |
| | | | **prio** integer | | no description |
| | | | **role** string | **Choices:*** **slave** ←
* master
| no description |
| | | | **sn** string | | no description |
| | | | **status** integer | | no description |
| | | **hdisk\_size** integer | | no description |
| | | **hostname** string | | no description |
| | | **hw\_rev\_major** integer | | no description |
| | | **hw\_rev\_minor** integer | | no description |
| | | **hyperscale** integer | | no description |
| | | **ip** string | | no description |
| | | **ips\_ext** integer | | no description |
| | | **ips\_ver** string | | no description |
| | | **last\_checked** integer | | no description |
| | | **last\_resync** integer | | no description |
| | | **latitude** string | | no description |
| | | **lic\_flags** integer | | no description |
| | | **lic\_region** string | | no description |
| | | **location\_from** string | | no description |
| | | **logdisk\_size** integer | | no description |
| | | **longitude** string | | no description |
| | | **maxvdom** integer | **Default:**10 | no description |
| | | **meta fields** dictionary | | no description |
| | | **mgmt\_id** integer | | no description |
| | | **mgmt\_if** string | | no description |
| | | **mgmt\_mode** string | **Choices:*** **unreg** ←
* fmg
* faz
* fmgfaz
| no description |
| | | **mgt\_vdom** string | | no description |
| | | **module\_sn** string | | no description |
| | | **mr** integer | **Default:**-1 | no description |
| | | **name** string | | Unique name for the device. |
| | | **nsxt\_service\_name** string | | no description |
| | | **os\_type** string | **Choices:*** **unknown** ←
* fos
* fsw
* foc
* fml
* faz
* fwb
* fch
* fct
* log
* fmg
* fsa
* fdd
* fac
* fpx
* fna
* fdc
* ffw
* fsr
* fad
* fap
* fxt
| no description |
| | | **os\_ver** string | **Choices:*** **unknown** ←
* 0.0
* 1.0
* 2.0
* 3.0
* 4.0
* 5.0
* 6.0
* 7.0
* 8.0
| no description |
| | | **patch** integer | | no description |
| | | **platform\_str** string | | no description |
| | | **prefer\_img\_ver** string | | no description |
| | | **prio** integer | | no description |
| | | **private\_key** string | | no description |
| | | **private\_key\_status** integer | | no description |
| | | **psk** string | | no description |
| | | **role** string | **Choices:*** **master** ←
* ha-slave
* autoscale-slave
| no description |
| | | **sn** string | | Unique value for each device. |
| | | **vdom** list / elements=string | | no description |
| | | | **comments** string | | no description |
| | | | **meta fields** dictionary | | no description |
| | | | **name** string | | no description |
| | | | **opmode** string | **Choices:*** **nat** ←
* transparent
| no description |
| | | | **rtm\_prof\_id** integer | | no description |
| | | | **status** string | | no description |
| | | | **vpn\_id** integer | | no description |
| | | **version** integer | | no description |
| | | **vm\_cpu** integer | | no description |
| | | **vm\_cpu\_limit** integer | | no description |
| | | **vm\_lic\_expire** integer | | no description |
| | | **vm\_mem** integer | | no description |
| | | **vm\_mem\_limit** integer | | no description |
| | | **vm\_status** integer | | no description |
| | **import-group-members** list / elements=string | | no description |
| | | **adom** string | | ADOM where the device group is located. Default is "root" if not specified. |
| | | **dev** string | | no description |
| | | **grp** string | | Target device group to associate device VDOM with. |
| | | **vdom** string | | no description |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Import a list of ADOMs and devices.
fmgr_dvm_cmd_import_devlist:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
dvm_cmd_import_devlist:
adom: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
import-adom-members:
-
adom: <value of string>
dev: <value of string>
vdom: <value of string>
import-adoms:
-
desc: <value of string>
flags:
- migration
- db_export
- no_vpn_console
- backup
- other_devices
- central_sdwan
- is_autosync
- per_device_wtp
- policy_check_on_install
- install_on_policy_check_fail
- auto_push_cfg
- per_device_fsw
log_db_retention_hours: <value of integer>
log_disk_quota: <value of integer>
log_disk_quota_alert_thres: <value of integer>
log_disk_quota_split_ratio: <value of integer>
log_file_retention_hours: <value of integer>
meta fields: <value of dict>
mig_mr: <value of integer>
mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
mode: <value in [ems, gms, provider]>
mr: <value of integer>
name: <value of string>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
restricted_prds:
- fos
- foc
- fml
- fch
- fwb
- log
- fct
- faz
- fsa
- fsw
- fmg
- fdd
- fac
- fpx
- fna
- fdc
- ffw
- fsr
- fad
- fap
- fxt
state: <value of integer>
uuid: <value of string>
create_time: <value of integer>
workspace_mode: <value of integer>
import-devices:
-
adm_pass: <value of string>
adm_usr: <value of string>
app_ver: <value of string>
av_ver: <value of string>
beta: <value of integer>
branch_pt: <value of integer>
build: <value of integer>
checksum: <value of string>
conf_status: <value in [unknown, insync, outofsync]>
conn_mode: <value in [active, passive]>
conn_status: <value in [UNKNOWN, up, down]>
db_status: <value in [unknown, nomod, mod]>
desc: <value of string>
dev_status: <value in [none, unknown, checkedin, ...]>
fap_cnt: <value of integer>
faz.full_act: <value of integer>
faz.perm: <value of integer>
faz.quota: <value of integer>
faz.used: <value of integer>
fex_cnt: <value of integer>
flags:
- has_hdd
- vdom_enabled
- discover
- reload
- interim_build
- offline_mode
- is_model
- fips_mode
- linked_to_model
- ip-conflict
- faz-autosync
foslic_cpu: <value of integer>
foslic_dr_site: <value in [disable, enable]>
foslic_inst_time: <value of integer>
foslic_last_sync: <value of integer>
foslic_ram: <value of integer>
foslic_type: <value in [temporary, trial, regular, ...]>
foslic_utm:
- fw
- av
- ips
- app
- url
- utm
- fwb
fsw_cnt: <value of integer>
ha_group_id: <value of integer>
ha_group_name: <value of string>
ha_mode: <value in [standalone, AP, AA, ...]>
ha_slave:
-
idx: <value of integer>
name: <value of string>
prio: <value of integer>
role: <value in [slave, master]>
sn: <value of string>
status: <value of integer>
hdisk_size: <value of integer>
hostname: <value of string>
hw_rev_major: <value of integer>
hw_rev_minor: <value of integer>
ip: <value of string>
ips_ext: <value of integer>
ips_ver: <value of string>
last_checked: <value of integer>
last_resync: <value of integer>
latitude: <value of string>
lic_flags: <value of integer>
lic_region: <value of string>
location_from: <value of string>
logdisk_size: <value of integer>
longitude: <value of string>
maxvdom: <value of integer>
meta fields: <value of dict>
mgmt_id: <value of integer>
mgmt_if: <value of string>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
mgt_vdom: <value of string>
mr: <value of integer>
name: <value of string>
os_type: <value in [unknown, fos, fsw, ...]>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
patch: <value of integer>
platform_str: <value of string>
psk: <value of string>
sn: <value of string>
vdom:
-
comments: <value of string>
name: <value of string>
opmode: <value in [nat, transparent]>
rtm_prof_id: <value of integer>
status: <value of string>
meta fields: <value of dict>
vpn_id: <value of integer>
version: <value of integer>
vm_cpu: <value of integer>
vm_cpu_limit: <value of integer>
vm_lic_expire: <value of integer>
vm_mem: <value of integer>
vm_mem_limit: <value of integer>
vm_status: <value of integer>
module_sn: <value of string>
prefer_img_ver: <value of string>
prio: <value of integer>
role: <value in [master, ha-slave, autoscale-slave]>
hyperscale: <value of integer>
nsxt_service_name: <value of string>
private_key: <value of string>
private_key_status: <value of integer>
import-group-members:
-
adom: <value of string>
dev: <value of string>
grp: <value of string>
vdom: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_antivirus_profile_pop3 – Configure POP3 AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_pop3 – Configure POP3 AntiVirus options.
========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_antivirus_profile_pop3`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **antivirus\_profile\_pop3** dictionary | | the top level parameters set |
| | **archive-block** list / elements=string | **Choices:*** encrypted
* corrupted
* multipart
* nested
* mailbomb
* unhandled
* partiallycorrupted
* fileslimit
* timeout
| no description |
| | **archive-log** list / elements=string | **Choices:*** encrypted
* corrupted
* multipart
* nested
* mailbomb
* unhandled
* partiallycorrupted
* fileslimit
* timeout
| no description |
| | **av-scan** string | **Choices:*** disable
* monitor
* block
| Enable AntiVirus scan service. |
| | **content-disarm** string | **Choices:*** disable
* enable
| Enable Content Disarm and Reconstruction for this protocol. |
| | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | **executables** string | **Choices:*** default
* virus
| Treat Windows executable files as viruses for the purpose of blocking or monitoring. |
| | **external-blocklist** string | **Choices:*** disable
* monitor
* block
| Enable external-blocklist. |
| | **options** list / elements=string | **Choices:*** scan
* file-filter
* quarantine
* avquery
* avmonitor
| no description |
| | **outbreak-prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure POP3 AntiVirus options.
fmgr_antivirus_profile_pop3:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
antivirus_profile_pop3:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
content-disarm: <value in [disable, enable]>
emulator: <value in [disable, enable]>
executables: <value in [default, virus]>
options:
- scan
- file-filter
- quarantine
- avquery
- avmonitor
outbreak-prevention: <value in [disabled, files, full-archive, ...]>
av-scan: <value in [disable, monitor, block]>
external-blocklist: <value in [disable, monitor, block]>
quarantine: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_sys_logout – Log out a session. fortinet.fortimanager.fmgr\_sys\_logout – Log out a session.
============================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_sys_logout`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Log out a session.
fmgr_sys_logout:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_dvmdb_workspace_unlock_obj – Unlock a specific object, where the url contains the full path to the object fortinet.fortimanager.fmgr\_dvmdb\_workspace\_unlock\_obj – Unlock a specific object, where the url contains the full path to the object
========================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvmdb_workspace_unlock_obj`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **object\_url\_name** string / required | | the parameter (object\_url\_name) in requested url |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Unlock a specific object, where the url contains the full path to the object
fmgr_dvmdb_workspace_unlock_obj:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
object_url_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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_spamfilter_dnsbl_entries – Spam filter DNSBL and ORBL server. fortinet.fortimanager.fmgr\_spamfilter\_dnsbl\_entries – Spam filter DNSBL and ORBL server.
===========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_spamfilter_dnsbl_entries`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **dnsbl** string / required | | the parameter (dnsbl) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **spamfilter\_dnsbl\_entries** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** spam
* reject
| Reject connection or mark as spam email. |
| | **id** integer | | DNSBL/ORBL entry ID. |
| | **server** string | | DNSBL or ORBL server name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Spam filter DNSBL and ORBL server.
fmgr_spamfilter_dnsbl_entries:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
dnsbl: <your own value>
state: <value in [present, absent]>
spamfilter_dnsbl_entries:
action: <value in [spam, reject]>
id: <value of integer>
server: <value of string>
status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_identitybasedroute – Configure identity based routing. fortinet.fortimanager.fmgr\_firewall\_identitybasedroute – Configure identity based routing.
============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_identitybasedroute`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_identitybasedroute** dictionary | | the top level parameters set |
| | **comments** string | | Comments. |
| | **name** string | | Name. |
| | **rule** list / elements=string | | no description |
| | | **device** string | | Outgoing interface for the rule. |
| | | **gateway** string | | IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0). |
| | | **groups** string | | Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space. |
| | | **id** integer | | Rule ID. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure identity based routing.
fmgr_firewall_identitybasedroute:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_identitybasedroute:
comments: <value of string>
name: <value of string>
rule:
-
device: <value of string>
gateway: <value of string>
groups: <value of string>
id: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity – Configuration method to edit Simple Network Management Protocol fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_snmpcommunity – Configuration method to edit Simple Network Management Protocol
============================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **managed-switch** string / required | | the parameter (managed-switch) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **switchcontroller\_managedswitch\_snmpcommunity** dictionary | | the top level parameters set |
| | **events** list / elements=string | **Choices:*** cpu-high
* mem-low
* log-full
* intf-ip
* ent-conf-change
| no description |
| | **hosts** list / elements=string | | no description |
| | | **id** integer | | Host entry ID. |
| | | **ip** string | | IPv4 address of the SNMP manager (host). |
| | **id** integer | | SNMP community ID. |
| | **name** string | | SNMP community name. |
| | **query-v1-port** integer | | SNMP v1 query port (default = 161). |
| | **query-v1-status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v1 queries. |
| | **query-v2c-port** integer | | SNMP v2c query port (default = 161). |
| | **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 (default = 162). |
| | **trap-v1-rport** integer | | SNMP v2c trap remote port (default = 162). |
| | **trap-v1-status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v1 traps. |
| | **trap-v2c-lport** integer | | SNMP v2c trap local port (default = 162). |
| | **trap-v2c-rport** integer | | SNMP v2c trap remote port (default = 162). |
| | **trap-v2c-status** string | **Choices:*** disable
* enable
| Enable/disable SNMP v2c traps. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configuration method to edit Simple Network Management Protocol
fmgr_switchcontroller_managedswitch_snmpcommunity:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
managed-switch: <your own value>
state: <value in [present, absent]>
switchcontroller_managedswitch_snmpcommunity:
events:
- cpu-high
- mem-low
- log-full
- intf-ip
- ent-conf-change
hosts:
-
id: <value of integer>
ip: <value of string>
id: <value of integer>
name: <value of string>
query-v1-port: <value of integer>
query-v1-status: <value in [disable, enable]>
query-v2c-port: <value of integer>
query-v2c-status: <value in [disable, enable]>
status: <value in [disable, enable]>
trap-v1-lport: <value of integer>
trap-v1-rport: <value of integer>
trap-v1-status: <value in [disable, enable]>
trap-v2c-lport: <value of integer>
trap-v2c-rport: <value of integer>
trap-v2c-status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_gtp_imsi – IMSI. fortinet.fortimanager.fmgr\_firewall\_gtp\_imsi – IMSI.
=======================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_gtp_imsi`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_gtp\_imsi** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* deny
| Action. |
| | **apnmember** string | | APN member. |
| | **id** integer | | ID. |
| | **mcc-mnc** string | | MCC MNC. |
| | **msisdn-prefix** string | | MSISDN prefix. |
| | **selection-mode** list / elements=string | **Choices:*** ms
* net
* vrf
| no description |
| **gtp** string / required | | the parameter (gtp) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: IMSI.
fmgr_firewall_gtp_imsi:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
gtp: <your own value>
state: <value in [present, absent]>
firewall_gtp_imsi:
action: <value in [allow, deny]>
apnmember: <value of string>
id: <value of integer>
mcc-mnc: <value of string>
msisdn-prefix: <value of string>
selection-mode:
- ms
- net
- vrf
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability – Configure connection capability. fortinet.fortimanager.fmgr\_hotspot20\_h2qpconncapability – Configure connection capability.
============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **hotspot20\_h2qpconncapability** dictionary | | the top level parameters set |
| | **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 | | 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. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure connection capability.
fmgr_hotspot20_h2qpconncapability:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
hotspot20_h2qpconncapability:
esp-port: <value in [closed, open, unknown]>
ftp-port: <value in [closed, open, unknown]>
http-port: <value in [closed, open, unknown]>
icmp-port: <value in [closed, open, unknown]>
ikev2-port: <value in [closed, open, unknown]>
ikev2-xx-port: <value in [closed, open, unknown]>
name: <value of string>
pptp-vpn-port: <value in [closed, open, unknown]>
ssh-port: <value in [closed, open, unknown]>
tls-port: <value in [closed, open, unknown]>
voip-tcp-port: <value in [closed, open, unknown]>
voip-udp-port: <value in [closed, open, unknown]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_webproxy_forwardserver – Configure forward-server addresses. fortinet.fortimanager.fmgr\_webproxy\_forwardserver – Configure forward-server addresses.
=========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webproxy_forwardserver`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **webproxy\_forwardserver** dictionary | | the top level parameters set |
| | **addr-type** string | **Choices:*** fqdn
* ip
| 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 ve... |
| | **ip** string | | Forward proxy server IP address. |
| | **monitor** string | | URL for forward server health check monitoring (default = http://www.google.com). |
| | **name** string | | Server name. |
| | **password** string | | no description |
| | **port** integer | | Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535, default = 3128). |
| | **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 the... |
| | **username** string | | HTTP authentication user name. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure forward-server addresses.
fmgr_webproxy_forwardserver:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
webproxy_forwardserver:
addr-type: <value in [fqdn, ip]>
comment: <value of string>
fqdn: <value of string>
healthcheck: <value in [disable, enable]>
ip: <value of string>
monitor: <value of string>
name: <value of string>
port: <value of integer>
server-down-option: <value in [block, pass]>
password: <value of string>
username: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm – AV Content Disarm and Reconstruction settings. fortinet.fortimanager.fmgr\_antivirus\_profile\_contentdisarm – AV Content Disarm and Reconstruction settings.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **antivirus\_profile\_contentdisarm** dictionary | | the top level parameters set |
| | **cover-page** string | **Choices:*** disable
* enable
| Enable/disable inserting a cover page into the disarmed document. |
| | **detect-only** string | **Choices:*** disable
* enable
| Enable/disable only detect disarmable files, do not alter content. |
| | **error-action** string | **Choices:*** block
* log-only
* ignore
| Action to be taken if CDR engine encounters an unrecoverable error. |
| | **office-action** string | **Choices:*** disable
* enable
| Enable/disable stripping of PowerPoint action events in Microsoft Office documents. |
| | **office-dde** string | **Choices:*** disable
* enable
| Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. |
| | **office-embed** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded objects in Microsoft Office documents. |
| | **office-hylink** string | **Choices:*** disable
* enable
| Enable/disable stripping of hyperlinks in Microsoft Office documents. |
| | **office-linked** string | **Choices:*** disable
* enable
| Enable/disable stripping of linked objects in Microsoft Office documents. |
| | **office-macro** string | **Choices:*** disable
* enable
| Enable/disable stripping of macros in Microsoft Office documents. |
| | **original-file-destination** string | **Choices:*** fortisandbox
* quarantine
* discard
| Destination to send original file if active content is removed. |
| | **pdf-act-form** string | **Choices:*** disable
* enable
| Enable/disable stripping of actions that submit data to other targets in PDF documents. |
| | **pdf-act-gotor** string | **Choices:*** disable
* enable
| Enable/disable stripping of links to other PDFs in PDF documents. |
| | **pdf-act-java** string | **Choices:*** disable
* enable
| Enable/disable stripping of actions that execute JavaScript code in PDF documents. |
| | **pdf-act-launch** string | **Choices:*** disable
* enable
| Enable/disable stripping of links to external applications in PDF documents. |
| | **pdf-act-movie** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded movies in PDF documents. |
| | **pdf-act-sound** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded sound files in PDF documents. |
| | **pdf-embedfile** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded files in PDF documents. |
| | **pdf-hyperlink** string | **Choices:*** disable
* enable
| Enable/disable stripping of hyperlinks from PDF documents. |
| | **pdf-javacode** string | **Choices:*** disable
* enable
| Enable/disable stripping of JavaScript code in PDF documents. |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: AV Content Disarm and Reconstruction settings.
fmgr_antivirus_profile_contentdisarm:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
antivirus_profile_contentdisarm:
cover-page: <value in [disable, enable]>
detect-only: <value in [disable, enable]>
office-embed: <value in [disable, enable]>
office-hylink: <value in [disable, enable]>
office-linked: <value in [disable, enable]>
office-macro: <value in [disable, enable]>
original-file-destination: <value in [fortisandbox, quarantine, discard]>
pdf-act-form: <value in [disable, enable]>
pdf-act-gotor: <value in [disable, enable]>
pdf-act-java: <value in [disable, enable]>
pdf-act-launch: <value in [disable, enable]>
pdf-act-movie: <value in [disable, enable]>
pdf-act-sound: <value in [disable, enable]>
pdf-embedfile: <value in [disable, enable]>
pdf-hyperlink: <value in [disable, enable]>
pdf-javacode: <value in [disable, enable]>
office-action: <value in [disable, enable]>
office-dde: <value in [disable, enable]>
error-action: <value in [block, log-only, ignore]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_dnsfilter_profile_domainfilter – Domain filter settings. fortinet.fortimanager.fmgr\_dnsfilter\_profile\_domainfilter – Domain filter settings.
======================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dnsfilter_profile_domainfilter`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **dnsfilter\_profile\_domainfilter** dictionary | | the top level parameters set |
| | **domain-filter-table** integer | | DNS domain filter table ID. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Domain filter settings.
fmgr_dnsfilter_profile_domainfilter:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
dnsfilter_profile_domainfilter:
domain-filter-table: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_extendercontroller_template – no description fortinet.fortimanager.fmgr\_extendercontroller\_template – no description
=========================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_extendercontroller_template`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **extendercontroller\_template** dictionary | | the top level parameters set |
| | **dataplan** string | | no description |
| | **description** string | | no description |
| | **modem1\_ifname** string | | no description |
| | **modem1\_sim\_profile** string | | no description |
| | **modem2\_ifname** string | | no description |
| | **modem2\_sim\_profile** string | | no description |
| | **name** string | | no description |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_extendercontroller_template:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
extendercontroller_template:
dataplan: <value of string>
description: <value of string>
modem1_ifname: <value of string>
modem1_sim_profile: <value of string>
modem2_ifname: <value of string>
modem2_sim_profile: <value of string>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_user_pop3 – POP3 server entry configuration. fortinet.fortimanager.fmgr\_user\_pop3 – POP3 server entry configuration.
=========================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_user_pop3`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **user\_pop3** dictionary | | the top level parameters set |
| | **name** string | | 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
* TLSv1
* TLSv1-1
* TLSv1-2
* SSLv3
| Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: POP3 server entry configuration.
fmgr_user_pop3:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_pop3:
name: <value of string>
port: <value of integer>
secure: <value in [none, starttls, pop3s]>
server: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_application_list_defaultnetworkservices – Default network service entries. fortinet.fortimanager.fmgr\_application\_list\_defaultnetworkservices – Default network service entries.
========================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_application_list_defaultnetworkservices`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **application\_list\_defaultnetworkservices** dictionary | | the top level parameters set |
| | **id** integer | | Entry ID. |
| | **port** integer | | Port number. |
| | **services** list / elements=string | **Choices:*** http
* ssh
* telnet
* ftp
* dns
* smtp
* pop3
* imap
* snmp
* nntp
* https
| no description |
| | **violation-action** string | **Choices:*** block
* monitor
* pass
| Action for protocols not white listed under selected port. |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **list** string / required | | the parameter (list) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Default network service entries.
fmgr_application_list_defaultnetworkservices:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
list: <your own value>
state: <value in [present, absent]>
application_list_defaultnetworkservices:
id: <value of integer>
port: <value of integer>
services:
- http
- ssh
- telnet
- ftp
- dns
- smtp
- pop3
- imap
- snmp
- nntp
- https
violation-action: <value in [block, monitor, pass]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_wanprof_system_sdwan_service – Create SD-WAN rules fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_service – Create SD-WAN rules
=================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_wanprof_system_sdwan_service`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_sdwan\_service** dictionary | | the top level parameters set |
| | **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:*** disable
* enable
| Enable/disable use of SD-WAN as default service. |
| | **dscp-forward** string | **Choices:*** disable
* enable
| Enable/disable forward traffic DSCP tag. |
| | **dscp-forward-tag** string | | Forward traffic DSCP tag. |
| | **dscp-reverse** string | **Choices:*** disable
* enable
| Enable/disable reverse traffic DSCP tag. |
| | **dscp-reverse-tag** string | | Reverse traffic DSCP tag. |
| | **dst** string | | Destination address name. |
| | **dst-negate** string | **Choices:*** disable
* enable
| Enable/disable negation of destination address match. |
| | **dst6** string | | Destination address6 name. |
| | **end-port** integer | | End destination port number. |
| | **gateway** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN service gateway. |
| | **groups** string | | User groups. |
| | **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** string | | Health check list. |
| | **hold-down-time** integer | | Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). |
| | **id** integer | | SD-WAN rule ID (1 - 4000). |
| | **input-device** string | | Source interface name. |
| | **input-device-negate** string | **Choices:*** disable
* enable
| Enable/disable negation of input device match. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet service for application-based load balancing. |
| | **internet-service-app-ctrl** integer | | no description |
| | **internet-service-app-ctrl-group** string | | Application control based Internet Service group list. |
| | **internet-service-custom** string | | Custom Internet service name list. |
| | **internet-service-custom-group** string | | Custom Internet Service group list. |
| | **internet-service-group** string | | Internet Service group list. |
| | **internet-service-name** string | | Internet service name list. |
| | **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, default = 10). |
| | **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** string | | Member sequence number list. |
| | **protocol** integer | | Protocol number. |
| | **quality-link** integer | | Quality grade. |
| | **role** string | **Choices:*** primary
* secondary
* standalone
| Service role to work with neighbor. |
| | **route-tag** integer | | IPv4 route map route-tag. |
| | **sla** list / elements=string | | no description |
| | | **health-check** string | | SD-WAN health-check. |
| | | **id** integer | | SLA ID. |
| | **sla-compare-method** string | **Choices:*** order
* number
| Method to compare SLA value for SLA mode. |
| | **src** string | | Source address name. |
| | **src-negate** string | **Choices:*** disable
* enable
| Enable/disable negation of source address match. |
| | **src6** string | | Source address6 name. |
| | **standalone-action** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| 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:*** disable
* enable
| Enable/disable use of ADVPN shortcut for quality comparison. |
| | **users** string | | User name. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Create SD-WAN rules
fmgr_wanprof_system_sdwan_service:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_sdwan_service:
addr-mode: <value in [ipv4, ipv6]>
bandwidth-weight: <value of integer>
default: <value in [disable, enable]>
dscp-forward: <value in [disable, enable]>
dscp-forward-tag: <value of string>
dscp-reverse: <value in [disable, enable]>
dscp-reverse-tag: <value of string>
dst: <value of string>
dst-negate: <value in [disable, enable]>
dst6: <value of string>
end-port: <value of integer>
gateway: <value in [disable, enable]>
groups: <value of string>
hash-mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
health-check: <value of string>
hold-down-time: <value of integer>
id: <value of integer>
input-device: <value of string>
input-device-negate: <value in [disable, enable]>
internet-service: <value in [disable, enable]>
internet-service-app-ctrl: <value of integer>
internet-service-app-ctrl-group: <value of string>
internet-service-custom: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-name: <value of string>
jitter-weight: <value of integer>
latency-weight: <value of integer>
link-cost-factor: <value in [latency, jitter, packet-loss, ...]>
link-cost-threshold: <value of integer>
minimum-sla-meet-members: <value of integer>
mode: <value in [auto, manual, priority, ...]>
name: <value of string>
packet-loss-weight: <value of integer>
priority-members: <value of string>
protocol: <value of integer>
quality-link: <value of integer>
role: <value in [primary, secondary, standalone]>
route-tag: <value of integer>
sla:
-
health-check: <value of string>
id: <value of integer>
sla-compare-method: <value in [order, number]>
src: <value of string>
src-negate: <value in [disable, enable]>
src6: <value of string>
standalone-action: <value in [disable, enable]>
start-port: <value of integer>
status: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
users: <value of string>
tie-break: <value in [zone, cfg-order, fib-best-match]>
use-shortcut-sla: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_log_interfacestats – Interface statistics settings. fortinet.fortimanager.fmgr\_system\_log\_interfacestats – Interface statistics settings.
========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_log_interfacestats`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_log\_interfacestats** dictionary | | the top level parameters set |
| | **billing-report** string | **Choices:*** **disable** ←
* enable
| Disable/Enable billing report feature. disable - Disable billing report. enable - Enable billing report. |
| | **retention-days** integer | **Default:**30 | Number of days for interface data storage. |
| | **sampling-interval** integer | **Default:**1200 | Interval of receiving interface data from FortiGates in seconds. |
| | **status** string | **Choices:*** disable
* **enable** ←
| Disable/Enable interface statistics feature. disable - Disable interface statistics. enable - Enable interface statistics. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Interface statistics settings.
fmgr_system_log_interfacestats:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
system_log_interfacestats:
retention-days: <value of integer>
sampling-interval: <value of integer>
status: <value in [disable, enable]>
billing-report: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_webproxy_forwardservergroup_serverlist – Add web forward servers to a list to form a server group. fortinet.fortimanager.fmgr\_webproxy\_forwardservergroup\_serverlist – Add web forward servers to a list to form a server group.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webproxy_forwardservergroup_serverlist`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **forward-server-group** string / required | | the parameter (forward-server-group) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **webproxy\_forwardservergroup\_serverlist** dictionary | | the top level parameters set |
| | **name** string | | Forward server name. |
| | **weight** integer | | Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10) |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Add web forward servers to a list to form a server group.
fmgr_webproxy_forwardservergroup_serverlist:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
forward-server-group: <your own value>
state: <value in [present, absent]>
webproxy_forwardservergroup_serverlist:
name: <value of string>
weight: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_icap_profile_icapheaders – Configure ICAP forwarded request headers. fortinet.fortimanager.fmgr\_icap\_profile\_icapheaders – Configure ICAP forwarded request headers.
==================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_icap_profile_icapheaders`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **icap\_profile\_icapheaders** dictionary | | the top level parameters set |
| | **base64-encoding** string | **Choices:*** disable
* enable
| Enable/disable use of base64 encoding of HTTP content. |
| | **content** string | | HTTP header content. |
| | **id** integer | | HTTP forwarded header ID. |
| | **name** string | | HTTP forwarded header name. |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure ICAP forwarded request headers.
fmgr_icap_profile_icapheaders:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
state: <value in [present, absent]>
icap_profile_icapheaders:
base64-encoding: <value in [disable, enable]>
content: <value of string>
id: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_spamfilter_profile_imap – IMAP. fortinet.fortimanager.fmgr\_spamfilter\_profile\_imap – IMAP.
=============================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_spamfilter_profile_imap`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **spamfilter\_profile\_imap** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** pass
* tag
| Action for spam email. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **tag-msg** string | | Subject text or header added to spam email. |
| | **tag-type** list / elements=string | **Choices:*** subject
* header
* spaminfo
| no description |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: IMAP.
fmgr_spamfilter_profile_imap:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
spamfilter_profile_imap:
action: <value in [pass, tag]>
log: <value in [disable, enable]>
tag-msg: <value of string>
tag-type:
- subject
- header
- spaminfo
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_admin_user_policypackage – Policy package access. fortinet.fortimanager.fmgr\_system\_admin\_user\_policypackage – Policy package access.
=======================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_admin_user_policypackage`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_admin\_user\_policypackage** dictionary | | the top level parameters set |
| | **policy-package-name** string | | Policy package names. |
| **user** string / required | | the parameter (user) in requested url |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Policy package access.
fmgr_system_admin_user_policypackage:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
user: <your own value>
state: <value in [present, absent]>
system_admin_user_policypackage:
policy-package-name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_vpnmgr_vpntable – no description fortinet.fortimanager.fmgr\_vpnmgr\_vpntable – no description
=============================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_vpnmgr_vpntable`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **vpnmgr\_vpntable** dictionary | | the top level parameters set |
| | **authmethod** string | **Choices:*** psk
* rsa-signature
* signature
| no description |
| | **auto-zone-policy** string | **Choices:*** disable
* **enable** ←
| no description |
| | **certificate** string | | no description |
| | **description** string | | no description |
| | **dpd** string | **Choices:*** disable
* enable
* on-idle
* on-demand
| no description |
| | **dpd-retrycount** integer | | no description |
| | **dpd-retryinterval** integer | | no description |
| | **fcc-enforcement** string | **Choices:*** disable
* enable
| no description |
| | **hub2spoke-zone** string | | no description |
| | **ike-version** string | **Choices:*** 1
* 2
| no description |
| | **ike1dhgroup** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
* 32
| no description |
| | **ike1dpd** string | **Choices:*** disable
* enable
| no description |
| | **ike1keylifesec** integer | | no description |
| | **ike1localid** string | | no description |
| | **ike1mode** string | **Choices:*** main
* aggressive
| no description |
| | **ike1natkeepalive** integer | | no description |
| | **ike1nattraversal** string | **Choices:*** disable
* enable
* forced
| no description |
| | **ike1proposal** string | **Choices:*** des-md5
* des-sha1
* 3des-md5
* 3des-sha1
* aes128-md5
* aes128-sha1
* aes192-md5
* aes192-sha1
* aes256-md5
* aes256-sha1
* des-sha256
* 3des-sha256
* aes128-sha256
* aes192-sha256
* aes256-sha256
* des-sha384
* des-sha512
* 3des-sha384
* 3des-sha512
* aes128-sha384
* aes128-sha512
* aes192-sha384
* aes192-sha512
* aes256-sha384
* aes256-sha512
* aria128-md5
* aria128-sha1
* aria128-sha256
* aria128-sha384
* aria128-sha512
* aria192-md5
* aria192-sha1
* aria192-sha256
* aria192-sha384
* aria192-sha512
* aria256-md5
* aria256-sha1
* aria256-sha256
* aria256-sha384
* aria256-sha512
* seed-md5
* seed-sha1
* seed-sha256
* seed-sha384
* seed-sha512
* aes128gcm-prfsha1
* aes128gcm-prfsha256
* aes128gcm-prfsha384
* aes128gcm-prfsha512
* aes256gcm-prfsha1
* aes256gcm-prfsha256
* aes256gcm-prfsha384
* aes256gcm-prfsha512
* chacha20poly1305-prfsha1
* chacha20poly1305-prfsha256
* chacha20poly1305-prfsha384
* chacha20poly1305-prfsha512
| no description |
| | **ike2autonego** string | **Choices:*** disable
* enable
| no description |
| | **ike2dhgroup** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
* 32
| no description |
| | **ike2keepalive** string | **Choices:*** disable
* enable
| no description |
| | **ike2keylifekbs** integer | | no description |
| | **ike2keylifesec** integer | | no description |
| | **ike2keylifetype** string | **Choices:*** seconds
* kbs
* both
| no description |
| | **ike2proposal** string | **Choices:*** null-md5
* null-sha1
* des-null
* 3des-null
* des-md5
* des-sha1
* 3des-md5
* 3des-sha1
* aes128-md5
* aes128-sha1
* aes192-md5
* aes192-sha1
* aes256-md5
* aes256-sha1
* aes128-null
* aes192-null
* aes256-null
* null-sha256
* des-sha256
* 3des-sha256
* aes128-sha256
* aes192-sha256
* aes256-sha256
* des-sha384
* des-sha512
* 3des-sha384
* 3des-sha512
* aes128-sha384
* aes128-sha512
* aes192-sha384
* aes192-sha512
* aes256-sha384
* aes256-sha512
* null-sha384
* null-sha512
* 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
* aes128gcm
* aes256gcm
* chacha20poly1305
| no description |
| | **inter-vdom** string | **Choices:*** disable
* enable
| no description |
| | **intf-mode** string | **Choices:*** off
* on
| no description |
| | **localid-type** string | **Choices:*** auto
* fqdn
* user-fqdn
* keyid
* address
* asn1dn
| no description |
| | **name** string | | no description |
| | **negotiate-timeout** integer | **Default:**30 | no description |
| | **network-id** integer | | no description |
| | **network-overlay** string | **Choices:*** disable
* enable
| no description |
| | **npu-offload** string | **Choices:*** disable
* **enable** ←
| no description |
| | **pfs** string | **Choices:*** disable
* enable
| no description |
| | **psk-auto-generate** string | **Choices:*** disable
* enable
| no description |
| | **psksecret** string | | no description |
| | **replay** string | **Choices:*** disable
* enable
| no description |
| | **rsa-certificate** string | | no description |
| | **spoke2hub-zone** string | | no description |
| | **topology** string | **Choices:*** meshed
* star
* dialup
| no description |
| | **vpn-zone** string | | no description |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_vpnmgr_vpntable:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
vpnmgr_vpntable:
authmethod: <value in [psk, rsa-signature, signature]>
auto-zone-policy: <value in [disable, enable]>
certificate: <value of string>
description: <value of string>
dpd: <value in [disable, enable, on-idle, ...]>
dpd-retrycount: <value of integer>
dpd-retryinterval: <value of integer>
fcc-enforcement: <value in [disable, enable]>
hub2spoke-zone: <value of string>
ike-version: <value in [1, 2]>
ike1dhgroup:
- 1
- 2
- 5
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 27
- 28
- 29
- 30
- 31
- 32
ike1dpd: <value in [disable, enable]>
ike1keylifesec: <value of integer>
ike1localid: <value of string>
ike1mode: <value in [main, aggressive]>
ike1natkeepalive: <value of integer>
ike1nattraversal: <value in [disable, enable, forced]>
ike1proposal: <value in [des-md5, des-sha1, 3des-md5, ...]>
ike2autonego: <value in [disable, enable]>
ike2dhgroup:
- 1
- 2
- 5
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 27
- 28
- 29
- 30
- 31
- 32
ike2keepalive: <value in [disable, enable]>
ike2keylifekbs: <value of integer>
ike2keylifesec: <value of integer>
ike2keylifetype: <value in [seconds, kbs, both]>
ike2proposal: <value in [null-md5, null-sha1, des-null, ...]>
inter-vdom: <value in [disable, enable]>
intf-mode: <value in [off, on]>
localid-type: <value in [auto, fqdn, user-fqdn, ...]>
name: <value of string>
negotiate-timeout: <value of integer>
npu-offload: <value in [disable, enable]>
pfs: <value in [disable, enable]>
psk-auto-generate: <value in [disable, enable]>
psksecret: <value of string>
replay: <value in [disable, enable]>
rsa-certificate: <value of string>
spoke2hub-zone: <value of string>
topology: <value in [meshed, star, dialup]>
vpn-zone: <value of string>
network-id: <value of integer>
network-overlay: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_system_report_group_groupby – Group-by variables. fortinet.fortimanager.fmgr\_system\_report\_group\_groupby – Group-by variables.
================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_report_group_groupby`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **group** string / required | | the parameter (group) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_report\_group\_groupby** dictionary | | the top level parameters set |
| | **var-expression** string | | Variable expression. |
| | **var-name** string | | Variable name. |
| | **var-type** string | **Choices:*** integer
* **string** ←
* enum
* ip
| Variable type. integer - Integer. string - String. enum - Enum. ip - IP. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Group-by variables.
fmgr_system_report_group_groupby:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
group: <your own value>
state: <value in [present, absent]>
system_report_group_groupby:
var-expression: <value of string>
var-name: <value of string>
var-type: <value in [integer, string, enum, ...]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_interface – Interface configuration. fortinet.fortimanager.fmgr\_system\_interface – Interface configuration.
========================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_interface`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_interface** dictionary | | the top level parameters set |
| | **alias** string | | Alias. |
| | **allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* webservice
* https-logging
* soc-fabric
| no description |
| | **description** string | | Description. |
| | **ip** string | **Default:**"0.0.0.0 0.0.0.0" | IP address of interface. |
| | **ipv6** dictionary | | no description |
| | | **ip6-address** string | **Default:**"::/0" | IPv6 address/prefix of interface. |
| | | **ip6-allowaccess** list / elements=string | **Choices:*** ping
* https
* ssh
* snmp
* http
* webservice
* https-logging
| no description |
| | | **ip6-autoconf** string | **Choices:*** disable
* **enable** ←
| Enable/disable address auto config (SLAAC). disable - Disable setting. enable - Enable setting. |
| | **mtu** integer | **Default:**1500 | Maximum transportation unit(68 - 9000). |
| | **name** string | | Interface name. |
| | **rating-service-ip** string | **Default:**"0.0.0.0 0.0.0.0" | IP address for fgt rating service, must be same subnet with interface ip. |
| | **serviceaccess** list / elements=string | **Choices:*** fgtupdates
* fclupdates
* webfilter-antispam
| no description |
| | **speed** string | **Choices:*** **auto** ←
* 10full
* 10half
* 100full
* 100half
* 1000full
* 10000full
| Speed. auto - Auto adjust speed. 10full - 10M full-duplex. 10half - 10M half-duplex. 100full - 100M full-duplex. 100half - 100M half-duplex. 1000full - 1000M full-duplex. 10000full - 10000M full-duplex. |
| | **status** string | **Choices:*** down
* **up** ←
| Interface status. down - Interface down. up - Interface up. |
| | **update-service-ip** string | **Default:**"0.0.0.0 0.0.0.0" | IP address for fgt/fct update service, must be same subnet with interface ip. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Interface configuration.
fmgr_system_interface:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_interface:
alias: <value of string>
allowaccess:
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- soc-fabric
description: <value of string>
ip: <value of string>
ipv6:
ip6-address: <value of string>
ip6-allowaccess:
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
ip6-autoconf: <value in [disable, enable]>
mtu: <value of integer>
name: <value of string>
serviceaccess:
- fgtupdates
- fclupdates
- webfilter-antispam
speed: <value in [auto, 10full, 10half, ...]>
status: <value in [down, up]>
rating-service-ip: <value of string>
update-service-ip: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy – IE remove policy. fortinet.fortimanager.fmgr\_firewall\_gtp\_ieremovepolicy – IE remove policy.
=============================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_gtp\_ieremovepolicy** dictionary | | the top level parameters set |
| | **id** integer | | ID. |
| | **remove-ies** list / elements=string | **Choices:*** apn-restriction
* rat-type
* rai
* uli
* imei
| no description |
| | **sgsn-addr** string | | SGSN address name. |
| | **sgsn-addr6** string | | SGSN IPv6 address name. |
| **gtp** string / required | | the parameter (gtp) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: IE remove policy.
fmgr_firewall_gtp_ieremovepolicy:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
gtp: <your own value>
state: <value in [present, absent]>
firewall_gtp_ieremovepolicy:
id: <value of integer>
remove-ies:
- apn-restriction
- rat-type
- rai
- uli
- imei
sgsn-addr: <value of string>
sgsn-addr6: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_pkg_firewall_policy_vpnsrcnode – no description fortinet.fortimanager.fmgr\_pkg\_firewall\_policy\_vpnsrcnode – no description
==============================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_pkg_firewall_policy_vpnsrcnode`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **pkg** string / required | | the parameter (pkg) in requested url |
| **pkg\_firewall\_policy\_vpnsrcnode** dictionary | | the top level parameters set |
| | **host** string | | no description |
| | **seq** integer | | no description |
| | **subnet** string | | no description |
| **policy** string / required | | the parameter (policy) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_pkg_firewall_policy_vpnsrcnode:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
pkg: <your own value>
policy: <your own value>
state: <value in [present, absent]>
pkg_firewall_policy_vpnsrcnode:
host: <value of string>
seq: <value of integer>
subnet: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_system_ha_peer – Peer. fortinet.fortimanager.fmgr\_system\_ha\_peer – Peer.
====================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_ha_peer`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_ha\_peer** dictionary | | the top level parameters set |
| | **id** integer | **Default:**0 | Id. |
| | **ip** string | **Default:**"0.0.0.0" | IP address of peer. |
| | **ip6** string | **Default:**"::" | IP address (V6) of peer. |
| | **serial-number** string | | Serial number of peer. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Peer.
fmgr_system_ha_peer:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_ha_peer:
id: <value of integer>
ip: <value of string>
ip6: <value of string>
serial-number: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_emailfilter_bwl – Configure anti-spam black/white list. fortinet.fortimanager.fmgr\_emailfilter\_bwl – Configure anti-spam black/white list.
====================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_bwl`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **emailfilter\_bwl** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** spam
* clear
* reject
| Reject, mark as spam or good email. |
| | | **addr-type** string | **Choices:*** ipv4
* ipv6
| IP address type. |
| | | **email-pattern** string | | Email address pattern. |
| | | **id** integer | | Entry ID. |
| | | **ip4-subnet** string | | IPv4 network address/subnet mask bits. |
| | | **ip6-subnet** string | | IPv6 network address/subnet mask bits. |
| | | **pattern-type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| | | **type** string | **Choices:*** ip
* email
| Entry type. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure anti-spam black/white list.
fmgr_emailfilter_bwl:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
emailfilter_bwl:
comment: <value of string>
entries:
-
action: <value in [spam, clear, reject]>
addr-type: <value in [ipv4, ipv6]>
email-pattern: <value of string>
id: <value of integer>
ip4-subnet: <value of string>
ip6-subnet: <value of string>
pattern-type: <value in [wildcard, regexp]>
status: <value in [disable, enable]>
type: <value in [ip, email]>
id: <value of integer>
name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_addrgrp_dynamicmapping – Configure IPv4 address groups. fortinet.fortimanager.fmgr\_firewall\_addrgrp\_dynamicmapping – Configure IPv4 address groups.
==============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_addrgrp_dynamicmapping`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **addrgrp** string / required | | the parameter (addrgrp) in requested url |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_addrgrp\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_image-base64** string | | no description |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **allow-routing** string | **Choices:*** disable
* enable
| no description |
| | **category** string | **Choices:*** default
* ztna-ems-tag
* ztna-geo-tag
| Address group category. |
| | **color** integer | | no description |
| | **comment** dictionary | | no description |
| | **exclude** string | **Choices:*** disable
* enable
| no description |
| | **exclude-member** string | | no description |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **global-object** integer | | no description |
| | **member** string | | no description |
| | **tags** string | | no description |
| | **type** string | **Choices:*** default
* array
* folder
| no description |
| | **uuid** string | | no description |
| | **visibility** string | **Choices:*** disable
* enable
| no description |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 address groups.
fmgr_firewall_addrgrp_dynamicmapping:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
addrgrp: <your own value>
state: <value in [present, absent]>
firewall_addrgrp_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
allow-routing: <value in [disable, enable]>
color: <value of integer>
comment: <value of dict>
exclude: <value in [disable, enable]>
exclude-member: <value of string>
member: <value of string>
tags: <value of string>
uuid: <value of string>
visibility: <value in [disable, enable]>
_image-base64: <value of string>
global-object: <value of integer>
type: <value in [default, array, folder]>
fabric-object: <value in [disable, enable]>
category: <value in [default, ztna-ems-tag, ztna-geo-tag]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_gtp_apn – APN. fortinet.fortimanager.fmgr\_firewall\_gtp\_apn – APN.
=====================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_gtp_apn`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_gtp\_apn** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* deny
| Action. |
| | **apnmember** string | | APN member. |
| | **id** integer | | ID. |
| | **selection-mode** list / elements=string | **Choices:*** ms
* net
* vrf
| no description |
| **gtp** string / required | | the parameter (gtp) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: APN.
fmgr_firewall_gtp_apn:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
gtp: <your own value>
state: <value in [present, absent]>
firewall_gtp_apn:
action: <value in [allow, deny]>
apnmember: <value of string>
id: <value of integer>
selection-mode:
- ms
- net
- vrf
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway – Set API Gateway. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_apigateway – Set API Gateway.
================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **access-proxy** string / required | | the parameter (access-proxy) in requested url |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_accessproxy\_apigateway** dictionary | | the top level parameters set |
| | **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 ... |
| | **https-cookie-secure** string | **Choices:*** disable
* enable
| Enable/disable verification that inserted HTTPS cookies are secure. |
| | **id** integer | | 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 ses... |
| | **realservers** list / elements=string | | no description |
| | | **address** string | | Address or address group of the real server. |
| | | **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 servers connectivity status. |
| | | **http-host** string | | HTTP server domain name in HTTP header. |
| | | **id** integer | | 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 ... |
| | | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connect... |
| | **saml-server** string | | SAML service provider configuration for VIP authentication. |
| | **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 | | no description |
| | | **cipher** string | **Choices:*** TLS-RSA-WITH-RC4-128-MD5
* TLS-RSA-WITH-RC4-128-SHA
* TLS-RSA-WITH-DES-CBC-SHA
* TLS-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* 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-RSA-WITH-SEED-CBC-SHA
* TLS-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-DHE-RSA-WITH-DES-CBC-SHA
* TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
* 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-256-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-RSA-WITH-SEED-CBC-SHA
* TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384
* TLS-ECDHE-RSA-WITH-RC4-128-SHA
* TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA
* TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
* 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-GCM-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-SHA256
* TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256
* 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-GCM-SHA256
* TLS-RSA-WITH-AES-256-GCM-SHA384
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA
* TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256
* TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256
* TLS-DHE-DSS-WITH-SEED-CBC-SHA
* TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256
* TLS-DHE-DSS-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-DHE-DSS-WITH-3DES-EDE-CBC-SHA
* TLS-DHE-DSS-WITH-DES-CBC-SHA
* TLS-AES-128-GCM-SHA256
* TLS-AES-256-GCM-SHA384
* TLS-CHACHA20-POLY1305-SHA256
| Cipher suite name. |
| | | **priority** integer | | SSL/TLS cipher suites priority. |
| | | **versions** list / elements=string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| no description |
| | **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. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Set API Gateway.
fmgr_firewall_accessproxy_apigateway:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
access-proxy: <your own value>
state: <value in [present, absent]>
firewall_accessproxy_apigateway:
http-cookie-age: <value of integer>
http-cookie-domain: <value of string>
http-cookie-domain-from-host: <value in [disable, enable]>
http-cookie-generation: <value of integer>
http-cookie-path: <value of string>
http-cookie-share: <value in [disable, same-ip]>
https-cookie-secure: <value in [disable, enable]>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
persistence: <value in [none, http-cookie]>
realservers:
-
address: <value of string>
health-check: <value in [disable, enable]>
health-check-proto: <value in [ping, http, tcp-connect]>
http-host: <value of string>
id: <value of integer>
ip: <value of string>
mappedport: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
saml-server: <value of string>
service: <value in [http, https, tcp-forwarding, ...]>
ssl-algorithm: <value in [high, medium, low, ...]>
ssl-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
priority: <value of integer>
versions:
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
ssl-dh-bits: <value in [768, 1024, 1536, ...]>
ssl-max-version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl-min-version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
url-map: <value of string>
url-map-type: <value in [sub-string, wildcard, regex]>
virtual-host: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_admin_ldap_adom – Admin domain. fortinet.fortimanager.fmgr\_system\_admin\_ldap\_adom – Admin domain.
=====================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_admin_ldap_adom`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **ldap** string / required | | the parameter (ldap) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_admin\_ldap\_adom** dictionary | | the top level parameters set |
| | **adom-name** string | | Admin domain names. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Admin domain.
fmgr_system_admin_ldap_adom:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
ldap: <your own value>
state: <value in [present, absent]>
system_admin_ldap_adom:
adom-name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_system_sdnconnector – Configure connection to SDN Connector. fortinet.fortimanager.fmgr\_system\_sdnconnector – Configure connection to SDN Connector.
=========================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_sdnconnector`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_sdnconnector** dictionary | | the top level parameters set |
| | **\_local\_cert** string | | no description |
| | **access-key** string | | AWS access key ID. |
| | **api-key** string | | no description |
| | **azure-region** string | **Choices:*** global
* china
* germany
* usgov
* local
| Azure server region. |
| | **client-id** string | | Azure client ID (application ID). |
| | **client-secret** string | | no description |
| | **compartment-id** string | | Compartment ID. |
| | **compute-generation** integer | | Compute generation for IBM cloud infrastructure. |
| | **domain** string | | Openstack domain. |
| | **external-ip** list / elements=string | | no description |
| | | **name** string | | External IP name. |
| | **gcp-project** string | | GCP project name. |
| | **group-name** string | | Group name of computers. |
| | **ha-status** string | **Choices:*** disable
* enable
| Enable/disable use for FortiGate HA service. |
| | **ibm-region** string | **Choices:*** us-south
* us-east
* germany
* great-britain
* japan
* australia
| IBM cloud region name. |
| | **ibm-region-gen1** string | **Choices:*** us-south
* us-east
* germany
* great-britain
* japan
* australia
| no description |
| | **ibm-region-gen2** string | **Choices:*** us-south
* us-east
* great-britain
| no description |
| | **key-passwd** string | | no description |
| | **last-update** integer | | no description |
| | **login-endpoint** string | | Azure Stack login enpoint. |
| | **name** string | | SDN connector name. |
| | **nic** list / elements=string | | no description |
| | | **ip** list / elements=string | | no description |
| | | | **name** string | | IP configuration name. |
| | | | **public-ip** string | | Public IP name. |
| | | | **resource-group** string | | Resource group of Azure public IP. |
| | | **name** string | | Network interface name. |
| | **nsx-cert-fingerprint** string | | NSX certificate fingerprint. |
| | **oci-cert** string | | OCI certificate. |
| | **oci-fingerprint** string | | no description |
| | **oci-region** string | **Choices:*** phoenix
* ashburn
* frankfurt
* london
* toronto
| OCI server region. |
| | **oci-region-type** string | **Choices:*** commercial
* government
| OCI region type. |
| | **password** string | | no description |
| | **private-key** string | | Private key of GCP service account. |
| | **region** string | | AWS region name. |
| | **resource-group** string | | Azure resource group. |
| | **resource-url** string | | Azure Stack resource URL. |
| | **rest-interface** string | **Choices:*** mgmt
* sync
| Interface name for REST service to listen on. |
| | **rest-password** string | | no description |
| | **rest-sport** integer | | REST service access port (1 - 65535). |
| | **rest-ssl** string | **Choices:*** disable
* enable
| no description |
| | **route** list / elements=string | | no description |
| | | **name** string | | Route name. |
| | **route-table** list / elements=string | | no description |
| | | **name** string | | Route table name. |
| | | **resource-group** string | | Resource group of Azure route table. |
| | | **route** list / elements=string | | no description |
| | | | **name** string | | Route name. |
| | | | **next-hop** string | | Next hop address. |
| | | **subscription-id** string | | Subscription ID of Azure route table. |
| | **secret-key** string | | no description |
| | **secret-token** string | | Secret token of Kubernetes service account. |
| | **server** string | | Server address of the remote SDN connector. |
| | **server-list** string | | no description |
| | **server-port** integer | | Port number of the remote SDN connector. |
| | **service-account** string | | GCP service account email. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable connection to the remote SDN connector. |
| | **subscription-id** string | | Azure subscription ID. |
| | **tenant-id** string | | Tenant ID (directory ID). |
| | **type** string | **Choices:*** aci
* aws
* nsx
* nuage
* azure
* gcp
* oci
* openstack
* kubernetes
* vmware
* acs
* alicloud
* sepm
* aci-direct
* ibm
* nutanix
| Type of SDN connector. |
| | **update-interval** integer | | Dynamic object update interval (0 - 3600 sec, 0 means disabled, default = 60). |
| | **updating** integer | | no description |
| | **use-metadata-iam** string | **Choices:*** disable
* enable
| Enable/disable using IAM role from metadata to call API. |
| | **user-id** string | | User ID. |
| | **username** string | | Username of the remote SDN connector as login credentials. |
| | **vcenter-password** string | | no description |
| | **vcenter-server** string | | vCenter server address for NSX quarantine. |
| | **vcenter-username** string | | vCenter server username for NSX quarantine. |
| | **vmx-image-url** string | | URL of web-hosted VMX image. |
| | **vmx-service-name** string | | VMX Service name. |
| | **vpc-id** string | | AWS VPC ID. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure connection to SDN Connector.
fmgr_system_sdnconnector:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
system_sdnconnector:
_local_cert: <value of string>
access-key: <value of string>
azure-region: <value in [global, china, germany, ...]>
client-id: <value of string>
client-secret: <value of string>
compartment-id: <value of string>
external-ip:
-
name: <value of string>
gcp-project: <value of string>
key-passwd: <value of string>
login-endpoint: <value of string>
name: <value of string>
nic:
-
ip:
-
name: <value of string>
public-ip: <value of string>
resource-group: <value of string>
name: <value of string>
nsx-cert-fingerprint: <value of string>
oci-cert: <value of string>
oci-fingerprint: <value of string>
oci-region: <value in [phoenix, ashburn, frankfurt, ...]>
password: <value of string>
private-key: <value of string>
region: <value of string>
resource-group: <value of string>
resource-url: <value of string>
rest-interface: <value in [mgmt, sync]>
rest-password: <value of string>
rest-sport: <value of integer>
rest-ssl: <value in [disable, enable]>
route:
-
name: <value of string>
route-table:
-
name: <value of string>
route:
-
name: <value of string>
next-hop: <value of string>
resource-group: <value of string>
subscription-id: <value of string>
secret-key: <value of string>
server: <value of string>
server-port: <value of integer>
service-account: <value of string>
status: <value in [disable, enable]>
subscription-id: <value of string>
tenant-id: <value of string>
type: <value in [aci, aws, nsx, ...]>
update-interval: <value of integer>
use-metadata-iam: <value in [disable, enable]>
user-id: <value of string>
username: <value of string>
vmx-image-url: <value of string>
vmx-service-name: <value of string>
vpc-id: <value of string>
domain: <value of string>
ha-status: <value in [disable, enable]>
last-update: <value of integer>
oci-region-type: <value in [commercial, government]>
secret-token: <value of string>
updating: <value of integer>
group-name: <value of string>
api-key: <value of string>
compute-generation: <value of integer>
ibm-region: <value in [us-south, us-east, germany, ...]>
ibm-region-gen1: <value in [us-south, us-east, germany, ...]>
ibm-region-gen2: <value in [us-south, us-east, great-britain]>
vcenter-password: <value of string>
vcenter-server: <value of string>
vcenter-username: <value of string>
server-list: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs_serverkeytab – Server keytab. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_cifs\_serverkeytab – Server keytab.
=================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs_serverkeytab`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_profileprotocoloptions\_cifs\_serverkeytab** dictionary | | the top level parameters set |
| | **keytab** string | | Base64 encoded keytab file containing credential of the server. |
| | **password** string | | no description |
| | **principal** string | | Service principal. For example, "host/[email protected]". |
| **profile-protocol-options** string / required | | the parameter (profile-protocol-options) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Server keytab.
fmgr_firewall_profileprotocoloptions_cifs_serverkeytab:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile-protocol-options: <your own value>
state: <value in [present, absent]>
firewall_profileprotocoloptions_cifs_serverkeytab:
keytab: <value of string>
password: <value of string>
principal: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_waf_profile_constraint_hostname – Enable/disable hostname check. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_hostname – Enable/disable hostname check.
===============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_waf_profile_constraint_hostname`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **waf\_profile\_constraint\_hostname** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Enable/disable hostname check.
fmgr_waf_profile_constraint_hostname:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
waf_profile_constraint_hostname:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_quota – FortiGuard traffic quota settings. fortinet.fortimanager.fmgr\_webfilter\_profile\_ftgdwf\_quota – FortiGuard traffic quota settings.
==================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_quota`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **profile** string / required | | the parameter (profile) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **webfilter\_profile\_ftgdwf\_quota** dictionary | | the top level parameters set |
| | **category** string | | FortiGuard categories to apply quota to (category action must be set to monitor). |
| | **duration** string | | Duration of quota. |
| | **id** integer | | ID number. |
| | **override-replacemsg** string | | Override replacement message. |
| | **type** string | **Choices:*** time
* traffic
| Quota type. |
| | **unit** string | **Choices:*** B
* KB
* MB
* GB
| Traffic quota unit of measurement. |
| | **value** integer | | Traffic quota value. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: FortiGuard traffic quota settings.
fmgr_webfilter_profile_ftgdwf_quota:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile: <your own value>
state: <value in [present, absent]>
webfilter_profile_ftgdwf_quota:
category: <value of string>
duration: <value of string>
id: <value of integer>
override-replacemsg: <value of string>
type: <value in [time, traffic]>
unit: <value in [B, KB, MB, ...]>
value: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_formdata – Form data. fortinet.fortimanager.fmgr\_vpnsslweb\_portal\_bookmarkgroup\_bookmarks\_formdata – Form data.
==============================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_formdata`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bookmark-group** string / required | | the parameter (bookmark-group) in requested url |
| **bookmarks** string / required | | the parameter (bookmarks) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **portal** string / required | | the parameter (portal) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **vpnsslweb\_portal\_bookmarkgroup\_bookmarks\_formdata** dictionary | | the top level parameters set |
| | **name** string | | Name. |
| | **value** string | | Value. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Form data.
fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_formdata:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
portal: <your own value>
bookmark-group: <your own value>
bookmarks: <your own value>
state: <value in [present, absent]>
vpnsslweb_portal_bookmarkgroup_bookmarks_formdata:
name: <value of string>
value: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries – Carrier end point black/white list. fortinet.fortimanager.fmgr\_firewall\_carrierendpointbwl\_entries – Carrier end point black/white list.
=======================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **carrier-endpoint-bwl** string / required | | the parameter (carrier-endpoint-bwl) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_carrierendpointbwl\_entries** dictionary | | the top level parameters set |
| | **action** list / elements=string | **Choices:*** block
* exempt
* exempt-mass-mms
| no description |
| | **carrier-endpoint** string | | End point to act on. |
| | **log-action** list / elements=string | **Choices:*** archive
* intercept
| no description |
| | **pattern-type** string | **Choices:*** wildcard
* regexp
* simple
| Wildcard pattern or regular expression. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable specified action(s) for this end point. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Carrier end point black/white list.
fmgr_firewall_carrierendpointbwl_entries:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
carrier-endpoint-bwl: <your own value>
state: <value in [present, absent]>
firewall_carrierendpointbwl_entries:
action:
- block
- exempt
- exempt-mass-mms
carrier-endpoint: <value of string>
log-action:
- archive
- intercept
pattern-type: <value in [wildcard, regexp, simple]>
status: <value in [disable, 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 |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry – Entries added to the Internet Service database and custom database. fortinet.fortimanager.fmgr\_firewall\_internetservicecustom\_entry – Entries added to the Internet Service database and custom database.
========================================================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_internetservicecustom\_entry** dictionary | | the top level parameters set |
| | **dst** string | | Destination address or address group name. |
| | **id** integer | | Entry ID(1-255). |
| | **port-range** list / elements=string | | no description |
| | | **end-port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535). |
| | | **id** integer | | 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). |
| **internet-service-custom** string / required | | the parameter (internet-service-custom) in requested url |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Entries added to the Internet Service database and custom database.
fmgr_firewall_internetservicecustom_entry:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
internet-service-custom: <your own value>
state: <value in [present, absent]>
firewall_internetservicecustom_entry:
dst: <value of string>
id: <value of integer>
port-range:
-
end-port: <value of integer>
id: <value of integer>
start-port: <value of integer>
protocol: <value of integer>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service – Create SD-WAN rules or priority rules fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_service – Create SD-WAN rules or priority rules
============================================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_virtualwanlink\_service** dictionary | | the top level parameters set |
| | **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:*** disable
* enable
| Enable/disable use of SD-WAN as default service. |
| | **dscp-forward** string | **Choices:*** disable
* enable
| Enable/disable forward traffic DSCP tag. |
| | **dscp-forward-tag** string | | Forward traffic DSCP tag. |
| | **dscp-reverse** string | **Choices:*** disable
* enable
| Enable/disable reverse traffic DSCP tag. |
| | **dscp-reverse-tag** string | | Reverse traffic DSCP tag. |
| | **dst** string | | Destination address name. |
| | **dst-negate** string | **Choices:*** disable
* enable
| Enable/disable negation of destination address match. |
| | **dst6** string | | Destination address6 name. |
| | **end-port** integer | | End destination port number. |
| | **gateway** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN service gateway. |
| | **groups** string | | User groups. |
| | **health-check** string | | Health check. |
| | **hold-down-time** integer | | Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). |
| | **id** integer | | Priority rule ID (1 - 4000). |
| | **input-device** string | | Source interface name. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet service for application-based load balancing. |
| | **internet-service-app-ctrl** integer | | no description |
| | **internet-service-app-ctrl-group** string | | Application control based Internet Service group list. |
| | **internet-service-ctrl** integer | | no description |
| | **internet-service-ctrl-group** string | | Control-based Internet Service group list. |
| | **internet-service-custom** string | | Custom Internet service name list. |
| | **internet-service-custom-group** string | | Custom Internet Service group list. |
| | **internet-service-group** string | | Internet Service group list. |
| | **internet-service-id** string | | Internet service ID list. |
| | **internet-service-name** string | | Internet service name list. |
| | **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, default = 10). |
| | **member** string | | Member sequence number. |
| | **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** string | | Member sequence number list. |
| | **protocol** integer | | Protocol number. |
| | **quality-link** integer | | Quality grade. |
| | **role** string | **Choices:*** primary
* secondary
* standalone
| Service role to work with neighbor. |
| | **route-tag** integer | | IPv4 route map route-tag. |
| | **sla** list / elements=string | | no description |
| | | **health-check** string | | Virtual WAN Link health-check. |
| | | **id** integer | | SLA ID. |
| | **sla-compare-method** string | **Choices:*** order
* number
| Method to compare SLA value for sla and load balance mode. |
| | **src** string | | Source address name. |
| | **src-negate** string | **Choices:*** disable
* enable
| Enable/disable negation of source address match. |
| | **src6** string | | Source address6 name. |
| | **standalone-action** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable/disable SD-WAN service. |
| | **tos** string | | Type of service bit pattern. |
| | **tos-mask** string | | Type of service evaluated bits. |
| | **users** string | | User name. |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Create SD-WAN rules or priority rules
fmgr_wanprof_system_virtualwanlink_service:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_service:
addr-mode: <value in [ipv4, ipv6]>
bandwidth-weight: <value of integer>
default: <value in [disable, enable]>
dscp-forward: <value in [disable, enable]>
dscp-forward-tag: <value of string>
dscp-reverse: <value in [disable, enable]>
dscp-reverse-tag: <value of string>
dst: <value of string>
dst-negate: <value in [disable, enable]>
dst6: <value of string>
end-port: <value of integer>
gateway: <value in [disable, enable]>
groups: <value of string>
health-check: <value of string>
hold-down-time: <value of integer>
id: <value of integer>
internet-service: <value in [disable, enable]>
internet-service-ctrl: <value of integer>
internet-service-ctrl-group: <value of string>
internet-service-custom: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-id: <value of string>
jitter-weight: <value of integer>
latency-weight: <value of integer>
link-cost-factor: <value in [latency, jitter, packet-loss, ...]>
link-cost-threshold: <value of integer>
member: <value of string>
mode: <value in [auto, manual, priority, ...]>
name: <value of string>
packet-loss-weight: <value of integer>
priority-members: <value of string>
protocol: <value of integer>
quality-link: <value of integer>
route-tag: <value of integer>
sla:
-
health-check: <value of string>
id: <value of integer>
src: <value of string>
src-negate: <value in [disable, enable]>
src6: <value of string>
start-port: <value of integer>
status: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
users: <value of string>
internet-service-app-ctrl: <value of integer>
internet-service-app-ctrl-group: <value of string>
role: <value in [primary, secondary, standalone]>
sla-compare-method: <value in [order, number]>
standalone-action: <value in [disable, enable]>
input-device: <value of string>
internet-service-name: <value of string>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
| programming_docs |
ansible fortinet.fortimanager.fmgr_devprof_system_ntp – Configure system NTP information. fortinet.fortimanager.fmgr\_devprof\_system\_ntp – Configure system NTP information.
====================================================================================
Note
This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortimanager`.
To use it in a playbook, specify: `fortinet.fortimanager.fmgr_devprof_system_ntp`.
New in version 2.10: of fortinet.fortimanager
* [Synopsis](#synopsis)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* This module is able to configure a FortiManager device.
* Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
----------
| Parameter | Choices/Defaults | Comments |
| --- | --- | --- |
| **adom** string / required | | the parameter (adom) in requested url |
| **bypass\_validation** boolean | **Choices:*** **no** ←
* yes
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
| **devprof** string / required | | the parameter (devprof) in requested url |
| **devprof\_system\_ntp** dictionary | | the top level parameters set |
| | **authentication** string | **Choices:*** disable
* enable
| Enable/disable authentication. |
| | **key** string | | no description |
| | **key-id** integer | | Key ID for authentication. |
| | **key-type** string | **Choices:*** MD5
* SHA1
| Key type for authentication (MD5, SHA1). |
| | **ntpserver** list / elements=string | | no description |
| | | **authentication** string | **Choices:*** disable
* enable
| Enable/disable MD5 authentication. |
| | | **id** integer | | NTP server ID. |
| | | **interface** string | | Specify outgoing interface to reach server. |
| | | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | | **key** string | | no description |
| | | **key-id** integer | | Key ID for authentication. |
| | | **ntpv3** string | **Choices:*** disable
* enable
| Enable to use NTPv3 instead of NTPv4. |
| | | **server** string | | IP address or hostname of the NTP Server. |
| | **ntpsync** string | **Choices:*** disable
* enable
| Enable/disable setting the FortiGate system time by synchronizing with an 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **rc\_failed** list / elements=string | | the rc codes list with which the conditions to fail will be overriden |
| **rc\_succeeded** list / elements=string | | the rc codes list with which the conditions to succeed will be overriden |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **workspace\_locking\_adom** string | | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
| **workspace\_locking\_timeout** integer | **Default:**300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
-----
Note
* Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work.
* To create or update an object, use state present directive.
* To delete an object, use state absent directive.
* Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded
Examples
--------
```
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure system NTP information.
fmgr_devprof_system_ntp:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
devprof_system_ntp:
ntpserver:
-
authentication: <value in [disable, enable]>
id: <value of integer>
key: <value of string>
key-id: <value of integer>
ntpv3: <value in [disable, enable]>
server: <value of string>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
ntpsync: <value in [disable, enable]>
source-ip6: <value of string>
syncinterval: <value of integer>
type: <value in [fortiguard, custom]>
authentication: <value in [disable, enable]>
key: <value of string>
key-id: <value of integer>
key-type: <value in [MD5, SHA1]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **request\_url** string | always | The full url requested **Sample:** /sys/login/user |
| **response\_code** integer | always | The status of api request |
| **response\_message** string | always | The descriptive message of the api response **Sample:** OK. |
### Authors
* Link Zheng (@chillancezen)
* Jie Xue (@JieX19)
* Frank Shen (@fshen01)
* Hongbin Lu (@fgtdev-hblu)
ansible fortinet.fortios.fortios_firewall_sniffer – Configure sniffer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_sniffer – Configure sniffer in Fortinet’s FortiOS and FortiGate.
====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 firewall feature and 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. |
| **firewall\_sniffer** dictionary | | Configure sniffer. |
| | **anomaly** list / elements=string | | Configuration method to edit Denial of Service (DoS) anomaly settings. |
| | | **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. |
| | **application\_list** string | | Name of an existing application list. Source application.list.name. |
| | **application\_list\_status** string | **Choices:*** enable
* disable
| Enable/disable application control profile. |
| | **av\_profile** string | | Name of an existing antivirus profile. Source antivirus.profile.name. |
| | **av\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable antivirus profile. |
| | **dlp\_sensor** string | | Name of an existing DLP sensor. Source dlp.sensor.name. |
| | **dlp\_sensor\_status** string | **Choices:*** enable
* disable
| Enable/disable DLP sensor. |
| | **dsri** string | **Choices:*** enable
* disable
| Enable/disable DSRI. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **emailfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable emailfilter. |
| | **file\_filter\_profile** string | | Name of an existing file-filter profile. Source file-filter.profile.name. |
| | **file\_filter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable file filter. |
| | **host** string | | Hosts to filter for in sniffer traffic (Format examples: 1.1.1.1, 2.2.2.0/24, 3.3.3.3/255.255.255.0, 4.4.4.0-4.4.4.240). |
| | **id** integer / required | | Sniffer ID. |
| | **interface** string | | Interface name that traffic sniffing will take place on. Source system.interface.name. |
| | **ip\_threatfeed** list / elements=string | | Name of an existing IP threat feed. |
| | | **name** string / required | | Threat feed name. Source system.external-resource.name. |
| | **ip\_threatfeed\_status** string | **Choices:*** enable
* disable
| Enable/disable IP threat feed. |
| | **ips\_dos\_status** string | **Choices:*** enable
* disable
| Enable/disable IPS DoS anomaly detection. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **ips\_sensor\_status** string | **Choices:*** enable
* disable
| Enable/disable IPS sensor. |
| | **ipv6** string | **Choices:*** enable
* disable
| Enable/disable sniffing IPv6 packets. |
| | **logtraffic** string | **Choices:*** all
* utm
* disable
| Either log all sessions, only sessions that have a security profile applied, or disable all logging for this policy. |
| | **max\_packet\_count** integer | | Maximum packet count (1 - 1000000). |
| | **non\_ip** string | **Choices:*** enable
* disable
| Enable/disable sniffing non-IP packets. |
| | **port** string | | Ports to sniff (Format examples: 10, :20, 30:40, 50-, 100-200). |
| | **protocol** string | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Enable/disable scanning of connections to Botnet servers. |
| | **spamfilter\_profile** string | | Name of an existing spam filter profile. Source spamfilter.profile.name. |
| | **spamfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable spam filter. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the active status of the sniffer. |
| | **vlan** string | | List of VLANs to sniff. |
| | **webfilter\_profile** string | | Name of an existing web filter profile. Source webfilter.profile.name. |
| | **webfilter\_profile\_status** string | **Choices:*** enable
* disable
| Enable/disable web filter profile. |
| **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 sniffer.
fortios_firewall_sniffer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_sniffer:
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"
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"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dlp_sensor_status: "enable"
dsri: "enable"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
emailfilter_profile_status: "enable"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
file_filter_profile_status: "enable"
host: "myhostname"
id: "25"
interface: "<your_own_value> (source system.interface.name)"
ip_threatfeed:
-
name: "default_name_28 (source system.external-resource.name)"
ip_threatfeed_status: "enable"
ips_dos_status: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_sensor_status: "enable"
ipv6: "enable"
logtraffic: "all"
max_packet_count: "35"
non_ip: "enable"
port: "<your_own_value>"
protocol: "<your_own_value>"
scan_botnet_connections: "disable"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
spamfilter_profile_status: "enable"
status: "enable"
vlan: "<your_own_value>"
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)
ansible fortinet.fortios.fortios_webfilter_ips_urlfilter_setting – Configure IPS URL filter settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_ips\_urlfilter\_setting – Configure IPS URL filter 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_webfilter_ips_urlfilter_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 webfilter feature and ips\_urlfilter\_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. |
| **webfilter\_ips\_urlfilter\_setting** dictionary | | Configure IPS URL filter settings. |
| | **device** string | | Interface for this route. Source system.interface.name. |
| | **distance** integer | | Administrative distance (1 - 255) for this route. |
| | **gateway** string | | Gateway IP address for this route. |
| | **geo\_filter** string | | Filter based on geographical location. Route will NOT be installed if the resolved IP address belongs to the country in the filter. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 settings.
fortios_webfilter_ips_urlfilter_setting:
vdom: "{{ vdom }}"
webfilter_ips_urlfilter_setting:
device: "<your_own_value> (source system.interface.name)"
distance: "4"
gateway: "<your_own_value>"
geo_filter: "<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_antivirus_notification – Configure AntiVirus notification lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_notification – Configure AntiVirus notification 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_antivirus_notification`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 notification category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_notification** dictionary | | Configure AntiVirus notification lists. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | modify this antivirus notification list |
| | | **name** string / required | | virus name or prefix |
| | | **prefix** string | **Choices:*** enable
* disable
| enable prefix matches based on this name |
| | | **status** string | **Choices:*** enable
* disable
| enable this entry for notifications |
| | **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 AntiVirus notification lists.
fortios_antivirus_notification:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
antivirus_notification:
comment: "Optional comments."
entries:
-
name: "default_name_5"
prefix: "enable"
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)
ansible fortinet.fortios.fortios_switch_controller_stp_instance – Configure FortiSwitch multiple spanning tree protocol (MSTP) instances in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_stp\_instance – Configure FortiSwitch multiple spanning tree protocol (MSTP) instances in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_instance`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_instance category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_stp\_instance** dictionary | | Configure FortiSwitch multiple spanning tree protocol (MSTP) instances. |
| | **id** string / required | | Instance ID. |
| | **vlan\_range** list / elements=string | | Configure VLAN range for STP instance. |
| | | **vlan\_name** string | | VLAN 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 FortiSwitch multiple spanning tree protocol (MSTP) instances.
fortios_switch_controller_stp_instance:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_stp_instance:
id: "3"
vlan_range:
-
vlan_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)
ansible fortinet.fortios.fortios_system_stp – Configure Spanning Tree Protocol (STP) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_stp – Configure 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_system_stp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 stp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_stp** dictionary | | Configure Spanning Tree Protocol (STP). |
| | **config\_revision** integer | | STP configuration revision (0 - 4294967295). |
| | **forward\_delay** integer | | Forward delay (4 - 30 sec). |
| | **hello\_time** integer | | Hello time (1 - 10 sec). |
| | **max\_age** integer | | Maximum packet age (6 - 40 sec). |
| | **max\_hops** integer | | Maximum number of hops (1 - 40). |
| | **region\_name** string | | Set region name. |
| | **status** string | | Enable/disable STP settings. |
| | **switch\_priority** string | **Choices:*** 0
* 4096
* 8192
* 12288
* 16384
* 20480
* 24576
* 28672
* 32768
* 36864
* 40960
* 45056
* 49152
* 53248
* 57344
| STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 Spanning Tree Protocol (STP).
fortios_system_stp:
vdom: "{{ vdom }}"
system_stp:
config_revision: "3"
forward_delay: "4"
hello_time: "5"
max_age: "6"
max_hops: "7"
region_name: "<your_own_value>"
status: "<your_own_value>"
switch_priority: "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_switch_controller_ptp_policy – PTP policy configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_ptp\_policy – PTP policy 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_switch_controller_ptp_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\_ptp 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\_ptp\_policy** dictionary | | PTP policy configuration. |
| | **name** string / required | | Policy name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable PTP policy. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: PTP policy configuration.
fortios_switch_controller_ptp_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_ptp_policy:
name: "default_name_3"
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)
ansible fortinet.fortios.fortios_dlp_fp_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\_fp\_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_fp_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 fp\_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\_fp\_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_fp_sensitivity:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_fp_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)
| programming_docs |
ansible fortinet.fortios.fortios_log_syslogd_override_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd\_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_syslogd_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\_syslogd 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\_syslogd\_override\_filter** dictionary | | Override 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: Override filters for remote system server.
fortios_log_syslogd_override_filter:
vdom: "{{ vdom }}"
log_syslogd_override_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_switch_controller_security_policy_local_access – Configure allowaccess list for mgmt and internal interfaces on managed FortiSwitch in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_security\_policy\_local\_access – Configure allowaccess list for mgmt and internal interfaces on managed 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_security_policy_local_access`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_security\_policy feature and local\_access category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_security\_policy\_local\_access** dictionary | | Configure allowaccess list for mgmt and internal interfaces on managed FortiSwitch. |
| | **internal\_allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* radius-acct
| Allowed access on the switch internal interface. |
| | **mgmt\_allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* radius-acct
| Allowed access on the switch management interface. |
| | **name** string / required | | 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 allowaccess list for mgmt and internal interfaces on managed FortiSwitch.
fortios_switch_controller_security_policy_local_access:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_security_policy_local_access:
internal_allowaccess: "https"
mgmt_allowaccess: "https"
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_log_syslogd3_override_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd3\_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_syslogd3_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\_syslogd3 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\_syslogd3\_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_syslogd3_override_setting:
vdom: "{{ vdom }}"
log_syslogd3_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_system_password_policy – Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_password\_policy – Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared 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_system_password_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 feature and password\_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. |
| **system\_password\_policy** dictionary | | Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys. |
| | **apply\_to** list / elements=string | **Choices:*** admin-password
* ipsec-preshared-key
| Apply password policy to administrator passwords or IPsec pre-shared keys or both. Separate entries with a space. |
| | **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 password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.
fortios_system_password_policy:
vdom: "{{ vdom }}"
system_password_policy:
apply_to: "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)
| programming_docs |
ansible fortinet.fortios.fortios_endpoint_control_fctems – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_fctems – Configure FortiClient Enterprise Management Server (EMS) 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_endpoint_control_fctems`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fctems category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fctems** dictionary | | Configure FortiClient Enterprise Management Server (EMS) entries. |
| | **admin\_password** string | | FortiClient EMS admin password. |
| | **admin\_username** string | | FortiClient EMS admin username. |
| | **call\_timeout** integer | | FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds). |
| | **capabilities** list / elements=string | **Choices:*** fabric-auth
* silent-approval
* websocket
| List of EMS capabilities. |
| | **certificate** string | | FortiClient EMS certificate. Source certificate.remote.name. |
| | **cloud\_server\_type** string | **Choices:*** production
* alpha
* beta
| Cloud server type. |
| | **fortinetone\_cloud\_authentication** string | **Choices:*** enable
* disable
| Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. |
| | **https\_port** integer | | FortiClient EMS HTTPS access port number. (1 - 65535). |
| | **name** string / required | | FortiClient Enterprise Management Server (EMS) name. |
| | **pull\_avatars** string | **Choices:*** enable
* disable
| Enable/disable pulling avatars from EMS. |
| | **pull\_malware\_hash** string | **Choices:*** enable
* disable
| Enable/disable pulling FortiClient malware hash from EMS. |
| | **pull\_sysinfo** string | **Choices:*** enable
* disable
| Enable/disable pulling SysInfo from EMS. |
| | **pull\_tags** string | **Choices:*** enable
* disable
| Enable/disable pulling FortiClient user tags from EMS. |
| | **pull\_vulnerabilities** string | **Choices:*** enable
* disable
| Enable/disable pulling vulnerabilities from EMS. |
| | **serial\_number** string | | FortiClient EMS Serial Number. |
| | **server** string | | FortiClient EMS FQDN or IPv4 address. |
| | **source\_ip** string | | REST API call source IP. |
| | **status\_check\_interval** integer | | FortiClient EMS call timeout in seconds (1 - 120 seconds). |
| | **websocket\_override** string | **Choices:*** enable
* disable
| Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. |
| **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 Enterprise Management Server (EMS) entries.
fortios_endpoint_control_fctems:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_fctems:
admin_password: "<your_own_value>"
admin_username: "<your_own_value>"
call_timeout: "5"
capabilities: "fabric-auth"
certificate: "<your_own_value> (source certificate.remote.name)"
cloud_server_type: "production"
fortinetone_cloud_authentication: "enable"
https_port: "10"
name: "default_name_11"
pull_avatars: "enable"
pull_malware_hash: "enable"
pull_sysinfo: "enable"
pull_tags: "enable"
pull_vulnerabilities: "enable"
serial_number: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status_check_interval: "20"
websocket_override: "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 – HttpApi Plugin for Fortinet FortiOS Appliance or VM fortinet.fortios.fortios – HttpApi Plugin for Fortinet FortiOS Appliance or VM
==============================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios`.
New in version 2.9: of fortinet.fortios
Synopsis
--------
* This HttpApi plugin provides methods to connect to Fortinet FortiOS Appliance or VM via REST API
### Authors
* Miguel Angel Munoz (@magonzalez)
ansible fortinet.fortios.fortios_cifs_profile – Configure CIFS profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_cifs\_profile – Configure CIFS 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_cifs_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 cifs 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. |
| **cifs\_profile** dictionary | | Configure CIFS profile. |
| | **domain\_controller** string | | Domain for which to decrypt CIFS traffic. Source cifs.domain-controller.server-name. |
| | **file\_filter** dictionary | | File filter. |
| | | **entries** list / elements=string | | File filter entries. |
| | | | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | | | **comment** string | | Comment. |
| | | | **direction** string | **Choices:*** incoming
* outgoing
* any
| Match files transmitted in the session"s originating or reply direction. |
| | | | **file\_type** list / elements=string | | Select file type. |
| | | | | **name** string / required | | File type name. Source antivirus.filetype.name. |
| | | | **filter** string / required | | Add a file filter. |
| | | | **protocol** string | **Choices:*** cifs
| Protocols to apply with. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable file filter logging. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable file filter. |
| | **name** string / required | | Profile name. |
| | **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. |
| | | **password** string | | Password for keytab. |
| | | **principal** string / required | | Service principal. For example, "host/[email protected]". |
| **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 CIFS profile.
fortios_cifs_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
cifs_profile:
domain_controller: "<your_own_value> (source cifs.domain-controller.server-name)"
file_filter:
entries:
-
action: "log"
comment: "Comment."
direction: "incoming"
file_type:
-
name: "default_name_10 (source antivirus.filetype.name)"
filter: "<your_own_value>"
protocol: "cifs"
log: "enable"
status: "enable"
name: "default_name_15"
server_credential_type: "none"
server_keytab:
-
keytab: "<your_own_value>"
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_router_static – Configure IPv4 static routing tables in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_static – Configure IPv4 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_static`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 static category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_static** dictionary | | Configure IPv4 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. |
| | **distance** integer | | Administrative distance (1 - 255). |
| | **dst** string | | Destination IP and mask for this route. |
| | **dstaddr** string | | Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name. |
| | **dynamic\_gateway** string | **Choices:*** enable
* disable
| Enable use of dynamic gateway retrieved from a DHCP or PPP server. |
| | **gateway** string | | Gateway IP for this route. |
| | **internet\_service** integer | | Application ID in the Internet service database. Source firewall.internet-service.id. |
| | **internet\_service\_custom** string | | Application name in the Internet service custom database. Source firewall.internet-service-custom.name. |
| | **link\_monitor\_exempt** string | **Choices:*** enable
* disable
| Enable/disable withdrawing this route when link monitor or health check is down. |
| | **priority** integer | | Administrative priority (0 - 4294967295). |
| | **sdwan** string | **Choices:*** enable
* disable
| Enable/disable egress through SD-WAN. |
| | **seq\_num** integer | | Sequence number. |
| | **src** string | | Source prefix for this route. |
| | **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. |
| | **vrf** integer | | Virtual Routing Forwarding ID. |
| | **weight** integer | | Administrative weight (0 - 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 IPv4 static routing tables.
fortios_router_static:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_static:
bfd: "enable"
blackhole: "enable"
comment: "Optional comments."
device: "<your_own_value> (source system.interface.name)"
distance: "7"
dst: "<your_own_value>"
dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
dynamic_gateway: "enable"
gateway: "<your_own_value>"
internet_service: "12 (source firewall.internet-service.id)"
internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
link_monitor_exempt: "enable"
priority: "15"
sdwan: "enable"
seq_num: "17"
src: "<your_own_value>"
status: "enable"
virtual_wan_link: "enable"
vrf: "21"
weight: "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_webfilter_ftgd_local_cat – Configure FortiGuard Web Filter local categories in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_ftgd\_local\_cat – Configure FortiGuard Web Filter local 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_webfilter_ftgd_local_cat`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_cat category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_cat** dictionary | | Configure FortiGuard Web Filter local categories. |
| | **desc** string / required | | Local category description. |
| | **id** integer | | Local category ID. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the local category. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 local categories.
fortios_webfilter_ftgd_local_cat:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_ftgd_local_cat:
desc: "<your_own_value>"
id: "4"
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_security_policy_captive_portal – Names of VLANs that use captive portal authentication in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_security\_policy\_captive\_portal – Names of VLANs that use captive portal 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_switch_controller_security_policy_captive_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 switch\_controller\_security\_policy feature and captive\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_security\_policy\_captive\_portal** dictionary | | Names of VLANs that use captive portal authentication. |
| | **name** string / required | | Policy name. |
| | **policy\_type** string | **Choices:*** captive-portal
| Policy type. |
| | **vlan** string | | Names of VLANs that use captive portal authentication. 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: Names of VLANs that use captive portal authentication.
fortios_switch_controller_security_policy_captive_portal:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_security_policy_captive_portal:
name: "default_name_3"
policy_type: "captive-portal"
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_vpn_ssl_web_portal – Portal in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_web\_portal – Portal in Fortinet’s FortiOS and FortiGate.
=============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 vpn\_ssl\_web feature and 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. |
| **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\_portal** dictionary | | Portal. |
| | **allow\_user\_access** list / elements=string | **Choices:*** web
* ftp
* smb
* telnet
* ssh
* vnc
* rdp
* ping
* citrix
* portforward
* sftp
| Allow user access to SSL-VPN applications. |
| | **auto\_connect** string | **Choices:*** enable
* disable
| Enable/disable automatic connect by client when system is up. |
| | **bookmark\_group** list / elements=string | | Portal bookmark group. |
| | | **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. |
| | | **name** string / required | | Bookmark group name. |
| | **custom\_lang** string | | Change the web portal display language. Overrides config system global set language. You can use config system custom-language and execute system custom-language to add custom language files. Source system.custom-language.name. |
| | **customize\_forticlient\_download\_url** string | **Choices:*** enable
* disable
| Enable support of customized download URL for FortiClient. |
| | **display\_bookmark** string | **Choices:*** enable
* disable
| Enable to display the web portal bookmark widget. |
| | **display\_connection\_tools** string | **Choices:*** enable
* disable
| Enable to display the web portal connection tools widget. |
| | **display\_history** string | **Choices:*** enable
* disable
| Enable to display the web portal user login history widget. |
| | **display\_status** string | **Choices:*** enable
* disable
| Enable to display the web portal status widget. |
| | **dns\_server1** string | | IPv4 DNS server 1. |
| | **dns\_server2** string | | IPv4 DNS server 2. |
| | **dns\_suffix** string | | DNS suffix. |
| | **exclusive\_routing** string | **Choices:*** enable
* disable
| Enable/disable all traffic go through tunnel only. |
| | **forticlient\_download** string | **Choices:*** enable
* disable
| Enable/disable download option for FortiClient. |
| | **forticlient\_download\_method** string | **Choices:*** direct
* ssl-vpn
| FortiClient download method. |
| | **heading** string | | Web portal heading message. |
| | **hide\_sso\_credential** string | **Choices:*** enable
* disable
| Enable to prevent SSO credential being sent to client. |
| | **host\_check** string | **Choices:*** none
* av
* fw
* av-fw
* custom
| Type of host checking performed on endpoints. |
| | **host\_check\_interval** integer | | Periodic host check interval. Value of 0 means disabled and host checking only happens when the endpoint connects. |
| | **host\_check\_policy** list / elements=string | | One or more policies to require the endpoint to have specific security software. |
| | | **name** string / required | | Host check software list name. Source vpn.ssl.web.host-check-software.name. |
| | **ip\_mode** string | **Choices:*** range
* user-group
| Method by which users of this SSL-VPN tunnel obtain IP addresses. |
| | **ip\_pools** list / elements=string | | IPv4 firewall source address objects reserved for SSL-VPN tunnel mode clients. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv6\_dns\_server1** string | | IPv6 DNS server 1. |
| | **ipv6\_dns\_server2** string | | IPv6 DNS server 2. |
| | **ipv6\_exclusive\_routing** string | **Choices:*** enable
* disable
| Enable/disable all IPv6 traffic go through tunnel only. |
| | **ipv6\_pools** list / elements=string | | IPv4 firewall source address objects reserved for SSL-VPN tunnel mode clients. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_service\_restriction** string | **Choices:*** enable
* disable
| Enable/disable IPv6 tunnel service restriction. |
| | **ipv6\_split\_tunneling** string | **Choices:*** enable
* disable
| Enable/disable IPv6 split tunneling. |
| | **ipv6\_split\_tunneling\_routing\_address** list / elements=string | | IPv6 SSL-VPN tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneling access. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_split\_tunneling\_routing\_negate** string | **Choices:*** enable
* disable
| Enable to negate IPv6 split tunneling routing address. |
| | **ipv6\_tunnel\_mode** string | **Choices:*** enable
* disable
| Enable/disable IPv6 SSL-VPN tunnel mode. |
| | **ipv6\_wins\_server1** string | | IPv6 WINS server 1. |
| | **ipv6\_wins\_server2** string | | IPv6 WINS server 2. |
| | **keep\_alive** string | **Choices:*** enable
* disable
| Enable/disable automatic reconnect for FortiClient connections. |
| | **limit\_user\_logins** string | **Choices:*** enable
* disable
| Enable to limit each user to one SSL-VPN session at a time. |
| | **mac\_addr\_action** string | **Choices:*** allow
* deny
| Client MAC address action. |
| | **mac\_addr\_check** string | **Choices:*** enable
* disable
| Enable/disable MAC address host checking. |
| | **mac\_addr\_check\_rule** list / elements=string | | Client MAC address check rule. |
| | | **mac\_addr\_list** list / elements=string | | Client MAC address list. |
| | | | **addr** string / required | | Client MAC address. |
| | | **mac\_addr\_mask** integer | | Client MAC address mask. |
| | | **name** string / required | | Client MAC address check rule name. |
| | **macos\_forticlient\_download\_url** string | | Download URL for Mac FortiClient. |
| | **name** string / required | | Portal name. |
| | **os\_check** string | **Choices:*** enable
* disable
| Enable to let the FortiGate decide action based on client OS. |
| | **os\_check\_list** list / elements=string | | SSL VPN OS checks. |
| | | **action** string | **Choices:*** deny
* allow
* check-up-to-date
| OS check options. |
| | | **latest\_patch\_level** string | | Latest OS patch level. |
| | | **name** string / required | | Name. |
| | | **tolerance** integer | | OS patch level tolerance. |
| | **prefer\_ipv6\_dns** string | **Choices:*** enable
* disable
| prefer to query IPv6 dns first if enabled. |
| | **redir\_url** string | | Client login redirect URL. |
| | **rewrite\_ip\_uri\_ui** string | **Choices:*** enable
* disable
| Rewrite contents for URI contains IP and "/ui/". |
| | **save\_password** string | **Choices:*** enable
* disable
| Enable/disable FortiClient saving the user"s password. |
| | **service\_restriction** string | **Choices:*** enable
* disable
| Enable/disable tunnel service restriction. |
| | **skip\_check\_for\_browser** string | **Choices:*** enable
* disable
| Enable to skip host check for browser support. |
| | **skip\_check\_for\_unsupported\_browser** string | **Choices:*** enable
* disable
| Enable to skip host check if browser does not support it. |
| | **skip\_check\_for\_unsupported\_os** string | **Choices:*** enable
* disable
| Enable to skip host check if client OS does not support it. |
| | **smb\_max\_version** string | **Choices:*** smbv1
* smbv2
* smbv3
| SMB maximum client protocol version. |
| | **smb\_min\_version** string | **Choices:*** smbv1
* smbv2
* smbv3
| SMB minimum client protocol version. |
| | **smb\_ntlmv1\_auth** string | **Choices:*** enable
* disable
| Enable support of NTLMv1 for Samba authentication. |
| | **smbv1** string | **Choices:*** enable
* disable
| Enable/disable support of SMBv1 for Samba. |
| | **split\_dns** list / elements=string | | Split DNS for SSL VPN. |
| | | **dns\_server1** string | | DNS server 1. |
| | | **dns\_server2** string | | DNS server 2. |
| | | **domains** string | | Split DNS domains used for SSL-VPN clients separated by comma(,). |
| | | **id** integer / required | | ID. |
| | | **ipv6\_dns\_server1** string | | IPv6 DNS server 1. |
| | | **ipv6\_dns\_server2** string | | IPv6 DNS server 2. |
| | **split\_tunneling** string | **Choices:*** enable
* disable
| Enable/disable IPv4 split tunneling. |
| | **split\_tunneling\_routing\_address** list / elements=string | | IPv4 SSL-VPN tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneling access. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **split\_tunneling\_routing\_negate** string | **Choices:*** enable
* disable
| Enable to negate split tunneling routing address. |
| | **theme** string | **Choices:*** blue
* green
* red
* melongene
* mariner
* neutrino
* jade
* graphite
* dark-matter
* onyx
* eclipse
| Web portal color scheme. |
| | **transform\_backward\_slashes** string | **Choices:*** enable
* disable
| Transform backward slashes to forward slashes in URLs. |
| | **tunnel\_mode** string | **Choices:*** enable
* disable
| Enable/disable IPv4 SSL-VPN tunnel mode. |
| | **use\_sdwan** string | **Choices:*** enable
* disable
| Use SD-WAN rules to get output interface. |
| | **user\_bookmark** string | **Choices:*** enable
* disable
| Enable to allow web portal users to create their own bookmarks. |
| | **user\_group\_bookmark** string | **Choices:*** enable
* disable
| Enable to allow web portal users to create bookmarks for all users in the same user group. |
| | **web\_mode** string | **Choices:*** enable
* disable
| Enable/disable SSL VPN web mode. |
| | **windows\_forticlient\_download\_url** string | | Download URL for Windows FortiClient. |
| | **wins\_server1** string | | IPv4 WINS server 1. |
| | **wins\_server2** string | | IPv4 WINS server 1. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Portal.
fortios_vpn_ssl_web_portal:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_portal:
allow_user_access: "web"
auto_connect: "enable"
bookmark_group:
-
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_13"
value: "<your_own_value>"
host: "<your_own_value>"
listening_port: "16"
load_balancing_info: "<your_own_value>"
logon_password: "<your_own_value>"
logon_user: "<your_own_value>"
name: "default_name_20"
port: "21"
preconnection_blob: "<your_own_value>"
preconnection_id: "23"
remote_port: "24"
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"
name: "default_name_34"
custom_lang: "<your_own_value> (source system.custom-language.name)"
customize_forticlient_download_url: "enable"
display_bookmark: "enable"
display_connection_tools: "enable"
display_history: "enable"
display_status: "enable"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_suffix: "<your_own_value>"
exclusive_routing: "enable"
forticlient_download: "enable"
forticlient_download_method: "direct"
heading: "<your_own_value>"
hide_sso_credential: "enable"
host_check: "none"
host_check_interval: "50"
host_check_policy:
-
name: "default_name_52 (source vpn.ssl.web.host-check-software.name)"
ip_mode: "range"
ip_pools:
-
name: "default_name_55 (source firewall.address.name firewall.addrgrp.name)"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
ipv6_exclusive_routing: "enable"
ipv6_pools:
-
name: "default_name_60 (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_service_restriction: "enable"
ipv6_split_tunneling: "enable"
ipv6_split_tunneling_routing_address:
-
name: "default_name_64 (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_split_tunneling_routing_negate: "enable"
ipv6_tunnel_mode: "enable"
ipv6_wins_server1: "<your_own_value>"
ipv6_wins_server2: "<your_own_value>"
keep_alive: "enable"
limit_user_logins: "enable"
mac_addr_action: "allow"
mac_addr_check: "enable"
mac_addr_check_rule:
-
mac_addr_list:
-
addr: "<your_own_value>"
mac_addr_mask: "76"
name: "default_name_77"
macos_forticlient_download_url: "<your_own_value>"
name: "default_name_79"
os_check: "enable"
os_check_list:
-
action: "deny"
latest_patch_level: "<your_own_value>"
name: "default_name_84"
tolerance: "85"
prefer_ipv6_dns: "enable"
redir_url: "<your_own_value>"
rewrite_ip_uri_ui: "enable"
save_password: "enable"
service_restriction: "enable"
skip_check_for_browser: "enable"
skip_check_for_unsupported_browser: "enable"
skip_check_for_unsupported_os: "enable"
smb_max_version: "smbv1"
smb_min_version: "smbv1"
smb_ntlmv1_auth: "enable"
smbv1: "enable"
split_dns:
-
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
domains: "<your_own_value>"
id: "102"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
split_tunneling: "enable"
split_tunneling_routing_address:
-
name: "default_name_107 (source firewall.address.name firewall.addrgrp.name)"
split_tunneling_routing_negate: "enable"
theme: "blue"
transform_backward_slashes: "enable"
tunnel_mode: "enable"
use_sdwan: "enable"
user_bookmark: "enable"
user_group_bookmark: "enable"
web_mode: "enable"
windows_forticlient_download_url: "<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)
| programming_docs |
ansible fortinet.fortios.fortios_webfilter_ips_urlfilter_setting6 – Configure IPS URL filter settings for IPv6 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_ips\_urlfilter\_setting6 – Configure IPS URL filter settings 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_webfilter_ips_urlfilter_setting6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ips\_urlfilter\_setting6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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. |
| **webfilter\_ips\_urlfilter\_setting6** dictionary | | Configure IPS URL filter settings for IPv6. |
| | **device** string | | Interface for this route. Source system.interface.name. |
| | **distance** integer | | Administrative distance (1 - 255) for this route. |
| | **gateway6** string | | Gateway IPv6 address for this route. |
| | **geo\_filter** string | | Filter based on geographical location. Route will NOT be installed if the resolved IPv6 address belongs to the country in the filter. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 settings for IPv6.
fortios_webfilter_ips_urlfilter_setting6:
vdom: "{{ vdom }}"
webfilter_ips_urlfilter_setting6:
device: "<your_own_value> (source system.interface.name)"
distance: "4"
gateway6: "<your_own_value>"
geo_filter: "<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_global_setting – Global settings for memory logging in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_memory\_global\_setting – Global settings for memory 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_memory_global_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 global\_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\_global\_setting** dictionary | | Global settings for memory logging. |
| | **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). |
| | **max\_size** integer | | Maximum amount of memory that can be used for memory logging in bytes. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 memory logging.
fortios_log_memory_global_setting:
vdom: "{{ vdom }}"
log_memory_global_setting:
full_final_warning_threshold: "3"
full_first_warning_threshold: "4"
full_second_warning_threshold: "5"
max_size: "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_settings – Configure WAN optimization settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_settings – Configure WAN optimization 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_wanopt_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 wanopt 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. |
| **wanopt\_settings** dictionary | | Configure WAN optimization settings. |
| | **auto\_detect\_algorithm** string | **Choices:*** simple
* diff-req-resp
| Auto detection algorithms used in tunnel negotiations. |
| | **host\_id** string | | Local host ID (must also be entered in the remote FortiGate"s peer list). |
| | **tunnel\_ssl\_algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted during tunnel negotiation. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 settings.
fortios_wanopt_settings:
vdom: "{{ vdom }}"
wanopt_settings:
auto_detect_algorithm: "simple"
host_id: "myhostname"
tunnel_ssl_algorithm: "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)
ansible fortinet.fortios.fortios_system_autoupdate_schedule – Configure update schedule in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_autoupdate\_schedule – Configure update schedule in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_autoupdate_schedule`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_autoupdate feature and schedule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_autoupdate\_schedule** dictionary | | Configure update schedule. |
| | **day** string | **Choices:*** Sunday
* Monday
* Tuesday
* Wednesday
* Thursday
* Friday
* Saturday
| Update day. |
| | **frequency** string | **Choices:*** every
* daily
* weekly
* automatic
| Update frequency. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable scheduled updates. |
| | **time** string | | Update time. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 update schedule.
fortios_system_autoupdate_schedule:
vdom: "{{ vdom }}"
system_autoupdate_schedule:
day: "Sunday"
frequency: "every"
status: "enable"
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_key_chain – Configure key-chain in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_key\_chain – Configure key-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_router_key_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 router feature and key\_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. |
| **router\_key\_chain** dictionary | | Configure key-chain. |
| | **key** list / elements=string | | Configuration method to edit key settings. |
| | | **accept\_lifetime** string | | Lifetime of received authentication key (format: hh:mm:ss day month year). |
| | | **id** string / required | | Key ID (0 - 2147483647). |
| | | **key\_string** string | | Password for the key (max. = 35 characters). |
| | | **send\_lifetime** string | | Lifetime of sent authentication key (format: hh:mm:ss day month year). |
| | **name** string / required | | Key-chain 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 key-chain.
fortios_router_key_chain:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_key_chain:
key:
-
accept_lifetime: "<your_own_value>"
id: "5"
key_string: "<your_own_value>"
send_lifetime: "<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)
| programming_docs |
ansible fortinet.fortios.fortios_ips_view_map – configure ips view-ma in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_view\_map – configure ips view-ma in Fortinet’s FortiOS and FortiGate.
=====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_view_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 ips feature and view\_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. |
| **ips\_view\_map** dictionary | | configure ips view-map |
| | **id** integer / required | | View ID. |
| | **id\_policy\_id** integer | | ID-based policy ID. |
| | **policy\_id** integer | | Policy ID. |
| | **vdom\_id** integer | | VDOM ID. |
| | **which** string | **Choices:*** firewall
* firewall6
* interface
* interface6
* sniffer
* sniffer6
* explicit
| 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 ips view-map
fortios_ips_view_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_view_map:
id: "3"
id_policy_id: "4"
policy_id: "5"
vdom_id: "6"
which: "firewall"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_affinity_packet_redistribution – Configure packet redistribution in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_affinity\_packet\_redistribution – Configure packet redistribution in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_affinity_packet_redistribution`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 affinity\_packet\_redistribution category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_affinity\_packet\_redistribution** dictionary | | Configure packet redistribution. |
| | **affinity\_cpumask** string | | Affinity setting for VM throughput (64-bit hexadecimal value in the format of 0xxxxxxxxxxxxxxxxx). |
| | **id** integer / required | | ID of the packet redistribution setting. |
| | **interface** string | | Physical interface name on which to perform packet redistribution. Source system.interface.name. |
| | **rxqid** integer | | ID of the receive queue (when the interface has multiple queues) on which to perform packet redistribution. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 packet redistribution.
fortios_system_affinity_packet_redistribution:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_affinity_packet_redistribution:
affinity_cpumask: "<your_own_value>"
id: "4"
interface: "<your_own_value> (source system.interface.name)"
rxqid: "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_system_nat64 – Configure NAT64 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_nat64 – Configure NAT64 in Fortinet’s FortiOS and FortiGate.
==============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_nat64`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 nat64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_nat64** dictionary | | Configure NAT64. |
| | **always\_synthesize\_aaaa\_record** string | **Choices:*** enable
* disable
| Enable/disable AAAA record synthesis . |
| | **generate\_ipv6\_fragment\_header** string | **Choices:*** enable
* disable
| Enable/disable IPv6 fragment header generation. |
| | **nat46\_force\_ipv4\_packet\_forwarding** string | **Choices:*** enable
* disable
| Enable/disable mandatory IPv4 packet forwarding in nat46. |
| | **nat64\_prefix** string | | NAT64 prefix must be ::/96 . |
| | **secondary\_prefix** list / elements=string | | Secondary NAT64 prefix. |
| | | **name** string / required | | NAT64 prefix name. |
| | | **nat64\_prefix** string | | NAT64 prefix. |
| | **secondary\_prefix\_status** string | **Choices:*** enable
* disable
| Enable/disable secondary NAT64 prefix. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable NAT64 . |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 NAT64.
fortios_system_nat64:
vdom: "{{ vdom }}"
system_nat64:
always_synthesize_aaaa_record: "enable"
generate_ipv6_fragment_header: "enable"
nat46_force_ipv4_packet_forwarding: "enable"
nat64_prefix: "<your_own_value>"
secondary_prefix:
-
name: "default_name_8"
nat64_prefix: "<your_own_value>"
secondary_prefix_status: "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_system_fortimanager – Configure FortiManager in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fortimanager – Configure FortiManager in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fortimanager`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fortimanager category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fortimanager** dictionary | | Configure FortiManager. |
| | **central\_management** string | **Choices:*** enable
* disable
| Enable/disable FortiManager central management. |
| | **central\_mgmt\_auto\_backup** string | **Choices:*** enable
* disable
| Enable/disable central management auto backup. |
| | **central\_mgmt\_schedule\_config\_restore** string | **Choices:*** enable
* disable
| Enable/disable central management schedule config restore. |
| | **central\_mgmt\_schedule\_script\_restore** string | **Choices:*** enable
* disable
| Enable/disable central management schedule script restore. |
| | **ip** string | | IP address. |
| | **ipsec** string | **Choices:*** enable
* disable
| Enable/disable FortiManager IPsec tunnel. |
| | **vdom** string | | 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 FortiManager.
fortios_system_fortimanager:
vdom: "{{ vdom }}"
system_fortimanager:
central_management: "enable"
central_mgmt_auto_backup: "enable"
central_mgmt_schedule_config_restore: "enable"
central_mgmt_schedule_script_restore: "enable"
ip: "<your_own_value>"
ipsec: "enable"
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_switch_controller_qos_queue_policy – Configure FortiSwitch QoS egress queue policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_qos\_queue\_policy – Configure FortiSwitch QoS egress queue 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_qos_queue_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\_qos feature and queue\_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\_qos\_queue\_policy** dictionary | | Configure FortiSwitch QoS egress queue policy. |
| | **cos\_queue** list / elements=string | | COS queue configuration. |
| | | **description** string | | Description of the COS queue. |
| | | **drop\_policy** string | **Choices:*** taildrop
* weighted-random-early-detection
| COS queue drop policy. |
| | | **ecn** string | **Choices:*** disable
* enable
| Enable/disable ECN packet marking to drop eligible packets. |
| | | **max\_rate** integer | | Maximum rate (0 - 4294967295 kbps, 0 to disable). |
| | | **max\_rate\_percent** integer | | Maximum rate (% of link speed). |
| | | **min\_rate** integer | | Minimum rate (0 - 4294967295 kbps, 0 to disable). |
| | | **min\_rate\_percent** integer | | Minimum rate (% of link speed). |
| | | **name** string / required | | Cos queue ID. |
| | | **weight** integer | | Weight of weighted round robin scheduling. |
| | **name** string / required | | QoS policy name |
| | **rate\_by** string | **Choices:*** kbps
* percent
| COS queue rate by kbps or percent. |
| | **schedule** string | **Choices:*** strict
* round-robin
* weighted
| COS queue scheduling. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 egress queue policy.
fortios_switch_controller_qos_queue_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_qos_queue_policy:
cos_queue:
-
description: "<your_own_value>"
drop_policy: "taildrop"
ecn: "disable"
max_rate: "7"
max_rate_percent: "8"
min_rate: "9"
min_rate_percent: "10"
name: "default_name_11"
weight: "12"
name: "default_name_13"
rate_by: "kbps"
schedule: "strict"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_ips_sensor – Configure IPS sensor in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_sensor – Configure IPS sensor in Fortinet’s FortiOS and FortiGate.
=================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 ips 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ips\_sensor** dictionary | | Configure IPS sensor. |
| | **block\_malicious\_url** string | **Choices:*** disable
* enable
| Enable/disable malicious URL blocking. |
| | **comment** string | | Comment. |
| | **entries** list / elements=string | | IPS sensor filter. |
| | | **action** string | **Choices:*** pass
* block
* reset
* default
| Action taken with traffic in which signatures are detected. |
| | | **application** string | | Applications to be protected. set application ? lists available applications. all includes all applications. other includes all unlisted applications. |
| | | **cve** list / elements=string | | List of CVE IDs of the signatures to add to the sensor |
| | | | **cve\_entry** string | | CVE IDs or CVE wildcards. |
| | | **exempt\_ip** list / elements=string | | Traffic from selected source or destination IP addresses is exempt from this signature. |
| | | | **dst\_ip** string | | Destination IP address and netmask. |
| | | | **id** integer / required | | Exempt IP ID. |
| | | | **src\_ip** string | | Source IP address and netmask. |
| | | **id** integer / required | | Rule ID in IPS database (0 - 4294967295). |
| | | **location** string | | Protect client or server traffic. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging of signatures included in filter. |
| | | **log\_attack\_context** string | **Choices:*** disable
* enable
| Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer. |
| | | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. Enable to save the packet that triggers the filter. You can download the packets in pcap format for diagnostic use. |
| | | **os** string | | Operating systems to be protected. all includes all operating systems. other includes all unlisted operating systems. |
| | | **protocol** string | | Protocols to be examined. set protocol ? lists available protocols. all includes all protocols. other includes all unlisted protocols. |
| | | **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. |
| | | **rule** list / elements=string | | Identifies the predefined or custom IPS signatures to add to the sensor. |
| | | | **id** integer / required | | Rule IPS. |
| | | **severity** string | | Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity. |
| | | **status** string | **Choices:*** disable
* enable
* default
| Status of the signatures included in filter. default enables the filter and only use filters with default status of enable. Filters with default status of disable will not be used. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging. |
| | **filter** list / elements=string | | IPS sensor filter. |
| | | **action** string | **Choices:*** pass
* block
* reset
* default
| Action of selected rules. |
| | | **application** string | | Vulnerable application filter. |
| | | **location** string | | Vulnerability location filter. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging of selected rules. |
| | | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging of selected rules. |
| | | **name** string / required | | Filter name. |
| | | **os** string | | Vulnerable OS filter. |
| | | **protocol** string | | Vulnerable protocol filter. |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine IP or interface. |
| | | **quarantine\_expiry** integer | | Duration of quarantine in minute. |
| | | **quarantine\_log** string | **Choices:*** disable
* enable
| Enable/disable logging of selected quarantine. |
| | | **severity** string | | Vulnerability severity filter. |
| | | **status** string | **Choices:*** disable
* enable
* default
| Selected rules status. |
| | **name** string / required | | Sensor name. |
| | **override** list / elements=string | | IPS override rule. |
| | | **action** string | **Choices:*** pass
* block
* reset
| Action of override rule. |
| | | **exempt\_ip** list / elements=string | | Exempted IP. |
| | | | **dst\_ip** string | | Destination IP address and netmask. |
| | | | **id** integer / required | | Exempt IP ID. |
| | | | **src\_ip** string | | Source IP address and netmask. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine IP or interface. |
| | | **quarantine\_expiry** integer | | Duration of quarantine in minute. |
| | | **quarantine\_log** string | **Choices:*** disable
* enable
| Enable/disable logging of selected quarantine. |
| | | **rule\_id** integer | | Override rule ID. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable status of override rule. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* block
* monitor
| Block or monitor connections to Botnet servers, or disable Botnet scanning. |
| **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 sensor.
fortios_ips_sensor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_sensor:
block_malicious_url: "disable"
comment: "Comment."
entries:
-
action: "pass"
application: "<your_own_value>"
cve:
-
cve_entry: "<your_own_value>"
exempt_ip:
-
dst_ip: "<your_own_value>"
id: "12"
src_ip: "<your_own_value>"
id: "14"
location: "<your_own_value>"
log: "disable"
log_attack_context: "disable"
log_packet: "disable"
os: "<your_own_value>"
protocol: "<your_own_value>"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
rate_count: "24"
rate_duration: "25"
rate_mode: "periodical"
rate_track: "none"
rule:
-
id: "29"
severity: "<your_own_value>"
status: "disable"
extended_log: "enable"
filter:
-
action: "pass"
application: "<your_own_value>"
location: "<your_own_value>"
log: "disable"
log_packet: "disable"
name: "default_name_39"
os: "<your_own_value>"
protocol: "<your_own_value>"
quarantine: "none"
quarantine_expiry: "43"
quarantine_log: "disable"
severity: "<your_own_value>"
status: "disable"
name: "default_name_47"
override:
-
action: "pass"
exempt_ip:
-
dst_ip: "<your_own_value>"
id: "52"
src_ip: "<your_own_value>"
log: "disable"
log_packet: "disable"
quarantine: "none"
quarantine_expiry: "57"
quarantine_log: "disable"
rule_id: "59"
status: "disable"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_botnet_connections: "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_emailfilter_bwl – Configure anti-spam black/white list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_bwl – Configure anti-spam black/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_emailfilter_bwl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bwl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_bwl** dictionary | | Configure anti-spam black/white list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Anti-spam black/white list entries. |
| | | **action** string | **Choices:*** reject
* spam
* clear
| Reject, mark as spam or good email. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
| IP address type. |
| | | **email\_pattern** string | | Email address pattern. |
| | | **id** integer / required | | Entry ID. |
| | | **ip4\_subnet** string | | IPv4 network address/subnet mask bits. |
| | | **ip6\_subnet** string | | IPv6 network address/subnet mask bits. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | | **type** string | **Choices:*** ip
* email
| Entry type. |
| | **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 anti-spam black/white list.
fortios_emailfilter_bwl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_bwl:
comment: "Optional comments."
entries:
-
action: "reject"
addr_type: "ipv4"
email_pattern: "<your_own_value>"
id: "8"
ip4_subnet: "<your_own_value>"
ip6_subnet: "<your_own_value>"
pattern_type: "wildcard"
status: "enable"
type: "ip"
id: "14"
name: "default_name_15"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_npu_hpe – Configure npu-hpe status monitoring in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_monitoring\_npu\_hpe – Configure npu-hpe 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_npu_hpe`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 npu\_hpe category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_npu\_hpe** dictionary | | Configure npu-hpe status monitoring. |
| | **interval** integer | | HPE status check interval (1 - 60 seconds). |
| | **multipliers** string | | HPE type interval multipliers (12 integers from <1> to <255>) number of continuous event logs. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable HPE status monitoring. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 npu-hpe status monitoring.
fortios_monitoring_npu_hpe:
vdom: "{{ vdom }}"
monitoring_npu_hpe:
interval: "3"
multipliers: "<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)
| programming_docs |
ansible fortinet.fortios.fortios_wanopt_content_delivery_network_rule – Configure WAN optimization content delivery network rules in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_content\_delivery\_network\_rule – Configure WAN optimization content delivery network 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_wanopt_content_delivery_network_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 wanopt feature and content\_delivery\_network\_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. |
| **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\_content\_delivery\_network\_rule** dictionary | | Configure WAN optimization content delivery network rules. |
| | **category** string | **Choices:*** vcache
* youtube
| Content delivery network rule category. |
| | **comment** string | | Comment about this CDN-rule. |
| | **host\_domain\_name\_suffix** list / elements=string | | Suffix portion of the fully qualified domain name (eg. fortinet.com in "www.fortinet.com"). |
| | | **name** string / required | | Suffix portion of the fully qualified domain name. |
| | **name** string / required | | Name of table. |
| | **request\_cache\_control** string | **Choices:*** enable
* disable
| Enable/disable HTTP request cache control. |
| | **response\_cache\_control** string | **Choices:*** enable
* disable
| Enable/disable HTTP response cache control. |
| | **response\_expires** string | **Choices:*** enable
* disable
| Enable/disable HTTP response cache expires. |
| | **rules** list / elements=string | | WAN optimization content delivery network rule entries. |
| | | **content\_id** dictionary | | Content ID settings. |
| | | | **end\_direction** string | **Choices:*** forward
* backward
| Search direction from end-str match. |
| | | | **end\_skip** integer | | Number of characters in URL to skip after end-str has been matched. |
| | | | **end\_str** string | | String from which to end search. |
| | | | **range\_str** string | | Name of content ID within the start string and end string. |
| | | | **start\_direction** string | **Choices:*** forward
* backward
| Search direction from start-str match. |
| | | | **start\_skip** integer | | Number of characters in URL to skip after start-str has been matched. |
| | | | **start\_str** string | | String from which to start search. |
| | | | **target** string | **Choices:*** path
* parameter
* referrer
* youtube-map
* youtube-id
* youku-id
* hls-manifest
* dash-manifest
* hls-fragment
* dash-fragment
| Option in HTTP header or URL parameter to match. |
| | | **match\_entries** list / elements=string | | List of entries to match. |
| | | | **id** integer / required | | Rule ID. |
| | | | **pattern** list / elements=string | | Pattern string for matching target (Referrer or URL pattern, eg. "a", "a\*c", "\*a\*", "a\*c\*e", and "\*"). |
| | | | | **string** string / required | | Pattern strings. |
| | | | **target** string | **Choices:*** path
* parameter
* referrer
* youtube-map
* youtube-id
* youku-id
| Option in HTTP header or URL parameter to match. |
| | | **match\_mode** string | **Choices:*** all
* any
| Match criteria for collecting content ID. |
| | | **name** string / required | | WAN optimization content delivery network rule name. |
| | | **skip\_entries** list / elements=string | | List of entries to skip. |
| | | | **id** integer / required | | Rule ID. |
| | | | **pattern** list / elements=string | | Pattern string for matching target (Referrer or URL pattern, eg. "a", "a\*c", "\*a\*", "a\*c\*e", and "\*"). |
| | | | | **string** string / required | | Pattern strings. |
| | | | **target** string | **Choices:*** path
* parameter
* referrer
* youtube-map
* youtube-id
* youku-id
| Option in HTTP header or URL parameter to match. |
| | | **skip\_rule\_mode** string | **Choices:*** all
* any
| Skip mode when evaluating skip-rules. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable WAN optimization content delivery network rules. |
| | **text\_response\_vcache** string | **Choices:*** enable
* disable
| Enable/disable caching of text responses. |
| | **updateserver** string | **Choices:*** enable
* disable
| Enable/disable update server. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 content delivery network rules.
fortios_wanopt_content_delivery_network_rule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wanopt_content_delivery_network_rule:
category: "vcache"
comment: "Comment about this CDN-rule."
host_domain_name_suffix:
-
name: "default_name_6"
name: "default_name_7"
request_cache_control: "enable"
response_cache_control: "enable"
response_expires: "enable"
rules:
-
content_id:
end_direction: "forward"
end_skip: "14"
end_str: "<your_own_value>"
range_str: "<your_own_value>"
start_direction: "forward"
start_skip: "18"
start_str: "<your_own_value>"
target: "path"
match_entries:
-
id: "22"
pattern:
-
string: "<your_own_value>"
target: "path"
match_mode: "all"
name: "default_name_27"
skip_entries:
-
id: "29"
pattern:
-
string: "<your_own_value>"
target: "path"
skip_rule_mode: "all"
status: "enable"
text_response_vcache: "enable"
updateserver: "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_debug_url – Configure debug URL addresses in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_debug\_url – Configure debug URL 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_debug_url`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 debug\_url category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_debug\_url** dictionary | | Configure debug URL addresses. |
| | **exact** string | **Choices:*** enable
* disable
| Enable/disable matching the exact path. |
| | **name** string / required | | Debug URL name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this URL exemption. |
| | **url\_pattern** string | | URL exemption pattern. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 debug URL addresses.
fortios_web_proxy_debug_url:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_debug_url:
exact: "enable"
name: "default_name_4"
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_system_automation_trigger – Trigger for automation stitches in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_automation\_trigger – Trigger for automation stitches in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_trigger`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_trigger category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_trigger** dictionary | | Trigger for automation stitches. |
| | **description** string | | Description. |
| | **event\_type** string | **Choices:*** ioc
* event-log
* reboot
* low-memory
* high-cpu
* license-near-expiry
* ha-failover
* config-change
* security-rating-summary
* virus-ips-db-updated
* faz-event
* incoming-webhook
* fabric-event
| Event type. |
| | **fabric\_event\_name** string | | Fabric connector event handler name. |
| | **fabric\_event\_severity** string | | Fabric connector event severity. |
| | **faz\_event\_name** string | | FortiAnalyzer event handler name. |
| | **faz\_event\_severity** string | | FortiAnalyzer event severity. |
| | **faz\_event\_tags** string | | FortiAnalyzer event tags. |
| | **fields** list / elements=string | | Customized trigger field settings. |
| | | **id** integer / required | | Entry ID. |
| | | **name** string | | Name. |
| | | **value** string | | Value. |
| | **ioc\_level** string | **Choices:*** medium
* high
| IOC threat level. |
| | **license\_type** string | **Choices:*** forticare-support
* fortiguard-webfilter
* fortiguard-antispam
* fortiguard-antivirus
* fortiguard-ips
* fortiguard-management
* forticloud
* any
| License type. |
| | **logid** integer | | Log ID to trigger event. |
| | **name** string / required | | Name. |
| | **report\_type** string | **Choices:*** PostureReport
* CoverageReport
* OptimizationReport
* posture
* coverage
* optimization
* any
| Security Rating report. |
| | **serial** string | | Fabric connector serial number. |
| | **trigger\_day** integer | | Day within a month to trigger. |
| | **trigger\_frequency** string | **Choices:*** hourly
* daily
* weekly
* monthly
| Scheduled trigger frequency . |
| | **trigger\_hour** integer | | Hour of the day on which to trigger (0 - 23). |
| | **trigger\_minute** integer | | Minute of the hour on which to trigger (0 - 59, 60 to randomize). |
| | **trigger\_type** string | **Choices:*** event-based
* scheduled
| Trigger type. |
| | **trigger\_weekday** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Day of week for trigger. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: Trigger for automation stitches.
fortios_system_automation_trigger:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_automation_trigger:
description: "<your_own_value>"
event_type: "ioc"
fabric_event_name: "<your_own_value>"
fabric_event_severity: "<your_own_value>"
faz_event_name: "<your_own_value>"
faz_event_severity: "<your_own_value>"
faz_event_tags: "<your_own_value>"
fields:
-
id: "11"
name: "default_name_12"
value: "<your_own_value>"
ioc_level: "medium"
license_type: "forticare-support"
logid: "16"
name: "default_name_17"
report_type: "PostureReport"
serial: "<your_own_value>"
trigger_day: "20"
trigger_frequency: "hourly"
trigger_hour: "22"
trigger_minute: "23"
trigger_type: "event-based"
trigger_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)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_qos_qos_policy – Configure FortiSwitch QoS policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_qos\_qos\_policy – Configure FortiSwitch QoS 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_qos_qos_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\_qos feature and qos\_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\_qos\_qos\_policy** dictionary | | Configure FortiSwitch QoS policy. |
| | **default\_cos** integer | | Default cos queue for untagged packets. |
| | **name** string / required | | QoS policy name. |
| | **queue\_policy** string | | QoS egress queue policy. Source switch-controller.qos.queue-policy.name. |
| | **trust\_dot1p\_map** string | | QoS trust 802.1p map. Source switch-controller.qos.dot1p-map.name. |
| | **trust\_ip\_dscp\_map** string | | QoS trust ip dscp map. Source switch-controller.qos.ip-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 policy.
fortios_switch_controller_qos_qos_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_qos_qos_policy:
default_cos: "3"
name: "default_name_4"
queue_policy: "<your_own_value> (source switch-controller.qos.queue-policy.name)"
trust_dot1p_map: "<your_own_value> (source switch-controller.qos.dot1p-map.name)"
trust_ip_dscp_map: "<your_own_value> (source switch-controller.qos.ip-dscp-map.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_acl – Configure IPv4 access control list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_acl – Configure IPv4 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_acl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 acl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_acl** dictionary | | Configure IPv4 access control list. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address name. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.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.address.name firewall.addrgrp.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 IPv4 access control list.
fortios_firewall_acl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_acl:
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_5 (source firewall.address.name firewall.addrgrp.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.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_vne_tunnel – Configure virtual network enabler tunnel in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vne\_tunnel – Configure virtual network enabler 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_vne_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 vne\_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\_vne\_tunnel** dictionary | | Configure virtual network enabler tunnel. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable tunnel ASIC offloading. |
| | **bmr\_hostname** string | | BMR hostname. |
| | **br** string | | Border relay IPv6 address. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **ipv4\_address** string | | Tunnel IPv4 address and netmask. |
| | **mode** string | **Choices:*** map-e
* fixed-ip
| VNE tunnel mode. |
| | **ssl\_certificate** string | | Name of local certificate for SSL connections. Source certificate.local.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable VNE tunnel. |
| | **update\_url** string | | URL of provisioning 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 virtual network enabler tunnel.
fortios_system_vne_tunnel:
vdom: "{{ vdom }}"
system_vne_tunnel:
auto_asic_offload: "enable"
bmr_hostname: "<your_own_value>"
br: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
ipv4_address: "<your_own_value>"
mode: "map-e"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
status: "enable"
update_url: "<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_mms_profile – Configure MMS profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_mms\_profile – Configure MMS 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_mms_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 mms\_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\_mms\_profile** dictionary | | Configure MMS profiles. |
| | **avnotificationtable** integer | | AntiVirus notification table ID. Source antivirus.notification.id. |
| | **bwordtable** integer | | MMS banned word table ID. Source webfilter.content.id. |
| | **carrier\_endpoint\_prefix** string | **Choices:*** enable
* disable
| Enable/disable prefixing of end point values. |
| | **carrier\_endpoint\_prefix\_range\_max** integer | | Maximum length of end point value that can be prefixed (1 - 48). |
| | **carrier\_endpoint\_prefix\_range\_min** integer | | Minimum end point length to be prefixed (1 - 48). |
| | **carrier\_endpoint\_prefix\_string** string | | String with which to prefix End point values. |
| | **carrierendpointbwltable** integer | | Carrier end point filter table ID. Source firewall.carrier-endpoint-bwl.id. |
| | **comment** string | | Comment. |
| | **dupe** list / elements=string | | Duplicate configuration. |
| | | **action1** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **action2** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **action3** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **block\_time1** integer | | Duration for which action takes effect (0 - 35791 min). |
| | | **block\_time2** integer | | Duration for which action takes effect (0 - 35791 min). |
| | | **block\_time3** integer | | Duration action takes effect (0 - 35791 min). |
| | | **limit1** integer | | Maximum number of messages allowed. |
| | | **limit2** integer | | Maximum number of messages allowed. |
| | | **limit3** integer | | Maximum number of messages allowed. |
| | | **protocol** string / required | | Protocol. |
| | | **status1** string | **Choices:*** enable
* disable
| Enable/disable status1 detection. |
| | | **status2** string | **Choices:*** enable
* disable
| Enable/disable status2 detection. |
| | | **status3** string | **Choices:*** enable
* disable
| Enable/disable status3 detection. |
| | | **window1** integer | | Window to count messages over (1 - 2880 min). |
| | | **window2** integer | | Window to count messages over (1 - 2880 min). |
| | | **window3** integer | | Window to count messages over (1 - 2880 min). |
| | **extended\_utm\_log** string | | Enable/disable detailed UTM log messages. |
| | **flood** list / elements=string | | Flood configuration. |
| | | **action1** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **action2** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **action3** list / elements=string | **Choices:*** block
* archive
* log
* archive-first
* alert-notif
| Action to take when threshold reached. |
| | | **block\_time1** integer | | Duration for which action takes effect (0 - 35791 min). |
| | | **block\_time2** integer | | Duration for which action takes effect (0 - 35791 min). |
| | | **block\_time3** integer | | Duration action takes effect (0 - 35791 min). |
| | | **limit1** integer | | Maximum number of messages allowed. |
| | | **limit2** integer | | Maximum number of messages allowed. |
| | | **limit3** integer | | Maximum number of messages allowed. |
| | | **protocol** string / required | | Protocol. |
| | | **status1** string | **Choices:*** enable
* disable
| Enable/disable status1 detection. |
| | | **status2** string | **Choices:*** enable
* disable
| Enable/disable status2 detection. |
| | | **status3** string | **Choices:*** enable
* disable
| Enable/disable status3 detection. |
| | | **window1** integer | | Window to count messages over (1 - 2880 min). |
| | | **window2** integer | | Window to count messages over (1 - 2880 min). |
| | | **window3** integer | | Window to count messages over (1 - 2880 min). |
| | **mm1** list / elements=string | **Choices:*** avmonitor
* oversize
* quarantine
* scan
* bannedword
* chunkedbypass
* clientcomfort
* servercomfort
* carrier-endpoint-bwl
* remove-blocked
* mms-checksum
| MM1 options. |
| | **mm1\_addr\_hdr** string | | HTTP header field (for MM1) containing user address. |
| | **mm1\_addr\_source** string | **Choices:*** http-header
* cookie
| Source for MM1 user address. |
| | **mm1\_convert\_hex** string | **Choices:*** enable
* disable
| Enable/disable converting user address from HEX string for MM1. |
| | **mm1\_outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **mm1\_retr\_dupe** string | **Choices:*** enable
* disable
| Enable/disable duplicate scanning of MM1 retr. |
| | **mm1\_retrieve\_scan** string | **Choices:*** enable
* disable
| Enable/disable scanning on MM1 retrieve configuration messages. |
| | **mm1comfortamount** integer | | MM1 comfort amount (0 - 4294967295). |
| | **mm1comfortinterval** integer | | MM1 comfort interval (0 - 4294967295). |
| | **mm1oversizelimit** integer | | Maximum file size to scan (1 - 819200 kB). |
| | **mm3** list / elements=string | **Choices:*** avmonitor
* oversize
* quarantine
* scan
* bannedword
* fragmail
* splice
* carrier-endpoint-bwl
* remove-blocked
* mms-checksum
| MM3 options. |
| | **mm3\_outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **mm3oversizelimit** integer | | Maximum file size to scan (1 - 819200 kB). |
| | **mm4** list / elements=string | **Choices:*** avmonitor
* oversize
* quarantine
* scan
* bannedword
* fragmail
* splice
* carrier-endpoint-bwl
* remove-blocked
* mms-checksum
| MM4 options. |
| | **mm4\_outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **mm4oversizelimit** integer | | Maximum file size to scan (1 - 819200 kB). |
| | **mm7** list / elements=string | **Choices:*** avmonitor
* oversize
* quarantine
* scan
* bannedword
* chunkedbypass
* clientcomfort
* servercomfort
* carrier-endpoint-bwl
* remove-blocked
* mms-checksum
| MM7 options. |
| | **mm7\_addr\_hdr** string | | HTTP header field (for MM7) containing user address. |
| | **mm7\_addr\_source** string | **Choices:*** http-header
* cookie
| Source for MM7 user address. |
| | **mm7\_convert\_hex** string | **Choices:*** enable
* disable
| Enable/disable conversion of user address from HEX string for MM7. |
| | **mm7\_outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **mm7comfortamount** integer | | MM7 comfort amount (0 - 4294967295). |
| | **mm7comfortinterval** integer | | MM7 comfort interval (0 - 4294967295). |
| | **mm7oversizelimit** integer | | Maximum file size to scan (1 - 819200 kB). |
| | **mms\_antispam\_mass\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS antispam mass. |
| | **mms\_av\_block\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS antivirus file blocking. |
| | **mms\_av\_oversize\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS antivirus oversize file blocking. |
| | **mms\_av\_virus\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS antivirus scanning. |
| | **mms\_carrier\_endpoint\_filter\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS end point filter blocking. |
| | **mms\_checksum\_log** string | **Choices:*** enable
* disable
| Enable/disable MMS content checksum logging. |
| | **mms\_checksum\_table** integer | | MMS content checksum table ID. Source antivirus.mms-checksum.id. |
| | **mms\_notification\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS notification messages. |
| | **mms\_web\_content\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for MMS web content blocking. |
| | **mmsbwordthreshold** integer | | MMS banned word threshold. |
| | **name** string / required | | Profile name. |
| | **notif\_msisdn** list / elements=string | | Notification for MSISDNs. |
| | | **msisdn** string / required | | Recipient MSISDN. |
| | | **threshold** string | **Choices:*** flood-thresh-1
* flood-thresh-2
* flood-thresh-3
* dupe-thresh-1
* dupe-thresh-2
* dupe-thresh-3
| Thresholds on which this MSISDN will receive an alert. |
| | **notification** list / elements=string | | Notification configuration. |
| | | **alert\_int** integer | | Alert notification send interval. |
| | | **alert\_int\_mode** string | **Choices:*** hours
* minutes
| Alert notification interval mode. |
| | | **alert\_src\_msisdn** string | | Specify from address for alert messages. |
| | | **alert\_status** string | **Choices:*** enable
* disable
| Alert notification status. |
| | | **bword\_int** integer | | Banned word notification send interval. |
| | | **bword\_int\_mode** string | **Choices:*** hours
* minutes
| Banned word notification interval mode. |
| | | **bword\_status** string | **Choices:*** enable
* disable
| Banned word notification status. |
| | | **carrier\_endpoint\_bwl\_int** integer | | Carrier end point black/white list notification send interval. |
| | | **carrier\_endpoint\_bwl\_int\_mode** string | **Choices:*** hours
* minutes
| Carrier end point black/white list notification interval mode. |
| | | **carrier\_endpoint\_bwl\_status** string | **Choices:*** enable
* disable
| Carrier end point black/white list notification status. |
| | | **days\_allowed** list / elements=string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Weekdays on which notification messages may be sent. |
| | | **detect\_server** string | **Choices:*** enable
* disable
| Enable/disable automatic server address determination. |
| | | **dupe\_int** integer | | Duplicate notification send interval. |
| | | **dupe\_int\_mode** string | **Choices:*** hours
* minutes
| Duplicate notification interval mode. |
| | | **dupe\_status** string | **Choices:*** enable
* disable
| Duplicate notification status. |
| | | **file\_block\_int** integer | | File block notification send interval. |
| | | **file\_block\_int\_mode** string | **Choices:*** hours
* minutes
| File block notification interval mode. |
| | | **file\_block\_status** string | **Choices:*** enable
* disable
| File block notification status. |
| | | **flood\_int** integer | | Flood notification send interval. |
| | | **flood\_int\_mode** string | **Choices:*** hours
* minutes
| Flood notification interval mode. |
| | | **flood\_status** string | **Choices:*** enable
* disable
| Flood notification status. |
| | | **from\_in\_header** string | **Choices:*** enable
* disable
| Enable/disable insertion of from address in HTTP header. |
| | | **mms\_checksum\_int** integer | | MMS checksum notification send interval. |
| | | **mms\_checksum\_int\_mode** string | **Choices:*** hours
* minutes
| MMS checksum notification interval mode. |
| | | **mms\_checksum\_status** string | **Choices:*** enable
* disable
| MMS checksum notification status. |
| | | **mmsc\_hostname** string | | Host name or IP address of the MMSC. |
| | | **mmsc\_password** string | | Password required for authentication with the MMSC. |
| | | **mmsc\_port** integer | | Port used on the MMSC for sending MMS messages (1 - 65535). |
| | | **mmsc\_url** string | | URL used on the MMSC for sending MMS messages. |
| | | **mmsc\_username** string | | User name required for authentication with the MMSC. |
| | | **msg\_protocol** string | **Choices:*** mm1
* mm3
* mm4
* mm7
| Protocol to use for sending notification messages. |
| | | **msg\_type** string | **Choices:*** submit-req
* deliver-req
| MM7 message type. |
| | | **protocol** string / required | | Protocol. |
| | | **rate\_limit** integer | | Rate limit for sending notification messages (0 - 250). |
| | | **tod\_window\_duration** string | | Time of day window duration. |
| | | **tod\_window\_end** string | | Obsolete. |
| | | **tod\_window\_start** string | | Time of day window start. |
| | | **user\_domain** string | | Domain name to which the user addresses belong. |
| | | **vas\_id** string | | VAS identifier. |
| | | **vasp\_id** string | | VASP identifier. |
| | | **virus\_int** integer | | Virus notification send interval. |
| | | **virus\_int\_mode** string | **Choices:*** hours
* minutes
| Virus notification interval mode. |
| | | **virus\_status** string | **Choices:*** enable
* disable
| Virus notification status. |
| | **outbreak\_prevention** dictionary | | Configure Virus Outbreak Prevention settings. |
| | | **external\_blocklist** string | **Choices:*** disable
* enable
| Enable/disable external malware blocklist. |
| | | **ftgd\_service** string | **Choices:*** disable
* enable
| Enable/disable FortiGuard Virus outbreak prevention service. |
| | **remove\_blocked\_const\_length** string | **Choices:*** enable
* disable
| Enable/disable MMS replacement of blocked file constant length. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-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: Configure MMS profiles.
fortios_firewall_mms_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_mms_profile:
avnotificationtable: "3 (source antivirus.notification.id)"
bwordtable: "4 (source webfilter.content.id)"
carrier_endpoint_prefix: "enable"
carrier_endpoint_prefix_range_max: "6"
carrier_endpoint_prefix_range_min: "7"
carrier_endpoint_prefix_string: "<your_own_value>"
carrierendpointbwltable: "9 (source firewall.carrier-endpoint-bwl.id)"
comment: "Comment."
dupe:
-
action1: "block"
action2: "block"
action3: "block"
block_time1: "15"
block_time2: "16"
block_time3: "17"
limit1: "18"
limit2: "19"
limit3: "20"
protocol: "<your_own_value>"
status1: "enable"
status2: "enable"
status3: "enable"
window1: "25"
window2: "26"
window3: "27"
extended_utm_log: "<your_own_value>"
flood:
-
action1: "block"
action2: "block"
action3: "block"
block_time1: "33"
block_time2: "34"
block_time3: "35"
limit1: "36"
limit2: "37"
limit3: "38"
protocol: "<your_own_value>"
status1: "enable"
status2: "enable"
status3: "enable"
window1: "43"
window2: "44"
window3: "45"
mm1: "avmonitor"
mm1_addr_hdr: "<your_own_value>"
mm1_addr_source: "http-header"
mm1_convert_hex: "enable"
mm1_outbreak_prevention: "disabled"
mm1_retr_dupe: "enable"
mm1_retrieve_scan: "enable"
mm1comfortamount: "53"
mm1comfortinterval: "54"
mm1oversizelimit: "55"
mm3: "avmonitor"
mm3_outbreak_prevention: "disabled"
mm3oversizelimit: "58"
mm4: "avmonitor"
mm4_outbreak_prevention: "disabled"
mm4oversizelimit: "61"
mm7: "avmonitor"
mm7_addr_hdr: "<your_own_value>"
mm7_addr_source: "http-header"
mm7_convert_hex: "enable"
mm7_outbreak_prevention: "disabled"
mm7comfortamount: "67"
mm7comfortinterval: "68"
mm7oversizelimit: "69"
mms_antispam_mass_log: "enable"
mms_av_block_log: "enable"
mms_av_oversize_log: "enable"
mms_av_virus_log: "enable"
mms_carrier_endpoint_filter_log: "enable"
mms_checksum_log: "enable"
mms_checksum_table: "76 (source antivirus.mms-checksum.id)"
mms_notification_log: "enable"
mms_web_content_log: "enable"
mmsbwordthreshold: "79"
name: "default_name_80"
notif_msisdn:
-
msisdn: "<your_own_value>"
threshold: "flood-thresh-1"
notification:
-
alert_int: "85"
alert_int_mode: "hours"
alert_src_msisdn: "<your_own_value>"
alert_status: "enable"
bword_int: "89"
bword_int_mode: "hours"
bword_status: "enable"
carrier_endpoint_bwl_int: "92"
carrier_endpoint_bwl_int_mode: "hours"
carrier_endpoint_bwl_status: "enable"
days_allowed: "sunday"
detect_server: "enable"
dupe_int: "97"
dupe_int_mode: "hours"
dupe_status: "enable"
file_block_int: "100"
file_block_int_mode: "hours"
file_block_status: "enable"
flood_int: "103"
flood_int_mode: "hours"
flood_status: "enable"
from_in_header: "enable"
mms_checksum_int: "107"
mms_checksum_int_mode: "hours"
mms_checksum_status: "enable"
mmsc_hostname: "myhostname"
mmsc_password: "<your_own_value>"
mmsc_port: "112"
mmsc_url: "<your_own_value>"
mmsc_username: "<your_own_value>"
msg_protocol: "mm1"
msg_type: "submit-req"
protocol: "<your_own_value>"
rate_limit: "118"
tod_window_duration: "<your_own_value>"
tod_window_end: "<your_own_value>"
tod_window_start: "<your_own_value>"
user_domain: "<your_own_value>"
vas_id: "<your_own_value>"
vasp_id: "<your_own_value>"
virus_int: "125"
virus_int_mode: "hours"
virus_status: "enable"
outbreak_prevention:
external_blocklist: "disable"
ftgd_service: "disable"
remove_blocked_const_length: "enable"
replacemsg_group: "<your_own_value> (source system.replacemsg-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_vpn_certificate_remote – Remote certificate as a PEM file in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_remote – Remote certificate 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_remote`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 remote category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_remote** dictionary | | Remote certificate as a PEM file. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either the global or VDOM IP address range for the remote certificate. |
| | **remote** string | | Remote certificate. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Remote certificate source type. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Remote certificate as a PEM file.
fortios_vpn_certificate_remote:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_remote:
name: "default_name_3"
range: "global"
remote: "<your_own_value>"
source: "factory"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_wan_metric – Configure WAN metrics in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_h2qp\_wan\_metric – Configure WAN metrics in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_wan_metric`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_wan\_metric category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_wan\_metric** dictionary | | Configure WAN metrics. |
| | **downlink\_load** integer | | Downlink load. |
| | **downlink\_speed** integer | | Downlink speed (in kilobits/s). |
| | **link\_at\_capacity** string | **Choices:*** enable
* disable
| Link at capacity. |
| | **link\_status** string | **Choices:*** up
* down
* in-test
| Link status. |
| | **load\_measurement\_duration** integer | | Load measurement duration (in tenths of a second). |
| | **name** string / required | | WAN metric name. |
| | **symmetric\_wan\_link** string | **Choices:*** symmetric
* asymmetric
| WAN link symmetry. |
| | **uplink\_load** integer | | Uplink load. |
| | **uplink\_speed** integer | | Uplink speed (in kilobits/s). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 metrics.
fortios_wireless_controller_hotspot20_h2qp_wan_metric:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_h2qp_wan_metric:
downlink_load: "3"
downlink_speed: "4"
link_at_capacity: "enable"
link_status: "up"
load_measurement_duration: "7"
name: "default_name_8"
symmetric_wan_link: "symmetric"
uplink_load: "10"
uplink_speed: "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_wireless_controller_status – Wireless controller status in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_status – Wireless controller 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_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 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\_status** dictionary | | Wireless controller status. |
| | **set\_1\_2** 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 status.
fortios_wireless_controller_status:
vdom: "{{ vdom }}"
wireless_controller_status:
set_1_2: "<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_multicast_policy – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_multicast\_policy – Configure multicast NAT 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_multicast_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 multicast\_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\_multicast\_policy** dictionary | | Configure multicast NAT policies. |
| | **action** string | **Choices:*** accept
* deny
| Accept or deny traffic matching the policy. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading policy traffic for hardware acceleration. |
| | **comments** string | | Comment. |
| | **dnat** string | | IPv4 DNAT address used for multicast destination addresses. |
| | **dstaddr** list / elements=string | | Destination address objects. |
| | | **name** string / required | | Destination address objects. Source firewall.multicast-address.name. |
| | **dstintf** string | | Destination interface name. Source system.interface.name system.zone.name. |
| | **end\_port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535). |
| | **id** integer / required | | Policy ID. |
| | **logtraffic** string | **Choices:*** enable
* disable
| Enable/disable logging traffic accepted by this policy. |
| | **name** string | | Policy name. |
| | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **snat** string | **Choices:*** enable
* disable
| Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). |
| | **snat\_ip** string | | IPv4 address to be used as the source address for NATed traffic. |
| | **srcaddr** list / elements=string | | Source address objects. |
| | | **name** string / required | | Source address objects. Source firewall.address.name firewall.addrgrp.name. |
| | **srcintf** string | | Source interface name. Source system.interface.name system.zone.name. |
| | **start\_port** integer | | Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| | **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 multicast NAT policies.
fortios_firewall_multicast_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_multicast_policy:
action: "accept"
auto_asic_offload: "enable"
comments: "<your_own_value>"
dnat: "<your_own_value>"
dstaddr:
-
name: "default_name_8 (source firewall.multicast-address.name)"
dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
end_port: "10"
id: "11"
logtraffic: "enable"
name: "default_name_13"
protocol: "14"
snat: "enable"
snat_ip: "<your_own_value>"
srcaddr:
-
name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
start_port: "20"
status: "enable"
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_log_syslogd3_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd3\_setting – Global 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_syslogd3_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\_syslogd3 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\_syslogd3\_setting** dictionary | | Global 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. |
| | **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: Global settings for remote syslog server.
fortios_log_syslogd3_setting:
vdom: "{{ vdom }}"
log_syslogd3_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"
port: "15"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "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_router_auth_path – Configure authentication based routing in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_auth\_path – Configure authentication based routing in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_auth_path`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 auth\_path category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_auth\_path** dictionary | | Configure authentication based routing. |
| | **device** string | | Outgoing interface. Source system.interface.name. |
| | **gateway** string | | Gateway IP address. |
| | **name** string / required | | Name of the entry. |
| **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 based routing.
fortios_router_auth_path:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_auth_path:
device: "<your_own_value> (source system.interface.name)"
gateway: "<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_system_lte_modem – Configure USB LTE/WIMAX devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_lte\_modem – Configure USB LTE/WIMAX 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_lte_modem`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 lte\_modem category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_lte\_modem** dictionary | | Configure USB LTE/WIMAX devices. |
| | **apn** string | | Login APN string for PDP-IP packet data calls. |
| | **authtype** string | **Choices:*** none
* pap
* chap
| Authentication type for PDP-IP packet data calls. |
| | **extra\_init** string | | Extra initialization string for USB LTE/WIMAX devices. |
| | **holddown\_timer** integer | | Hold down timer (10 - 60 sec). |
| | **interface** string | | The interface that the modem is acting as a redundant interface for. Source system.interface.name. |
| | **mode** string | **Choices:*** standalone
* redundant
| Modem operation mode. |
| | **modem\_port** integer | | Modem port index (0 - 20). |
| | **passwd** string | | Authentication password for PDP-IP packet data calls. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable USB LTE/WIMAX device. |
| | **username** string | | Authentication username for PDP-IP packet data calls. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 USB LTE/WIMAX devices.
fortios_system_lte_modem:
vdom: "{{ vdom }}"
system_lte_modem:
apn: "<your_own_value>"
authtype: "none"
extra_init: "<your_own_value>"
holddown_timer: "6"
interface: "<your_own_value> (source system.interface.name)"
mode: "standalone"
modem_port: "9"
passwd: "<your_own_value>"
status: "enable"
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_vpn_certificate_ca – CA certificate in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_ca – CA certificate in Fortinet’s FortiOS and FortiGate.
====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ca`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ca** dictionary | | CA certificate. |
| | **auto\_update\_days** integer | | Number of days to wait before requesting an updated CA certificate (0 - 4294967295, 0 = disabled). |
| | **auto\_update\_days\_warning** integer | | Number of days before an expiry-warning message is generated (0 - 4294967295, 0 = disabled). |
| | **ca** string | | CA certificate as a PEM file. |
| | **last\_updated** integer | | Time at which CA was last updated. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either global or VDOM IP address range for the CA certificate. |
| | **scep\_url** string | | URL of the SCEP server. |
| | **source** string | **Choices:*** factory
* user
* bundle
| CA certificate source type. |
| | **source\_ip** string | | Source IP address for communications to the SCEP server. |
| | **ssl\_inspection\_trusted** string | **Choices:*** enable
* disable
| Enable/disable this CA as a trusted CA for SSL inspection. |
| | **trusted** string | **Choices:*** enable
* disable
| Enable/disable as a trusted CA. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: CA certificate.
fortios_vpn_certificate_ca:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_ca:
auto_update_days: "3"
auto_update_days_warning: "4"
ca: "<your_own_value>"
last_updated: "6"
name: "default_name_7"
range: "global"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
ssl_inspection_trusted: "enable"
trusted: "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_replacemsg_ec – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_ec – 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_ec`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ec category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ec** 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_ec:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_ec:
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_log_syslogd4_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd4\_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_syslogd4_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\_syslogd4 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\_syslogd4\_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 4 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_syslogd4_filter:
vdom: "{{ vdom }}"
log_syslogd4_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_system_replacemsg_sslvpn – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_sslvpn – 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_sslvpn`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 sslvpn category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_sslvpn** 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_sslvpn:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_sslvpn:
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_switch_interface – Configure software switch interfaces by grouping physical and WiFi interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_switch\_interface – Configure software switch interfaces by grouping physical and WiFi 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_switch_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 switch\_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\_switch\_interface** dictionary | | Configure software switch interfaces by grouping physical and WiFi interfaces. |
| | **intra\_switch\_policy** string | **Choices:*** implicit
* explicit
| Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. |
| | **mac\_ttl** integer | | Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec). |
| | **member** list / elements=string | | Names of the interfaces that belong to the virtual switch. |
| | | **interface\_name** string | | Physical interface name. Source system.interface.name. |
| | **name** string / required | | Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links). |
| | **span** string | **Choices:*** disable
* enable
| Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. |
| | **span\_dest\_port** string | | SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port. Source system.interface.name. |
| | **span\_direction** string | **Choices:*** rx
* tx
* both
| The direction in which the SPAN port operates, either: rx, tx, or both. |
| | **span\_source\_port** list / elements=string | | Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. |
| | | **interface\_name** string | | Physical interface name. Source system.interface.name. |
| | **type** string | **Choices:*** switch
* hub
| Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. |
| | **vdom** string | | VDOM that the software switch belongs to. 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 software switch interfaces by grouping physical and WiFi interfaces.
fortios_system_switch_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_switch_interface:
intra_switch_policy: "implicit"
mac_ttl: "4"
member:
-
interface_name: "<your_own_value> (source system.interface.name)"
name: "default_name_7"
span: "disable"
span_dest_port: "<your_own_value> (source system.interface.name)"
span_direction: "rx"
span_source_port:
-
interface_name: "<your_own_value> (source system.interface.name)"
type: "switch"
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_local_in_policy6 – Configure user defined IPv6 local-in policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_local\_in\_policy6 – Configure user defined IPv6 local-in 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_local_in_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 local\_in\_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\_local\_in\_policy6** dictionary | | Configure user defined IPv6 local-in policies. |
| | **action** string | **Choices:*** accept
* deny
| Action performed on traffic matching the policy . |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address object from available options. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **intf** string | | Incoming interface name from available options. Source system.zone.name system.interface.name. |
| | **policyid** integer / required | | User defined local in policy 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 from available options. Separate names with a space. |
| | | **name** string / required | | Service 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. |
| | **srcaddr** list / elements=string | | Source address object from available options. |
| | | **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. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this local-in policy. |
| | **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 user defined IPv6 local-in policies.
fortios_firewall_local_in_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_local_in_policy6:
action: "accept"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_6 (source firewall.address6.name firewall.addrgrp6.name)"
dstaddr_negate: "enable"
intf: "<your_own_value> (source system.zone.name system.interface.name)"
policyid: "9"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_12 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
srcaddr:
-
name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
srcaddr_negate: "enable"
status: "enable"
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_report_layout – Report layout configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_layout – Report layout 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_layout`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 layout category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_layout** dictionary | | Report layout configuration. |
| | **body\_item** list / elements=string | | Configure report body item. |
| | | **chart** string | | Report item chart name. |
| | | **chart\_options** string | **Choices:*** include-no-data
* hide-title
* show-caption
| Report chart options. |
| | | **column** integer | | Report section column number. |
| | | **content** string | | Report item text content. |
| | | **description** string | | Description. |
| | | **drill\_down\_items** string | | Control how drill down charts are shown. |
| | | **drill\_down\_types** string | | Control whether keys from the parent being combined or not. |
| | | **hide** string | **Choices:*** enable
* disable
| Enable/disable hide item in report. |
| | | **id** integer / required | | Report item ID. |
| | | **img\_src** string | | Report item image file name. |
| | | **list** list / elements=string | | Configure report list item. |
| | | | **content** string | | List entry content. |
| | | | **id** integer / required | | List entry ID. |
| | | **list\_component** string | **Choices:*** bullet
* numbered
| Report item list component. |
| | | **misc\_component** string | **Choices:*** hline
* page-break
* column-break
* section-start
| Report item miscellaneous component. |
| | | **parameters** list / elements=string | | Parameters. |
| | | | **id** integer / required | | ID. |
| | | | **name** string | | Field name that match field of parameters defined in dataset. |
| | | | **value** string | | Value to replace corresponding field of parameters defined in dataset. |
| | | **style** string | | Report item style. |
| | | **table\_caption\_style** string | | Table chart caption style. |
| | | **table\_column\_widths** string | | Report item table column widths. |
| | | **table\_even\_row\_style** string | | Table chart even row style. |
| | | **table\_head\_style** string | | Table chart head style. |
| | | **table\_odd\_row\_style** string | | Table chart odd row style. |
| | | **text\_component** string | **Choices:*** text
* heading1
* heading2
* heading3
| Report item text component. |
| | | **title** string | | Report section title. |
| | | **top\_n** integer | | Value of top. |
| | | **type** string | **Choices:*** text
* image
* chart
* misc
| Report item type. |
| | **cutoff\_option** string | **Choices:*** run-time
* custom
| Cutoff-option is either run-time or custom. |
| | **cutoff\_time** string | | Custom cutoff time to generate report [hh:mm]. |
| | **day** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Schedule days of week to generate report. |
| | **description** string | | Description. |
| | **email\_recipients** string | | Email recipients for generated reports. |
| | **email\_send** string | **Choices:*** enable
* disable
| Enable/disable sending emails after reports are generated. |
| | **format** list / elements=string | **Choices:*** pdf
| Report format. |
| | **max\_pdf\_report** integer | | Maximum number of PDF reports to keep at one time (oldest report is overwritten). |
| | **name** string / required | | Report layout name. |
| | **options** list / elements=string | **Choices:*** include-table-of-content
* auto-numbering-heading
* view-chart-as-heading
* show-html-navbar-before-heading
* dummy-option
| Report layout options. |
| | **page** dictionary | | Configure report page. |
| | | **column\_break\_before** list / elements=string | **Choices:*** heading1
* heading2
* heading3
| Report page auto column break before heading. |
| | | **footer** dictionary | | Configure report page footer. |
| | | | **footer\_item** list / elements=string | | Configure report footer item. |
| | | | | **content** string | | Report item text content. |
| | | | | **description** string | | Description. |
| | | | | **id** integer / required | | Report item ID. |
| | | | | **img\_src** string | | Report item image file name. |
| | | | | **style** string | | Report item style. |
| | | | | **type** string | **Choices:*** text
* image
| Report item type. |
| | | | **style** string | | Report footer style. |
| | | **header** dictionary | | Configure report page header. |
| | | | **header\_item** list / elements=string | | Configure report header item. |
| | | | | **content** string | | Report item text content. |
| | | | | **description** string | | Description. |
| | | | | **id** integer / required | | Report item ID. |
| | | | | **img\_src** string | | Report item image file name. |
| | | | | **style** string | | Report item style. |
| | | | | **type** string | **Choices:*** text
* image
| Report item type. |
| | | | **style** string | | Report header style. |
| | | **options** list / elements=string | **Choices:*** header-on-first-page
* footer-on-first-page
| Report page options. |
| | | **page\_break\_before** list / elements=string | **Choices:*** heading1
* heading2
* heading3
| Report page auto page break before heading. |
| | | **paper** string | **Choices:*** a4
* letter
| Report page paper. |
| | **schedule\_type** string | **Choices:*** demand
* daily
* weekly
| Report schedule type. |
| | **style\_theme** string | | Report style theme. |
| | **subtitle** string | | Report subtitle. |
| | **time** string | | Schedule time to generate report [hh:mm]. |
| | **title** string | | Report title. |
| **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 layout configuration.
fortios_report_layout:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_layout:
body_item:
-
chart: "<your_own_value>"
chart_options: "include-no-data"
column: "6"
content: "<your_own_value>"
description: "<your_own_value>"
drill_down_items: "<your_own_value>"
drill_down_types: "<your_own_value>"
hide: "enable"
id: "12"
img_src: "<your_own_value>"
list:
-
content: "<your_own_value>"
id: "16"
list_component: "bullet"
misc_component: "hline"
parameters:
-
id: "20"
name: "default_name_21"
value: "<your_own_value>"
style: "<your_own_value>"
table_caption_style: "<your_own_value>"
table_column_widths: "<your_own_value>"
table_even_row_style: "<your_own_value>"
table_head_style: "<your_own_value>"
table_odd_row_style: "<your_own_value>"
text_component: "text"
title: "<your_own_value>"
top_n: "31"
type: "text"
cutoff_option: "run-time"
cutoff_time: "<your_own_value>"
day: "sunday"
description: "<your_own_value>"
email_recipients: "<your_own_value>"
email_send: "enable"
format: "pdf"
max_pdf_report: "40"
name: "default_name_41"
options: "include-table-of-content"
page:
column_break_before: "heading1"
footer:
footer_item:
-
content: "<your_own_value>"
description: "<your_own_value>"
id: "49"
img_src: "<your_own_value>"
style: "<your_own_value>"
type: "text"
style: "<your_own_value>"
header:
header_item:
-
content: "<your_own_value>"
description: "<your_own_value>"
id: "58"
img_src: "<your_own_value>"
style: "<your_own_value>"
type: "text"
style: "<your_own_value>"
options: "header-on-first-page"
page_break_before: "heading1"
paper: "a4"
schedule_type: "demand"
style_theme: "<your_own_value>"
subtitle: "<your_own_value>"
time: "<your_own_value>"
title: "<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_server – Configure SSL servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssl\_server – Configure SSL 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_firewall_ssl_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 firewall feature and ssl\_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. |
| **firewall\_ssl\_server** dictionary | | Configure SSL servers. |
| | **add\_header\_x\_forwarded\_proto** string | **Choices:*** enable
* disable
| Enable/disable adding an X-Forwarded-Proto header to forwarded requests. |
| | **ip** string | | IPv4 address of the SSL server. |
| | **mapped\_port** integer | | Mapped server service port (1 - 65535). |
| | **name** string / required | | Server name. |
| | **port** integer | | Server service port (1 - 65535). |
| | **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 vpn.certificate.local.name. |
| | **ssl\_client\_renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow or block client renegotiation by server. |
| | **ssl\_dh\_bits** string | **Choices:*** 768
* 1024
* 1536
* 2048
| Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation . |
| | **ssl\_max\_version** string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
| Highest SSL/TLS version to negotiate. |
| | **ssl\_min\_version** string | **Choices:*** tls-1.0
* tls-1.1
* tls-1.2
| Lowest SSL/TLS version to negotiate. |
| | **ssl\_mode** string | **Choices:*** half
* full
| SSL/TLS mode for encryption and decryption of traffic. |
| | **ssl\_send\_empty\_frags** string | **Choices:*** enable
* disable
| Enable/disable sending empty fragments to avoid attack on CBC IV. |
| | **url\_rewrite** string | **Choices:*** enable
* disable
| Enable/disable rewriting the URL. |
| **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 servers.
fortios_firewall_ssl_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ssl_server:
add_header_x_forwarded_proto: "enable"
ip: "<your_own_value>"
mapped_port: "5"
name: "default_name_6"
port: "7"
ssl_algorithm: "high"
ssl_cert: "<your_own_value> (source vpn.certificate.local.name)"
ssl_client_renegotiation: "allow"
ssl_dh_bits: "768"
ssl_max_version: "tls-1.0"
ssl_min_version: "tls-1.0"
ssl_mode: "half"
ssl_send_empty_frags: "enable"
url_rewrite: "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_nai_realm – Configure network access identifier (NAI) realm in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_nai\_realm – Configure network access identifier (NAI) 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_wireless_controller_hotspot20_anqp_nai_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 wireless\_controller\_hotspot20 feature and anqp\_nai\_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. |
| **wireless\_controller\_hotspot20\_anqp\_nai\_realm** dictionary | | Configure network access identifier (NAI) realm. |
| | **nai\_list** list / elements=string | | NAI list. |
| | | **eap\_method** list / elements=string | | EAP Methods. |
| | | | **auth\_param** string | | EAP auth param. |
| | | | | **id** string | **Choices:*** non-eap-inner-auth
* inner-auth-eap
* credential
* tunneled-credential
| ID of authentication parameter. |
| | | | | **index** integer / required | | Param index. |
| | | | | **val** string | **Choices:*** eap-identity
* eap-md5
* eap-tls
* eap-ttls
* eap-peap
* eap-sim
* eap-aka
* eap-aka-prime
* non-eap-pap
* non-eap-chap
* non-eap-mschap
* non-eap-mschapv2
* cred-sim
* cred-usim
* cred-nfc
* cred-hardware-token
* cred-softoken
* cred-certificate
* cred-user-pwd
* cred-none
* cred-vendor-specific
* tun-cred-sim
* tun-cred-usim
* tun-cred-nfc
* tun-cred-hardware-token
* tun-cred-softoken
* tun-cred-certificate
* tun-cred-user-pwd
* tun-cred-anonymous
* tun-cred-vendor-specific
| Value of authentication parameter. |
| | | | **index** integer / required | | EAP method index. |
| | | | **method** string | **Choices:*** eap-identity
* eap-md5
* eap-tls
* eap-ttls
* eap-peap
* eap-sim
* eap-aka
* eap-aka-prime
| EAP method type. |
| | | **encoding** string | **Choices:*** disable
* enable
| Enable/disable format in accordance with IETF RFC 4282. |
| | | **nai\_realm** string | | Configure NAI realms (delimited by a semi-colon character). |
| | | **name** string / required | | NAI realm name. |
| | **name** string / required | | NAI realm 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 network access identifier (NAI) realm.
fortios_wireless_controller_hotspot20_anqp_nai_realm:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_nai_realm:
nai_list:
-
eap_method:
-
auth_param:
-
id: "6"
index: "7"
val: "eap-identity"
index: "9"
method: "eap-identity"
encoding: "disable"
nai_realm: "<your_own_value>"
name: "default_name_13"
name: "default_name_14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_remote_log – Configure logging by FortiSwitch device to a remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_remote\_log – Configure logging by FortiSwitch device to a 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_switch_controller_remote_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 remote\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **switch\_controller\_remote\_log** dictionary | | Configure logging by FortiSwitch device to a remote syslog server. |
| | **csv** string | **Choices:*** enable
* disable
| Enable/disable comma-separated value (CSV) strings. |
| | **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
| Facility to log to remote syslog server. |
| | **name** string / required | | Remote log name. |
| | **port** integer | | Remote syslog server listening port. |
| | **server** string | | IPv4 address of the remote syslog server. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Severity of logs to be transferred to remote log server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable logging by FortiSwitch device to a remote syslog 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 logging by FortiSwitch device to a remote syslog server.
fortios_switch_controller_remote_log:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_remote_log:
csv: "enable"
facility: "kernel"
name: "default_name_5"
port: "6"
server: "192.168.100.40"
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_report_dataset – Report dataset configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_dataset – Report dataset 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_dataset`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dataset category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dataset** dictionary | | Report dataset configuration. |
| | **field** list / elements=string | | Fields. |
| | | **displayname** string | | Display name. |
| | | **id** integer / required | | Field ID (1 to number of columns in SQL result). |
| | | **name** string | | Name. |
| | | **type** string | **Choices:*** text
* integer
* double
| Field type. |
| | **name** string / required | | Name. |
| | **parameters** list / elements=string | | Parameters. |
| | | **data\_type** string | **Choices:*** text
* integer
* double
* long-integer
* date-time
| Data type. |
| | | **display\_name** string | | Display name. |
| | | **field** string | | SQL field name. |
| | | **id** integer / required | | Parameter ID (1 to number of columns in SQL result). |
| | **policy** integer | | Used by monitor policy. |
| | **query** string | | SQL query statement. |
| **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 dataset configuration.
fortios_report_dataset:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_dataset:
field:
-
displayname: "<your_own_value>"
id: "5"
name: "default_name_6"
type: "text"
name: "default_name_8"
parameters:
-
data_type: "text"
display_name: "<your_own_value>"
field: "<your_own_value>"
id: "13"
policy: "14"
query: "<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_monitor_fact – Retrieve Facts of FortiOS Monitor Objects. fortinet.fortios.fortios\_monitor\_fact – Retrieve Facts of FortiOS Monitor 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_monitor_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 monitor facts from network devices running the fortios operating system. 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:*** firewall\_acl6
* firewall\_ippool
* webfilter\_malicious-urls
* fortiguard\_redirect-portal
* firewall\_policy-lookup
* system\_acquired-dns
* wifi\_interfering\_ap
* system\_botnet-domains
* firewall\_address-dynamic
* vpn\_ocvpn\_status
* wifi\_vlan-probe
* system\_sandbox\_status
* system\_running-processes
* system\_storage
* router\_ipv4
* log\_historic-daily-remote-logs
* webfilter\_malicious-urls\_stat
* ips\_anomaly
* wanopt\_peer\_stats
* wifi\_network\_status
* log\_hourly-disk-usage
* wifi\_region-image
* system\_object\_usage
* wifi\_euclid
* system\_current-admins
* system\_sandbox\_test-connect
* system\_interface\_speed-test-status
* user\_info\_query
* wifi\_rogue\_ap
* system\_config-revision\_info
* utm\_antivirus\_stats
* system\_3g-modem
* endpoint-control\_installer\_download
* network\_arp
* firewall\_address-fqdns
* wifi\_firmware
* user\_fsso
* system\_interface
* endpoint-control\_installer
* utm\_app-lookup
* system\_firmware
* system\_interface\_dhcp-status
* wifi\_client
* system\_botnet-domains\_stat
* firewall\_address6-dynamic
* system\_external-resource\_entry-list
* webfilter\_fortiguard-categories
* log\_local-report-list
* firewall\_internet-service-match
* router\_policy6
* virtual-wan\_sla-log
* system\_security-rating
* switch-controller\_managed-switch\_dhcp-snooping
* system\_time
* system\_fortimanager\_backup-details
* firewall\_shaper
* system\_available-interfaces
* system\_fortimanager\_status
* system\_sensor-info
* system\_status
* nsx\_instance
* web-ui\_custom-language\_download
* wanopt\_history
* log\_forticloud
* system\_vdom-link
* utm\_blacklisted-certificates
* webcache\_stats
* system\_config-revision\_file
* user\_device
* system\_dhcp
* router\_lookup
* utm\_blacklisted-certificates\_statistics
* log\_device\_state
* vpn\_one-click\_status
* system\_sniffer
* system\_firmware\_upgrade-paths
* router\_ospf\_neighbors
* system\_sandbox\_stats
* wanopt\_webcache
* network\_lldp\_neighbors
* log\_local-report\_download
* system\_config-error-log\_download
* firewall\_load-balance
* vpn\_ocvpn\_meta
* system\_sandbox\_cloud-regions
* firewall\_address-fqdns6
* firewall\_acl
* system\_link-monitor
* system\_com-log\_download
* user\_device\_query
* fortiguard\_service-communication-stats
* fortiview\_sandbox-file-details
* system\_available-certificates
* registration\_forticloud\_domains
* switch-controller\_fsw-firmware
* system\_ha-table-checksums
* fortiview\_statistics
* router\_ipv6
* endpoint-control\_registration\_summary
* firewall\_gtp-runtime-statistics
* firewall\_uuid-list
* router\_statistics
* system\_config\_usb-filelist
* endpoint-control\_ems\_cert-status
* system\_config-script
* user\_banned
* system\_sdn-connector\_nsx-security-tags
* system\_object-tagging\_usage
* system\_com-log\_update
* system\_global-resources
* system\_ipconf
* switch-controller\_mclag-icl\_eligible-peer
* user\_fortitoken-cloud\_status
* firewall\_per-ip-shaper
* wifi\_network\_list
* ips\_exceed-scan-range
* log\_current-disk-usage
* license\_status
* firewall\_session
* firewall\_ippool\_mapping
* virtual-wan\_members
* switch-controller\_managed-switch\_faceplate-xml
* firewall\_security-policy
* endpoint-control\_record-list
* videofilter\_fortiguard-categories
* webfilter\_category-quota
* log\_forticloud-report-list
* log\_policy-archive\_download
* system\_ha-checksums
* system\_debug\_download
* system\_automation-action\_stats
* log\_fortianalyzer-queue
* network\_ddns\_servers
* system\_nat46-ippools
* system\_vdom-resource
* system\_modem
* firewall\_proxy-policy
* nsx\_service\_status
* azure\_application-list
* log\_forticloud-report\_download
* user\_info\_thumbnail
* system\_sdn-connector\_status
* vpn\_ipsec
* endpoint-control\_ems\_status-summary
* firewall\_multicast-policy
* switch-controller\_validate-switch-prefix
* system\_security-rating\_history
* endpoint-control\_summary
* system\_csf
* license\_forticare-resellers
* endpoint-control\_profile\_xml
* wifi\_ap\_status
* user\_device-category
* system\_ntp\_status
* firewall\_gtp-statistics
* utm\_application-categories
* router\_lookup-policy
* system\_ha-history
* license\_forticare-org-list
* system\_security-rating\_lang
* router\_bgp\_paths6
* vpn\_one-click\_members
* switch-controller\_managed-switch\_health
* system\_timezone
* firewall\_sdn-connector-filters
* webfilter\_trusted-urls
* system\_usb-log
* network\_lldp\_ports
* system\_fortiguard-blacklist
* firewall\_policy
* system\_ha-statistics
* switch-controller\_matched-devices
* network\_dns\_latency
* system\_fortimanager\_backup-summary
* system\_sniffer\_download
* user\_detected-device
* system\_botnet\_stat
* system\_vm-information
* system\_security-rating\_supported-reports
* user\_fortitoken
* system\_botnet
* vpn\_ssl\_stats
* switch-controller\_managed-switch\_transceivers
* webfilter\_override
* log\_stats
* system\_csf\_pending-authorizations
* system\_resolve-fqdn
* log\_fortianalyzer
* log\_ips-archive\_download
* system\_interface-connected-admins-info
* system\_config-revision
* router\_bgp\_neighbors
* user\_collected-email
* ips\_rate-based
* switch-controller\_detected-device
* webproxy\_pacfile\_download
* registration\_forticloud\_device-status
* firewall\_policy6
* endpoint-control\_ems\_status
* router\_policy
* system\_sandbox\_connection
* user\_firewall
* firewall\_multicast-policy6
* user\_device-type
* switch-controller\_managed-switch\_cable-status
* system\_automation-stitch\_stats
* system\_traffic-history\_interface
* network\_ddns\_lookup
* wifi\_managed\_ap
* system\_interface\_transceivers
* system\_config\_backup
* system\_traffic-history\_top-applications
* firewall\_uuid-type-lookup
* virtual-wan\_interface-log
* network\_reverse-ip-lookup
* firewall\_health
* router\_bgp\_neighbors6
* system\_security-rating\_status
* registration\_forticloud\_disclaimer
* system\_botnet-domains\_hits
* firewall\_internet-service-details
* log\_event
* system\_config-sync\_status
* network\_fortiguard\_live-services-latency
* fortiview\_sandbox-file-list
* system\_fortiguard\_server-info
* vpn\_ssl
* system\_check-port-availability
* log\_av-archive\_download
* license\_fortianalyzer-status
* virtual-wan\_health-check
* router\_bgp\_paths
* endpoint-control\_avatar\_download
* system\_resource\_usage
* system\_certificate\_download
* system\_ha-peer
* system\_interface\_poe
* ips\_metadata
* extender-controller\_extender
* firewall\_local-in
* wifi\_spectrum
* firewall\_consolidated-policy
* switch-controller\_managed-switch
* system\_trusted-cert-authorities
* vpn\_ocvpn\_members
| selector of the retrieved fortimanager facts |
| **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.
* Not all parameters are required for a slector.
* This module is exclusivly for FortiOS monitor API.
* The result of API request is stored in results.
Examples
--------
```
- hosts: fortigate03
connection: httpapi
collections:
- fortinet.fortios
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- fortios_monitor_fact:
vdom: ""
formatters:
- model_name
filters:
- model_name==FortiGat
selector: 'system_status'
- name: fact gathering
fortios_monitor_fact:
vdom: ""
access_token: ""
selector: 'firewall_acl'
- name: fact gathering
fortios_monitor_fact:
vdom: ""
access_token: ""
selector: 'firewall_security-policy'
params:
policyid: '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:** 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_system_vdom_dns – Configure DNS servers for a non-management VDOM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_dns – Configure DNS servers for a non-management 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_system_vdom_dns`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_vdom\_dns** dictionary | | Configure DNS servers for a non-management VDOM. |
| | **dns\_over\_tls** string | **Choices:*** disable
* enable
* enforce
| Enable/disable/enforce DNS over TLS. |
| | **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\_primary** string | | Primary IPv6 DNS server IP address for the VDOM. |
| | **ip6\_secondary** string | | Secondary IPv6 DNS server IP address for the VDOM. |
| | **primary** string | | Primary DNS server IP address for the VDOM. |
| | **protocol** list / elements=string | **Choices:*** cleartext
* dot
* doh
| DNS protocols. |
| | **secondary** string | | Secondary DNS server IP address for the VDOM. |
| | **server\_hostname** list / elements=string | | DNS server host name list. |
| | | **hostname** string / required | | DNS server host name list separated by space (maximum 4 domains). |
| | **source\_ip** string | | Source IP for communications with the DNS server. |
| | **ssl\_certificate** string | | Name of local certificate for SSL connections. Source certificate.local.name. |
| | **vdom\_dns** string | **Choices:*** enable
* disable
| Enable/disable configuring DNS servers for the current VDOM. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 DNS servers for a non-management VDOM.
fortios_system_vdom_dns:
vdom: "{{ vdom }}"
system_vdom_dns:
dns_over_tls: "disable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip6_primary: "<your_own_value>"
ip6_secondary: "<your_own_value>"
primary: "<your_own_value>"
protocol: "cleartext"
secondary: "<your_own_value>"
server_hostname:
-
hostname: "myhostname"
source_ip: "84.230.14.43"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
vdom_dns: "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_dedicated_mgmt – Configure dedicated management in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dedicated\_mgmt – Configure dedicated management in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dedicated_mgmt`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dedicated\_mgmt category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dedicated\_mgmt** dictionary | | Configure dedicated management. |
| | **default\_gateway** string | | Default gateway for dedicated management interface. |
| | **dhcp\_end\_ip** string | | DHCP end IP for dedicated management. |
| | **dhcp\_netmask** string | | DHCP netmask. |
| | **dhcp\_server** string | **Choices:*** enable
* disable
| Enable/disable DHCP server on management interface. |
| | **dhcp\_start\_ip** string | | DHCP start IP for dedicated management. |
| | **interface** string | | Dedicated management interface. Source system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable dedicated management. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 dedicated management.
fortios_system_dedicated_mgmt:
vdom: "{{ vdom }}"
system_dedicated_mgmt:
default_gateway: "<your_own_value>"
dhcp_end_ip: "<your_own_value>"
dhcp_netmask: "<your_own_value>"
dhcp_server: "enable"
dhcp_start_ip: "<your_own_value>"
interface: "<your_own_value> (source system.interface.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_web_proxy_global – Configure Web proxy global settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_global – Configure Web proxy 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_web_proxy_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 web\_proxy 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. |
| **web\_proxy\_global** dictionary | | Configure Web proxy global settings. |
| | **fast\_policy\_match** string | **Choices:*** enable
* disable
| Enable/disable fast matching algorithm for explicit and transparent proxy policy. |
| | **forward\_proxy\_auth** string | **Choices:*** enable
* disable
| Enable/disable forwarding proxy authentication headers. |
| | **forward\_server\_affinity\_timeout** integer | | Period of time before the source IP"s traffic is no longer assigned to the forwarding server (6 - 60 min). |
| | **learn\_client\_ip** string | **Choices:*** enable
* disable
| Enable/disable learning the client"s IP address from headers. |
| | **learn\_client\_ip\_from\_header** list / elements=string | **Choices:*** true-client-ip
* x-real-ip
* x-forwarded-for
| Learn client IP address from the specified headers. |
| | **learn\_client\_ip\_srcaddr** list / elements=string | | Source address name (srcaddr or srcaddr6 must be set). |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **learn\_client\_ip\_srcaddr6** list / elements=string | | IPv6 Source address name (srcaddr or srcaddr6 must be set). |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **max\_message\_length** integer | | Maximum length of HTTP message, not including body (16 - 256 Kbytes). |
| | **max\_request\_length** integer | | Maximum length of HTTP request line (2 - 64 Kbytes). |
| | **max\_waf\_body\_cache\_length** integer | | Maximum length of HTTP messages processed by Web Application Firewall (WAF) (10 - 1024 Kbytes). |
| | **proxy\_fqdn** string | | Fully Qualified Domain Name (FQDN) that clients connect to to connect to the explicit web proxy. |
| | **src\_affinity\_exempt\_addr** string | | IPv4 source addresses to exempt proxy affinity. |
| | **src\_affinity\_exempt\_addr6** string | | IPv6 source addresses to exempt proxy affinity. |
| | **ssl\_ca\_cert** string | | SSL CA certificate for SSL interception. Source vpn.certificate.local.name. |
| | **ssl\_cert** string | | SSL certificate for SSL interception. Source vpn.certificate.local.name. |
| | **strict\_web\_check** string | **Choices:*** enable
* disable
| Enable/disable strict web checking to block web sites that send incorrect headers that don"t conform to HTTP 1.1. |
| | **tunnel\_non\_http** string | **Choices:*** enable
* disable
| Enable/disable allowing non-HTTP traffic. Allowed non-HTTP traffic is tunneled. |
| | **unknown\_http\_version** string | **Choices:*** reject
* tunnel
* best-effort
| Action to take when an unknown version of HTTP is encountered: reject, allow (tunnel), or proceed with best-effort. |
| | **webproxy\_profile** string | | Name of the web proxy profile to apply when explicit proxy traffic is allowed by default and traffic is accepted that does not match an explicit proxy policy. Source web-proxy.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 Web proxy global settings.
fortios_web_proxy_global:
vdom: "{{ vdom }}"
web_proxy_global:
fast_policy_match: "enable"
forward_proxy_auth: "enable"
forward_server_affinity_timeout: "5"
learn_client_ip: "enable"
learn_client_ip_from_header: "true-client-ip"
learn_client_ip_srcaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
learn_client_ip_srcaddr6:
-
name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
max_message_length: "12"
max_request_length: "13"
max_waf_body_cache_length: "14"
proxy_fqdn: "<your_own_value>"
src_affinity_exempt_addr: "<your_own_value>"
src_affinity_exempt_addr6: "<your_own_value>"
ssl_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
ssl_cert: "<your_own_value> (source vpn.certificate.local.name)"
strict_web_check: "enable"
tunnel_non_http: "enable"
unknown_http_version: "reject"
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)
ansible fortinet.fortios.fortios_wanopt_cache_service – Designate cache-service for wan-optimization and webcache in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_cache\_service – Designate cache-service for wan-optimization and webcache in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_cache_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 wanopt feature and cache\_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. |
| **vdom** string | **Default:**"root" | Virtual 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\_cache\_service** dictionary | | Designate cache-service for wan-optimization and webcache. |
| | **acceptable\_connections** string | **Choices:*** any
* peers
| Set strategy when accepting cache collaboration connection. |
| | **collaboration** string | **Choices:*** enable
* disable
| Enable/disable cache-collaboration between cache-service clusters. |
| | **device\_id** string | | Set identifier for this cache device. |
| | **dst\_peer** list / elements=string | | Modify cache-service destination peer list. |
| | | **auth\_type** integer | | Set authentication type for this peer. |
| | | **device\_id** string | | Device ID of this peer. |
| | | **encode\_type** integer | | Set encode type for this peer. |
| | | **ip** string | | Set cluster IP address of this peer. |
| | | **priority** integer | | Set priority for this peer. |
| | **prefer\_scenario** string | **Choices:*** balance
* prefer-speed
* prefer-cache
| Set the preferred cache behavior towards the balance between latency and hit-ratio. |
| | **src\_peer** list / elements=string | | Modify cache-service source peer list. |
| | | **auth\_type** integer | | Set authentication type for this peer. |
| | | **device\_id** string | | Device ID of this peer. |
| | | **encode\_type** integer | | Set encode type for this peer. |
| | | **ip** string | | Set cluster IP address of this peer. |
| | | **priority** integer | | Set priority for this peer. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 cache-service for wan-optimization and webcache.
fortios_wanopt_cache_service:
vdom: "{{ vdom }}"
wanopt_cache_service:
acceptable_connections: "any"
collaboration: "enable"
device_id: "<your_own_value>"
dst_peer:
-
auth_type: "7"
device_id: "<your_own_value>"
encode_type: "9"
ip: "<your_own_value>"
priority: "11"
prefer_scenario: "balance"
src_peer:
-
auth_type: "14"
device_id: "<your_own_value>"
encode_type: "16"
ip: "<your_own_value>"
priority: "18"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_profile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wtp\_profile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 wtp\_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\_wtp\_profile** dictionary | | Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. |
| | **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. |
| | **ap\_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 in which this WTP, FortiAP or AP will operate . |
| | **ap\_handoff** string | **Choices:*** enable
* disable
| Enable/disable AP handoff of clients to other APs . |
| | **apcfg\_profile** string | | AP local configuration profile name. Source wireless-controller.apcfg-profile.name. |
| | **ble\_profile** string | | Bluetooth Low Energy profile name. Source wireless-controller.ble-profile.name. |
| | **comment** string | | Comment. |
| | **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
| Enable/disable CAPWAP control message data channel offload. |
| | **deny\_mac\_list** list / elements=string | | List of MAC addresses that are denied access to this WTP, FortiAP, or AP. |
| | | **id** integer / required | | ID. |
| | | **mac** string | | A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. |
| | **dtls\_in\_kernel** string | **Choices:*** enable
* disable
| Enable/disable data channel DTLS in kernel. |
| | **dtls\_policy** list / elements=string | **Choices:*** clear-text
* dtls-enabled
* ipsec-vpn
| WTP data channel DTLS policy . |
| | **energy\_efficient\_ethernet** string | **Choices:*** enable
* disable
| Enable/disable use of energy efficient Ethernet on WTP. |
| | **ext\_info\_enable** string | **Choices:*** enable
* disable
| Enable/disable station/VAP/radio extension information. |
| | **frequency\_handoff** string | **Choices:*** enable
* disable
| Enable/disable frequency handoff of clients to other channels . |
| | **handoff\_roaming** string | **Choices:*** enable
* disable
| Enable/disable client load balancing during roaming to avoid roaming delay . |
| | **handoff\_rssi** integer | | Minimum received signal strength indicator (RSSI) value for handoff (20 - 30). |
| | **handoff\_sta\_thresh** integer | | Threshold value for AP handoff. |
| | **ip\_fragment\_preventing** list / elements=string | **Choices:*** tcp-mss-adjust
* icmp-unreachable
| Select how to prevent IP fragmentation 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. |
| | **lbs** dictionary | | Set various location based service (LBS) options. |
| | | **aeroscout** string | **Choices:*** enable
* disable
| Enable/disable AeroScout Real Time Location Service (RTLS) support . |
| | | **aeroscout\_ap\_mac** string | **Choices:*** bssid
* board-mac
| Use BSSID or board MAC address as AP MAC address in AeroScout AP messages . |
| | | **aeroscout\_mmu\_report** string | **Choices:*** enable
* disable
| Enable/disable compounded AeroScout tag and MU report . |
| | | **aeroscout\_mu** string | **Choices:*** enable
* disable
| Enable/disable AeroScout Mobile Unit (MU) support . |
| | | **aeroscout\_mu\_factor** integer | | AeroScout MU mode dilution factor . |
| | | **aeroscout\_mu\_timeout** integer | | AeroScout MU mode timeout (0 - 65535 sec). |
| | | **aeroscout\_server\_ip** string | | IP address of AeroScout server. |
| | | **aeroscout\_server\_port** integer | | AeroScout server UDP listening port. |
| | | **ekahau\_blink\_mode** string | **Choices:*** enable
* disable
| Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags . |
| | | **ekahau\_tag** string | | WiFi frame MAC address or WiFi Tag. |
| | | **erc\_server\_ip** string | | IP address of Ekahau RTLS Controller (ERC). |
| | | **erc\_server\_port** integer | | Ekahau RTLS Controller (ERC) UDP listening port. |
| | | **fortipresence** string | **Choices:*** foreign
* both
* disable
| Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they don"t connect to this WiFi network . |
| | | **fortipresence\_ble** string | **Choices:*** enable
* disable
| Enable/disable FortiPresence finding and reporting BLE devices. |
| | | **fortipresence\_frequency** integer | | FortiPresence report transmit frequency (5 - 65535 sec). |
| | | **fortipresence\_port** integer | | FortiPresence server UDP listening port . |
| | | **fortipresence\_project** string | | FortiPresence project name (max. 16 characters). |
| | | **fortipresence\_rogue** string | **Choices:*** enable
* disable
| Enable/disable FortiPresence finding and reporting rogue APs. |
| | | **fortipresence\_secret** string | | FortiPresence secret password (max. 16 characters). |
| | | **fortipresence\_server** string | | FortiPresence server IP address. |
| | | **fortipresence\_unassoc** string | **Choices:*** enable
* disable
| Enable/disable FortiPresence finding and reporting unassociated stations. |
| | | **station\_locate** string | **Choices:*** enable
* disable
| Enable/disable client station locating services for all clients, whether associated or not . |
| | **led\_schedules** list / elements=string | | Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least one of the schedules is valid. Separate multiple schedule names with a space. |
| | | **name** string / required | | LED schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name. |
| | **led\_state** string | **Choices:*** enable
* disable
| Enable/disable use of LEDs on WTP . |
| | **lldp** string | **Choices:*** enable
* disable
| Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP . |
| | **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). |
| | **max\_clients** integer | | Maximum number of stations (STAs) supported by the WTP . |
| | **name** string / required | | WTP (or FortiAP or AP) profile name. |
| | **platform** dictionary | | WTP, FortiAP, or AP platform. |
| | | **ddscan** string | **Choices:*** enable
* disable
| Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat management. |
| | | **mode** string | **Choices:*** single-5G
* dual-5G
| Configure operation mode of 5G radios . |
| | | **type** string | **Choices:*** AP-11N
* 220B
* 210B
* 222B
* 112B
* 320B
* 11C
* 14C
* 223B
* 28C
* 320C
* 221C
* 25D
* 222C
* 224D
* 214B
* 21D
* 24D
* 112D
* 223C
* 321C
* C220C
* C225C
* C23JD
* C24JE
* S321C
* S322C
* S323C
* S311C
* S313C
* S321CR
* S322CR
* S323CR
* S421E
* S422E
* S423E
* 421E
* 423E
* 221E
* 222E
* 223E
* 224E
* S221E
* S223E
* U421E
* U422EV
* U423E
* U221EV
* U223EV
* U24JEV
* U321EV
* U323EV
* 231E
* 321E
* 431F
* 432F
* 433F
* 231F
* 234F
* 23JF
* U431F
* U433F
* 831F
* U231F
* U234F
* U432F
| WTP, FortiAP or AP platform type. There are built-in WTP profiles for all supported FortiAP models. You can select a built-in profile and customize it or create a new profile. |
| | **poe\_mode** string | **Choices:*** auto
* 8023af
* 8023at
* power-adapter
* full
* high
* low
| Set the WTP, FortiAP, or AP"s PoE mode. |
| | **radio\_1** dictionary | | Configuration options for radio 1. |
| | | **airtime\_fairness** string | **Choices:*** enable
* disable
| Enable/disable airtime fairness . |
| | | **amsdu** string | **Choices:*** enable
* disable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . |
| | | **ap\_handoff** string | **Choices:*** enable
* disable
| Enable/disable AP handoff of clients to other APs . |
| | | **ap\_sniffer\_addr** string | | MAC address to monitor. |
| | | **ap\_sniffer\_bufsize** integer | | Sniffer buffer size (1 - 32 MB). |
| | | **ap\_sniffer\_chan** integer | | Channel on which to operate the sniffer . |
| | | **ap\_sniffer\_ctl** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi control frame . |
| | | **ap\_sniffer\_data** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi data frame . |
| | | **ap\_sniffer\_mgmt\_beacon** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management Beacon frames . |
| | | **ap\_sniffer\_mgmt\_other** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management other frames . |
| | | **ap\_sniffer\_mgmt\_probe** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management probe frames . |
| | | **auto\_power\_high** integer | | Automatic transmit power high limit 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 | | 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.11ac
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 1 operates on. |
| | | **band\_5g\_type** string | **Choices:*** 5g-full
* 5g-high
* 5g-low
| WiFi 5G band type. |
| | | **bandwidth\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. |
| | | **bandwidth\_capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps). |
| | | **beacon\_interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). |
| | | **bss\_color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. ). |
| | | **call\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. |
| | | **call\_capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **channel\_bonding** string | **Choices:*** 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel\_utilization** string | **Choices:*** enable
* disable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** enable
* disable
| Enable/disable allowing both HT20 and HT40 on the same radio . |
| | | **darrp** string | **Choices:*** enable
* disable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) . |
| | | **drma\_sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant . |
| | | **dtim** integer | | DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life. |
| | | **frag\_threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). |
| | | **frequency\_handoff** string | **Choices:*** enable
* disable
| Enable/disable frequency handoff of clients to other channels . |
| | | **iperf\_protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol . |
| | | **iperf\_server\_port** integer | | Iperf service port number. |
| | | **max\_clients** integer | | Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. |
| | | **max\_distance** integer | | Maximum expected distance between the AP and clients (0 - 54000 m). |
| | | **mode** string | **Choices:*** disabled
* ap
* monitor
* sniffer
* sam
| Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. |
| | | **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). |
| | | **powersave\_optimize** string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| Enable client power-saving features such as TIM, AC VO, and OBSS etc. |
| | | **protection\_mode** string | **Choices:*** rtscts
* ctsonly
* disable
| Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). |
| | | **radio\_id** integer | | radio-id |
| | | **rts\_threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). |
| | | **sam\_bssid** string | | BSSID for WiFi network. |
| | | **sam\_captive\_portal** string | **Choices:*** enable
* disable
| Enable/disable Captive Portal Authentication . |
| | | **sam\_password** string | | Passphrase for WiFi network connection. |
| | | **sam\_report\_intv** integer | | SAM report interval (sec), 0 for a one-time report. |
| | | **sam\_security\_type** string | **Choices:*** open
* wpa-personal
* wpa-enterprise
| Select WiFi network security type . |
| | | **sam\_server** string | | SAM test server IP address or domain name. |
| | | **sam\_ssid** string | | SSID for WiFi network. |
| | | **sam\_test** string | **Choices:*** ping
* iperf
| Select SAM test type . |
| | | **sam\_username** string | | Username for WiFi network connection. |
| | | **short\_guard\_interval** string | **Choices:*** enable
* disable
| Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **transmit\_optimize** string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. |
| | | **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. |
| | | **wids\_profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. |
| | | **zero\_wait\_dfs** string | **Choices:*** enable
* disable
| Enable/disable zero wait DFS on radio . |
| | **radio\_2** dictionary | | Configuration options for radio 2. |
| | | **airtime\_fairness** string | **Choices:*** enable
* disable
| Enable/disable airtime fairness . |
| | | **amsdu** string | **Choices:*** enable
* disable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . |
| | | **ap\_handoff** string | **Choices:*** enable
* disable
| Enable/disable AP handoff of clients to other APs . |
| | | **ap\_sniffer\_addr** string | | MAC address to monitor. |
| | | **ap\_sniffer\_bufsize** integer | | Sniffer buffer size (1 - 32 MB). |
| | | **ap\_sniffer\_chan** integer | | Channel on which to operate the sniffer . |
| | | **ap\_sniffer\_ctl** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi control frame . |
| | | **ap\_sniffer\_data** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi data frame . |
| | | **ap\_sniffer\_mgmt\_beacon** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management Beacon frames . |
| | | **ap\_sniffer\_mgmt\_other** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management other frames . |
| | | **ap\_sniffer\_mgmt\_probe** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management probe frames . |
| | | **auto\_power\_high** integer | | Automatic transmit power high limit 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 | | 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.11ac
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax-5G
* 802.11ax
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 2 operates on. |
| | | **band\_5g\_type** string | **Choices:*** 5g-full
* 5g-high
* 5g-low
| WiFi 5G band type. |
| | | **bandwidth\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. |
| | | **bandwidth\_capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps). |
| | | **beacon\_interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). |
| | | **bss\_color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. ). |
| | | **call\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. |
| | | **call\_capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **channel\_bonding** string | **Choices:*** 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel\_utilization** string | **Choices:*** enable
* disable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** enable
* disable
| Enable/disable allowing both HT20 and HT40 on the same radio . |
| | | **darrp** string | **Choices:*** enable
* disable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) . |
| | | **drma\_sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant . |
| | | **dtim** integer | | DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life. |
| | | **frag\_threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). |
| | | **frequency\_handoff** string | **Choices:*** enable
* disable
| Enable/disable frequency handoff of clients to other channels . |
| | | **iperf\_protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol . |
| | | **iperf\_server\_port** integer | | Iperf service port number. |
| | | **max\_clients** integer | | Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. |
| | | **max\_distance** integer | | Maximum expected distance between the AP and clients (0 - 54000 m). |
| | | **mode** string | **Choices:*** disabled
* ap
* monitor
* sniffer
* sam
| Mode of radio 2. Radio 2 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. |
| | | **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). |
| | | **powersave\_optimize** string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| Enable client power-saving features such as TIM, AC VO, and OBSS etc. |
| | | **protection\_mode** string | **Choices:*** rtscts
* ctsonly
* disable
| Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). |
| | | **radio\_id** integer | | radio-id |
| | | **rts\_threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). |
| | | **sam\_bssid** string | | BSSID for WiFi network. |
| | | **sam\_captive\_portal** string | **Choices:*** enable
* disable
| Enable/disable Captive Portal Authentication . |
| | | **sam\_password** string | | Passphrase for WiFi network connection. |
| | | **sam\_report\_intv** integer | | SAM report interval (sec), 0 for a one-time report. |
| | | **sam\_security\_type** string | **Choices:*** open
* wpa-personal
* wpa-enterprise
| Select WiFi network security type . |
| | | **sam\_server** string | | SAM test server IP address or domain name. |
| | | **sam\_ssid** string | | SSID for WiFi network. |
| | | **sam\_test** string | **Choices:*** ping
* iperf
| Select SAM test type . |
| | | **sam\_username** string | | Username for WiFi network connection. |
| | | **short\_guard\_interval** string | **Choices:*** enable
* disable
| Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **transmit\_optimize** string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. |
| | | **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. |
| | | **wids\_profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. |
| | | **zero\_wait\_dfs** string | **Choices:*** enable
* disable
| Enable/disable zero wait DFS on radio . |
| | **radio\_3** dictionary | | Configuration options for radio 3. |
| | | **airtime\_fairness** string | **Choices:*** enable
* disable
| Enable/disable airtime fairness . |
| | | **amsdu** string | **Choices:*** enable
* disable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . |
| | | **ap\_handoff** string | **Choices:*** enable
* disable
| Enable/disable AP handoff of clients to other APs . |
| | | **ap\_sniffer\_addr** string | | MAC address to monitor. |
| | | **ap\_sniffer\_bufsize** integer | | Sniffer buffer size (1 - 32 MB). |
| | | **ap\_sniffer\_chan** integer | | Channel on which to operate the sniffer . |
| | | **ap\_sniffer\_ctl** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi control frame . |
| | | **ap\_sniffer\_data** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi data frame . |
| | | **ap\_sniffer\_mgmt\_beacon** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management Beacon frames . |
| | | **ap\_sniffer\_mgmt\_other** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management other frames . |
| | | **ap\_sniffer\_mgmt\_probe** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management probe frames . |
| | | **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.11ac
* 802.11ax-5G
* 802.11ax
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 3 operates on. |
| | | **band\_5g\_type** string | **Choices:*** 5g-full
* 5g-high
* 5g-low
| WiFi 5G band type. |
| | | **bandwidth\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. |
| | | **bandwidth\_capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps). |
| | | **beacon\_interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). |
| | | **bss\_color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. ). |
| | | **call\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. |
| | | **call\_capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **channel\_bonding** string | **Choices:*** 160MHz
* 80MHz
* 40MHz
* 20MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel\_utilization** string | **Choices:*** enable
* disable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** enable
* disable
| Enable/disable allowing both HT20 and HT40 on the same radio . |
| | | **darrp** string | **Choices:*** enable
* disable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) . |
| | | **drma\_sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant . |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. |
| | | **frag\_threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). |
| | | **frequency\_handoff** string | **Choices:*** enable
* disable
| Enable/disable frequency handoff of clients to other channels . |
| | | **iperf\_protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol . |
| | | **iperf\_server\_port** integer | | Iperf service port number. |
| | | **max\_clients** integer | | Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. |
| | | **max\_distance** integer | | Maximum expected distance between the AP and clients (0 - 54000 m). |
| | | **mode** string | **Choices:*** disabled
* ap
* monitor
* sniffer
* sam
| Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. |
| | | **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). |
| | | **powersave\_optimize** string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| Enable client power-saving features such as TIM, AC VO, and OBSS etc. |
| | | **protection\_mode** string | **Choices:*** rtscts
* ctsonly
* disable
| Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). |
| | | **radio\_id** integer | | radio-id |
| | | **rts\_threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). |
| | | **sam\_bssid** string | | BSSID for WiFi network. |
| | | **sam\_captive\_portal** string | **Choices:*** enable
* disable
| Enable/disable Captive Portal Authentication . |
| | | **sam\_password** string | | Passphrase for WiFi network connection. |
| | | **sam\_report\_intv** integer | | SAM report interval (sec), 0 for a one-time report. |
| | | **sam\_security\_type** string | **Choices:*** open
* wpa-personal
* wpa-enterprise
| Select WiFi network security type . |
| | | **sam\_server** string | | SAM test server IP address or domain name. |
| | | **sam\_ssid** string | | SSID for WiFi network. |
| | | **sam\_test** string | **Choices:*** ping
* iperf
| Select SAM test type . |
| | | **sam\_username** string | | Username for WiFi network connection. |
| | | **short\_guard\_interval** string | **Choices:*** enable
* disable
| Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **transmit\_optimize** string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. |
| | | **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. |
| | | **wids\_profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. |
| | | **zero\_wait\_dfs** string | **Choices:*** enable
* disable
| Enable/disable zero wait DFS on radio . |
| | **radio\_4** dictionary | | Configuration options for radio 4. |
| | | **airtime\_fairness** string | **Choices:*** enable
* disable
| Enable/disable airtime fairness . |
| | | **amsdu** string | **Choices:*** enable
* disable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . |
| | | **ap\_handoff** string | **Choices:*** enable
* disable
| Enable/disable AP handoff of clients to other APs . |
| | | **ap\_sniffer\_addr** string | | MAC address to monitor. |
| | | **ap\_sniffer\_bufsize** integer | | Sniffer buffer size (1 - 32 MB). |
| | | **ap\_sniffer\_chan** integer | | Channel on which to operate the sniffer . |
| | | **ap\_sniffer\_ctl** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi control frame . |
| | | **ap\_sniffer\_data** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi data frame . |
| | | **ap\_sniffer\_mgmt\_beacon** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management Beacon frames . |
| | | **ap\_sniffer\_mgmt\_other** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management other frames . |
| | | **ap\_sniffer\_mgmt\_probe** string | **Choices:*** enable
* disable
| Enable/disable sniffer on WiFi management probe frames . |
| | | **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.11ac
* 802.11ax-5G
* 802.11ax
* 802.11n,g-only
* 802.11g-only
* 802.11n-only
* 802.11n-5G-only
* 802.11ac,n-only
* 802.11ac-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-5G-only
* 802.11ax,n-only
* 802.11ax,n,g-only
* 802.11ax-only
* 802.11ac-2G
| WiFi band that Radio 3 operates on. |
| | | **band\_5g\_type** string | **Choices:*** 5g-full
* 5g-high
* 5g-low
| WiFi 5G band type. |
| | | **bandwidth\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. |
| | | **bandwidth\_capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps). |
| | | **beacon\_interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). |
| | | **bss\_color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. ). |
| | | **call\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. |
| | | **call\_capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). |
| | | **channel** list / elements=string | | Selected list of wireless radio channels. |
| | | | **chan** string / required | | Channel number. |
| | | **channel\_bonding** string | **Choices:*** 160MHz
* 80MHz
* 40MHz
* 20MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel\_utilization** string | **Choices:*** enable
* disable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** enable
* disable
| Enable/disable allowing both HT20 and HT40 on the same radio . |
| | | **darrp** string | **Choices:*** enable
* disable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) . |
| | | **drma\_sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant . |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. |
| | | **frag\_threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). |
| | | **frequency\_handoff** string | **Choices:*** enable
* disable
| Enable/disable frequency handoff of clients to other channels . |
| | | **iperf\_protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol . |
| | | **iperf\_server\_port** integer | | Iperf service port number. |
| | | **max\_clients** integer | | Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. |
| | | **max\_distance** integer | | Maximum expected distance between the AP and clients (0 - 54000 m). |
| | | **mode** string | **Choices:*** disabled
* ap
* monitor
* sniffer
* sam
| Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. |
| | | **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). |
| | | **powersave\_optimize** string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| Enable client power-saving features such as TIM, AC VO, and OBSS etc. |
| | | **protection\_mode** string | **Choices:*** rtscts
* ctsonly
* disable
| Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). |
| | | **rts\_threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). |
| | | **sam\_bssid** string | | BSSID for WiFi network. |
| | | **sam\_captive\_portal** string | **Choices:*** enable
* disable
| Enable/disable Captive Portal Authentication . |
| | | **sam\_password** string | | Passphrase for WiFi network connection. |
| | | **sam\_report\_intv** integer | | SAM report interval (sec), 0 for a one-time report. |
| | | **sam\_security\_type** string | **Choices:*** open
* wpa-personal
* wpa-enterprise
| Select WiFi network security type . |
| | | **sam\_server** string | | SAM test server IP address or domain name. |
| | | **sam\_ssid** string | | SSID for WiFi network. |
| | | **sam\_test** string | **Choices:*** ping
* iperf
| Select SAM test type . |
| | | **sam\_username** string | | Username for WiFi network connection. |
| | | **short\_guard\_interval** string | **Choices:*** enable
* disable
| Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. |
| | | **spectrum\_analysis** string | **Choices:*** enable
* disable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | | **transmit\_optimize** string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. |
| | | **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. |
| | | **wids\_profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. |
| | | **zero\_wait\_dfs** string | **Choices:*** enable
* disable
| Enable/disable zero wait DFS on radio . |
| | **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 CAPWAP tunnel MTU (0, 576, or 1500 bytes). |
| | **tun\_mtu\_uplink** integer | | Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes). |
| | **wan\_port\_mode** string | **Choices:*** wan-lan
* wan-only
| Enable/disable using a WAN port as a LAN port. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fortios_wireless_controller_wtp_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wtp_profile:
allowaccess: "telnet"
ap_country: "NA"
ap_handoff: "enable"
apcfg_profile: "<your_own_value> (source wireless-controller.apcfg-profile.name)"
ble_profile: "<your_own_value> (source wireless-controller.ble-profile.name)"
comment: "Comment."
control_message_offload: "ebp-frame"
deny_mac_list:
-
id: "11"
mac: "<your_own_value>"
dtls_in_kernel: "enable"
dtls_policy: "clear-text"
energy_efficient_ethernet: "enable"
ext_info_enable: "enable"
frequency_handoff: "enable"
handoff_roaming: "enable"
handoff_rssi: "19"
handoff_sta_thresh: "20"
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)"
lbs:
aeroscout: "enable"
aeroscout_ap_mac: "bssid"
aeroscout_mmu_report: "enable"
aeroscout_mu: "enable"
aeroscout_mu_factor: "48"
aeroscout_mu_timeout: "49"
aeroscout_server_ip: "<your_own_value>"
aeroscout_server_port: "51"
ekahau_blink_mode: "enable"
ekahau_tag: "<your_own_value>"
erc_server_ip: "<your_own_value>"
erc_server_port: "55"
fortipresence: "foreign"
fortipresence_ble: "enable"
fortipresence_frequency: "58"
fortipresence_port: "59"
fortipresence_project: "<your_own_value>"
fortipresence_rogue: "enable"
fortipresence_secret: "<your_own_value>"
fortipresence_server: "<your_own_value>"
fortipresence_unassoc: "enable"
station_locate: "enable"
led_schedules:
-
name: "default_name_67 (source firewall.schedule.group.name firewall.schedule.recurring.name)"
led_state: "enable"
lldp: "enable"
login_passwd: "<your_own_value>"
login_passwd_change: "yes"
max_clients: "72"
name: "default_name_73"
platform:
ddscan: "enable"
mode: "single-5G"
type: "AP-11N"
poe_mode: "auto"
radio_1:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "84"
ap_sniffer_chan: "85"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
auto_power_high: "91"
auto_power_level: "enable"
auto_power_low: "93"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "98"
beacon_interval: "99"
bss_color: "100"
call_admission_control: "enable"
call_capacity: "102"
channel:
-
chan: "<your_own_value>"
channel_bonding: "80MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "111"
frag_threshold: "112"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "115"
max_clients: "116"
max_distance: "117"
mode: "disabled"
power_level: "119"
power_mode: "dBm"
power_value: "121"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "124"
rts_threshold: "125"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_password: "<your_own_value>"
sam_report_intv: "129"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "enable"
vaps:
-
name: "default_name_140 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_2:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "148"
ap_sniffer_chan: "149"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
auto_power_high: "155"
auto_power_level: "enable"
auto_power_low: "157"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "162"
beacon_interval: "163"
bss_color: "164"
call_admission_control: "enable"
call_capacity: "166"
channel:
-
chan: "<your_own_value>"
channel_bonding: "80MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "175"
frag_threshold: "176"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "179"
max_clients: "180"
max_distance: "181"
mode: "disabled"
power_level: "183"
power_mode: "dBm"
power_value: "185"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "188"
rts_threshold: "189"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_password: "<your_own_value>"
sam_report_intv: "193"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "enable"
vaps:
-
name: "default_name_204 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_3:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "212"
ap_sniffer_chan: "213"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
auto_power_high: "219"
auto_power_level: "enable"
auto_power_low: "221"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "226"
beacon_interval: "227"
bss_color: "228"
call_admission_control: "enable"
call_capacity: "230"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "239"
frag_threshold: "240"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "243"
max_clients: "244"
max_distance: "245"
mode: "disabled"
power_level: "247"
power_mode: "dBm"
power_value: "249"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "252"
rts_threshold: "253"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_password: "<your_own_value>"
sam_report_intv: "257"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "enable"
vaps:
-
name: "default_name_268 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_4:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "276"
ap_sniffer_chan: "277"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
auto_power_high: "283"
auto_power_level: "enable"
auto_power_low: "285"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "290"
beacon_interval: "291"
bss_color: "292"
call_admission_control: "enable"
call_capacity: "294"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "303"
frag_threshold: "304"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "307"
max_clients: "308"
max_distance: "309"
mode: "disabled"
power_level: "311"
power_mode: "dBm"
power_value: "313"
powersave_optimize: "tim"
protection_mode: "rtscts"
rts_threshold: "316"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_password: "<your_own_value>"
sam_report_intv: "320"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "enable"
vaps:
-
name: "default_name_331 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
split_tunneling_acl:
-
dest_ip: "<your_own_value>"
id: "336"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
tun_mtu_downlink: "339"
tun_mtu_uplink: "340"
wan_port_mode: "wan-lan"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_utm – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_utm – 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_utm`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 utm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_utm** 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_utm:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_utm:
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_log_syslogd2_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd2\_setting – Global 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_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 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\_setting** dictionary | | Global 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. |
| | **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: Global settings for remote syslog server.
fortios_log_syslogd2_setting:
vdom: "{{ vdom }}"
log_syslogd2_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"
port: "15"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "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_system_replacemsg_ftp – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_ftp – 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_ftp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ftp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ftp** 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_ftp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_ftp:
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_storm_control – Configure FortiSwitch storm control in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_storm\_control – Configure FortiSwitch storm control in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_storm\_control** dictionary | | Configure FortiSwitch storm control. |
| | **broadcast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop broadcast traffic. |
| | **rate** integer | | Rate in packets per second at which storm traffic is controlled (1 - 10000000). Storm control drops excess traffic data rates beyond this threshold. |
| | **unknown\_multicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop unknown multicast traffic. |
| | **unknown\_unicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop unknown unicast 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 FortiSwitch storm control.
fortios_switch_controller_storm_control:
vdom: "{{ vdom }}"
switch_controller_storm_control:
broadcast: "enable"
rate: "4"
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)
| programming_docs |
ansible fortinet.fortios.fortios_webfilter_content – Configure Web filter banned word table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_content – Configure Web filter banned word 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_webfilter_content`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 content category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_content** dictionary | | Configure Web filter banned word table. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Configure banned word entries. |
| | | **action** string | **Choices:*** block
* exempt
| Block or exempt word when a match is found. |
| | | **lang** string | **Choices:*** western
* simch
* trach
* japanese
* korean
* french
* thai
* spanish
* cyrillic
| Language of banned word. |
| | | **name** string / required | | Banned word. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Banned word pattern type: wildcard pattern or Perl regular expression. |
| | | **score** integer | | Score, to be applied every time the word appears on a web page (0 - 4294967295). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable banned word. |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 Web filter banned word table.
fortios_webfilter_content:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_content:
comment: "Optional comments."
entries:
-
action: "block"
lang: "western"
name: "default_name_7"
pattern_type: "wildcard"
score: "9"
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)
ansible fortinet.fortios.fortios_ips_rule_settings – Configure IPS rule setting in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_rule\_settings – Configure IPS rule 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_ips_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 ips 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ips\_rule\_settings** dictionary | | Configure IPS rule setting. |
| | **id** integer / required | | Rule 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 IPS rule setting.
fortios_ips_rule_settings:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_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)
ansible fortinet.fortios.fortios_web_proxy_profile – Configure web proxy profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_web\_proxy\_profile – Configure web proxy 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_web_proxy_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 web\_proxy 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. |
| **web\_proxy\_profile** dictionary | | Configure web proxy profiles. |
| | **header\_client\_ip** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **header\_front\_end\_https** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **header\_via\_request** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **header\_via\_response** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. |
| | **header\_x\_authenticated\_groups** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **header\_x\_authenticated\_user** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **header\_x\_forwarded\_for** string | **Choices:*** pass
* add
* remove
| Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. |
| | **headers** list / elements=string | | Configure HTTP forwarded requests headers. |
| | | **action** string | **Choices:*** add-to-request
* add-to-response
* remove-from-request
* remove-from-response
| Action when HTTP the header forwarded. |
| | | **add\_option** string | **Choices:*** append
* new-on-not-found
* new
| Configure options to append content to existing HTTP header or add new HTTP header. |
| | | **base64\_encoding** string | **Choices:*** disable
* enable
| Enable/disable use of base64 encoding of HTTP content. |
| | | **content** string | | HTTP header"s content. |
| | | **dstaddr** list / elements=string | | Destination address and address group names. |
| | | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **dstaddr6** list / elements=string | | Destination address and address group names (IPv6). |
| | | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **id** integer / required | | HTTP forwarded header id. |
| | | **name** string | | HTTP forwarded header name. |
| | | **protocol** list / elements=string | **Choices:*** https
* http
| Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). |
| | **log\_header\_change** string | **Choices:*** enable
* disable
| Enable/disable logging HTTP header changes. |
| | **name** string / required | | Profile name. |
| | **strip\_encoding** string | **Choices:*** enable
* disable
| Enable/disable stripping unsupported encoding from the request 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 web proxy profiles.
fortios_web_proxy_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_profile:
header_client_ip: "pass"
header_front_end_https: "pass"
header_via_request: "pass"
header_via_response: "pass"
header_x_authenticated_groups: "pass"
header_x_authenticated_user: "pass"
header_x_forwarded_for: "pass"
headers:
-
action: "add-to-request"
add_option: "append"
base64_encoding: "disable"
content: "<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)"
id: "19"
name: "default_name_20"
protocol: "https"
log_header_change: "enable"
name: "default_name_23"
strip_encoding: "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_snmp_user – SNMP user configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_snmp\_user – SNMP user 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_user`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_snmp\_user** dictionary | | SNMP user configuration. |
| | **auth\_proto** string | **Choices:*** md5
* sha
* sha224
* sha256
* sha384
* sha512
| Authentication protocol. |
| | **auth\_pwd** string | | Password for authentication protocol. |
| | **events** list / elements=string | **Choices:*** cpu-high
* mem-low
* log-full
* intf-ip
* vpn-tun-up
* vpn-tun-down
* ha-switch
* ha-hb-failure
* ips-signature
* ips-anomaly
* av-virus
* av-oversize
* av-pattern
* av-fragmented
* fm-if-change
* fm-conf-change
* bgp-established
* bgp-backward-transition
* ha-member-up
* ha-member-down
* ent-conf-change
* av-conserve
* av-bypass
* av-oversize-passed
* av-oversize-blocked
* ips-pkg-update
* ips-fail-open
* temperature-high
* voltage-alert
* power-supply-failure
* faz-disconnect
* fan-failure
* wc-ap-up
* wc-ap-down
* fswctl-session-up
* fswctl-session-down
* load-balance-real-server-down
* device-new
* per-cpu-high
* dhcp
* ospf-nbr-state-change
* ospf-virtnbr-state-change
| SNMP notifications (traps) to send. |
| | **ha\_direct** string | **Choices:*** enable
* disable
| Enable/disable direct management of HA cluster members. |
| | **name** string / required | | SNMP user name. |
| | **notify\_hosts** list / elements=string | | SNMP managers to send notifications (traps) to. |
| | **notify\_hosts6** list / elements=string | | IPv6 SNMP managers to send notifications (traps) to. |
| | **priv\_proto** string | **Choices:*** aes
* des
* aes256
* aes256cisco
| Privacy (encryption) protocol. |
| | **priv\_pwd** string | | Password for privacy (encryption) protocol. |
| | **queries** string | **Choices:*** enable
* disable
| Enable/disable SNMP queries for this user. |
| | **query\_port** integer | | SNMPv3 query port . |
| | **security\_level** string | **Choices:*** no-auth-no-priv
* auth-no-priv
* auth-priv
| Security level for message authentication and encryption. |
| | **source\_ip** string | | Source IP for SNMP trap. |
| | **source\_ipv6** string | | Source IPv6 for SNMP trap. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this SNMP user. |
| | **trap\_lport** integer | | SNMPv3 local trap port . |
| | **trap\_rport** integer | | SNMPv3 trap remote port . |
| | **trap\_status** string | **Choices:*** enable
* disable
| Enable/disable traps for this SNMP user. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 user configuration.
fortios_system_snmp_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
events: "cpu-high"
ha_direct: "enable"
name: "default_name_7"
notify_hosts: "<your_own_value>"
notify_hosts6: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
query_port: "13"
security_level: "no-auth-no-priv"
source_ip: "84.230.14.43"
source_ipv6: "<your_own_value>"
status: "enable"
trap_lport: "18"
trap_rport: "19"
trap_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_antivirus_settings – Configure AntiVirus settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_settings – Configure AntiVirus 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_antivirus_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 antivirus 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. |
| **antivirus\_settings** dictionary | | Configure AntiVirus settings. |
| | **default\_db** string | **Choices:*** normal
* extended
* extreme
| Select the AV database to be used for AV scanning. |
| | **grayware** string | **Choices:*** enable
* disable
| Enable/disable grayware detection when an AntiVirus profile is applied to traffic. |
| | **machine\_learning\_detection** string | **Choices:*** enable
* monitor
* disable
| Use machine learning based malware detection. |
| | **override\_timeout** integer | | Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size. |
| | **use\_extreme\_db** string | **Choices:*** enable
* disable
| Enable/disable the use of Extreme AVDB. |
| **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 AntiVirus settings.
fortios_antivirus_settings:
vdom: "{{ vdom }}"
antivirus_settings:
default_db: "normal"
grayware: "enable"
machine_learning_detection: "enable"
override_timeout: "6"
use_extreme_db: "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_fortianalyzer2_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer2\_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_fortianalyzer2_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 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\_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_fortianalyzer2_setting:
vdom: "{{ vdom }}"
log_fortianalyzer2_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_cifs_domain_controller – Define known domain controller servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_cifs\_domain\_controller – Define known domain controller 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_cifs_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 cifs 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. |
| **cifs\_domain\_controller** dictionary | | Define known domain controller servers. |
| | **domain\_name** string | | Fully qualified domain name (FQDN). E.g. "EXAMPLE.COM". |
| | **ip** string | | IPv4 server address. |
| | **ip6** string | | IPv6 server address. |
| | **password** string | | Password for specified username. |
| | **port** integer | | Port number of service. Port number 0 indicates automatic discovery. |
| | **server\_name** string | | Name of the server to connect to. |
| | **username** string | | User name to sign in with. Must have proper permissions for service. |
| **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: Define known domain controller servers.
fortios_cifs_domain_controller:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
cifs_domain_controller:
domain_name: "<your_own_value>"
ip: "<your_own_value>"
ip6: "<your_own_value>"
password: "<your_own_value>"
port: "7"
server_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_system_affinity_interrupt – Configure interrupt affinity in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_affinity\_interrupt – Configure interrupt affinity in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_affinity_interrupt`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 affinity\_interrupt category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_affinity\_interrupt** dictionary | | Configure interrupt affinity. |
| | **affinity\_cpumask** string | | Affinity setting for VM throughput (64-bit hexadecimal value in the format of 0xxxxxxxxxxxxxxxxx). |
| | **id** integer / required | | ID of the interrupt affinity setting. |
| | **interrupt** string | | Interrupt 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 interrupt affinity.
fortios_system_affinity_interrupt:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_affinity_interrupt:
affinity_cpumask: "<your_own_value>"
id: "4"
interrupt: "<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 Fortinet.Fortios
================
Collection version 2.1.2
Plugin Index
------------
These are the plugins in the fortinet.fortios collection
### Httpapi Plugins
* [fortios](fortios_httpapi#ansible-collections-fortinet-fortios-fortios-httpapi) – HttpApi Plugin for Fortinet FortiOS Appliance or VM
### Modules
* [fortios\_alertemail\_setting](fortios_alertemail_setting_module#ansible-collections-fortinet-fortios-fortios-alertemail-setting-module) – Configure alert email settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_heuristic](fortios_antivirus_heuristic_module#ansible-collections-fortinet-fortios-fortios-antivirus-heuristic-module) – Configure global heuristic options in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_mms\_checksum](fortios_antivirus_mms_checksum_module#ansible-collections-fortinet-fortios-fortios-antivirus-mms-checksum-module) – Configure MMS content checksum list in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_notification](fortios_antivirus_notification_module#ansible-collections-fortinet-fortios-fortios-antivirus-notification-module) – Configure AntiVirus notification lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_profile](fortios_antivirus_profile_module#ansible-collections-fortinet-fortios-fortios-antivirus-profile-module) – Configure AntiVirus profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_quarantine](fortios_antivirus_quarantine_module#ansible-collections-fortinet-fortios-fortios-antivirus-quarantine-module) – Configure quarantine options in Fortinet’s FortiOS and FortiGate.
* [fortios\_antivirus\_settings](fortios_antivirus_settings_module#ansible-collections-fortinet-fortios-fortios-antivirus-settings-module) – Configure AntiVirus settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_application\_custom](fortios_application_custom_module#ansible-collections-fortinet-fortios-fortios-application-custom-module) – Configure custom application signatures in Fortinet’s FortiOS and FortiGate.
* [fortios\_application\_group](fortios_application_group_module#ansible-collections-fortinet-fortios-fortios-application-group-module) – Configure firewall application groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_application\_list](fortios_application_list_module#ansible-collections-fortinet-fortios-fortios-application-list-module) – Configure application control lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_application\_name](fortios_application_name_module#ansible-collections-fortinet-fortios-fortios-application-name-module) – Configure application signatures in Fortinet’s FortiOS and FortiGate.
* [fortios\_application\_rule\_settings](fortios_application_rule_settings_module#ansible-collections-fortinet-fortios-fortios-application-rule-settings-module) – Configure application rule settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_authentication\_rule](fortios_authentication_rule_module#ansible-collections-fortinet-fortios-fortios-authentication-rule-module) – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate.
* [fortios\_authentication\_scheme](fortios_authentication_scheme_module#ansible-collections-fortinet-fortios-fortios-authentication-scheme-module) – Configure Authentication Schemes in Fortinet’s FortiOS and FortiGate.
* [fortios\_authentication\_setting](fortios_authentication_setting_module#ansible-collections-fortinet-fortios-fortios-authentication-setting-module) – Configure authentication setting in Fortinet’s FortiOS and FortiGate.
* [fortios\_certificate\_ca](fortios_certificate_ca_module#ansible-collections-fortinet-fortios-fortios-certificate-ca-module) – CA certificate in Fortinet’s FortiOS and FortiGate.
* [fortios\_certificate\_crl](fortios_certificate_crl_module#ansible-collections-fortinet-fortios-fortios-certificate-crl-module) – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
* [fortios\_certificate\_local](fortios_certificate_local_module#ansible-collections-fortinet-fortios-fortios-certificate-local-module) – Local keys and certificates in Fortinet’s FortiOS and FortiGate.
* [fortios\_certificate\_remote](fortios_certificate_remote_module#ansible-collections-fortinet-fortios-fortios-certificate-remote-module) – Remote certificate as a PEM file in Fortinet’s FortiOS and FortiGate.
* [fortios\_cifs\_domain\_controller](fortios_cifs_domain_controller_module#ansible-collections-fortinet-fortios-fortios-cifs-domain-controller-module) – Define known domain controller servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_cifs\_profile](fortios_cifs_profile_module#ansible-collections-fortinet-fortios-fortios-cifs-profile-module) – Configure CIFS profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_configuration\_fact](fortios_configuration_fact_module#ansible-collections-fortinet-fortios-fortios-configuration-fact-module) – Retrieve Facts of FortiOS Configurable Objects.
* [fortios\_credential\_store\_domain\_controller](fortios_credential_store_domain_controller_module#ansible-collections-fortinet-fortios-fortios-credential-store-domain-controller-module) – Define known domain controller servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_dlp\_filepattern](fortios_dlp_filepattern_module#ansible-collections-fortinet-fortios-fortios-dlp-filepattern-module) – Configure file patterns used by DLP blocking in Fortinet’s FortiOS and FortiGate.
* [fortios\_dlp\_fp\_doc\_source](fortios_dlp_fp_doc_source_module#ansible-collections-fortinet-fortios-fortios-dlp-fp-doc-source-module) – 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.
* [fortios\_dlp\_fp\_sensitivity](fortios_dlp_fp_sensitivity_module#ansible-collections-fortinet-fortios-fortios-dlp-fp-sensitivity-module) – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source in Fortinet’s FortiOS and FortiGate.
* [fortios\_dlp\_sensitivity](fortios_dlp_sensitivity_module#ansible-collections-fortinet-fortios-fortios-dlp-sensitivity-module) – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source in Fortinet’s FortiOS and FortiGate.
* [fortios\_dlp\_sensor](fortios_dlp_sensor_module#ansible-collections-fortinet-fortios-fortios-dlp-sensor-module) – Configure DLP sensors in Fortinet’s FortiOS and FortiGate.
* [fortios\_dlp\_settings](fortios_dlp_settings_module#ansible-collections-fortinet-fortios-fortios-dlp-settings-module) – Designate logical storage for DLP fingerprint database in Fortinet’s FortiOS and FortiGate.
* [fortios\_dnsfilter\_domain\_filter](fortios_dnsfilter_domain_filter_module#ansible-collections-fortinet-fortios-fortios-dnsfilter-domain-filter-module) – Configure DNS domain filters in Fortinet’s FortiOS and FortiGate.
* [fortios\_dnsfilter\_profile](fortios_dnsfilter_profile_module#ansible-collections-fortinet-fortios-fortios-dnsfilter-profile-module) – Configure DNS domain filter profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_dpdk\_cpus](fortios_dpdk_cpus_module#ansible-collections-fortinet-fortios-fortios-dpdk-cpus-module) – Configure CPUs enabled to run engines in each DPDK stage in Fortinet’s FortiOS and FortiGate.
* [fortios\_dpdk\_global](fortios_dpdk_global_module#ansible-collections-fortinet-fortios-fortios-dpdk-global-module) – Configure global DPDK options in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_block\_allow\_list](fortios_emailfilter_block_allow_list_module#ansible-collections-fortinet-fortios-fortios-emailfilter-block-allow-list-module) – Configure anti-spam block/allow list in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_bwl](fortios_emailfilter_bwl_module#ansible-collections-fortinet-fortios-fortios-emailfilter-bwl-module) – Configure anti-spam black/white list in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_bword](fortios_emailfilter_bword_module#ansible-collections-fortinet-fortios-fortios-emailfilter-bword-module) – Configure AntiSpam banned word list in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_dnsbl](fortios_emailfilter_dnsbl_module#ansible-collections-fortinet-fortios-fortios-emailfilter-dnsbl-module) – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_fortishield](fortios_emailfilter_fortishield_module#ansible-collections-fortinet-fortios-fortios-emailfilter-fortishield-module) – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_iptrust](fortios_emailfilter_iptrust_module#ansible-collections-fortinet-fortios-fortios-emailfilter-iptrust-module) – Configure AntiSpam IP trust in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_mheader](fortios_emailfilter_mheader_module#ansible-collections-fortinet-fortios-fortios-emailfilter-mheader-module) – Configure AntiSpam MIME header in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_options](fortios_emailfilter_options_module#ansible-collections-fortinet-fortios-fortios-emailfilter-options-module) – Configure AntiSpam options in Fortinet’s FortiOS and FortiGate.
* [fortios\_emailfilter\_profile](fortios_emailfilter_profile_module#ansible-collections-fortinet-fortios-fortios-emailfilter-profile-module) – Configure Email Filter profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_client](fortios_endpoint_control_client_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-client-module) – Configure endpoint control client lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_fctems](fortios_endpoint_control_fctems_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-fctems-module) – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_forticlient\_ems](fortios_endpoint_control_forticlient_ems_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-forticlient-ems-module) – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_forticlient\_registration\_sync](fortios_endpoint_control_forticlient_registration_sync_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-forticlient-registration-sync-module) – Configure FortiClient registration synchronization settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_profile](fortios_endpoint_control_profile_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-profile-module) – Configure FortiClient endpoint control profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_registered\_forticlient](fortios_endpoint_control_registered_forticlient_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-registered-forticlient-module) – Registered FortiClient list in Fortinet’s FortiOS and FortiGate.
* [fortios\_endpoint\_control\_settings](fortios_endpoint_control_settings_module#ansible-collections-fortinet-fortios-fortios-endpoint-control-settings-module) – Configure endpoint control settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_controller\_dataplan](fortios_extender_controller_dataplan_module#ansible-collections-fortinet-fortios-fortios-extender-controller-dataplan-module) – FortiExtender dataplan configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_controller\_extender](fortios_extender_controller_extender_module#ansible-collections-fortinet-fortios-fortios-extender-controller-extender-module) – Extender controller configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_extender\_info](fortios_extender_extender_info_module#ansible-collections-fortinet-fortios-fortios-extender-extender-info-module) – Display extender struct information in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_lte\_carrier\_by\_mcc\_mnc](fortios_extender_lte_carrier_by_mcc_mnc_module#ansible-collections-fortinet-fortios-fortios-extender-lte-carrier-by-mcc-mnc-module) – Display extender modem carrier based on MCC and MNC in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_lte\_carrier\_list](fortios_extender_lte_carrier_list_module#ansible-collections-fortinet-fortios-fortios-extender-lte-carrier-list-module) – Display extender modem carrier list in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_modem\_status](fortios_extender_modem_status_module#ansible-collections-fortinet-fortios-fortios-extender-modem-status-module) – Display detailed extender modem status in Fortinet’s FortiOS and FortiGate.
* [fortios\_extender\_sys\_info](fortios_extender_sys_info_module#ansible-collections-fortinet-fortios-fortios-extender-sys-info-module) – Display detailed extender system information in Fortinet’s FortiOS and FortiGate.
* [fortios\_file\_filter\_profile](fortios_file_filter_profile_module#ansible-collections-fortinet-fortios-fortios-file-filter-profile-module) – Configure file-filter profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_access\_proxy](fortios_firewall_access_proxy_module#ansible-collections-fortinet-fortios-fortios-firewall-access-proxy-module) – Configure Access Proxy in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_access\_proxy\_virtual\_host](fortios_firewall_access_proxy_virtual_host_module#ansible-collections-fortinet-fortios-fortios-firewall-access-proxy-virtual-host-module) – Configure Access Proxy virtual hosts in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_acl](fortios_firewall_acl_module#ansible-collections-fortinet-fortios-fortios-firewall-acl-module) – Configure IPv4 access control list in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_acl6](fortios_firewall_acl6_module#ansible-collections-fortinet-fortios-fortios-firewall-acl6-module) – Configure IPv6 access control list in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_address](fortios_firewall_address_module#ansible-collections-fortinet-fortios-fortios-firewall-address-module) – Configure IPv4 addresses in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_address6](fortios_firewall_address6_module#ansible-collections-fortinet-fortios-fortios-firewall-address6-module) – Configure IPv6 firewall addresses in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_address6\_template](fortios_firewall_address6_template_module#ansible-collections-fortinet-fortios-fortios-firewall-address6-template-module) – Configure IPv6 address templates in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_addrgrp](fortios_firewall_addrgrp_module#ansible-collections-fortinet-fortios-fortios-firewall-addrgrp-module) – Configure IPv4 address groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_addrgrp6](fortios_firewall_addrgrp6_module#ansible-collections-fortinet-fortios-fortios-firewall-addrgrp6-module) – Configure IPv6 address groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_auth\_portal](fortios_firewall_auth_portal_module#ansible-collections-fortinet-fortios-fortios-firewall-auth-portal-module) – Configure firewall authentication portals in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_carrier\_endpoint\_bwl](fortios_firewall_carrier_endpoint_bwl_module#ansible-collections-fortinet-fortios-fortios-firewall-carrier-endpoint-bwl-module) – Carrier end point black/white list tables in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_central\_snat\_map](fortios_firewall_central_snat_map_module#ansible-collections-fortinet-fortios-fortios-firewall-central-snat-map-module) – Configure central SNAT policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_city](fortios_firewall_city_module#ansible-collections-fortinet-fortios-fortios-firewall-city-module) – Define city table in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_consolidated\_policy](fortios_firewall_consolidated_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-consolidated-policy-module) – Configure consolidated IPv4/IPv6 policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_country](fortios_firewall_country_module#ansible-collections-fortinet-fortios-fortios-firewall-country-module) – Define country table in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_decrypted\_traffic\_mirror](fortios_firewall_decrypted_traffic_mirror_module#ansible-collections-fortinet-fortios-fortios-firewall-decrypted-traffic-mirror-module) – Configure decrypted traffic mirror in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_dnstranslation](fortios_firewall_dnstranslation_module#ansible-collections-fortinet-fortios-fortios-firewall-dnstranslation-module) – Configure DNS translation in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_dos\_policy](fortios_firewall_dos_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-dos-policy-module) – Configure IPv4 DoS policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_dos\_policy6](fortios_firewall_dos_policy6_module#ansible-collections-fortinet-fortios-fortios-firewall-dos-policy6-module) – Configure IPv6 DoS policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_gtp](fortios_firewall_gtp_module#ansible-collections-fortinet-fortios-fortios-firewall-gtp-module) – Configure GTP in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_identity\_based\_route](fortios_firewall_identity_based_route_module#ansible-collections-fortinet-fortios-fortios-firewall-identity-based-route-module) – Configure identity based routing in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_interface\_policy](fortios_firewall_interface_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-interface-policy-module) – Configure IPv4 interface policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_interface\_policy6](fortios_firewall_interface_policy6_module#ansible-collections-fortinet-fortios-fortios-firewall-interface-policy6-module) – Configure IPv6 interface policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service](fortios_firewall_internet_service_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-module) – Show Internet Service application in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_addition](fortios_firewall_internet_service_addition_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-addition-module) – Configure Internet Services Addition in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_append](fortios_firewall_internet_service_append_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-append-module) – Configure additional port mappings for Internet Services in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_botnet](fortios_firewall_internet_service_botnet_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-botnet-module) – Show Internet Service botnet in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_custom](fortios_firewall_internet_service_custom_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-custom-module) – Configure custom Internet Services in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_custom\_group](fortios_firewall_internet_service_custom_group_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-custom-group-module) – Configure custom Internet Service group in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_definition](fortios_firewall_internet_service_definition_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-definition-module) – Configure Internet Service definition in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_extension](fortios_firewall_internet_service_extension_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-extension-module) – Configure Internet Services Extension in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_group](fortios_firewall_internet_service_group_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-group-module) – Configure group of Internet Service in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_ipbl\_reason](fortios_firewall_internet_service_ipbl_reason_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-ipbl-reason-module) – IP blacklist reason in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_ipbl\_vendor](fortios_firewall_internet_service_ipbl_vendor_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-ipbl-vendor-module) – IP blacklist vendor in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_list](fortios_firewall_internet_service_list_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-list-module) – Internet Service list in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_name](fortios_firewall_internet_service_name_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-name-module) – Define internet service names in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_owner](fortios_firewall_internet_service_owner_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-owner-module) – Internet Service owner in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_reputation](fortios_firewall_internet_service_reputation_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-reputation-module) – Show Internet Service reputation in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_internet\_service\_sld](fortios_firewall_internet_service_sld_module#ansible-collections-fortinet-fortios-fortios-firewall-internet-service-sld-module) – Internet Service Second Level Domain in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ip\_translation](fortios_firewall_ip_translation_module#ansible-collections-fortinet-fortios-fortios-firewall-ip-translation-module) – Configure firewall IP-translation in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ipmacbinding\_setting](fortios_firewall_ipmacbinding_setting_module#ansible-collections-fortinet-fortios-fortios-firewall-ipmacbinding-setting-module) – Configure IP to MAC binding settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ipmacbinding\_table](fortios_firewall_ipmacbinding_table_module#ansible-collections-fortinet-fortios-fortios-firewall-ipmacbinding-table-module) – Configure IP to MAC address pairs in the IP/MAC binding table in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ippool](fortios_firewall_ippool_module#ansible-collections-fortinet-fortios-fortios-firewall-ippool-module) – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ippool6](fortios_firewall_ippool6_module#ansible-collections-fortinet-fortios-fortios-firewall-ippool6-module) – Configure IPv6 IP pools in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_iprope\_list](fortios_firewall_iprope_list_module#ansible-collections-fortinet-fortios-fortios-firewall-iprope-list-module) – lis in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ipv6\_eh\_filter](fortios_firewall_ipv6_eh_filter_module#ansible-collections-fortinet-fortios-fortios-firewall-ipv6-eh-filter-module) – Configure IPv6 extension header filter in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ldb\_monitor](fortios_firewall_ldb_monitor_module#ansible-collections-fortinet-fortios-fortios-firewall-ldb-monitor-module) – Configure server load balancing health monitors in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_local\_in\_policy](fortios_firewall_local_in_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-local-in-policy-module) – Configure user defined IPv4 local-in policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_local\_in\_policy6](fortios_firewall_local_in_policy6_module#ansible-collections-fortinet-fortios-fortios-firewall-local-in-policy6-module) – Configure user defined IPv6 local-in policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_mms\_profile](fortios_firewall_mms_profile_module#ansible-collections-fortinet-fortios-fortios-firewall-mms-profile-module) – Configure MMS profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_multicast\_address](fortios_firewall_multicast_address_module#ansible-collections-fortinet-fortios-fortios-firewall-multicast-address-module) – Configure multicast addresses in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_multicast\_address6](fortios_firewall_multicast_address6_module#ansible-collections-fortinet-fortios-fortios-firewall-multicast-address6-module) – Configure IPv6 multicast address in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_multicast\_policy](fortios_firewall_multicast_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-multicast-policy-module) – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_multicast\_policy6](fortios_firewall_multicast_policy6_module#ansible-collections-fortinet-fortios-fortios-firewall-multicast-policy6-module) – Configure IPv6 multicast NAT policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_policy](fortios_firewall_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-policy-module) – Configure IPv4 policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_policy46](fortios_firewall_policy46_module#ansible-collections-fortinet-fortios-fortios-firewall-policy46-module) – Configure IPv4 to IPv6 policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_policy6](fortios_firewall_policy6_module#ansible-collections-fortinet-fortios-fortios-firewall-policy6-module) – Configure IPv6 policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_policy64](fortios_firewall_policy64_module#ansible-collections-fortinet-fortios-fortios-firewall-policy64-module) – Configure IPv6 to IPv4 policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_profile\_group](fortios_firewall_profile_group_module#ansible-collections-fortinet-fortios-fortios-firewall-profile-group-module) – Configure profile groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_profile\_protocol\_options](fortios_firewall_profile_protocol_options_module#ansible-collections-fortinet-fortios-fortios-firewall-profile-protocol-options-module) – Configure protocol options in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_proute](fortios_firewall_proute_module#ansible-collections-fortinet-fortios-fortios-firewall-proute-module) – List policy routing in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_proxy\_address](fortios_firewall_proxy_address_module#ansible-collections-fortinet-fortios-fortios-firewall-proxy-address-module) – Web proxy address configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_proxy\_addrgrp](fortios_firewall_proxy_addrgrp_module#ansible-collections-fortinet-fortios-fortios-firewall-proxy-addrgrp-module) – Web proxy address group configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_proxy\_policy](fortios_firewall_proxy_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-proxy-policy-module) – Configure proxy policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_region](fortios_firewall_region_module#ansible-collections-fortinet-fortios-fortios-firewall-region-module) – Define region table in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_schedule\_group](fortios_firewall_schedule_group_module#ansible-collections-fortinet-fortios-fortios-firewall-schedule-group-module) – Schedule group configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_schedule\_onetime](fortios_firewall_schedule_onetime_module#ansible-collections-fortinet-fortios-fortios-firewall-schedule-onetime-module) – Onetime schedule configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_schedule\_recurring](fortios_firewall_schedule_recurring_module#ansible-collections-fortinet-fortios-fortios-firewall-schedule-recurring-module) – Recurring schedule configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_security\_policy](fortios_firewall_security_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-security-policy-module) – Configure NGFW IPv4/IPv6 application policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_service\_category](fortios_firewall_service_category_module#ansible-collections-fortinet-fortios-fortios-firewall-service-category-module) – Configure service categories in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_service\_custom](fortios_firewall_service_custom_module#ansible-collections-fortinet-fortios-fortios-firewall-service-custom-module) – Configure custom services in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_service\_group](fortios_firewall_service_group_module#ansible-collections-fortinet-fortios-fortios-firewall-service-group-module) – Configure service groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_shaper\_per\_ip\_shaper](fortios_firewall_shaper_per_ip_shaper_module#ansible-collections-fortinet-fortios-fortios-firewall-shaper-per-ip-shaper-module) – Configure per-IP traffic shaper in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_shaper\_traffic\_shaper](fortios_firewall_shaper_traffic_shaper_module#ansible-collections-fortinet-fortios-fortios-firewall-shaper-traffic-shaper-module) – Configure shared traffic shaper in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_shaping\_policy](fortios_firewall_shaping_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-shaping-policy-module) – Configure shaping policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_shaping\_profile](fortios_firewall_shaping_profile_module#ansible-collections-fortinet-fortios-fortios-firewall-shaping-profile-module) – Configure shaping profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_sniffer](fortios_firewall_sniffer_module#ansible-collections-fortinet-fortios-fortios-firewall-sniffer-module) – Configure sniffer in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssh\_host\_key](fortios_firewall_ssh_host_key_module#ansible-collections-fortinet-fortios-fortios-firewall-ssh-host-key-module) – SSH proxy host public keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssh\_local\_ca](fortios_firewall_ssh_local_ca_module#ansible-collections-fortinet-fortios-fortios-firewall-ssh-local-ca-module) – SSH proxy local CA in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssh\_local\_key](fortios_firewall_ssh_local_key_module#ansible-collections-fortinet-fortios-fortios-firewall-ssh-local-key-module) – SSH proxy local keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssh\_setting](fortios_firewall_ssh_setting_module#ansible-collections-fortinet-fortios-fortios-firewall-ssh-setting-module) – SSH proxy settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssl\_server](fortios_firewall_ssl_server_module#ansible-collections-fortinet-fortios-fortios-firewall-ssl-server-module) – Configure SSL servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssl\_setting](fortios_firewall_ssl_setting_module#ansible-collections-fortinet-fortios-fortios-firewall-ssl-setting-module) – SSL proxy settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ssl\_ssh\_profile](fortios_firewall_ssl_ssh_profile_module#ansible-collections-fortinet-fortios-fortios-firewall-ssl-ssh-profile-module) – Configure SSL/SSH protocol options in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_traffic\_class](fortios_firewall_traffic_class_module#ansible-collections-fortinet-fortios-fortios-firewall-traffic-class-module) – Configure names for shaping classes in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_ttl\_policy](fortios_firewall_ttl_policy_module#ansible-collections-fortinet-fortios-fortios-firewall-ttl-policy-module) – Configure TTL policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vendor\_mac](fortios_firewall_vendor_mac_module#ansible-collections-fortinet-fortios-fortios-firewall-vendor-mac-module) – Show vendor and the MAC address they have in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vip](fortios_firewall_vip_module#ansible-collections-fortinet-fortios-fortios-firewall-vip-module) – Configure virtual IP for IPv4 in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vip46](fortios_firewall_vip46_module#ansible-collections-fortinet-fortios-fortios-firewall-vip46-module) – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vip6](fortios_firewall_vip6_module#ansible-collections-fortinet-fortios-fortios-firewall-vip6-module) – Configure virtual IP for IPv6 in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vip64](fortios_firewall_vip64_module#ansible-collections-fortinet-fortios-fortios-firewall-vip64-module) – Configure IPv6 to IPv4 virtual IPs in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vipgrp](fortios_firewall_vipgrp_module#ansible-collections-fortinet-fortios-fortios-firewall-vipgrp-module) – Configure IPv4 virtual IP groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vipgrp46](fortios_firewall_vipgrp46_module#ansible-collections-fortinet-fortios-fortios-firewall-vipgrp46-module) – Configure IPv4 to IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vipgrp6](fortios_firewall_vipgrp6_module#ansible-collections-fortinet-fortios-fortios-firewall-vipgrp6-module) – Configure IPv6 virtual IP groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_vipgrp64](fortios_firewall_vipgrp64_module#ansible-collections-fortinet-fortios-fortios-firewall-vipgrp64-module) – Configure IPv6 to IPv4 virtual IP groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_wildcard\_fqdn\_custom](fortios_firewall_wildcard_fqdn_custom_module#ansible-collections-fortinet-fortios-fortios-firewall-wildcard-fqdn-custom-module) – Config global/VDOM Wildcard FQDN address in Fortinet’s FortiOS and FortiGate.
* [fortios\_firewall\_wildcard\_fqdn\_group](fortios_firewall_wildcard_fqdn_group_module#ansible-collections-fortinet-fortios-fortios-firewall-wildcard-fqdn-group-module) – Config global Wildcard FQDN address groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_ftp\_proxy\_explicit](fortios_ftp_proxy_explicit_module#ansible-collections-fortinet-fortios-fortios-ftp-proxy-explicit-module) – Configure explicit FTP proxy settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_apn](fortios_gtp_apn_module#ansible-collections-fortinet-fortios-fortios-gtp-apn-module) – Configure APN for GTP in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_apn\_shaper](fortios_gtp_apn_shaper_module#ansible-collections-fortinet-fortios-fortios-gtp-apn-shaper-module) – Global per-APN shaper in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_apngrp](fortios_gtp_apngrp_module#ansible-collections-fortinet-fortios-fortios-gtp-apngrp-module) – Configure APN groups for GTP in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_ie\_allow\_list](fortios_gtp_ie_allow_list_module#ansible-collections-fortinet-fortios-fortios-gtp-ie-allow-list-module) – IE allow list in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_ie\_white\_list](fortios_gtp_ie_white_list_module#ansible-collections-fortinet-fortios-fortios-gtp-ie-white-list-module) – IE white list in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_message\_filter\_v0v1](fortios_gtp_message_filter_v0v1_module#ansible-collections-fortinet-fortios-fortios-gtp-message-filter-v0v1-module) – Message filter for GTPv0/v1 messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_message\_filter\_v2](fortios_gtp_message_filter_v2_module#ansible-collections-fortinet-fortios-fortios-gtp-message-filter-v2-module) – Message filter for GTPv2 messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_gtp\_tunnel\_limit](fortios_gtp_tunnel_limit_module#ansible-collections-fortinet-fortios-fortios-gtp-tunnel-limit-module) – GTP tunnel limiter in Fortinet’s FortiOS and FortiGate.
* [fortios\_hardware\_nic](fortios_hardware_nic_module#ansible-collections-fortinet-fortios-fortios-hardware-nic-module) – Display NIC information in Fortinet’s FortiOS and FortiGate.
* [fortios\_hardware\_npu\_np6\_dce](fortios_hardware_npu_np6_dce_module#ansible-collections-fortinet-fortios-fortios-hardware-npu-np6-dce-module) – Show NP6 non-zero subengine drop counters in Fortinet’s FortiOS and FortiGate.
* [fortios\_hardware\_npu\_np6\_session\_stats](fortios_hardware_npu_np6_session_stats_module#ansible-collections-fortinet-fortios-fortios-hardware-npu-np6-session-stats-module) – Show NP6 session offloading statistics counters in Fortinet’s FortiOS and FortiGate.
* [fortios\_hardware\_npu\_np6\_sse\_stats](fortios_hardware_npu_np6_sse_stats_module#ansible-collections-fortinet-fortios-fortios-hardware-npu-np6-sse-stats-module) – Show NP6 hardware session statistics counters in Fortinet’s FortiOS and FortiGate.
* [fortios\_icap\_profile](fortios_icap_profile_module#ansible-collections-fortinet-fortios-fortios-icap-profile-module) – Configure ICAP profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_icap\_server](fortios_icap_server_module#ansible-collections-fortinet-fortios-fortios-icap-server-module) – Configure ICAP servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_custom](fortios_ips_custom_module#ansible-collections-fortinet-fortios-fortios-ips-custom-module) – Configure IPS custom signature in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_decoder](fortios_ips_decoder_module#ansible-collections-fortinet-fortios-fortios-ips-decoder-module) – Configure IPS decoder in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_global](fortios_ips_global_module#ansible-collections-fortinet-fortios-fortios-ips-global-module) – Configure IPS global parameter in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_rule](fortios_ips_rule_module#ansible-collections-fortinet-fortios-fortios-ips-rule-module) – Configure IPS rules in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_rule\_settings](fortios_ips_rule_settings_module#ansible-collections-fortinet-fortios-fortios-ips-rule-settings-module) – Configure IPS rule setting in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_sensor](fortios_ips_sensor_module#ansible-collections-fortinet-fortios-fortios-ips-sensor-module) – Configure IPS sensor in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_settings](fortios_ips_settings_module#ansible-collections-fortinet-fortios-fortios-ips-settings-module) – Configure IPS VDOM parameter in Fortinet’s FortiOS and FortiGate.
* [fortios\_ips\_view\_map](fortios_ips_view_map_module#ansible-collections-fortinet-fortios-fortios-ips-view-map-module) – configure ips view-ma in Fortinet’s FortiOS and FortiGate.
* [fortios\_json\_generic](fortios_json_generic_module#ansible-collections-fortinet-fortios-fortios-json-generic-module) – Config Fortinet’s FortiOS and FortiGate with json generic method.
* [fortios\_log\_custom\_field](fortios_log_custom_field_module#ansible-collections-fortinet-fortios-fortios-log-custom-field-module) – Configure custom log fields in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_disk\_filter](fortios_log_disk_filter_module#ansible-collections-fortinet-fortios-fortios-log-disk-filter-module) – Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_disk\_setting](fortios_log_disk_setting_module#ansible-collections-fortinet-fortios-fortios-log-disk-setting-module) – Settings for local disk logging in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_eventfilter](fortios_log_eventfilter_module#ansible-collections-fortinet-fortios-fortios-log-eventfilter-module) – Configure log event filters in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fact](fortios_log_fact_module#ansible-collections-fortinet-fortios-fortios-log-fact-module) – Retrieve log data of fortios log objects.
* [fortios\_log\_fortianalyzer2\_filter](fortios_log_fortianalyzer2_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer2-filter-module) – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer2\_override\_filter](fortios_log_fortianalyzer2_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer2-override-filter-module) – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer2\_override\_setting](fortios_log_fortianalyzer2_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer2-override-setting-module) – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer2\_setting](fortios_log_fortianalyzer2_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer2-setting-module) – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer3\_filter](fortios_log_fortianalyzer3_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer3-filter-module) – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer3\_override\_filter](fortios_log_fortianalyzer3_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer3-override-filter-module) – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer3\_override\_setting](fortios_log_fortianalyzer3_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer3-override-setting-module) – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer3\_setting](fortios_log_fortianalyzer3_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer3-setting-module) – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_cloud\_filter](fortios_log_fortianalyzer_cloud_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-cloud-filter-module) – Filters for FortiAnalyzer Cloud in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_cloud\_override\_filter](fortios_log_fortianalyzer_cloud_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-cloud-override-filter-module) – Override filters for FortiAnalyzer Cloud in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_cloud\_override\_setting](fortios_log_fortianalyzer_cloud_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-cloud-override-setting-module) – Override FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_cloud\_setting](fortios_log_fortianalyzer_cloud_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-cloud-setting-module) – Global FortiAnalyzer Cloud settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_filter](fortios_log_fortianalyzer_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-filter-module) – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_override\_filter](fortios_log_fortianalyzer_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-override-filter-module) – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_override\_setting](fortios_log_fortianalyzer_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-override-setting-module) – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortianalyzer\_setting](fortios_log_fortianalyzer_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortianalyzer-setting-module) – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortiguard\_filter](fortios_log_fortiguard_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortiguard-filter-module) – Filters for FortiCloud in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortiguard\_override\_filter](fortios_log_fortiguard_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-fortiguard-override-filter-module) – Override filters for FortiCloud in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortiguard\_override\_setting](fortios_log_fortiguard_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortiguard-override-setting-module) – Override global FortiCloud logging settings for this VDOM in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_fortiguard\_setting](fortios_log_fortiguard_setting_module#ansible-collections-fortinet-fortios-fortios-log-fortiguard-setting-module) – Configure logging to FortiCloud in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_gui\_display](fortios_log_gui_display_module#ansible-collections-fortinet-fortios-fortios-log-gui-display-module) – Configure how log messages are displayed on the GUI in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_memory\_filter](fortios_log_memory_filter_module#ansible-collections-fortinet-fortios-fortios-log-memory-filter-module) – Filters for memory buffer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_memory\_global\_setting](fortios_log_memory_global_setting_module#ansible-collections-fortinet-fortios-fortios-log-memory-global-setting-module) – Global settings for memory logging in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_memory\_setting](fortios_log_memory_setting_module#ansible-collections-fortinet-fortios-fortios-log-memory-setting-module) – Settings for memory buffer in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_null\_device\_filter](fortios_log_null_device_filter_module#ansible-collections-fortinet-fortios-fortios-log-null-device-filter-module) – Filters for null device logging in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_null\_device\_setting](fortios_log_null_device_setting_module#ansible-collections-fortinet-fortios-fortios-log-null-device-setting-module) – Settings for null device logging in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_setting](fortios_log_setting_module#ansible-collections-fortinet-fortios-fortios-log-setting-module) – Configure general log settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd2\_filter](fortios_log_syslogd2_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd2-filter-module) – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd2\_override\_filter](fortios_log_syslogd2_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd2-override-filter-module) – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd2\_override\_setting](fortios_log_syslogd2_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd2-override-setting-module) – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd2\_setting](fortios_log_syslogd2_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd2-setting-module) – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd3\_filter](fortios_log_syslogd3_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd3-filter-module) – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd3\_override\_filter](fortios_log_syslogd3_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd3-override-filter-module) – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd3\_override\_setting](fortios_log_syslogd3_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd3-override-setting-module) – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd3\_setting](fortios_log_syslogd3_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd3-setting-module) – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd4\_filter](fortios_log_syslogd4_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd4-filter-module) – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd4\_override\_filter](fortios_log_syslogd4_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd4-override-filter-module) – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd4\_override\_setting](fortios_log_syslogd4_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd4-override-setting-module) – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd4\_setting](fortios_log_syslogd4_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd4-setting-module) – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd\_filter](fortios_log_syslogd_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd-filter-module) – Filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd\_override\_filter](fortios_log_syslogd_override_filter_module#ansible-collections-fortinet-fortios-fortios-log-syslogd-override-filter-module) – Override filters for remote system server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd\_override\_setting](fortios_log_syslogd_override_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd-override-setting-module) – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_syslogd\_setting](fortios_log_syslogd_setting_module#ansible-collections-fortinet-fortios-fortios-log-syslogd-setting-module) – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_threat\_weight](fortios_log_threat_weight_module#ansible-collections-fortinet-fortios-fortios-log-threat-weight-module) – Configure threat weight settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_webtrends\_filter](fortios_log_webtrends_filter_module#ansible-collections-fortinet-fortios-fortios-log-webtrends-filter-module) – Filters for WebTrends in Fortinet’s FortiOS and FortiGate.
* [fortios\_log\_webtrends\_setting](fortios_log_webtrends_setting_module#ansible-collections-fortinet-fortios-fortios-log-webtrends-setting-module) – Settings for WebTrends in Fortinet’s FortiOS and FortiGate.
* [fortios\_monitor](fortios_monitor_module#ansible-collections-fortinet-fortios-fortios-monitor-module) – Ansible Module for FortiOS Monitor API
* [fortios\_monitor\_fact](fortios_monitor_fact_module#ansible-collections-fortinet-fortios-fortios-monitor-fact-module) – Retrieve Facts of FortiOS Monitor Objects.
* [fortios\_monitoring\_np6\_ipsec\_engine](fortios_monitoring_np6_ipsec_engine_module#ansible-collections-fortinet-fortios-fortios-monitoring-np6-ipsec-engine-module) – Configure NP6 IPsec engine status monitoring in Fortinet’s FortiOS and FortiGate.
* [fortios\_monitoring\_npu\_hpe](fortios_monitoring_npu_hpe_module#ansible-collections-fortinet-fortios-fortios-monitoring-npu-hpe-module) – Configure npu-hpe status monitoring in Fortinet’s FortiOS and FortiGate.
* [fortios\_nsxt\_service\_chain](fortios_nsxt_service_chain_module#ansible-collections-fortinet-fortios-fortios-nsxt-service-chain-module) – Configure NSX-T service chain in Fortinet’s FortiOS and FortiGate.
* [fortios\_nsxt\_setting](fortios_nsxt_setting_module#ansible-collections-fortinet-fortios-fortios-nsxt-setting-module) – Configure NSX-T setting in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_chart](fortios_report_chart_module#ansible-collections-fortinet-fortios-fortios-report-chart-module) – Report chart widget configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_dataset](fortios_report_dataset_module#ansible-collections-fortinet-fortios-fortios-report-dataset-module) – Report dataset configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_layout](fortios_report_layout_module#ansible-collections-fortinet-fortios-fortios-report-layout-module) – Report layout configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_setting](fortios_report_setting_module#ansible-collections-fortinet-fortios-fortios-report-setting-module) – Report setting configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_style](fortios_report_style_module#ansible-collections-fortinet-fortios-fortios-report-style-module) – Report style configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_report\_theme](fortios_report_theme_module#ansible-collections-fortinet-fortios-fortios-report-theme-module) – Report themes configuratio in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_access\_list](fortios_router_access_list_module#ansible-collections-fortinet-fortios-fortios-router-access-list-module) – Configure access lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_access\_list6](fortios_router_access_list6_module#ansible-collections-fortinet-fortios-fortios-router-access-list6-module) – Configure IPv6 access lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_aspath\_list](fortios_router_aspath_list_module#ansible-collections-fortinet-fortios-fortios-router-aspath-list-module) – Configure Autonomous System (AS) path lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_auth\_path](fortios_router_auth_path_module#ansible-collections-fortinet-fortios-fortios-router-auth-path-module) – Configure authentication based routing in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_bfd](fortios_router_bfd_module#ansible-collections-fortinet-fortios-fortios-router-bfd-module) – Configure BFD in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_bfd6](fortios_router_bfd6_module#ansible-collections-fortinet-fortios-fortios-router-bfd6-module) – Configure IPv6 BFD in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_bgp](fortios_router_bgp_module#ansible-collections-fortinet-fortios-fortios-router-bgp-module) – Configure BGP in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_community\_list](fortios_router_community_list_module#ansible-collections-fortinet-fortios-fortios-router-community-list-module) – Configure community lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_isis](fortios_router_isis_module#ansible-collections-fortinet-fortios-fortios-router-isis-module) – Configure IS-IS in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_key\_chain](fortios_router_key_chain_module#ansible-collections-fortinet-fortios-fortios-router-key-chain-module) – Configure key-chain in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_multicast](fortios_router_multicast_module#ansible-collections-fortinet-fortios-fortios-router-multicast-module) – Configure router multicast in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_multicast6](fortios_router_multicast6_module#ansible-collections-fortinet-fortios-fortios-router-multicast6-module) – Configure IPv6 multicast in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_multicast\_flow](fortios_router_multicast_flow_module#ansible-collections-fortinet-fortios-fortios-router-multicast-flow-module) – Configure multicast-flow in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_ospf](fortios_router_ospf_module#ansible-collections-fortinet-fortios-fortios-router-ospf-module) – Configure OSPF in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_ospf6](fortios_router_ospf6_module#ansible-collections-fortinet-fortios-fortios-router-ospf6-module) – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_policy](fortios_router_policy_module#ansible-collections-fortinet-fortios-fortios-router-policy-module) – Configure IPv4 routing policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_policy6](fortios_router_policy6_module#ansible-collections-fortinet-fortios-fortios-router-policy6-module) – Configure IPv6 routing policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_prefix\_list](fortios_router_prefix_list_module#ansible-collections-fortinet-fortios-fortios-router-prefix-list-module) – Configure IPv4 prefix lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_prefix\_list6](fortios_router_prefix_list6_module#ansible-collections-fortinet-fortios-fortios-router-prefix-list6-module) – Configure IPv6 prefix lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_rip](fortios_router_rip_module#ansible-collections-fortinet-fortios-fortios-router-rip-module) – Configure RIP in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_ripng](fortios_router_ripng_module#ansible-collections-fortinet-fortios-fortios-router-ripng-module) – Configure RIPng in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_route\_map](fortios_router_route_map_module#ansible-collections-fortinet-fortios-fortios-router-route-map-module) – Configure route maps in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_setting](fortios_router_setting_module#ansible-collections-fortinet-fortios-fortios-router-setting-module) – Configure router settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_static](fortios_router_static_module#ansible-collections-fortinet-fortios-fortios-router-static-module) – Configure IPv4 static routing tables in Fortinet’s FortiOS and FortiGate.
* [fortios\_router\_static6](fortios_router_static6_module#ansible-collections-fortinet-fortios-fortios-router-static6-module) – Configure IPv6 static routing tables in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_bwl](fortios_spamfilter_bwl_module#ansible-collections-fortinet-fortios-fortios-spamfilter-bwl-module) – Configure anti-spam black/white list in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_bword](fortios_spamfilter_bword_module#ansible-collections-fortinet-fortios-fortios-spamfilter-bword-module) – Configure AntiSpam banned word list in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_dnsbl](fortios_spamfilter_dnsbl_module#ansible-collections-fortinet-fortios-fortios-spamfilter-dnsbl-module) – Configure AntiSpam DNSBL/ORBL in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_fortishield](fortios_spamfilter_fortishield_module#ansible-collections-fortinet-fortios-fortios-spamfilter-fortishield-module) – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_iptrust](fortios_spamfilter_iptrust_module#ansible-collections-fortinet-fortios-fortios-spamfilter-iptrust-module) – Configure AntiSpam IP trust in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_mheader](fortios_spamfilter_mheader_module#ansible-collections-fortinet-fortios-fortios-spamfilter-mheader-module) – Configure AntiSpam MIME header in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_options](fortios_spamfilter_options_module#ansible-collections-fortinet-fortios-fortios-spamfilter-options-module) – Configure AntiSpam options in Fortinet’s FortiOS and FortiGate.
* [fortios\_spamfilter\_profile](fortios_spamfilter_profile_module#ansible-collections-fortinet-fortios-fortios-spamfilter-profile-module) – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_ssh\_filter\_profile](fortios_ssh_filter_profile_module#ansible-collections-fortinet-fortios-fortios-ssh-filter-profile-module) – SSH filter profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_802\_1x\_settings](fortios_switch_controller_802_1x_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-802-1x-settings-module) – Configure global 802.1X settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_auto\_config\_custom](fortios_switch_controller_auto_config_custom_module#ansible-collections-fortinet-fortios-fortios-switch-controller-auto-config-custom-module) – Policies which can override the ‘default’ for specific ISL/ICL/FortiLink interface in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_auto\_config\_default](fortios_switch_controller_auto_config_default_module#ansible-collections-fortinet-fortios-fortios-switch-controller-auto-config-default-module) – Policies which are applied automatically to all ISL/ICL/FortiLink interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_auto\_config\_policy](fortios_switch_controller_auto_config_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-auto-config-policy-module) – Policy definitions which can define the behavior on auto configured interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_custom\_command](fortios_switch_controller_custom_command_module#ansible-collections-fortinet-fortios-fortios-switch-controller-custom-command-module) – Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_dynamic\_port\_policy](fortios_switch_controller_dynamic_port_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-dynamic-port-policy-module) – Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_flow\_tracking](fortios_switch_controller_flow_tracking_module#ansible-collections-fortinet-fortios-fortios-switch-controller-flow-tracking-module) – Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_fortilink\_settings](fortios_switch_controller_fortilink_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-fortilink-settings-module) – Configure integrated FortiLink settings for FortiSwitch in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_global](fortios_switch_controller_global_module#ansible-collections-fortinet-fortios-fortios-switch-controller-global-module) – Configure FortiSwitch global settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_igmp\_snooping](fortios_switch_controller_igmp_snooping_module#ansible-collections-fortinet-fortios-fortios-switch-controller-igmp-snooping-module) – Configure FortiSwitch IGMP snooping global settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_initial\_config\_template](fortios_switch_controller_initial_config_template_module#ansible-collections-fortinet-fortios-fortios-switch-controller-initial-config-template-module) – Configure template for auto-generated VLANs in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_initial\_config\_vlans](fortios_switch_controller_initial_config_vlans_module#ansible-collections-fortinet-fortios-fortios-switch-controller-initial-config-vlans-module) – Configure initial template for auto-generated VLAN interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_lldp\_profile](fortios_switch_controller_lldp_profile_module#ansible-collections-fortinet-fortios-fortios-switch-controller-lldp-profile-module) – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_lldp\_settings](fortios_switch_controller_lldp_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-lldp-settings-module) – Configure FortiSwitch LLDP settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_location](fortios_switch_controller_location_module#ansible-collections-fortinet-fortios-fortios-switch-controller-location-module) – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_mac\_policy](fortios_switch_controller_mac_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-mac-policy-module) – Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_mac\_sync\_settings](fortios_switch_controller_mac_sync_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-mac-sync-settings-module) – Configure global MAC synchronization settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_managed\_switch](fortios_switch_controller_managed_switch_module#ansible-collections-fortinet-fortios-fortios-switch-controller-managed-switch-module) – Configure FortiSwitch devices that are managed by this FortiGate in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_nac\_device](fortios_switch_controller_nac_device_module#ansible-collections-fortinet-fortios-fortios-switch-controller-nac-device-module) – Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_nac\_settings](fortios_switch_controller_nac_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-nac-settings-module) – Configure integrated NAC settings for FortiSwitch in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_network\_monitor\_settings](fortios_switch_controller_network_monitor_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-network-monitor-settings-module) – Configure network monitor settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_poe](fortios_switch_controller_poe_module#ansible-collections-fortinet-fortios-fortios-switch-controller-poe-module) – List PoE end-points status in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_port\_policy](fortios_switch_controller_port_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-port-policy-module) – Configure port policy to be applied on the managed FortiSwitch ports through NAC device in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_ptp\_policy](fortios_switch_controller_ptp_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-ptp-policy-module) – PTP policy configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_ptp\_settings](fortios_switch_controller_ptp_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-ptp-settings-module) – Global PTP settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_qos\_dot1p\_map](fortios_switch_controller_qos_dot1p_map_module#ansible-collections-fortinet-fortios-fortios-switch-controller-qos-dot1p-map-module) – Configure FortiSwitch QoS 802.1p in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_qos\_ip\_dscp\_map](fortios_switch_controller_qos_ip_dscp_map_module#ansible-collections-fortinet-fortios-fortios-switch-controller-qos-ip-dscp-map-module) – Configure FortiSwitch QoS IP precedence/DSCP in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_qos\_qos\_policy](fortios_switch_controller_qos_qos_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-qos-qos-policy-module) – Configure FortiSwitch QoS policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_qos\_queue\_policy](fortios_switch_controller_qos_queue_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-qos-queue-policy-module) – Configure FortiSwitch QoS egress queue policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_quarantine](fortios_switch_controller_quarantine_module#ansible-collections-fortinet-fortios-fortios-switch-controller-quarantine-module) – Configure FortiSwitch quarantine support in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_remote\_log](fortios_switch_controller_remote_log_module#ansible-collections-fortinet-fortios-fortios-switch-controller-remote-log-module) – Configure logging by FortiSwitch device to a remote syslog server in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_security\_policy\_802\_1x](fortios_switch_controller_security_policy_802_1x_module#ansible-collections-fortinet-fortios-fortios-switch-controller-security-policy-802-1x-module) – Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_security\_policy\_captive\_portal](fortios_switch_controller_security_policy_captive_portal_module#ansible-collections-fortinet-fortios-fortios-switch-controller-security-policy-captive-portal-module) – Names of VLANs that use captive portal authentication in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_security\_policy\_local\_access](fortios_switch_controller_security_policy_local_access_module#ansible-collections-fortinet-fortios-fortios-switch-controller-security-policy-local-access-module) – Configure allowaccess list for mgmt and internal interfaces on managed FortiSwitch in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_sflow](fortios_switch_controller_sflow_module#ansible-collections-fortinet-fortios-fortios-switch-controller-sflow-module) – Configure FortiSwitch sFlow in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_snmp\_community](fortios_switch_controller_snmp_community_module#ansible-collections-fortinet-fortios-fortios-switch-controller-snmp-community-module) – Configure FortiSwitch SNMP v1/v2c communities globally in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_snmp\_sysinfo](fortios_switch_controller_snmp_sysinfo_module#ansible-collections-fortinet-fortios-fortios-switch-controller-snmp-sysinfo-module) – Configure FortiSwitch SNMP system information globally in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_snmp\_trap\_threshold](fortios_switch_controller_snmp_trap_threshold_module#ansible-collections-fortinet-fortios-fortios-switch-controller-snmp-trap-threshold-module) – Configure FortiSwitch SNMP trap threshold values globally in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_snmp\_user](fortios_switch_controller_snmp_user_module#ansible-collections-fortinet-fortios-fortios-switch-controller-snmp-user-module) – Configure FortiSwitch SNMP v3 users globally in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_storm\_control](fortios_switch_controller_storm_control_module#ansible-collections-fortinet-fortios-fortios-switch-controller-storm-control-module) – Configure FortiSwitch storm control in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_storm\_control\_policy](fortios_switch_controller_storm_control_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-storm-control-policy-module) – Configure FortiSwitch storm control policy to be applied on managed-switch ports in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_stp\_instance](fortios_switch_controller_stp_instance_module#ansible-collections-fortinet-fortios-fortios-switch-controller-stp-instance-module) – Configure FortiSwitch multiple spanning tree protocol (MSTP) instances in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_stp\_settings](fortios_switch_controller_stp_settings_module#ansible-collections-fortinet-fortios-fortios-switch-controller-stp-settings-module) – Configure FortiSwitch spanning tree protocol (STP) in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_switch\_group](fortios_switch_controller_switch_group_module#ansible-collections-fortinet-fortios-fortios-switch-controller-switch-group-module) – Configure FortiSwitch switch groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_switch\_interface\_tag](fortios_switch_controller_switch_interface_tag_module#ansible-collections-fortinet-fortios-fortios-switch-controller-switch-interface-tag-module) – Configure switch object tags in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_switch\_log](fortios_switch_controller_switch_log_module#ansible-collections-fortinet-fortios-fortios-switch-controller-switch-log-module) – Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log) in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_switch\_profile](fortios_switch_controller_switch_profile_module#ansible-collections-fortinet-fortios-fortios-switch-controller-switch-profile-module) – Configure FortiSwitch switch profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_system](fortios_switch_controller_system_module#ansible-collections-fortinet-fortios-fortios-switch-controller-system-module) – Configure system-wide switch controller settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_traffic\_policy](fortios_switch_controller_traffic_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-traffic-policy-module) – Configure FortiSwitch traffic policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_traffic\_sniffer](fortios_switch_controller_traffic_sniffer_module#ansible-collections-fortinet-fortios-fortios-switch-controller-traffic-sniffer-module) – Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_virtual\_port\_pool](fortios_switch_controller_virtual_port_pool_module#ansible-collections-fortinet-fortios-fortios-switch-controller-virtual-port-pool-module) – Configure virtual pool in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_vlan](fortios_switch_controller_vlan_module#ansible-collections-fortinet-fortios-fortios-switch-controller-vlan-module) – Configure VLANs for switch controller in Fortinet’s FortiOS and FortiGate.
* [fortios\_switch\_controller\_vlan\_policy](fortios_switch_controller_vlan_policy_module#ansible-collections-fortinet-fortios-fortios-switch-controller-vlan-policy-module) – Configure VLAN policy to be applied on the managed FortiSwitch ports through port-policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_3g\_modem\_custom](fortios_system_3g_modem_custom_module#ansible-collections-fortinet-fortios-fortios-system-3g-modem-custom-module) – 3G MODEM custom in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_accprofile](fortios_system_accprofile_module#ansible-collections-fortinet-fortios-fortios-system-accprofile-module) – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_acme](fortios_system_acme_module#ansible-collections-fortinet-fortios-fortios-system-acme-module) – Configure ACME client in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_admin](fortios_system_admin_module#ansible-collections-fortinet-fortios-fortios-system-admin-module) – Configure admin users in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_affinity\_interrupt](fortios_system_affinity_interrupt_module#ansible-collections-fortinet-fortios-fortios-system-affinity-interrupt-module) – Configure interrupt affinity in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_affinity\_packet\_redistribution](fortios_system_affinity_packet_redistribution_module#ansible-collections-fortinet-fortios-fortios-system-affinity-packet-redistribution-module) – Configure packet redistribution in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_alarm](fortios_system_alarm_module#ansible-collections-fortinet-fortios-fortios-system-alarm-module) – Configure alarm in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_alias](fortios_system_alias_module#ansible-collections-fortinet-fortios-fortios-system-alias-module) – Configure alias command in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_api\_user](fortios_system_api_user_module#ansible-collections-fortinet-fortios-fortios-system-api-user-module) – Configure API users in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_arp\_table](fortios_system_arp_table_module#ansible-collections-fortinet-fortios-fortios-system-arp-table-module) – Configure ARP table in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_auto\_install](fortios_system_auto_install_module#ansible-collections-fortinet-fortios-fortios-system-auto-install-module) – Configure USB auto installation in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_auto\_script](fortios_system_auto_script_module#ansible-collections-fortinet-fortios-fortios-system-auto-script-module) – Configure auto script in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_automation\_action](fortios_system_automation_action_module#ansible-collections-fortinet-fortios-fortios-system-automation-action-module) – Action for automation stitches in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_automation\_destination](fortios_system_automation_destination_module#ansible-collections-fortinet-fortios-fortios-system-automation-destination-module) – Automation destinations in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_automation\_stitch](fortios_system_automation_stitch_module#ansible-collections-fortinet-fortios-fortios-system-automation-stitch-module) – Automation stitches in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_automation\_trigger](fortios_system_automation_trigger_module#ansible-collections-fortinet-fortios-fortios-system-automation-trigger-module) – Trigger for automation stitches in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_autoupdate\_push\_update](fortios_system_autoupdate_push_update_module#ansible-collections-fortinet-fortios-fortios-system-autoupdate-push-update-module) – Configure push updates in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_autoupdate\_schedule](fortios_system_autoupdate_schedule_module#ansible-collections-fortinet-fortios-fortios-system-autoupdate-schedule-module) – Configure update schedule in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_autoupdate\_tunneling](fortios_system_autoupdate_tunneling_module#ansible-collections-fortinet-fortios-fortios-system-autoupdate-tunneling-module) – Configure web proxy tunnelling for the FDN in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_central\_management](fortios_system_central_management_module#ansible-collections-fortinet-fortios-fortios-system-central-management-module) – Configure central management in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_cluster\_sync](fortios_system_cluster_sync_module#ansible-collections-fortinet-fortios-fortios-system-cluster-sync-module) – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_console](fortios_system_console_module#ansible-collections-fortinet-fortios-fortios-system-console-module) – Configure console in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_csf](fortios_system_csf_module#ansible-collections-fortinet-fortios-fortios-system-csf-module) –
* [fortios\_system\_custom\_language](fortios_system_custom_language_module#ansible-collections-fortinet-fortios-fortios-system-custom-language-module) – Configure custom languages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ddns](fortios_system_ddns_module#ansible-collections-fortinet-fortios-fortios-system-ddns-module) – Configure DDNS in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dedicated\_mgmt](fortios_system_dedicated_mgmt_module#ansible-collections-fortinet-fortios-fortios-system-dedicated-mgmt-module) – Configure dedicated management in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dhcp6\_server](fortios_system_dhcp6_server_module#ansible-collections-fortinet-fortios-fortios-system-dhcp6-server-module) – Configure DHCPv6 servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dhcp\_server](fortios_system_dhcp_server_module#ansible-collections-fortinet-fortios-fortios-system-dhcp-server-module) – Configure DHCP servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dns](fortios_system_dns_module#ansible-collections-fortinet-fortios-fortios-system-dns-module) – Configure DNS in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dns\_database](fortios_system_dns_database_module#ansible-collections-fortinet-fortios-fortios-system-dns-database-module) – Configure DNS databases in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dns\_server](fortios_system_dns_server_module#ansible-collections-fortinet-fortios-fortios-system-dns-server-module) – Configure DNS servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_dscp\_based\_priority](fortios_system_dscp_based_priority_module#ansible-collections-fortinet-fortios-fortios-system-dscp-based-priority-module) – Configure DSCP based priority table in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_email\_server](fortios_system_email_server_module#ansible-collections-fortinet-fortios-fortios-system-email-server-module) – Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_external\_resource](fortios_system_external_resource_module#ansible-collections-fortinet-fortios-fortios-system-external-resource-module) – Configure external resource in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_federated\_upgrade](fortios_system_federated_upgrade_module#ansible-collections-fortinet-fortios-fortios-system-federated-upgrade-module) – Coordinate federated upgrades within the Security Fabric in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fips\_cc](fortios_system_fips_cc_module#ansible-collections-fortinet-fortios-fortios-system-fips-cc-module) – Configure FIPS-CC mode in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fm](fortios_system_fm_module#ansible-collections-fortinet-fortios-fortios-system-fm-module) – Configure FM in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fortiguard](fortios_system_fortiguard_module#ansible-collections-fortinet-fortios-fortios-system-fortiguard-module) – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fortimanager](fortios_system_fortimanager_module#ansible-collections-fortinet-fortios-fortios-system-fortimanager-module) – Configure FortiManager in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fortisandbox](fortios_system_fortisandbox_module#ansible-collections-fortinet-fortios-fortios-system-fortisandbox-module) – Configure FortiSandbox in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_fsso\_polling](fortios_system_fsso_polling_module#ansible-collections-fortinet-fortios-fortios-system-fsso-polling-module) – Configure Fortinet Single Sign On (FSSO) server in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ftm\_push](fortios_system_ftm_push_module#ansible-collections-fortinet-fortios-fortios-system-ftm-push-module) – Configure FortiToken Mobile push services in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_geneve](fortios_system_geneve_module#ansible-collections-fortinet-fortios-fortios-system-geneve-module) – Configure GENEVE devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_geoip\_country](fortios_system_geoip_country_module#ansible-collections-fortinet-fortios-fortios-system-geoip-country-module) – Define geoip country name-ID table in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_geoip\_override](fortios_system_geoip_override_module#ansible-collections-fortinet-fortios-fortios-system-geoip-override-module) – Configure geographical location mapping for IP address(es) to override mappings from FortiGuard in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_gi\_gk](fortios_system_gi_gk_module#ansible-collections-fortinet-fortios-fortios-system-gi-gk-module) – Configure Gi Firewall Gatekeeper in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_global](fortios_system_global_module#ansible-collections-fortinet-fortios-fortios-system-global-module) – Configure global attributes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_gre\_tunnel](fortios_system_gre_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-gre-tunnel-module) – Configure GRE tunnel in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ha](fortios_system_ha_module#ansible-collections-fortinet-fortios-fortios-system-ha-module) – Configure HA in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ha\_monitor](fortios_system_ha_monitor_module#ansible-collections-fortinet-fortios-fortios-system-ha-monitor-module) – Configure HA monitor in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ike](fortios_system_ike_module#ansible-collections-fortinet-fortios-fortios-system-ike-module) – Configure IKE global attributes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_interface](fortios_system_interface_module#ansible-collections-fortinet-fortios-fortios-system-interface-module) – Configure interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ipip\_tunnel](fortios_system_ipip_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-ipip-tunnel-module) – Configure IP in IP Tunneling in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ips](fortios_system_ips_module#ansible-collections-fortinet-fortios-fortios-system-ips-module) – Configure IPS system settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ips\_urlfilter\_dns](fortios_system_ips_urlfilter_dns_module#ansible-collections-fortinet-fortios-fortios-system-ips-urlfilter-dns-module) – Configure IPS URL filter DNS servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ips\_urlfilter\_dns6](fortios_system_ips_urlfilter_dns6_module#ansible-collections-fortinet-fortios-fortios-system-ips-urlfilter-dns6-module) – Configure IPS URL filter IPv6 DNS servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ipsec\_aggregate](fortios_system_ipsec_aggregate_module#ansible-collections-fortinet-fortios-fortios-system-ipsec-aggregate-module) – Configure an aggregate of IPsec tunnels in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ipv6\_neighbor\_cache](fortios_system_ipv6_neighbor_cache_module#ansible-collections-fortinet-fortios-fortios-system-ipv6-neighbor-cache-module) – Configure IPv6 neighbor cache table in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ipv6\_tunnel](fortios_system_ipv6_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-ipv6-tunnel-module) – Configure IPv6/IPv4 in IPv6 tunnel in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_isf\_queue\_profile](fortios_system_isf_queue_profile_module#ansible-collections-fortinet-fortios-fortios-system-isf-queue-profile-module) – Create a queue profile of switch in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_link\_monitor](fortios_system_link_monitor_module#ansible-collections-fortinet-fortios-fortios-system-link-monitor-module) – Configure Link Health Monitor in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_lldp\_network\_policy](fortios_system_lldp_network_policy_module#ansible-collections-fortinet-fortios-fortios-system-lldp-network-policy-module) – Configure LLDP network policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_lte\_modem](fortios_system_lte_modem_module#ansible-collections-fortinet-fortios-fortios-system-lte-modem-module) – Configure USB LTE/WIMAX devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_mac\_address\_table](fortios_system_mac_address_table_module#ansible-collections-fortinet-fortios-fortios-system-mac-address-table-module) – Configure MAC address tables in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_management\_tunnel](fortios_system_management_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-management-tunnel-module) – Management tunnel configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_mem\_mgr](fortios_system_mem_mgr_module#ansible-collections-fortinet-fortios-fortios-system-mem-mgr-module) – Configure memory manager in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_mobile\_tunnel](fortios_system_mobile_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-mobile-tunnel-module) – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_modem](fortios_system_modem_module#ansible-collections-fortinet-fortios-fortios-system-modem-module) – Configure MODEM in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_nat64](fortios_system_nat64_module#ansible-collections-fortinet-fortios-fortios-system-nat64-module) – Configure NAT64 in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_nd\_proxy](fortios_system_nd_proxy_module#ansible-collections-fortinet-fortios-fortios-system-nd-proxy-module) – Configure IPv6 neighbor discovery proxy (RFC4389) in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_netflow](fortios_system_netflow_module#ansible-collections-fortinet-fortios-fortios-system-netflow-module) – Configure NetFlow in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_network\_visibility](fortios_system_network_visibility_module#ansible-collections-fortinet-fortios-fortios-system-network-visibility-module) – Configure network visibility settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_np6](fortios_system_np6_module#ansible-collections-fortinet-fortios-fortios-system-np6-module) – Configure NP6 attributes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_npu](fortios_system_npu_module#ansible-collections-fortinet-fortios-fortios-system-npu-module) – Configure NPU attributes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ntp](fortios_system_ntp_module#ansible-collections-fortinet-fortios-fortios-system-ntp-module) – Configure system NTP information in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_object\_tagging](fortios_system_object_tagging_module#ansible-collections-fortinet-fortios-fortios-system-object-tagging-module) – Configure object tagging in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_password\_policy](fortios_system_password_policy_module#ansible-collections-fortinet-fortios-fortios-system-password-policy-module) – Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_password\_policy\_guest\_admin](fortios_system_password_policy_guest_admin_module#ansible-collections-fortinet-fortios-fortios-system-password-policy-guest-admin-module) – Configure the password policy for guest administrators in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_performance\_top](fortios_system_performance_top_module#ansible-collections-fortinet-fortios-fortios-system-performance-top-module) – Display information about the top CPU processes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_physical\_switch](fortios_system_physical_switch_module#ansible-collections-fortinet-fortios-fortios-system-physical-switch-module) – Configure physical switches in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_pppoe\_interface](fortios_system_pppoe_interface_module#ansible-collections-fortinet-fortios-fortios-system-pppoe-interface-module) – Configure the PPPoE interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_probe\_response](fortios_system_probe_response_module#ansible-collections-fortinet-fortios-fortios-system-probe-response-module) – Configure system probe response in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_proxy\_arp](fortios_system_proxy_arp_module#ansible-collections-fortinet-fortios-fortios-system-proxy-arp-module) – Configure proxy-ARP in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_ptp](fortios_system_ptp_module#ansible-collections-fortinet-fortios-fortios-system-ptp-module) – Configure system PTP information in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_admin](fortios_system_replacemsg_admin_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-admin-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_alertmail](fortios_system_replacemsg_alertmail_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-alertmail-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_auth](fortios_system_replacemsg_auth_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-auth-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_automation](fortios_system_replacemsg_automation_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-automation-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_device\_detection\_portal](fortios_system_replacemsg_device_detection_portal_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-device-detection-portal-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_ec](fortios_system_replacemsg_ec_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-ec-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_fortiguard\_wf](fortios_system_replacemsg_fortiguard_wf_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-fortiguard-wf-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_ftp](fortios_system_replacemsg_ftp_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-ftp-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_group](fortios_system_replacemsg_group_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-group-module) – Configure replacement message groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_http](fortios_system_replacemsg_http_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-http-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_icap](fortios_system_replacemsg_icap_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-icap-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_image](fortios_system_replacemsg_image_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-image-module) – Configure replacement message images in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mail](fortios_system_replacemsg_mail_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mail-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mm1](fortios_system_replacemsg_mm1_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mm1-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mm3](fortios_system_replacemsg_mm3_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mm3-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mm4](fortios_system_replacemsg_mm4_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mm4-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mm7](fortios_system_replacemsg_mm7_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mm7-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_mms](fortios_system_replacemsg_mms_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-mms-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_nac\_quar](fortios_system_replacemsg_nac_quar_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-nac-quar-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_nntp](fortios_system_replacemsg_nntp_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-nntp-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_spam](fortios_system_replacemsg_spam_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-spam-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_sslvpn](fortios_system_replacemsg_sslvpn_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-sslvpn-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_traffic\_quota](fortios_system_replacemsg_traffic_quota_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-traffic-quota-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_utm](fortios_system_replacemsg_utm_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-utm-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_replacemsg\_webproxy](fortios_system_replacemsg_webproxy_module#ansible-collections-fortinet-fortios-fortios-system-replacemsg-webproxy-module) – Replacement messages in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_resource\_limits](fortios_system_resource_limits_module#ansible-collections-fortinet-fortios-fortios-system-resource-limits-module) – Configure resource limits in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_saml](fortios_system_saml_module#ansible-collections-fortinet-fortios-fortios-system-saml-module) – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sdn\_connector](fortios_system_sdn_connector_module#ansible-collections-fortinet-fortios-fortios-system-sdn-connector-module) –
* [fortios\_system\_sdwan](fortios_system_sdwan_module#ansible-collections-fortinet-fortios-fortios-system-sdwan-module) – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_session\_helper](fortios_system_session_helper_module#ansible-collections-fortinet-fortios-fortios-system-session-helper-module) – Configure session helper in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_session\_ttl](fortios_system_session_ttl_module#ansible-collections-fortinet-fortios-fortios-system-session-ttl-module) – Configure global session TTL timers for this FortiGate in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_settings](fortios_system_settings_module#ansible-collections-fortinet-fortios-fortios-system-settings-module) – Configure VDOM settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sflow](fortios_system_sflow_module#ansible-collections-fortinet-fortios-fortios-system-sflow-module) – Configure sFlow in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sit\_tunnel](fortios_system_sit_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-sit-tunnel-module) – Configure IPv6 tunnel over IPv4 in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_smc\_ntp](fortios_system_smc_ntp_module#ansible-collections-fortinet-fortios-fortios-system-smc-ntp-module) – Configure SMC NTP information in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sms\_server](fortios_system_sms_server_module#ansible-collections-fortinet-fortios-fortios-system-sms-server-module) – Configure SMS server for sending SMS messages to support user authentication in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_snmp\_community](fortios_system_snmp_community_module#ansible-collections-fortinet-fortios-fortios-system-snmp-community-module) – SNMP community configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_snmp\_sysinfo](fortios_system_snmp_sysinfo_module#ansible-collections-fortinet-fortios-fortios-system-snmp-sysinfo-module) – SNMP system info configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_snmp\_user](fortios_system_snmp_user_module#ansible-collections-fortinet-fortios-fortios-system-snmp-user-module) – SNMP user configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_speed\_test\_schedule](fortios_system_speed_test_schedule_module#ansible-collections-fortinet-fortios-fortios-system-speed-test-schedule-module) – Speed test schedule for each interface in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_speed\_test\_server](fortios_system_speed_test_server_module#ansible-collections-fortinet-fortios-fortios-system-speed-test-server-module) – Configure speed test server list in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sso\_admin](fortios_system_sso_admin_module#ansible-collections-fortinet-fortios-fortios-system-sso-admin-module) – Configure SSO admin users in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_sso\_forticloud\_admin](fortios_system_sso_forticloud_admin_module#ansible-collections-fortinet-fortios-fortios-system-sso-forticloud-admin-module) – Configure FortiCloud SSO admin users in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_standalone\_cluster](fortios_system_standalone_cluster_module#ansible-collections-fortinet-fortios-fortios-system-standalone-cluster-module) – Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_storage](fortios_system_storage_module#ansible-collections-fortinet-fortios-fortios-system-storage-module) – Configure logical storage in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_stp](fortios_system_stp_module#ansible-collections-fortinet-fortios-fortios-system-stp-module) – Configure Spanning Tree Protocol (STP) in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_switch\_interface](fortios_system_switch_interface_module#ansible-collections-fortinet-fortios-fortios-system-switch-interface-module) – Configure software switch interfaces by grouping physical and WiFi interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_tos\_based\_priority](fortios_system_tos_based_priority_module#ansible-collections-fortinet-fortios-fortios-system-tos-based-priority-module) – Configure Type of Service (ToS) based priority table to set network traffic priorities in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom](fortios_system_vdom_module#ansible-collections-fortinet-fortios-fortios-system-vdom-module) – Configure virtual domain in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_dns](fortios_system_vdom_dns_module#ansible-collections-fortinet-fortios-fortios-system-vdom-dns-module) – Configure DNS servers for a non-management VDOM in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_exception](fortios_system_vdom_exception_module#ansible-collections-fortinet-fortios-fortios-system-vdom-exception-module) – Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_link](fortios_system_vdom_link_module#ansible-collections-fortinet-fortios-fortios-system-vdom-link-module) – Configure VDOM links in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_netflow](fortios_system_vdom_netflow_module#ansible-collections-fortinet-fortios-fortios-system-vdom-netflow-module) – Configure NetFlow per VDOM in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_property](fortios_system_vdom_property_module#ansible-collections-fortinet-fortios-fortios-system-vdom-property-module) – Configure VDOM property in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_radius\_server](fortios_system_vdom_radius_server_module#ansible-collections-fortinet-fortios-fortios-system-vdom-radius-server-module) – Configure a RADIUS server to use as a RADIUS Single Sign On (RSSO) server for this VDOM in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vdom\_sflow](fortios_system_vdom_sflow_module#ansible-collections-fortinet-fortios-fortios-system-vdom-sflow-module) – Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow collector in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_virtual\_switch](fortios_system_virtual_switch_module#ansible-collections-fortinet-fortios-fortios-system-virtual-switch-module) – Configure virtual hardware switch interfaces in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_virtual\_wan\_link](fortios_system_virtual_wan_link_module#ansible-collections-fortinet-fortios-fortios-system-virtual-wan-link-module) – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_virtual\_wire\_pair](fortios_system_virtual_wire_pair_module#ansible-collections-fortinet-fortios-fortios-system-virtual-wire-pair-module) – Configure virtual wire pairs in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vne\_tunnel](fortios_system_vne_tunnel_module#ansible-collections-fortinet-fortios-fortios-system-vne-tunnel-module) – Configure virtual network enabler tunnel in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_vxlan](fortios_system_vxlan_module#ansible-collections-fortinet-fortios-fortios-system-vxlan-module) – Configure VXLAN devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_wccp](fortios_system_wccp_module#ansible-collections-fortinet-fortios-fortios-system-wccp-module) – Configure WCCP in Fortinet’s FortiOS and FortiGate.
* [fortios\_system\_zone](fortios_system_zone_module#ansible-collections-fortinet-fortios-fortios-system-zone-module) – Configure zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in the zone in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_adgrp](fortios_user_adgrp_module#ansible-collections-fortinet-fortios-fortios-user-adgrp-module) – Configure FSSO groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_device](fortios_user_device_module#ansible-collections-fortinet-fortios-fortios-user-device-module) – Configure devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_device\_access\_list](fortios_user_device_access_list_module#ansible-collections-fortinet-fortios-fortios-user-device-access-list-module) – Configure device access control lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_device\_category](fortios_user_device_category_module#ansible-collections-fortinet-fortios-fortios-user-device-category-module) – Configure device categories in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_device\_group](fortios_user_device_group_module#ansible-collections-fortinet-fortios-fortios-user-device-group-module) – Configure device groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_domain\_controller](fortios_user_domain_controller_module#ansible-collections-fortinet-fortios-fortios-user-domain-controller-module) – Configure domain controller entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_exchange](fortios_user_exchange_module#ansible-collections-fortinet-fortios-fortios-user-exchange-module) – Configure MS Exchange server entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_fortitoken](fortios_user_fortitoken_module#ansible-collections-fortinet-fortios-fortios-user-fortitoken-module) – Configure FortiToken in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_fsso](fortios_user_fsso_module#ansible-collections-fortinet-fortios-fortios-user-fsso-module) – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_fsso\_polling](fortios_user_fsso_polling_module#ansible-collections-fortinet-fortios-fortios-user-fsso-polling-module) – Configure FSSO active directory servers for polling mode in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_group](fortios_user_group_module#ansible-collections-fortinet-fortios-fortios-user-group-module) – Configure user groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_krb\_keytab](fortios_user_krb_keytab_module#ansible-collections-fortinet-fortios-fortios-user-krb-keytab-module) – Configure Kerberos keytab entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_ldap](fortios_user_ldap_module#ansible-collections-fortinet-fortios-fortios-user-ldap-module) – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_local](fortios_user_local_module#ansible-collections-fortinet-fortios-fortios-user-local-module) – Configure local users in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_nac\_policy](fortios_user_nac_policy_module#ansible-collections-fortinet-fortios-fortios-user-nac-policy-module) – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_password\_policy](fortios_user_password_policy_module#ansible-collections-fortinet-fortios-fortios-user-password-policy-module) – Configure user password policy in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_peer](fortios_user_peer_module#ansible-collections-fortinet-fortios-fortios-user-peer-module) – Configure peer users in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_peergrp](fortios_user_peergrp_module#ansible-collections-fortinet-fortios-fortios-user-peergrp-module) – Configure peer groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_pop3](fortios_user_pop3_module#ansible-collections-fortinet-fortios-fortios-user-pop3-module) – POP3 server entry configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_quarantine](fortios_user_quarantine_module#ansible-collections-fortinet-fortios-fortios-user-quarantine-module) – Configure quarantine support in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_radius](fortios_user_radius_module#ansible-collections-fortinet-fortios-fortios-user-radius-module) – Configure RADIUS server entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_saml](fortios_user_saml_module#ansible-collections-fortinet-fortios-fortios-user-saml-module) – SAML server entry configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_security\_exempt\_list](fortios_user_security_exempt_list_module#ansible-collections-fortinet-fortios-fortios-user-security-exempt-list-module) – Configure security exemption list in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_setting](fortios_user_setting_module#ansible-collections-fortinet-fortios-fortios-user-setting-module) – Configure user authentication setting in Fortinet’s FortiOS and FortiGate.
* [fortios\_user\_tacacsplus](fortios_user_tacacsplus_module#ansible-collections-fortinet-fortios-fortios-user-tacacsplus-module) – Configure TACACS+ server entries in Fortinet’s FortiOS and FortiGate.
* [fortios\_videofilter\_profile](fortios_videofilter_profile_module#ansible-collections-fortinet-fortios-fortios-videofilter-profile-module) – Configure VideoFilter profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_videofilter\_youtube\_channel\_filter](fortios_videofilter_youtube_channel_filter_module#ansible-collections-fortinet-fortios-fortios-videofilter-youtube-channel-filter-module) – Configure YouTube channel filter in Fortinet’s FortiOS and FortiGate.
* [fortios\_videofilter\_youtube\_key](fortios_videofilter_youtube_key_module#ansible-collections-fortinet-fortios-fortios-videofilter-youtube-key-module) – Configure YouTube API keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_voip\_profile](fortios_voip_profile_module#ansible-collections-fortinet-fortios-fortios-voip-profile-module) – Configure VoIP profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_ca](fortios_vpn_certificate_ca_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-ca-module) – CA certificate in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_crl](fortios_vpn_certificate_crl_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-crl-module) – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_local](fortios_vpn_certificate_local_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-local-module) – Local keys and certificates in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_ocsp\_server](fortios_vpn_certificate_ocsp_server_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-ocsp-server-module) – OCSP server configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_remote](fortios_vpn_certificate_remote_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-remote-module) – Remote certificate as a PEM file in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_certificate\_setting](fortios_vpn_certificate_setting_module#ansible-collections-fortinet-fortios-fortios-vpn-certificate-setting-module) – VPN certificate setting in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ike\_gateway](fortios_vpn_ike_gateway_module#ansible-collections-fortinet-fortios-fortios-vpn-ike-gateway-module) – List gateways in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_concentrator](fortios_vpn_ipsec_concentrator_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-concentrator-module) – Concentrator configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_forticlient](fortios_vpn_ipsec_forticlient_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-forticlient-module) – Configure FortiClient policy realm in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_manualkey](fortios_vpn_ipsec_manualkey_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-manualkey-module) – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_manualkey\_interface](fortios_vpn_ipsec_manualkey_interface_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-manualkey-interface-module) – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_phase1](fortios_vpn_ipsec_phase1_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-phase1-module) – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_phase1\_interface](fortios_vpn_ipsec_phase1_interface_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-phase1-interface-module) – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_phase2](fortios_vpn_ipsec_phase2_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-phase2-module) – Configure VPN autokey tunnel in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ipsec\_phase2\_interface](fortios_vpn_ipsec_phase2_interface_module#ansible-collections-fortinet-fortios-fortios-vpn-ipsec-phase2-interface-module) – Configure VPN autokey tunnel in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_l2tp](fortios_vpn_l2tp_module#ansible-collections-fortinet-fortios-fortios-vpn-l2tp-module) – Configure L2TP in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ocvpn](fortios_vpn_ocvpn_module#ansible-collections-fortinet-fortios-fortios-vpn-ocvpn-module) – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_pptp](fortios_vpn_pptp_module#ansible-collections-fortinet-fortios-fortios-vpn-pptp-module) – Configure PPTP in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_client](fortios_vpn_ssl_client_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-client-module) – clien in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_settings](fortios_vpn_ssl_settings_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-settings-module) – Configure SSL VPN in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_web\_host\_check\_software](fortios_vpn_ssl_web_host_check_software_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-web-host-check-software-module) – SSL-VPN host check software in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_web\_portal](fortios_vpn_ssl_web_portal_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-web-portal-module) – Portal in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_web\_realm](fortios_vpn_ssl_web_realm_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-web-realm-module) – Realm in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_web\_user\_bookmark](fortios_vpn_ssl_web_user_bookmark_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-web-user-bookmark-module) – Configure SSL VPN user bookmark in Fortinet’s FortiOS and FortiGate.
* [fortios\_vpn\_ssl\_web\_user\_group\_bookmark](fortios_vpn_ssl_web_user_group_bookmark_module#ansible-collections-fortinet-fortios-fortios-vpn-ssl-web-user-group-bookmark-module) – Configure SSL VPN user group bookmark in Fortinet’s FortiOS and FortiGate.
* [fortios\_waf\_main\_class](fortios_waf_main_class_module#ansible-collections-fortinet-fortios-fortios-waf-main-class-module) – Hidden table for datasource in Fortinet’s FortiOS and FortiGate.
* [fortios\_waf\_profile](fortios_waf_profile_module#ansible-collections-fortinet-fortios-fortios-waf-profile-module) – Web application firewall configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_waf\_signature](fortios_waf_signature_module#ansible-collections-fortinet-fortios-fortios-waf-signature-module) – Hidden table for datasource in Fortinet’s FortiOS and FortiGate.
* [fortios\_waf\_sub\_class](fortios_waf_sub_class_module#ansible-collections-fortinet-fortios-fortios-waf-sub-class-module) – Hidden table for datasource in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_auth\_group](fortios_wanopt_auth_group_module#ansible-collections-fortinet-fortios-fortios-wanopt-auth-group-module) – Configure WAN optimization authentication groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_cache\_service](fortios_wanopt_cache_service_module#ansible-collections-fortinet-fortios-fortios-wanopt-cache-service-module) – Designate cache-service for wan-optimization and webcache in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_content\_delivery\_network\_rule](fortios_wanopt_content_delivery_network_rule_module#ansible-collections-fortinet-fortios-fortios-wanopt-content-delivery-network-rule-module) – Configure WAN optimization content delivery network rules in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_peer](fortios_wanopt_peer_module#ansible-collections-fortinet-fortios-fortios-wanopt-peer-module) – Configure WAN optimization peers in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_profile](fortios_wanopt_profile_module#ansible-collections-fortinet-fortios-fortios-wanopt-profile-module) – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_remote\_storage](fortios_wanopt_remote_storage_module#ansible-collections-fortinet-fortios-fortios-wanopt-remote-storage-module) – Configure a remote cache device as Web cache storage in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_settings](fortios_wanopt_settings_module#ansible-collections-fortinet-fortios-fortios-wanopt-settings-module) – Configure WAN optimization settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_wanopt\_webcache](fortios_wanopt_webcache_module#ansible-collections-fortinet-fortios-fortios-wanopt-webcache-module) – Configure global Web cache settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_debug\_url](fortios_web_proxy_debug_url_module#ansible-collections-fortinet-fortios-fortios-web-proxy-debug-url-module) – Configure debug URL addresses in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_explicit](fortios_web_proxy_explicit_module#ansible-collections-fortinet-fortios-fortios-web-proxy-explicit-module) – Configure explicit Web proxy settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_forward\_server](fortios_web_proxy_forward_server_module#ansible-collections-fortinet-fortios-fortios-web-proxy-forward-server-module) – Configure forward-server addresses in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_forward\_server\_group](fortios_web_proxy_forward_server_group_module#ansible-collections-fortinet-fortios-fortios-web-proxy-forward-server-group-module) – Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_global](fortios_web_proxy_global_module#ansible-collections-fortinet-fortios-fortios-web-proxy-global-module) – Configure Web proxy global settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_profile](fortios_web_proxy_profile_module#ansible-collections-fortinet-fortios-fortios-web-proxy-profile-module) – Configure web proxy profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_url\_match](fortios_web_proxy_url_match_module#ansible-collections-fortinet-fortios-fortios-web-proxy-url-match-module) – Exempt URLs from web proxy forwarding and caching in Fortinet’s FortiOS and FortiGate.
* [fortios\_web\_proxy\_wisp](fortios_web_proxy_wisp_module#ansible-collections-fortinet-fortios-fortios-web-proxy-wisp-module) – Configure Wireless Internet service provider (WISP) servers in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_content](fortios_webfilter_content_module#ansible-collections-fortinet-fortios-fortios-webfilter-content-module) – Configure Web filter banned word table in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_content\_header](fortios_webfilter_content_header_module#ansible-collections-fortinet-fortios-fortios-webfilter-content-header-module) – Configure content types used by Web filter in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_fortiguard](fortios_webfilter_fortiguard_module#ansible-collections-fortinet-fortios-fortios-webfilter-fortiguard-module) – Configure FortiGuard Web Filter service in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_ftgd\_local\_cat](fortios_webfilter_ftgd_local_cat_module#ansible-collections-fortinet-fortios-fortios-webfilter-ftgd-local-cat-module) – Configure FortiGuard Web Filter local categories in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_ftgd\_local\_rating](fortios_webfilter_ftgd_local_rating_module#ansible-collections-fortinet-fortios-fortios-webfilter-ftgd-local-rating-module) – Configure local FortiGuard Web Filter local ratings in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_ips\_urlfilter\_cache\_setting](fortios_webfilter_ips_urlfilter_cache_setting_module#ansible-collections-fortinet-fortios-fortios-webfilter-ips-urlfilter-cache-setting-module) – Configure IPS URL filter cache settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_ips\_urlfilter\_setting](fortios_webfilter_ips_urlfilter_setting_module#ansible-collections-fortinet-fortios-fortios-webfilter-ips-urlfilter-setting-module) – Configure IPS URL filter settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_ips\_urlfilter\_setting6](fortios_webfilter_ips_urlfilter_setting6_module#ansible-collections-fortinet-fortios-fortios-webfilter-ips-urlfilter-setting6-module) – Configure IPS URL filter settings for IPv6 in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_override](fortios_webfilter_override_module#ansible-collections-fortinet-fortios-fortios-webfilter-override-module) – Configure FortiGuard Web Filter administrative overrides in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_profile](fortios_webfilter_profile_module#ansible-collections-fortinet-fortios-fortios-webfilter-profile-module) – Configure Web filter profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_search\_engine](fortios_webfilter_search_engine_module#ansible-collections-fortinet-fortios-fortios-webfilter-search-engine-module) – Configure web filter search engines in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_status](fortios_webfilter_status_module#ansible-collections-fortinet-fortios-fortios-webfilter-status-module) – Display rating info in Fortinet’s FortiOS and FortiGate.
* [fortios\_webfilter\_urlfilter](fortios_webfilter_urlfilter_module#ansible-collections-fortinet-fortios-fortios-webfilter-urlfilter-module) – Configure URL filter lists in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_access\_control\_list](fortios_wireless_controller_access_control_list_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-access-control-list-module) – Configure WiFi bridge access control list in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_address](fortios_wireless_controller_address_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-address-module) – Configure the client with its MAC address in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_addrgrp](fortios_wireless_controller_addrgrp_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-addrgrp-module) – Configure the MAC address group in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_ap\_status](fortios_wireless_controller_ap_status_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-ap-status-module) – Configure access point status (rogue | accepted | suppressed) in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_apcfg\_profile](fortios_wireless_controller_apcfg_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-apcfg-profile-module) – Configure AP local configuration profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_arrp\_profile](fortios_wireless_controller_arrp_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-arrp-profile-module) – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_ble\_profile](fortios_wireless_controller_ble_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-ble-profile-module) – Configure Bluetooth Low Energy profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_bonjour\_profile](fortios_wireless_controller_bonjour_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-bonjour-profile-module) – 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.
* [fortios\_wireless\_controller\_client\_info](fortios_wireless_controller_client_info_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-client-info-module) – Wireless controller client-info in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_global](fortios_wireless_controller_global_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-global-module) – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_3gpp\_cellular](fortios_wireless_controller_hotspot20_anqp_3gpp_cellular_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-3gpp-cellular-module) – Configure 3GPP public land mobile network (PLMN) in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_ip\_address\_type](fortios_wireless_controller_hotspot20_anqp_ip_address_type_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-ip-address-type-module) – Configure IP address type availability in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_nai\_realm](fortios_wireless_controller_hotspot20_anqp_nai_realm_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-nai-realm-module) – Configure network access identifier (NAI) realm in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_network\_auth\_type](fortios_wireless_controller_hotspot20_anqp_network_auth_type_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-network-auth-type-module) – Configure network authentication type in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_roaming\_consortium](fortios_wireless_controller_hotspot20_anqp_roaming_consortium_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-roaming-consortium-module) – Configure roaming consortium in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_anqp\_venue\_name](fortios_wireless_controller_hotspot20_anqp_venue_name_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-anqp-venue-name-module) – Configure venue name duple in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_h2qp\_conn\_capability](fortios_wireless_controller_hotspot20_h2qp_conn_capability_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-h2qp-conn-capability-module) – Configure connection capability in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_h2qp\_operator\_name](fortios_wireless_controller_hotspot20_h2qp_operator_name_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-h2qp-operator-name-module) – Configure operator friendly name in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_h2qp\_osu\_provider](fortios_wireless_controller_hotspot20_h2qp_osu_provider_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-h2qp-osu-provider-module) – Configure online sign up (OSU) provider list in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_h2qp\_wan\_metric](fortios_wireless_controller_hotspot20_h2qp_wan_metric_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-h2qp-wan-metric-module) – Configure WAN metrics in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_hs\_profile](fortios_wireless_controller_hotspot20_hs_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-hs-profile-module) – Configure hotspot profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_icon](fortios_wireless_controller_hotspot20_icon_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-icon-module) – Configure OSU provider icon in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_hotspot20\_qos\_map](fortios_wireless_controller_hotspot20_qos_map_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-hotspot20-qos-map-module) – Configure QoS map set in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_inter\_controller](fortios_wireless_controller_inter_controller_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-inter-controller-module) – Configure inter wireless controller operation in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_log](fortios_wireless_controller_log_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-log-module) – Configure wireless controller event log filters in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_mpsk\_profile](fortios_wireless_controller_mpsk_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-mpsk-profile-module) – Configure MPSK profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_nac\_profile](fortios_wireless_controller_nac_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-nac-profile-module) – Configure WiFi network access control (NAC) profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_qos\_profile](fortios_wireless_controller_qos_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-qos-profile-module) – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_region](fortios_wireless_controller_region_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-region-module) – Configure FortiAP regions (for floor plans and maps) in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_rf\_analysis](fortios_wireless_controller_rf_analysis_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-rf-analysis-module) – Wireless controller rf-analysis in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_setting](fortios_wireless_controller_setting_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-setting-module) – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_snmp](fortios_wireless_controller_snmp_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-snmp-module) – Configure SNMP in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_spectral\_info](fortios_wireless_controller_spectral_info_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-spectral-info-module) – Wireless controller spectrum analysis in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_ssid\_policy](fortios_wireless_controller_ssid_policy_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-ssid-policy-module) – Configure WiFi SSID policies in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_status](fortios_wireless_controller_status_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-status-module) – Wireless controller status in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_timers](fortios_wireless_controller_timers_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-timers-module) – Configure CAPWAP timers in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_utm\_profile](fortios_wireless_controller_utm_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-utm-profile-module) – Configure UTM (Unified Threat Management) profile in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_vap](fortios_wireless_controller_vap_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-vap-module) – Configure Virtual Access Points (VAPs) in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_vap\_group](fortios_wireless_controller_vap_group_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-vap-group-module) – Configure virtual Access Point (VAP) groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_vap\_status](fortios_wireless_controller_vap_status_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-vap-status-module) – Wireless controller VAP-status in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wag\_profile](fortios_wireless_controller_wag_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wag-profile-module) – Configure wireless access gateway (WAG) profiles used for tunnels on AP in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wids\_profile](fortios_wireless_controller_wids_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wids-profile-module) – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wtp](fortios_wireless_controller_wtp_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wtp-module) – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wtp\_group](fortios_wireless_controller_wtp_group_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wtp-group-module) – Configure WTP groups in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wtp\_profile](fortios_wireless_controller_wtp_profile_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wtp-profile-module) – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet’s FortiOS and FortiGate.
* [fortios\_wireless\_controller\_wtp\_status](fortios_wireless_controller_wtp_status_module#ansible-collections-fortinet-fortios-fortios-wireless-controller-wtp-status-module) – Wireless controller WTP-status in Fortinet’s FortiOS and FortiGate.
See also
List of [collections](../../index#list-of-collections) with docs hosted here.
| programming_docs |
ansible fortinet.fortios.fortios_endpoint_control_forticlient_ems – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_forticlient\_ems – Configure FortiClient Enterprise Management Server (EMS) 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_endpoint_control_forticlient_ems`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 forticlient\_ems category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_forticlient\_ems** dictionary | | Configure FortiClient Enterprise Management Server (EMS) entries. |
| | **address** string | | Firewall address name. Source firewall.address.name. |
| | **admin\_password** string | | FortiClient EMS admin password. |
| | **admin\_type** string | **Choices:*** Windows
* LDAP
| FortiClient EMS admin type. |
| | **admin\_username** string | | FortiClient EMS admin username. |
| | **https\_port** integer | | FortiClient EMS HTTPS access port number. (1 - 65535). |
| | **listen\_port** integer | | FortiClient EMS telemetry listen port number. (1 - 65535). |
| | **name** string / required | | FortiClient Enterprise Management Server (EMS) name. |
| | **rest\_api\_auth** string | **Choices:*** disable
* userpass
| FortiClient EMS REST API authentication. |
| | **serial\_number** string | | FortiClient EMS Serial Number. |
| | **upload\_port** integer | | FortiClient EMS telemetry upload port number. (1 - 65535). |
| **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 Enterprise Management Server (EMS) entries.
fortios_endpoint_control_forticlient_ems:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_forticlient_ems:
address: "<your_own_value> (source firewall.address.name)"
admin_password: "<your_own_value>"
admin_type: "Windows"
admin_username: "<your_own_value>"
https_port: "7"
listen_port: "8"
name: "default_name_9"
rest_api_auth: "disable"
serial_number: "<your_own_value>"
upload_port: "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_switch_controller_sflow – Configure FortiSwitch sFlow in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_sflow – Configure FortiSwitch sFlow in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sflow`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_sflow** dictionary | | Configure FortiSwitch sFlow. |
| | **collector\_ip** string | | Collector IP. |
| | **collector\_port** integer | | SFlow collector port (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 FortiSwitch sFlow.
fortios_switch_controller_sflow:
vdom: "{{ vdom }}"
switch_controller_sflow:
collector_ip: "<your_own_value>"
collector_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_log_syslogd4_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd4\_setting – Global 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_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 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\_setting** dictionary | | Global 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. |
| | **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: Global settings for remote syslog server.
fortios_log_syslogd4_setting:
vdom: "{{ vdom }}"
log_syslogd4_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"
port: "15"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "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_system_dns_server – Configure DNS servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dns\_server – Configure 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_dns_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 dns\_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\_dns\_server** dictionary | | Configure DNS servers. |
| | **dnsfilter\_profile** string | | DNS filter profile. Source dnsfilter.profile.name. |
| | **doh** string | **Choices:*** enable
* disable
| DNS over HTTPS. |
| | **mode** string | **Choices:*** recursive
* non-recursive
* forward-only
| DNS server mode. |
| | **name** string / required | | DNS server 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 DNS servers.
fortios_system_dns_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_dns_server:
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
doh: "enable"
mode: "recursive"
name: "default_name_6 (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_gtp_message_filter_v0v1 – Message filter for GTPv0/v1 messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_message\_filter\_v0v1 – Message filter for GTPv0/v1 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_gtp_message_filter_v0v1`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 message\_filter\_v0v1 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_message\_filter\_v0v1** dictionary | | Message filter for GTPv0/v1 messages. |
| | **create\_mbms** string | **Choices:*** allow
* deny
| GTPv1 create MBMS context (req 100, resp 101). |
| | **create\_pdp** string | **Choices:*** allow
* deny
| Create PDP context (req 16, resp 17). |
| | **data\_record** string | **Choices:*** allow
* deny
| Data record transfer (req 240, resp 241). |
| | **delete\_aa\_pdp** string | **Choices:*** allow
* deny
| GTPv0 delete AA PDP context (req 24, resp 25). |
| | **delete\_mbms** string | **Choices:*** allow
* deny
| GTPv1 delete MBMS context (req 104, resp 105). |
| | **delete\_pdp** string | **Choices:*** allow
* deny
| Delete PDP context (req 20, resp 21). |
| | **echo** string | **Choices:*** allow
* deny
| Echo (req 1, resp 2). |
| | **end\_marker** string | **Choices:*** allow
* deny
| GTPv1 End marker (254). |
| | **error\_indication** string | **Choices:*** allow
* deny
| Error indication (26). |
| | **failure\_report** string | **Choices:*** allow
* deny
| Failure report (req 34, resp 35). |
| | **fwd\_relocation** string | **Choices:*** allow
* deny
| GTPv1 forward relocation (req 53, resp 54, complete 55, complete ack 59). |
| | **fwd\_srns\_context** string | **Choices:*** allow
* deny
| GTPv1 forward SRNS (context 58, context ack 60). |
| | **gtp\_pdu** string | **Choices:*** allow
* deny
| PDU (255). |
| | **identification** string | **Choices:*** allow
* deny
| Identification (req 48, resp 49). |
| | **mbms\_de\_registration** string | **Choices:*** allow
* deny
| GTPv1 MBMS de-registration (req 114, resp 115). |
| | **mbms\_notification** string | **Choices:*** allow
* deny
| GTPv1 MBMS notification (req 96, resp 97, reject req 98. reject resp 99). |
| | **mbms\_registration** string | **Choices:*** allow
* deny
| GTPv1 MBMS registration (req 112, resp 113). |
| | **mbms\_session\_start** string | **Choices:*** allow
* deny
| GTPv1 MBMS session start (req 116, resp 117). |
| | **mbms\_session\_stop** string | **Choices:*** allow
* deny
| GTPv1 MBMS session stop (req 118, resp 119). |
| | **mbms\_session\_update** string | **Choices:*** allow
* deny
| GTPv1 MBMS session update (req 120, resp 121). |
| | **ms\_info\_change\_notif** string | **Choices:*** allow
* deny
| GTPv1 MS info change notification (req 128, resp 129). |
| | **name** string / required | | Message filter name. |
| | **node\_alive** string | **Choices:*** allow
* deny
| Node alive (req 4, resp 5). |
| | **note\_ms\_present** string | **Choices:*** allow
* deny
| Note MS GPRS present (req 36, resp 37). |
| | **pdu\_notification** string | **Choices:*** allow
* deny
| PDU notification (req 27, resp 28, reject req 29, reject resp 30). |
| | **ran\_info** string | **Choices:*** allow
* deny
| GTPv1 RAN information relay (70). |
| | **redirection** string | **Choices:*** allow
* deny
| Redirection (req 6, resp 7). |
| | **relocation\_cancel** string | **Choices:*** allow
* deny
| GTPv1 relocation cancel (req 56, resp 57). |
| | **send\_route** string | **Choices:*** allow
* deny
| Send routing information for GPRS (req 32, resp 33). |
| | **sgsn\_context** string | **Choices:*** allow
* deny
| SGSN context (req 50, resp 51, ack 52). |
| | **support\_extension** string | **Choices:*** allow
* deny
| GTPv1 supported extension headers notify (31). |
| | **unknown\_message** string | **Choices:*** allow
* deny
| Allow or Deny unknown messages. |
| | **unknown\_message\_white\_list** list / elements=string | | White list (to allow) of unknown messages. |
| | | **id** integer / required | | Message IDs. |
| | **update\_mbms** string | **Choices:*** allow
* deny
| GTPv1 update MBMS context (req 102, resp 103). |
| | **update\_pdp** string | **Choices:*** allow
* deny
| Update PDP context (req 18, resp 19). |
| | **v0\_create\_aa\_pdp\_\_v1\_init\_pdp\_ctx** string | **Choices:*** allow
* deny
| GTPv0 create AA PDP context (req 22, resp 23); Or GTPv1 initiate PDP context (req 22, resp 23). |
| | **version\_not\_support** string | **Choices:*** allow
* deny
| Version not supported (3). |
| **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: Message filter for GTPv0/v1 messages.
fortios_gtp_message_filter_v0v1:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_message_filter_v0v1:
create_mbms: "allow"
create_pdp: "allow"
data_record: "allow"
delete_aa_pdp: "allow"
delete_mbms: "allow"
delete_pdp: "allow"
echo: "allow"
end_marker: "allow"
error_indication: "allow"
failure_report: "allow"
fwd_relocation: "allow"
fwd_srns_context: "allow"
gtp_pdu: "allow"
identification: "allow"
mbms_de_registration: "allow"
mbms_notification: "allow"
mbms_registration: "allow"
mbms_session_start: "allow"
mbms_session_stop: "allow"
mbms_session_update: "allow"
ms_info_change_notif: "allow"
name: "default_name_24"
node_alive: "allow"
note_ms_present: "allow"
pdu_notification: "allow"
ran_info: "allow"
redirection: "allow"
relocation_cancel: "allow"
send_route: "allow"
sgsn_context: "allow"
support_extension: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "36"
update_mbms: "allow"
update_pdp: "allow"
v0_create_aa_pdp__v1_init_pdp_ctx: "allow"
version_not_support: "allow"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_dns – Configure IPS URL filter DNS servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ips\_urlfilter\_dns – Configure IPS URL filter 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_dns`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dns** dictionary | | Configure IPS URL filter DNS servers. |
| | **address** string / required | | DNS server IP address. |
| | **ipv6\_capability** string | **Choices:*** enable
* disable
| Enable/disable this server for IPv6 queries. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable using this DNS server for IPS URL filter 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 DNS servers.
fortios_system_ips_urlfilter_dns:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ips_urlfilter_dns:
address: "<your_own_value>"
ipv6_capability: "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_firewall_internet_service_append – Configure additional port mappings for Internet Services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_append – Configure additional port mappings for Internet 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_firewall_internet_service_append`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_append category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_append** dictionary | | Configure additional port mappings for Internet Services. |
| | **append\_port** integer | | Appending TCP/UDP/SCTP destination port (1 to 65535). |
| | **match\_port** integer | | Matching TCP/UDP/SCTP destination port (1 to 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 additional port mappings for Internet Services.
fortios_firewall_internet_service_append:
vdom: "{{ vdom }}"
firewall_internet_service_append:
append_port: "3"
match_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_firewall_ldb_monitor – Configure server load balancing health monitors in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ldb\_monitor – Configure server load balancing health monitors in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ldb_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 firewall feature and ldb\_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. |
| **firewall\_ldb\_monitor** dictionary | | Configure server load balancing health monitors. |
| | **dns\_match\_ip** string | | Response IP expected from DNS server. |
| | **dns\_protocol** string | **Choices:*** udp
* tcp
| Select the protocol used by the DNS health check monitor to check the health of the server (UDP | TCP). |
| | **dns\_request\_domain** string | | Fully qualified domain name to resolve for the DNS probe. |
| | **http\_get** string | | URL used to send a GET request to check the health of an HTTP server. |
| | **http\_match** string | | String to match the value expected in response to an HTTP-GET request. |
| | **http\_max\_redirects** integer | | The maximum number of HTTP redirects to be allowed (0 - 5). |
| | **interval** integer | | Time between health checks (5 - 65635 sec). |
| | **name** string / required | | Monitor name. |
| | **port** integer | | Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65635). |
| | **retry** integer | | Number health check attempts before the server is considered down (1 - 255). |
| | **src\_ip** string | | Source IP for ldb-monitor. |
| | **timeout** integer | | Time to wait to receive response to a health check from a server. Reaching the timeout means the health check failed (1 - 255 sec). |
| | **type** string | **Choices:*** ping
* tcp
* http
* passive-sip
* https
* dns
| Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP). |
| **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 server load balancing health monitors.
fortios_firewall_ldb_monitor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ldb_monitor:
dns_match_ip: "<your_own_value>"
dns_protocol: "udp"
dns_request_domain: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
http_max_redirects: "8"
interval: "9"
name: "default_name_10"
port: "11"
retry: "12"
src_ip: "<your_own_value>"
timeout: "14"
type: "ping"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_sflow – Configure sFlow in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sflow – Configure sFlow in Fortinet’s FortiOS and FortiGate.
==============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sflow`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_sflow** dictionary | | Configure sFlow. |
| | **collector\_ip** string | | IP address of the sFlow collector that sFlow agents added to interfaces in this VDOM send sFlow datagrams to . |
| | **collector\_port** integer | | UDP port number used for sending sFlow datagrams (configure only if required by your sFlow collector or your network configuration) (0 - 65535). |
| | **source\_ip** string | | Source IP address for sFlow agent. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 sFlow.
fortios_system_sflow:
vdom: "{{ vdom }}"
system_sflow:
collector_ip: "<your_own_value>"
collector_port: "4"
source_ip: "84.230.14.43"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_storage – Configure logical storage in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_storage – Configure logical 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_system_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 system feature and 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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_storage** dictionary | | Configure logical storage. |
| | **device** string | | Partition device. |
| | **media\_status** string | **Choices:*** enable
* disable
* fail
| The physical status of current media. |
| | **name** string / required | | Storage name. |
| | **order** integer | | Set storage order. |
| | **partition** string | | Label of underlying partition. |
| | **size** integer | | Partition size. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable storage. |
| | **usage** string | **Choices:*** log
* wanopt
| Use hard disk for logging or WAN Optimization . |
| | **wanopt\_mode** string | **Choices:*** mix
* wanopt
* webcache
| WAN Optimization 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 logical storage.
fortios_system_storage:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_storage:
device: "<your_own_value>"
media_status: "enable"
name: "default_name_5"
order: "6"
partition: "<your_own_value>"
size: "8"
status: "enable"
usage: "log"
wanopt_mode: "mix"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_probe_response – Configure system probe response in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_probe\_response – Configure system probe response in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_probe_response`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 probe\_response category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_probe\_response** dictionary | | Configure system probe response. |
| | **http\_probe\_value** string | | Value to respond to the monitoring server. |
| | **mode** string | **Choices:*** none
* http-probe
* twamp
| SLA response mode. |
| | **password** string | | Twamp respondor password in authentication mode |
| | **port** integer | | Port number to response. |
| | **security\_mode** string | **Choices:*** none
* authentication
| Twamp respondor security mode. |
| | **timeout** integer | | An inactivity timer for a twamp test session. |
| | **ttl\_mode** string | **Choices:*** reinit
* decrease
* retain
| Mode for TWAMP packet TTL modification. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 probe response.
fortios_system_probe_response:
vdom: "{{ vdom }}"
system_probe_response:
http_probe_value: "<your_own_value>"
mode: "none"
password: "<your_own_value>"
port: "6"
security_mode: "none"
timeout: "8"
ttl_mode: "reinit"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer3\_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_fortianalyzer3_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\_fortianalyzer3 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\_fortianalyzer3\_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_fortianalyzer3_setting:
vdom: "{{ vdom }}"
log_fortianalyzer3_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)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_managed_switch – Configure FortiSwitch devices that are managed by this FortiGate in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_managed\_switch – Configure FortiSwitch devices that are managed by 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_switch_controller_managed_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 switch\_controller feature and managed\_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. |
| **switch\_controller\_managed\_switch** dictionary | | Configure FortiSwitch devices that are managed by this FortiGate. |
| | **access\_profile** string | | FortiSwitch access profile. Source switch-controller.security-policy.local-access.name. |
| | **custom\_command** list / elements=string | | Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller or the FortiSwitch. |
| | | **command\_entry** string | | List of FortiSwitch commands. |
| | | **command\_name** string | | Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-command. Source switch-controller.custom-command.command-name. |
| | **delayed\_restart\_trigger** integer | | Delayed restart triggered for this FortiSwitch. |
| | **description** string | | Description. |
| | **directly\_connected** integer | | Directly connected FortiSwitch. |
| | **dynamic\_capability** integer | | List of features this FortiSwitch supports (not configurable) that is sent to the FortiGate device for subsequent configuration initiated by the FortiGate device. |
| | **dynamically\_discovered** integer | | Dynamically discovered FortiSwitch. |
| | **firmware\_provision** string | **Choices:*** enable
* disable
| Enable/disable provisioning of firmware to FortiSwitches on join connection. |
| | **firmware\_provision\_version** string | | Firmware version to provision to this FortiSwitch on bootup (major.minor.build, i.e. 6.2.1234). |
| | **flow\_identity** string | | Flow-tracking netflow ipfix switch identity in hex format(00000000-FFFFFFFF ). |
| | **fsw\_wan1\_admin** string | **Choices:*** discovered
* disable
* enable
| FortiSwitch WAN1 admin status; enable to authorize the FortiSwitch as a managed switch. |
| | **fsw\_wan1\_peer** string | | Fortiswitch WAN1 peer port. Source system.interface.name. |
| | **fsw\_wan2\_admin** string | **Choices:*** discovered
* disable
* enable
| FortiSwitch WAN2 admin status; enable to authorize the FortiSwitch as a managed switch. |
| | **fsw\_wan2\_peer** string | | FortiSwitch WAN2 peer port. |
| | **igmp\_snooping** dictionary | | Configure FortiSwitch IGMP snooping global settings. |
| | | **aging\_time** integer | | Maximum time 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. |
| | | **local\_override** string | **Choices:*** enable
* disable
| Enable/disable overriding the global IGMP snooping configuration. |
| | **ip\_source\_guard** list / elements=string | | IP source guard. |
| | | **binding\_entry** list / elements=string | | IP and MAC address configuration. |
| | | | **entry\_name** string | | Configure binding pair. |
| | | | **ip** string | | Source IP for this rule. |
| | | | **mac** string | | MAC address for this rule. |
| | | **description** string | | Description. |
| | | **port** string / required | | Ingress interface to which source guard is bound. |
| | **l3\_discovered** integer | | Layer 3 management discovered. |
| | **max\_allowed\_trunk\_members** integer | | FortiSwitch maximum allowed trunk members. |
| | **mclag\_igmp\_snooping\_aware** string | **Choices:*** enable
* disable
| Enable/disable MCLAG IGMP-snooping awareness. |
| | **mirror** list / elements=string | | Configuration method to edit FortiSwitch packet mirror. |
| | | **dst** string | | Destination port. |
| | | **name** string / required | | Mirror name. |
| | | **src\_egress** list / elements=string | | Source egress interfaces. |
| | | | **name** string / required | | Interface name. |
| | | **src\_ingress** list / elements=string | | Source ingress interfaces. |
| | | | **name** string / required | | Interface name. |
| | | **status** string | **Choices:*** active
* inactive
| Active/inactive mirror configuration. |
| | | **switching\_packet** string | **Choices:*** enable
* disable
| Enable/disable switching functionality when mirroring. |
| | **name** string | | Managed-switch name. |
| | **override\_snmp\_community** string | **Choices:*** enable
* disable
| Enable/disable overriding the global SNMP communities. |
| | **override\_snmp\_sysinfo** string | **Choices:*** disable
* enable
| Enable/disable overriding the global SNMP system information. |
| | **override\_snmp\_trap\_threshold** string | **Choices:*** enable
* disable
| Enable/disable overriding the global SNMP trap threshold values. |
| | **override\_snmp\_user** string | **Choices:*** enable
* disable
| Enable/disable overriding the global SNMP users. |
| | **owner\_vdom** string | | VDOM which owner of port belongs to. |
| | **poe\_detection\_type** integer | | PoE detection type for FortiSwitch. |
| | **poe\_lldp\_detection** string | **Choices:*** enable
* disable
| Enable/disable PoE LLDP detection. |
| | **poe\_pre\_standard\_detection** string | **Choices:*** enable
* disable
| Enable/disable PoE pre-standard detection. |
| | **ports** list / elements=string | | Managed-switch port list. |
| | | **access\_mode** string | **Choices:*** normal
* nac
* dynamic
* static
| Access mode of the port. |
| | | **aggregator\_mode** string | **Choices:*** bandwidth
* count
| LACP member select mode. |
| | | **allowed\_vlans** list / elements=string | | Configure switch port tagged vlans |
| | | | **vlan\_name** string | | VLAN name. Source system.interface.name. |
| | | **allowed\_vlans\_all** string | **Choices:*** enable
* disable
| Enable/disable all defined vlans on this port. |
| | | **arp\_inspection\_trust** string | **Choices:*** untrusted
* trusted
| Trusted or untrusted dynamic ARP inspection. |
| | | **bundle** string | **Choices:*** enable
* disable
| Enable/disable Link Aggregation Group (LAG) bundling for non-FortiLink interfaces. |
| | | **description** string | | Description for port. |
| | | **dhcp\_snoop\_option82\_trust** string | **Choices:*** enable
* disable
| Enable/disable allowance of DHCP with option-82 on untrusted interface. |
| | | **dhcp\_snooping** string | **Choices:*** untrusted
* trusted
| Trusted or untrusted DHCP-snooping interface. |
| | | **discard\_mode** string | **Choices:*** none
* all-untagged
* all-tagged
| Configure discard mode for port. |
| | | **edge\_port** string | **Choices:*** enable
* disable
| Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. |
| | | **export\_tags** list / elements=string | | Switch controller export tag name. |
| | | | **tag\_name** string | | Switch tag name. Source switch-controller.switch-interface-tag.name. |
| | | **export\_to** string | | Export managed-switch port to a tenant VDOM. Source system.vdom.name. |
| | | **export\_to\_pool** string | | Switch controller export port to pool-list. Source switch-controller.virtual-port-pool.name. |
| | | **export\_to\_pool\_flag** integer | | Switch controller export port to pool-list. |
| | | **fec\_capable** integer | | FEC capable. |
| | | **fec\_state** string | **Choices:*** disabled
* cl74
* cl91
| State of forward error correction. |
| | | **fgt\_peer\_device\_name** string | | FGT peer device name. |
| | | **fgt\_peer\_port\_name** string | | FGT peer port name. |
| | | **fiber\_port** integer | | Fiber-port. |
| | | **flags** integer | | Port properties flags. |
| | | **flow\_control** string | **Choices:*** disable
* tx
* rx
* both
| Flow control direction. |
| | | **fortilink\_port** integer | | FortiLink uplink port. |
| | | **igmp\_snooping** string | **Choices:*** enable
* disable
| Set IGMP snooping mode for the physical port interface. |
| | | **igmps\_flood\_reports** string | **Choices:*** enable
* disable
| Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled. |
| | | **igmps\_flood\_traffic** string | **Choices:*** enable
* disable
| Enable/disable flooding of IGMP snooping traffic to this interface. |
| | | **ip\_source\_guard** string | **Choices:*** disable
* enable
| Enable/disable IP source guard. |
| | | **isl\_local\_trunk\_name** string | | ISL local trunk name. |
| | | **isl\_peer\_device\_name** string | | ISL peer device name. |
| | | **isl\_peer\_port\_name** string | | ISL peer port name. |
| | | **lacp\_speed** string | **Choices:*** slow
* fast
| end Link Aggregation Control Protocol (LACP) messages every 30 seconds (slow) or every second (fast). |
| | | **learning\_limit** integer | | Limit the number of dynamic MAC addresses on this Port (1 - 128, 0 = no limit, default). |
| | | **lldp\_profile** string | | LLDP port TLV profile. Source switch-controller.lldp-profile.name. |
| | | **lldp\_status** string | **Choices:*** disable
* rx-only
* tx-only
* tx-rx
| LLDP transmit and receive status. |
| | | **loop\_guard** string | **Choices:*** enabled
* disabled
| Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops. |
| | | **loop\_guard\_timeout** integer | | Loop-guard timeout (0 - 120 min). |
| | | **mac\_addr** string | | Port/Trunk MAC. |
| | | **matched\_dpp\_intf\_tags** string | | Matched interface tags in the dynamic port policy. |
| | | **matched\_dpp\_policy** string | | Matched child policy in the dynamic port policy. |
| | | **max\_bundle** integer | | Maximum size of LAG bundle (1 - 24) |
| | | **mclag** string | **Choices:*** enable
* disable
| Enable/disable multi-chassis link aggregation (MCLAG). |
| | | **mclag\_icl\_port** integer | | MCLAG-ICL port. |
| | | **media\_type** string | | Media type. |
| | | **member\_withdrawal\_behavior** string | **Choices:*** forward
* block
| Port behavior after it withdraws because of loss of control packets. |
| | | **members** list / elements=string | | Aggregated LAG bundle interfaces. |
| | | | **member\_name** string | | Interface name from available options. |
| | | **min\_bundle** integer | | Minimum size of LAG bundle (1 - 24) |
| | | **mode** string | **Choices:*** static
* lacp-passive
* lacp-active
| LACP mode: ignore and do not send control messages, or negotiate 802.3ad aggregation passively or actively. |
| | | **p2p\_port** integer | | General peer to peer tunnel port. |
| | | **packet\_sample\_rate** integer | | Packet sampling rate (0 - 99999 p/sec). |
| | | **packet\_sampler** string | **Choices:*** enabled
* disabled
| Enable/disable packet sampling on this interface. |
| | | **pause\_meter** integer | | Configure ingress pause metering rate, in kbps . |
| | | **pause\_meter\_resume** string | **Choices:*** 75%
* 50%
* 25%
| Resume threshold for resuming traffic on ingress port. |
| | | **poe\_capable** integer | | PoE capable. |
| | | **poe\_pre\_standard\_detection** string | **Choices:*** enable
* disable
| Enable/disable PoE pre-standard detection. |
| | | **poe\_status** string | **Choices:*** enable
* disable
| Enable/disable PoE status. |
| | | **port\_name** string | | Switch port name. |
| | | **port\_number** integer | | Port number. |
| | | **port\_owner** string | | Switch port name. |
| | | **port\_policy** string | | Switch controller dynamic port policy from available options. Source switch-controller.dynamic-port-policy.name. |
| | | **port\_prefix\_type** integer | | Port prefix type. |
| | | **port\_security\_policy** string | | Switch controller authentication policy to apply to this managed switch from available options. Source switch-controller .security-policy.802-1X.name switch-controller.security-policy.captive-portal.name. |
| | | **port\_selection\_criteria** string | **Choices:*** src-mac
* dst-mac
* src-dst-mac
* src-ip
* dst-ip
* src-dst-ip
| Algorithm for aggregate port selection. |
| | | **ptp\_policy** string | | PTP policy configuration. Source switch-controller.ptp.policy.name. |
| | | **qos\_policy** string | | Switch controller QoS policy from available options. Source switch-controller.qos.qos-policy.name. |
| | | **rpvst\_port** string | **Choices:*** disabled
* enabled
| Enable/disable inter-operability with rapid PVST on this interface. |
| | | **sample\_direction** string | **Choices:*** tx
* rx
* both
| sFlow sample direction. |
| | | **sflow\_counter\_interval** integer | | sFlow sampler counter polling interval (1 - 255 sec). |
| | | **sflow\_sample\_rate** integer | | sFlow sampler sample rate (0 - 99999 p/sec). |
| | | **sflow\_sampler** string | **Choices:*** enabled
* disabled
| Enable/disable sFlow protocol on this interface. |
| | | **speed** string | **Choices:*** 10half
* 10full
* 100half
* 100full
* 1000auto
* 1000fiber
* 1000full
* 10000
* 40000
* auto
* auto-module
* 100FX-half
* 100FX-full
* 100000full
* 2500full
* 25000full
* 50000full
* 10000cr
* 10000sr
* 100000sr4
* 100000cr4
* 25000cr4
* 25000sr4
* 5000full
* 2500auto
| Switch port speed; default and available settings depend on hardware. |
| | | **speed\_mask** integer | | Switch port speed mask. |
| | | **stacking\_port** integer | | Stacking port. |
| | | **status** string | **Choices:*** up
* down
| Switch port admin status: up or down. |
| | | **sticky\_mac** string | **Choices:*** enable
* disable
| Enable or disable sticky-mac on the interface. |
| | | **storm\_control\_policy** string | | Switch controller storm control policy from available options. Source switch-controller.storm-control-policy.name. |
| | | **stp\_bpdu\_guard** string | **Choices:*** enabled
* disabled
| Enable/disable STP BPDU guard on this interface. |
| | | **stp\_bpdu\_guard\_timeout** integer | | BPDU Guard disabling protection (0 - 120 min). |
| | | **stp\_root\_guard** string | **Choices:*** enabled
* disabled
| Enable/disable STP root guard on this interface. |
| | | **stp\_state** string | **Choices:*** enabled
* disabled
| Enable/disable Spanning Tree Protocol (STP) on this interface. |
| | | **switch\_id** string | | Switch id. |
| | | **type** string | **Choices:*** physical
* trunk
| Interface type: physical or trunk port. |
| | | **untagged\_vlans** list / elements=string | | Configure switch port untagged vlans |
| | | | **vlan\_name** string | | VLAN name. Source system.interface.name. |
| | | **virtual\_port** integer | | Virtualized switch port. |
| | | **vlan** string | | Assign switch ports to a VLAN. Source system.interface.name. |
| | **pre\_provisioned** integer | | Pre-provisioned managed switch. |
| | **qos\_drop\_policy** string | **Choices:*** taildrop
* random-early-detection
| Set QoS drop-policy. |
| | **qos\_red\_probability** integer | | Set QoS RED/WRED drop probability. |
| | **remote\_log** list / elements=string | | Configure logging by FortiSwitch device to a remote syslog server. |
| | | **csv** string | **Choices:*** enable
* disable
| Enable/disable comma-separated value (CSV) strings. |
| | | **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
| Facility to log to remote syslog server. |
| | | **name** string / required | | Remote log name. |
| | | **port** integer | | Remote syslog server listening port. |
| | | **server** string | | IPv4 address of the remote syslog server. |
| | | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* notification
* information
* debug
| Severity of logs to be transferred to remote log server. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable logging by FortiSwitch device to a remote syslog server. |
| | **settings\_802\_1X** dictionary | | Configuration method to edit FortiSwitch 802.1X global settings. |
| | | **link\_down\_auth** string | **Choices:*** set-unauth
* no-action
| Authentication state to set if a link is down. |
| | | **local\_override** string | **Choices:*** enable
* disable
| Enable to override global 802.1X settings on individual FortiSwitches. |
| | | **max\_reauth\_attempt** integer | | Maximum number of authentication attempts (0 - 15). |
| | | **reauth\_period** integer | | Reauthentication time interval (1 - 1440 min). |
| | | **tx\_period** integer | | 802.1X Tx period (seconds). |
| | **snmp\_community** list / elements=string | | Configuration method to edit Simple Network Management Protocol (SNMP) communities. |
| | | **events** 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. |
| | **snmp\_sysinfo** dictionary | | Configuration method to edit Simple Network Management Protocol (SNMP) system info. |
| | | **contact\_info** string | | Contact information. |
| | | **description** string | | System description. |
| | | **engine\_id** string | | Local SNMP engine ID string (max 24 char). |
| | | **location** string | | System location. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable SNMP. |
| | **snmp\_trap\_threshold** dictionary | | Configuration method to edit Simple Network Management Protocol (SNMP) trap threshold values. |
| | | **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. |
| | **snmp\_user** list / elements=string | | Configuration method to edit Simple Network Management Protocol (SNMP) users. |
| | | **auth\_proto** string | **Choices:*** md5
* sha
* sha1
* sha224
* sha256
* sha384
* sha512
| Authentication protocol. |
| | | **auth\_pwd** string | | Password for authentication protocol. |
| | | **name** string / required | | SNMP user name. |
| | | **priv\_proto** string | **Choices:*** aes
* des
* aes128
* aes192
* aes192c
* aes256
* aes256c
| Privacy (encryption) protocol. |
| | | **priv\_pwd** string | | Password for privacy (encryption) protocol. |
| | | **queries** string | **Choices:*** disable
* enable
| Enable/disable SNMP queries for this user. |
| | | **query\_port** integer | | SNMPv3 query port . |
| | | **security\_level** string | **Choices:*** no-auth-no-priv
* auth-no-priv
* auth-priv
| Security level for message authentication and encryption. |
| | **staged\_image\_version** string | | Staged image version for FortiSwitch. |
| | **static\_mac** list / elements=string | | Configuration method to edit FortiSwitch Static and Sticky MAC. |
| | | **description** string | | Description. |
| | | **id** integer / required | | Id |
| | | **interface** string | | Interface name. |
| | | **mac** string | | MAC address. |
| | | **type** string | **Choices:*** static
* sticky
| Type. |
| | | **vlan** string | | Vlan. Source system.interface.name. |
| | **storm\_control** dictionary | | Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption. |
| | | **broadcast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop broadcast traffic. |
| | | **local\_override** string | **Choices:*** enable
* disable
| Enable to override global FortiSwitch storm control settings for this FortiSwitch. |
| | | **rate** integer | | Rate in packets per second at which storm traffic is controlled (1 - 10000000). Storm control drops excess traffic data rates beyond this threshold. |
| | | **unknown\_multicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop unknown multicast traffic. |
| | | **unknown\_unicast** string | **Choices:*** enable
* disable
| Enable/disable storm control to drop unknown unicast traffic. |
| | **stp\_instance** list / elements=string | | Configuration method to edit Spanning Tree Protocol (STP) instances. |
| | | **id** string / required | | Instance ID. |
| | | **priority** string | **Choices:*** 0
* 4096
* 8192
* 12288
* 16384
* 20480
* 24576
* 28672
* 32768
* 36864
* 40960
* 45056
* 49152
* 53248
* 57344
* 61440
| Priority. |
| | **stp\_settings** dictionary | | Configuration method to edit Spanning Tree Protocol (STP) settings used to prevent bridge loops. |
| | | **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). |
| | | **local\_override** string | **Choices:*** enable
* disable
| Enable to configure local STP settings that override global STP settings. |
| | | **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 local 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. |
| | **switch\_device\_tag** string | | User definable label/tag. |
| | **switch\_dhcp\_opt43\_key** string | | DHCP option43 key. |
| | **switch\_id** string | | Managed-switch id. |
| | **switch\_log** dictionary | | Configuration method to edit FortiSwitch logging settings (logs are transferred to and inserted into the FortiGate event log). |
| | | **local\_override** string | **Choices:*** enable
* disable
| Enable to configure local logging settings that override global logging settings. |
| | | **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 the FortiGate event log. |
| | **switch\_profile** string | | FortiSwitch profile. Source switch-controller.switch-profile.name. |
| | **switch\_stp\_settings** dictionary | | Configure spanning tree protocol (STP). |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable STP. |
| | **tdr\_supported** string | | TDR supported. |
| | **type** string | **Choices:*** virtual
* physical
| Indication of switch type, physical or virtual. |
| | **version** integer | | FortiSwitch 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 FortiSwitch devices that are managed by this FortiGate.
fortios_switch_controller_managed_switch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_managed_switch:
settings_802_1X:
link_down_auth: "set-unauth"
local_override: "enable"
max_reauth_attempt: "6"
reauth_period: "7"
tx_period: "8"
access_profile: "<your_own_value> (source switch-controller.security-policy.local-access.name)"
custom_command:
-
command_entry: "<your_own_value>"
command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
delayed_restart_trigger: "13"
description: "<your_own_value>"
directly_connected: "15"
dynamic_capability: "16"
dynamically_discovered: "17"
firmware_provision: "enable"
firmware_provision_version: "<your_own_value>"
flow_identity: "<your_own_value>"
fsw_wan1_admin: "discovered"
fsw_wan1_peer: "<your_own_value> (source system.interface.name)"
fsw_wan2_admin: "discovered"
fsw_wan2_peer: "<your_own_value>"
igmp_snooping:
aging_time: "26"
flood_unknown_multicast: "enable"
local_override: "enable"
ip_source_guard:
-
binding_entry:
-
entry_name: "<your_own_value>"
ip: "<your_own_value>"
mac: "<your_own_value>"
description: "<your_own_value>"
port: "<your_own_value>"
l3_discovered: "36"
max_allowed_trunk_members: "37"
mclag_igmp_snooping_aware: "enable"
mirror:
-
dst: "<your_own_value>"
name: "default_name_41"
src_egress:
-
name: "default_name_43"
src_ingress:
-
name: "default_name_45"
status: "active"
switching_packet: "enable"
name: "default_name_48"
override_snmp_community: "enable"
override_snmp_sysinfo: "disable"
override_snmp_trap_threshold: "enable"
override_snmp_user: "enable"
owner_vdom: "<your_own_value>"
poe_detection_type: "54"
poe_lldp_detection: "enable"
poe_pre_standard_detection: "enable"
ports:
-
access_mode: "normal"
aggregator_mode: "bandwidth"
allowed_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
allowed_vlans_all: "enable"
arp_inspection_trust: "untrusted"
bundle: "enable"
description: "<your_own_value>"
dhcp_snoop_option82_trust: "enable"
dhcp_snooping: "untrusted"
discard_mode: "none"
edge_port: "enable"
export_tags:
-
tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
export_to: "<your_own_value> (source system.vdom.name)"
export_to_pool: "<your_own_value> (source switch-controller.virtual-port-pool.name)"
export_to_pool_flag: "74"
export_to_pool_flag: "75"
fec_capable: "76"
fec_state: "disabled"
fgt_peer_device_name: "<your_own_value>"
fgt_peer_port_name: "<your_own_value>"
fiber_port: "80"
flags: "81"
flow_control: "disable"
fortilink_port: "83"
igmp_snooping: "enable"
igmps_flood_reports: "enable"
igmps_flood_traffic: "enable"
ip_source_guard: "disable"
isl_local_trunk_name: "<your_own_value>"
isl_peer_device_name: "<your_own_value>"
isl_peer_port_name: "<your_own_value>"
lacp_speed: "slow"
learning_limit: "92"
lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
lldp_status: "disable"
loop_guard: "enabled"
loop_guard_timeout: "96"
mac_addr: "<your_own_value>"
matched_dpp_intf_tags: "<your_own_value>"
matched_dpp_policy: "<your_own_value>"
max_bundle: "100"
mclag: "enable"
mclag_icl_port: "102"
media_type: "<your_own_value>"
member_withdrawal_behavior: "forward"
members:
-
member_name: "<your_own_value>"
min_bundle: "107"
mode: "static"
p2p_port: "109"
packet_sample_rate: "110"
packet_sampler: "enabled"
pause_meter: "112"
pause_meter_resume: "75%"
poe_capable: "114"
poe_pre_standard_detection: "enable"
poe_status: "enable"
port_name: "<your_own_value>"
port_number: "118"
port_owner: "<your_own_value>"
port_policy: "<your_own_value> (source switch-controller.dynamic-port-policy.name)"
port_prefix_type: "121"
port_security_policy: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal
.name)"
port_selection_criteria: "src-mac"
ptp_policy: "<your_own_value> (source switch-controller.ptp.policy.name)"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
rpvst_port: "disabled"
sample_direction: "tx"
sflow_counter_interval: "128"
sflow_sample_rate: "129"
sflow_sampler: "enabled"
speed: "10half"
speed_mask: "132"
stacking_port: "133"
status: "up"
sticky_mac: "enable"
storm_control_policy: "<your_own_value> (source switch-controller.storm-control-policy.name)"
stp_bpdu_guard: "enabled"
stp_bpdu_guard_timeout: "138"
stp_root_guard: "enabled"
stp_state: "enabled"
switch_id: "<your_own_value>"
type: "physical"
untagged_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
virtual_port: "145"
vlan: "<your_own_value> (source system.interface.name)"
pre_provisioned: "147"
qos_drop_policy: "taildrop"
qos_red_probability: "149"
remote_log:
-
csv: "enable"
facility: "kernel"
name: "default_name_153"
port: "154"
server: "192.168.100.40"
severity: "emergency"
status: "enable"
snmp_community:
-
events: "cpu-high"
hosts:
-
id: "161"
ip: "<your_own_value>"
id: "163"
name: "default_name_164"
query_v1_port: "165"
query_v1_status: "disable"
query_v2c_port: "167"
query_v2c_status: "disable"
status: "disable"
trap_v1_lport: "170"
trap_v1_rport: "171"
trap_v1_status: "disable"
trap_v2c_lport: "173"
trap_v2c_rport: "174"
trap_v2c_status: "disable"
snmp_sysinfo:
contact_info: "<your_own_value>"
description: "<your_own_value>"
engine_id: "<your_own_value>"
location: "<your_own_value>"
status: "disable"
snmp_trap_threshold:
trap_high_cpu_threshold: "183"
trap_log_full_threshold: "184"
trap_low_memory_threshold: "185"
snmp_user:
-
auth_proto: "md5"
auth_pwd: "<your_own_value>"
name: "default_name_189"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "disable"
query_port: "193"
security_level: "no-auth-no-priv"
staged_image_version: "<your_own_value>"
static_mac:
-
description: "<your_own_value>"
id: "198"
interface: "<your_own_value>"
mac: "<your_own_value>"
type: "static"
vlan: "<your_own_value> (source system.interface.name)"
storm_control:
broadcast: "enable"
local_override: "enable"
rate: "206"
unknown_multicast: "enable"
unknown_unicast: "enable"
stp_instance:
-
id: "210"
priority: "0"
stp_settings:
forward_time: "213"
hello_time: "214"
local_override: "enable"
max_age: "216"
max_hops: "217"
name: "default_name_218"
pending_timer: "219"
revision: "220"
status: "enable"
switch_device_tag: "<your_own_value>"
switch_dhcp_opt43_key: "<your_own_value>"
switch_id: "<your_own_value>"
switch_log:
local_override: "enable"
severity: "emergency"
status: "enable"
switch_profile: "<your_own_value> (source switch-controller.switch-profile.name)"
switch_stp_settings:
status: "enable"
tdr_supported: "<your_own_value>"
type: "virtual"
version: "234"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_custom – Configure custom Internet Services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_custom – Configure custom Internet 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_firewall_internet_service_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 feature and internet\_service\_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\_internet\_service\_custom** dictionary | | Configure custom Internet Services. |
| | **comment** string | | Comment. |
| | **disable\_entry** list / elements=string | | Disable entries in the Internet Service database. |
| | | **id** integer / required | | Disable entry ID. |
| | | **ip\_range** list / elements=string | | IP ranges in the disable entry. |
| | | | **end\_ip** string | | End IP address. |
| | | | **id** integer / required | | Disable entry range ID. |
| | | | **start\_ip** string | | Start IP address. |
| | | **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). |
| | **entry** list / elements=string | | Entries added to the Internet Service database and custom database. |
| | | **dst** list / elements=string | | Destination address or address group name. |
| | | | **name** string / required | | Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name. |
| | | **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). |
| | **master\_service\_id** integer | | Internet Service ID in the Internet Service database. Source firewall.internet-service.id. |
| | **name** string / required | | Internet Service name. |
| | **reputation** integer | | Reputation level of the custom Internet Service. Source firewall.internet-service-reputation.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 custom Internet Services.
fortios_firewall_internet_service_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_custom:
comment: "Comment."
disable_entry:
-
id: "5"
ip_range:
-
end_ip: "<your_own_value>"
id: "8"
start_ip: "<your_own_value>"
port: "10"
protocol: "11"
entry:
-
dst:
-
name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
id: "15"
port_range:
-
end_port: "17"
id: "18"
start_port: "19"
protocol: "20"
master_service_id: "21 (source firewall.internet-service.id)"
name: "default_name_22"
reputation: "23 (source firewall.internet-service-reputation.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_user_group – Configure user groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_group – Configure user 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_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 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\_group** dictionary | | Configure user groups. |
| | **auth\_concurrent\_override** string | **Choices:*** enable
* disable
| Enable/disable overriding the global number of concurrent authentication sessions for this user group. |
| | **auth\_concurrent\_value** integer | | Maximum number of concurrent authenticated connections per user (0 - 100). |
| | **authtimeout** integer | | Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout. |
| | **company** string | **Choices:*** optional
* mandatory
* disabled
| Set the action for the company guest user field. |
| | **email** string | **Choices:*** disable
* enable
| Enable/disable the guest user email address field. |
| | **expire** integer | | Time in seconds before guest user accounts expire. (1 - 31536000 sec) |
| | **expire\_type** string | **Choices:*** immediately
* first-successful-login
| Determine when the expiration countdown begins. |
| | **group\_type** string | **Choices:*** firewall
* fsso-service
* rsso
* guest
| Set the group to be for firewall authentication, FSSO, RSSO, or guest users. |
| | **guest** list / elements=string | | Guest User. |
| | | **comment** string | | Comment. |
| | | **company** string | | Set the action for the company guest user field. |
| | | **email** string | | Email. |
| | | **expiration** string | | Expire time. |
| | | **id** integer | | Guest ID. |
| | | **mobile\_phone** string | | Mobile phone. |
| | | **name** string | | Guest name. |
| | | **password** string | | Guest password. |
| | | **sponsor** string | | Set the action for the sponsor guest user field. |
| | | **user\_id** string | | Guest ID. |
| | **http\_digest\_realm** string | | Realm attribute for MD5-digest authentication. |
| | **id** integer | | Group ID. |
| | **match** list / elements=string | | Group matches. |
| | | **group\_name** string | | Name of matching group on remote authentication server. |
| | | **id** integer / required | | ID. |
| | | **server\_name** string | | Name of remote auth server. Source user.radius.name user.ldap.name user.tacacs+.name. |
| | **max\_accounts** integer | | Maximum number of guest accounts that can be created for this group (0 means unlimited). |
| | **member** list / elements=string | | Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. |
| | | **name** string / required | | Group member name. Source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user .pop3.name. |
| | **mobile\_phone** string | **Choices:*** disable
* enable
| Enable/disable the guest user mobile phone number field. |
| | **multiple\_guest\_add** string | **Choices:*** disable
* enable
| Enable/disable addition of multiple guests. |
| | **name** string / required | | Group name. |
| | **password** string | **Choices:*** auto-generate
* specify
* disable
| Guest user password type. |
| | **sms\_custom\_server** string | | SMS server. Source system.sms-server.name. |
| | **sms\_server** string | **Choices:*** fortiguard
* custom
| Send SMS through FortiGuard or other external server. |
| | **sponsor** string | **Choices:*** optional
* mandatory
* disabled
| Set the action for the sponsor guest user field. |
| | **sso\_attribute\_value** string | | Name of the RADIUS user group that this local user group represents. |
| | **user\_id** string | **Choices:*** email
* auto-generate
* specify
| Guest user ID type. |
| | **user\_name** string | **Choices:*** disable
* enable
| Enable/disable the guest user name entry. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 groups.
fortios_user_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_group:
auth_concurrent_override: "enable"
auth_concurrent_value: "4"
authtimeout: "5"
company: "optional"
email: "disable"
expire: "8"
expire_type: "immediately"
group_type: "firewall"
guest:
-
comment: "Comment."
company: "<your_own_value>"
email: "<your_own_value>"
expiration: "<your_own_value>"
id: "16"
mobile_phone: "<your_own_value>"
name: "default_name_18"
password: "<your_own_value>"
sponsor: "<your_own_value>"
user_id: "<your_own_value>"
http_digest_realm: "<your_own_value>"
id: "23"
match:
-
group_name: "<your_own_value>"
id: "26"
server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name)"
max_accounts: "28"
member:
-
name: "default_name_30 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user.pop3.name)"
mobile_phone: "disable"
multiple_guest_add: "disable"
name: "default_name_33"
password: "auto-generate"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_server: "fortiguard"
sponsor: "optional"
sso_attribute_value: "<your_own_value>"
user_id: "email"
user_name: "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_authentication_scheme – Configure Authentication Schemes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_authentication\_scheme – Configure Authentication Schemes in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_scheme`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 scheme category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_scheme** dictionary | | Configure Authentication Schemes. |
| | **domain\_controller** string | | Domain controller setting. Source user.domain-controller.name. |
| | **ems\_device\_owner** string | **Choices:*** enable
* disable
| Enable/disable SSH public-key authentication with device owner . |
| | **fsso\_agent\_for\_ntlm** string | | FSSO agent to use for NTLM authentication. Source user.fsso.name. |
| | **fsso\_guest** string | **Choices:*** enable
* disable
| Enable/disable user fsso-guest authentication . |
| | **kerberos\_keytab** string | | Kerberos keytab setting. Source user.krb-keytab.name. |
| | **method** list / elements=string | **Choices:*** ntlm
* basic
* digest
* form
* negotiate
* fsso
* rsso
* ssh-publickey
* cert
* saml
| Authentication methods . |
| | **name** string / required | | Authentication scheme name. |
| | **negotiate\_ntlm** string | **Choices:*** enable
* disable
| Enable/disable negotiate authentication for NTLM . |
| | **require\_tfa** string | **Choices:*** enable
* disable
| Enable/disable two-factor authentication . |
| | **saml\_server** string | | SAML configuration. Source user.saml.name. |
| | **saml\_timeout** integer | | SAML authentication timeout in seconds. |
| | **ssh\_ca** string | | SSH CA name. Source firewall.ssh.local-ca.name. |
| | **user\_database** list / elements=string | | Authentication server to contain user information; "local" (default) or "123" (for LDAP). |
| | | **name** string / required | | Authentication server name. Source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.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: Configure Authentication Schemes.
fortios_authentication_scheme:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
authentication_scheme:
domain_controller: "<your_own_value> (source user.domain-controller.name)"
ems_device_owner: "enable"
fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
fsso_guest: "enable"
kerberos_keytab: "<your_own_value> (source user.krb-keytab.name)"
method: "ntlm"
name: "default_name_9"
negotiate_ntlm: "enable"
require_tfa: "enable"
saml_server: "<your_own_value> (source user.saml.name)"
saml_timeout: "13"
ssh_ca: "<your_own_value> (source firewall.ssh.local-ca.name)"
user_database:
-
name: "default_name_16 (source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name 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_system_dscp_based_priority – Configure DSCP based priority table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dscp\_based\_priority – Configure DSCP based priority 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_dscp_based_priority`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dscp\_based\_priority category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dscp\_based\_priority** dictionary | | Configure DSCP based priority table. |
| | **ds** integer | | DSCP(DiffServ) DS value (0 - 63). |
| | **id** integer / required | | Item ID. |
| | **priority** string | **Choices:*** low
* medium
* high
| DSCP based priority level. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 DSCP based priority table.
fortios_system_dscp_based_priority:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_dscp_based_priority:
ds: "3"
id: "4"
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_vpn_l2tp – Configure L2TP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_l2tp – Configure L2TP in Fortinet’s FortiOS and FortiGate.
=========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_l2tp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 l2tp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_l2tp** dictionary | | Configure L2TP. |
| | **compress** string | **Choices:*** enable
* disable
| Enable/disable data compression. |
| | **eip** string | | End IP. |
| | **enforce\_ipsec** string | **Choices:*** enable
* disable
| Enable/disable IPsec enforcement. |
| | **lcp\_echo\_interval** integer | | Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. |
| | **lcp\_max\_echo\_fails** integer | | Maximum number of missed LCP echo messages before disconnect. |
| | **sip** string | | Start IP. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FortiGate as a L2TP gateway. |
| | **usrgrp** string | | User group. 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 L2TP.
fortios_vpn_l2tp:
vdom: "{{ vdom }}"
vpn_l2tp:
compress: "enable"
eip: "<your_own_value>"
enforce_ipsec: "enable"
lcp_echo_interval: "6"
lcp_max_echo_fails: "7"
sip: "<your_own_value>"
status: "enable"
usrgrp: "<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_vpn_ipsec_phase2 – Configure VPN autokey tunnel in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_phase2 – 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`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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** dictionary | | Configure VPN autokey tunnel. |
| | **add\_route** string | **Choices:*** phase1
* enable
* disable
| Enable/disable automatic route addition. |
| | **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
| 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.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. |
| | **selector\_match** string | **Choices:*** exact
* subset
* auto
| Match type to use when comparing selectors. |
| | **single\_source** string | **Choices:*** enable
* disable
| Enable/disable single source IP restriction. |
| | **src\_addr\_type** string | **Choices:*** subnet
* range
* ip
* name
| 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. |
| | **use\_natip** string | **Choices:*** enable
* disable
| Enable to use the FortiGate public IP as the source selector when outbound NAT is used. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_phase2:
add_route: "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: "15"
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: "25"
keylifeseconds: "26"
l2tp: "enable"
name: "default_name_28"
pfs: "enable"
phase1name: "<your_own_value> (source vpn.ipsec.phase1.name)"
proposal: "null-md5"
protocol: "32"
replay: "enable"
route_overlap: "use-old"
selector_match: "exact"
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: "42"
src_start_ip: "<your_own_value>"
src_start_ip6: "<your_own_value>"
src_subnet: "<your_own_value>"
src_subnet6: "<your_own_value>"
use_natip: "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_aspath_list – Configure Autonomous System (AS) path lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_aspath\_list – Configure Autonomous System (AS) path 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_aspath_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 aspath\_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\_aspath\_list** dictionary | | Configure Autonomous System (AS) path lists. |
| | **name** string / required | | AS path list name. |
| | **rule** list / elements=string | | AS path list rule. |
| | | **action** string | **Choices:*** deny
* permit
| Permit or deny route-based operations, based on the route"s AS\_PATH attribute. |
| | | **id** integer / required | | ID. |
| | | **regexp** string | | Regular-expression to match the Border Gateway Protocol (BGP) AS paths. |
| **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 Autonomous System (AS) path lists.
fortios_router_aspath_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_aspath_list:
name: "default_name_3"
rule:
-
action: "deny"
id: "6"
regexp: "<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_webfilter_search_engine – Configure web filter search engines in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_search\_engine – Configure web filter search engines in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_search_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 webfilter feature and search\_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. |
| **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\_search\_engine** dictionary | | Configure web filter search engines. |
| | **charset** string | **Choices:*** utf-8
* gb2312
| Search engine charset. |
| | **hostname** string | | Hostname (regular expression). |
| | **name** string / required | | Search engine name. |
| | **query** string | | Code used to prefix a query (must end with an equals character). |
| | **safesearch** string | **Choices:*** disable
* url
* header
| Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header. |
| | **safesearch\_str** string | | Safe search parameter used in the URL. |
| | **url** string | | URL (regular expression). |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 web filter search engines.
fortios_webfilter_search_engine:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_search_engine:
charset: "utf-8"
hostname: "myhostname"
name: "default_name_5"
query: "<your_own_value>"
safesearch: "disable"
safesearch_str: "<your_own_value>"
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_spamfilter_bword – Configure AntiSpam banned word list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_bword – Configure AntiSpam banned word 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_spamfilter_bword`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bword category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_bword** dictionary | | Configure AntiSpam banned word list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter banned word. |
| | | **action** string | **Choices:*** spam
* clear
| Mark spam or good. |
| | | **id** integer / required | | Banned word entry ID. |
| | | **language** string | **Choices:*** western
* simch
* trach
* japanese
* korean
* french
* thai
* spanish
| Language for the banned word. |
| | | **pattern** string | | Pattern for the banned word. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **score** integer | | Score value. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | | **where** string | **Choices:*** subject
* body
* all
| Component of the email to be scanned. |
| | **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 banned word list.
fortios_spamfilter_bword:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_bword:
comment: "Optional comments."
entries:
-
action: "spam"
id: "6"
language: "western"
pattern: "<your_own_value>"
pattern_type: "wildcard"
score: "10"
status: "enable"
where: "subject"
id: "13"
name: "default_name_14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_addrgrp – Configure IPv4 address groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_addrgrp – Configure IPv4 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_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 firewall 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. |
| **firewall\_addrgrp** dictionary | | Configure IPv4 address groups. |
| | **allow\_routing** string | **Choices:*** enable
* disable
| Enable/disable use of this group in the static route configuration. |
| | **category** string | **Choices:*** default
* ztna-ems-tag
* ztna-geo-tag
| Address group category. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **exclude** string | **Choices:*** enable
* disable
| Enable/disable address exclusion. |
| | **exclude\_member** list / elements=string | | Address exclusion member. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **member** list / elements=string | | Address objects contained within the group. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **name** string / required | | Address 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. |
| | **type** string | **Choices:*** default
* folder
| Address group type. |
| | **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. |
| **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 address groups.
fortios_firewall_addrgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_addrgrp:
allow_routing: "enable"
category: "default"
color: "5"
comment: "Comment."
exclude: "enable"
exclude_member:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
fabric_object: "enable"
member:
-
name: "default_name_12 (source firewall.address.name firewall.addrgrp.name)"
name: "default_name_13"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_16"
tags:
-
name: "default_name_18 (source system.object-tagging.tags.name)"
type: "default"
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_user_security_exempt_list – Configure security exemption list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_security\_exempt\_list – Configure security exemption 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_user_security_exempt_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 user feature and security\_exempt\_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_security\_exempt\_list** dictionary | | Configure security exemption list. |
| | **description** string | | Description. |
| | **name** string / required | | Name of the exempt list. |
| | **rule** list / elements=string | | Configure rules for exempting users from captive portal authentication. |
| | | **devices** list / elements=string | | Devices or device groups. |
| | | | **name** string / required | | Device or group name. Source user.device.alias user.device-group.name user.device-category.name. |
| | | **dstaddr** list / elements=string | | Destination addresses or address groups. |
| | | | **name** string / required | | Address or group name. Source firewall.address.name firewall.addrgrp.name. |
| | | **id** integer / required | | ID. |
| | | **service** list / elements=string | | Destination services. |
| | | | **name** string / required | | Service name. Source firewall.service.custom.name firewall.service.group.name. |
| | | **srcaddr** list / elements=string | | Source addresses or address groups. |
| | | | **name** string / required | | Address or group name. Source firewall.address.name firewall.addrgrp.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 security exemption list.
fortios_user_security_exempt_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_security_exempt_list:
description: "<your_own_value>"
name: "default_name_4"
rule:
-
devices:
-
name: "default_name_7 (source user.device.alias user.device-group.name user.device-category.name)"
dstaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
id: "10"
service:
-
name: "default_name_12 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_ddns – Configure DDNS in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ddns – Configure DDNS in Fortinet’s FortiOS and FortiGate.
============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ddns`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ddns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ddns** dictionary | | Configure DDNS. |
| | **addr\_type** string | **Choices:*** ipv4
* ipv6
| Address type of interface address in DDNS update. |
| | **bound\_ip** string | | Bound IP address. |
| | **clear\_text** string | **Choices:*** disable
* enable
| Enable/disable use of clear text connections. |
| | **ddns\_auth** string | **Choices:*** disable
* tsig
| Enable/disable TSIG authentication for your DDNS server. |
| | **ddns\_domain** string | | Your fully qualified domain name (for example, yourname.DDNS.com). |
| | **ddns\_key** string | | DDNS update key (base 64 encoding). |
| | **ddns\_keyname** string | | DDNS update key name. |
| | **ddns\_password** string | | DDNS password. |
| | **ddns\_server** string | **Choices:*** dyndns.org
* dyns.net
* tzo.com
* vavic.com
* dipdns.net
* now.net.cn
* dhs.org
* easydns.com
* genericDDNS
* FortiGuardDDNS
* noip.com
| Select a DDNS service provider. |
| | **ddns\_server\_addr** list / elements=string | | Generic DDNS server IP/FQDN list. |
| | | **addr** string / required | | IP address or FQDN of the server. |
| | **ddns\_server\_ip** string | | Generic DDNS server IP. |
| | **ddns\_sn** string | | DDNS Serial Number. |
| | **ddns\_ttl** integer | | Time-to-live for DDNS packets. |
| | **ddns\_username** string | | DDNS user name. |
| | **ddns\_zone** string | | Zone of your domain name (for example, DDNS.com). |
| | **ddnsid** integer / required | | DDNS ID. |
| | **monitor\_interface** list / elements=string | | Monitored interface. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **server\_type** string | **Choices:*** ipv4
* ipv6
| Address type of the DDNS server. |
| | **ssl\_certificate** string | | Name of local certificate for SSL connections. Source certificate.local.name. |
| | **update\_interval** integer | | DDNS update interval (60 - 2592000 sec). |
| | **use\_public\_ip** string | **Choices:*** disable
* enable
| Enable/disable use of public IP 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 DDNS.
fortios_system_ddns:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ddns:
addr_type: "ipv4"
bound_ip: "<your_own_value>"
clear_text: "disable"
ddns_auth: "disable"
ddns_domain: "<your_own_value>"
ddns_key: "<your_own_value>"
ddns_keyname: "<your_own_value>"
ddns_password: "<your_own_value>"
ddns_server: "dyndns.org"
ddns_server_addr:
-
addr: "<your_own_value>"
ddns_server_ip: "<your_own_value>"
ddns_sn: "<your_own_value>"
ddns_ttl: "16"
ddns_username: "<your_own_value>"
ddns_zone: "<your_own_value>"
ddnsid: "19"
monitor_interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
server_type: "ipv4"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
update_interval: "24"
use_public_ip: "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_ptp – Configure system PTP information in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ptp – Configure system PTP 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_ptp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ptp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ptp** dictionary | | Configure system PTP information. |
| | **delay\_mechanism** string | **Choices:*** E2E
* P2P
| End to end delay detection or peer to peer delay detection. |
| | **interface** string | | PTP slave will reply through this interface. Source system.interface.name. |
| | **mode** string | **Choices:*** multicast
* hybrid
| Multicast transmission or hybrid transmission. |
| | **request\_interval** integer | | The delay request value is the logarithmic mean interval in seconds between the delay request messages sent by the slave to the master. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable setting the FortiGate system time by synchronizing with an PTP 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 PTP information.
fortios_system_ptp:
vdom: "{{ vdom }}"
system_ptp:
delay_mechanism: "E2E"
interface: "<your_own_value> (source system.interface.name)"
mode: "multicast"
request_interval: "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_wireless_controller_wtp_group – Configure WTP groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wtp\_group – Configure WTP 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_wtp_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 wtp\_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\_wtp\_group** dictionary | | Configure WTP groups. |
| | **name** string / required | | WTP group name. |
| | **platform\_type** string | **Choices:*** AP-11N
* 220B
* 210B
* 222B
* 112B
* 320B
* 11C
* 14C
* 223B
* 28C
* 320C
* 221C
* 25D
* 222C
* 224D
* 214B
* 21D
* 24D
* 112D
* 223C
* 321C
* C220C
* C225C
* C23JD
* C24JE
* S321C
* S322C
* S323C
* S311C
* S313C
* S321CR
* S322CR
* S323CR
* S421E
* S422E
* S423E
* 421E
* 423E
* 221E
* 222E
* 223E
* 224E
* S221E
* S223E
* U421E
* U422EV
* U423E
* U221EV
* U223EV
* U24JEV
* U321EV
* U323EV
* 231E
* 321E
* 431F
* 432F
* 433F
* 231F
* 234F
* 23JF
* U431F
* U433F
* 831F
* U231F
* U234F
* U432F
| FortiAP models to define the WTP group platform type. |
| | **wtps** list / elements=string | | WTP list. |
| | | **wtp\_id** string | | WTP ID. Source wireless-controller.wtp.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: Configure WTP groups.
fortios_wireless_controller_wtp_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wtp_group:
name: "default_name_3"
platform_type: "AP-11N"
wtps:
-
wtp_id: "<your_own_value> (source wireless-controller.wtp.wtp-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)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_address6 – Configure IPv6 firewall addresses in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_address6 – Configure IPv6 firewall 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_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 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\_address6** dictionary | | Configure IPv6 firewall addresses. |
| | **cache\_ttl** integer | | Minimal TTL of individual IPv6 addresses in FQDN cache. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32). |
| | **comment** string | | Comment. |
| | **country** string | | IPv6 addresses associated to a specific country. |
| | **end\_ip** string | | Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **end\_mac** string | | Last MAC address in the range. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **fqdn** string | | Fully qualified domain name. |
| | **host** string | | Host Address. |
| | **host\_type** string | **Choices:*** any
* specific
| Host type. |
| | **ip6** string | | IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). |
| | **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. |
| | **obj\_id** string | | Object ID for NSX. |
| | **sdn** string | **Choices:*** nsx
| SDN. Source system.sdn-connector.name. |
| | **start\_ip** string | | First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **start\_mac** string | | First MAC address in the range. |
| | **subnet\_segment** list / elements=string | | IPv6 subnet segments. |
| | | **name** string / required | | Name. |
| | | **type** string | **Choices:*** any
* specific
| Subnet segment type. |
| | | **value** string | | Subnet segment value. |
| | **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. |
| | **template** string | | IPv6 address template. Source firewall.address6-template.name. |
| | **type** string | **Choices:*** ipprefix
* iprange
* fqdn
* dynamic
* template
* mac
* geography
| Type of IPv6 address object . |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable the 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: Configure IPv6 firewall addresses.
fortios_firewall_address6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_address6:
cache_ttl: "3"
color: "4"
comment: "Comment."
country: "<your_own_value>"
end_ip: "<your_own_value>"
end_mac: "<your_own_value>"
fabric_object: "enable"
fqdn: "<your_own_value>"
host: "<your_own_value>"
host_type: "any"
ip6: "<your_own_value>"
list:
-
ip: "<your_own_value>"
net_id: "<your_own_value>"
obj_id: "<your_own_value>"
macaddr:
-
macaddr: "<your_own_value>"
name: "default_name_20"
obj_id: "<your_own_value>"
sdn: "nsx"
start_ip: "<your_own_value>"
start_mac: "<your_own_value>"
subnet_segment:
-
name: "default_name_26"
type: "any"
value: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_31"
tags:
-
name: "default_name_33 (source system.object-tagging.tags.name)"
template: "<your_own_value> (source firewall.address6-template.name)"
type: "ipprefix"
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_router_prefix_list6 – Configure IPv6 prefix lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_prefix\_list6 – Configure IPv6 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_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 prefix\_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\_prefix\_list6** dictionary | | Configure IPv6 prefix lists. |
| | **comments** string | | Comment. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | IPv6 prefix list rule. |
| | | **action** string | **Choices:*** permit
* deny
| Permit or deny packets that match this rule. |
| | | **flags** integer | | Flags. |
| | | **ge** integer | | Minimum prefix length to be matched (0 - 128). |
| | | **id** integer / required | | Rule ID. |
| | | **le** integer | | Maximum prefix length to be matched (0 - 128). |
| | | **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 prefix lists.
fortios_router_prefix_list6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_prefix_list6:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
action: "permit"
flags: "7"
ge: "8"
id: "9"
le: "10"
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_system_zone – Configure zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in the zone in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_zone – Configure zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in the zone in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_zone`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 zone category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_zone** dictionary | | Configure zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in the zone. |
| | **description** string | | Description. |
| | **interface** list / elements=string | | Add interfaces to this zone. Interfaces must not be assigned to another zone or have firewall policies defined. |
| | | **interface\_name** string | | Select two or more interfaces to add to the zone. Source system.interface.name. |
| | **intrazone** string | **Choices:*** allow
* deny
| Allow or deny traffic routing between different interfaces in the same zone . |
| | **name** string / required | | Zone 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 zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in
the zone.
fortios_system_zone:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_zone:
description: "<your_own_value>"
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
intrazone: "allow"
name: "default_name_7"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_10"
tags:
-
name: "default_name_12 (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_hardware_npu_np6_session_stats – Show NP6 session offloading statistics counters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_hardware\_npu\_np6\_session\_stats – Show NP6 session offloading 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_session_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 session\_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\_session\_stats** dictionary | | Show NP6 session offloading 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 session offloading statistics counters.
fortios_hardware_npu_np6_session_stats:
vdom: "{{ vdom }}"
hardware_npu_np6_session_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)
| programming_docs |
ansible fortinet.fortios.fortios_log_syslogd_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd\_setting – Global 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_syslogd_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\_syslogd 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\_syslogd\_setting** dictionary | | Global 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. |
| | **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: Global settings for remote syslog server.
fortios_log_syslogd_setting:
vdom: "{{ vdom }}"
log_syslogd_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"
port: "15"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "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_system_ips – Configure IPS system settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ips – Configure IPS system 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_ips`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ips** dictionary | | Configure IPS system settings. |
| | **override\_signature\_hold\_by\_id** string | **Choices:*** enable
* disable
| Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. |
| | **signature\_hold\_time** string | | Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 system settings.
fortios_system_ips:
vdom: "{{ vdom }}"
system_ips:
override_signature_hold_by_id: "enable"
signature_hold_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_system_fips_cc – Configure FIPS-CC mode in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fips\_cc – Configure FIPS-CC mode in Fortinet’s FortiOS and FortiGate.
========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fips_cc`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fips\_cc category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fips\_cc** dictionary | | Configure FIPS-CC mode. |
| | **entropy\_token** string | **Choices:*** enable
* disable
* dynamic
| Enable/disable/dynamic entropy token. |
| | **key\_generation\_self\_test** string | **Choices:*** enable
* disable
| Enable/disable self tests after key generation. |
| | **self\_test\_period** integer | | Self test period. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FIPS-CC 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 FIPS-CC mode.
fortios_system_fips_cc:
vdom: "{{ vdom }}"
system_fips_cc:
entropy_token: "enable"
key_generation_self_test: "enable"
self_test_period: "5"
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_router_policy – Configure IPv4 routing policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_policy – Configure IPv4 routing 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_router_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 router 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. |
| **router\_policy** dictionary | | Configure IPv4 routing policies. |
| | **action** string | **Choices:*** deny
* permit
| Action of the policy route. |
| | **comments** string | | Optional comments. |
| | **dst** list / elements=string | | Destination IP and mask (x.x.x.x/x). |
| | | **subnet** string / required | | IP and mask. |
| | **dst\_negate** string | **Choices:*** enable
* disable
| Enable/disable negating destination address match. |
| | **dstaddr** list / elements=string | | Destination address name. |
| | | **name** string / required | | Address/group name. Source firewall.address.name firewall.addrgrp.name. |
| | **end\_port** integer | | End destination port number (0 - 65535). |
| | **end\_source\_port** integer | | End source port number (0 - 65535). |
| | **gateway** string | | IP address of the gateway. |
| | **input\_device** list / elements=string | | Incoming 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\_custom** list / elements=string | | Custom Destination Internet Service name. |
| | | **name** string / required | | Custom Destination Internet Service name. Source firewall.internet-service-custom.name. |
| | **internet\_service\_id** list / elements=string | | Destination Internet Service ID. |
| | | **id** integer / required | | Destination Internet Service ID. Source firewall.internet-service.id. |
| | **output\_device** string | | Outgoing interface name. Source system.interface.name. |
| | **protocol** integer | | Protocol number (0 - 255). |
| | **seq\_num** integer | | Sequence number. |
| | **src** list / elements=string | | Source IP and mask (x.x.x.x/x). |
| | | **subnet** string / required | | IP and mask. |
| | **src\_negate** string | **Choices:*** enable
* disable
| Enable/disable negating source address match. |
| | **srcaddr** list / elements=string | | Source address name. |
| | | **name** string / required | | Address/group name. Source firewall.address.name firewall.addrgrp.name. |
| | **start\_port** integer | | Start destination port number (0 - 65535). |
| | **start\_source\_port** integer | | Start source port number (0 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy route. |
| | **tos** string | | Type of service bit pattern. |
| | **tos\_mask** string | | Type of service evaluated bits. |
| **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 routing policies.
fortios_router_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_policy:
action: "deny"
comments: "<your_own_value>"
dst:
-
subnet: "<your_own_value>"
dst_negate: "enable"
dstaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
end_port: "10"
end_source_port: "11"
gateway: "<your_own_value>"
input_device:
-
name: "default_name_14 (source system.interface.name)"
input_device_negate: "enable"
internet_service_custom:
-
name: "default_name_17 (source firewall.internet-service-custom.name)"
internet_service_id:
-
id: "19 (source firewall.internet-service.id)"
output_device: "<your_own_value> (source system.interface.name)"
protocol: "21"
seq_num: "22"
src:
-
subnet: "<your_own_value>"
src_negate: "enable"
srcaddr:
-
name: "default_name_27 (source firewall.address.name firewall.addrgrp.name)"
start_port: "28"
start_source_port: "29"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<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_vpn_certificate_ocsp_server – OCSP server configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_certificate\_ocsp\_server – OCSP server 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_vpn_certificate_ocsp_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 vpn\_certificate feature and ocsp\_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. |
| **vpn\_certificate\_ocsp\_server** dictionary | | OCSP server configuration. |
| | **cert** string | | OCSP server certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name. |
| | **name** string / required | | OCSP server entry name. |
| | **secondary\_cert** string | | Secondary OCSP server certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name. |
| | **secondary\_url** string | | Secondary OCSP server URL. |
| | **source\_ip** string | | Source IP address for communications to the OCSP server. |
| | **unavail\_action** string | **Choices:*** revoke
* ignore
| Action when server is unavailable (revoke the certificate or ignore the result of the check). |
| | **url** string | | OCSP server 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: OCSP server configuration.
fortios_vpn_certificate_ocsp_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_ocsp_server:
cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
name: "default_name_4"
secondary_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
secondary_url: "<your_own_value>"
source_ip: "84.230.14.43"
unavail_action: "revoke"
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_system_performance_top – Display information about the top CPU processes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_performance\_top – Display information about the top CPU processes in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_performance_top`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_performance feature and top category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_performance\_top** dictionary | | Display information about the top CPU processes. |
| | string | | Delay in 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: Display information about the top CPU processes.
fortios_system_performance_top:
vdom: "{{ vdom }}"
system_performance_top:
<delay>: "<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_dhcp6_server – Configure DHCPv6 servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dhcp6\_server – Configure DHCPv6 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_dhcp6_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\_dhcp6 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\_dhcp6\_server** dictionary | | Configure DHCPv6 servers. |
| | **dns\_search\_list** string | **Choices:*** delegated
* specify
| DNS search list options. |
| | **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:*** delegated
* default
* specify
| Options for assigning DNS servers to DHCPv6 clients. |
| | **domain** string | | Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
| | **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
* delegated
| 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. |
| | **lease\_time** integer | | Lease time in seconds, 0 means unlimited. |
| | **option1** string | | Option 1. |
| | **option2** string | | Option 2. |
| | **option3** string | | Option 3. |
| | **prefix\_mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from a DHCPv6 client or RA. |
| | **prefix\_range** list / elements=string | | DHCP prefix configuration. |
| | | **end\_prefix** string | | End of prefix range. |
| | | **id** integer / required | | ID. |
| | | **prefix\_length** integer | | Prefix length. |
| | | **start\_prefix** string | | Start of prefix range. |
| | **rapid\_commit** string | **Choices:*** disable
* enable
| Enable/disable allow/disallow rapid commit. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this DHCPv6 configuration. |
| | **subnet** string | | Subnet or subnet-id if the IP mode is delegated. |
| | **upstream\_interface** string | | Interface name from where delegated information is provided. 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 DHCPv6 servers.
fortios_system_dhcp6_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_dhcp6_server:
dns_search_list: "delegated"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_server3: "<your_own_value>"
dns_server4: "<your_own_value>"
dns_service: "delegated"
domain: "<your_own_value>"
id: "10"
interface: "<your_own_value> (source system.interface.name)"
ip_mode: "range"
ip_range:
-
end_ip: "<your_own_value>"
id: "15"
start_ip: "<your_own_value>"
lease_time: "17"
option1: "<your_own_value>"
option2: "<your_own_value>"
option3: "<your_own_value>"
prefix_mode: "dhcp6"
prefix_range:
-
end_prefix: "<your_own_value>"
id: "24"
prefix_length: "25"
start_prefix: "<your_own_value>"
rapid_commit: "disable"
status: "disable"
subnet: "<your_own_value>"
upstream_interface: "<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_webfilter_fortiguard – Configure FortiGuard Web Filter service in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_fortiguard – Configure FortiGuard Web Filter service in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 webfilter 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. |
| **vdom** string | **Default:**"root" | Virtual 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\_fortiguard** dictionary | | Configure FortiGuard Web Filter service. |
| | **cache\_mem\_percent** integer | | Maximum percentage of available memory allocated to caching (1 - 15%). |
| | **cache\_mode** string | **Choices:*** ttl
* db-ver
| Cache entry expiration mode. |
| | **cache\_prefix\_match** string | **Choices:*** enable
* disable
| Enable/disable prefix matching in the cache. |
| | **close\_ports** string | **Choices:*** enable
* disable
| Close ports used for HTTP/HTTPS override authentication and disable user overrides. |
| | **ovrd\_auth\_https** string | **Choices:*** enable
* disable
| Enable/disable use of HTTPS for override authentication. |
| | **ovrd\_auth\_port** integer | | Port to use for FortiGuard Web Filter override authentication. |
| | **ovrd\_auth\_port\_http** integer | | Port to use for FortiGuard Web Filter HTTP override authentication |
| | **ovrd\_auth\_port\_https** integer | | Port to use for FortiGuard Web Filter HTTPS override authentication. |
| | **ovrd\_auth\_port\_https\_flow** integer | | Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode. |
| | **ovrd\_auth\_port\_warning** integer | | Port to use for FortiGuard Web Filter Warning override authentication. |
| | **request\_packet\_size\_limit** integer | | Limit size of URL request packets sent to FortiGuard server (0 for default). |
| | **warn\_auth\_https** string | **Choices:*** enable
* disable
| Enable/disable use of HTTPS for warning and authentication. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 service.
fortios_webfilter_fortiguard:
vdom: "{{ vdom }}"
webfilter_fortiguard:
cache_mem_percent: "3"
cache_mode: "ttl"
cache_prefix_match: "enable"
close_ports: "enable"
ovrd_auth_https: "enable"
ovrd_auth_port: "8"
ovrd_auth_port_http: "9"
ovrd_auth_port_https: "10"
ovrd_auth_port_https_flow: "11"
ovrd_auth_port_warning: "12"
request_packet_size_limit: "13"
warn_auth_https: "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_spamfilter_mheader – Configure AntiSpam MIME header in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_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_spamfilter_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 spamfilter 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **spamfilter\_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. |
| **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_spamfilter_mheader:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_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)
ansible fortinet.fortios.fortios_system_network_visibility – Configure network visibility settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_network\_visibility – Configure network visibility 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_network_visibility`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 network\_visibility category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_network\_visibility** dictionary | | Configure network visibility settings. |
| | **destination\_hostname\_visibility** string | **Choices:*** disable
* enable
| Enable/disable logging of destination hostname visibility. |
| | **destination\_location** string | **Choices:*** disable
* enable
| Enable/disable logging of destination geographical location visibility. |
| | **destination\_visibility** string | **Choices:*** disable
* enable
| Enable/disable logging of destination visibility. |
| | **hostname\_limit** integer | | Limit of the number of hostname table entries (0 - 50000). |
| | **hostname\_ttl** integer | | TTL of hostname table entries (60 - 86400). |
| | **source\_location** string | **Choices:*** disable
* enable
| Enable/disable logging of source geographical location visibility. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 network visibility settings.
fortios_system_network_visibility:
vdom: "{{ vdom }}"
system_network_visibility:
destination_hostname_visibility: "disable"
destination_location: "disable"
destination_visibility: "disable"
hostname_limit: "6"
hostname_ttl: "7"
source_location: "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_replacemsg_alertmail – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_alertmail – 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_alertmail`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 alertmail category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_alertmail** 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_alertmail:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_alertmail:
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_webfilter_content_header – Configure content types used by Web filter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_content\_header – Configure content types used by Web 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_webfilter_content_header`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 content\_header category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_content\_header** dictionary | | Configure content types used by Web filter. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Configure content types used by web filter. |
| | | **action** string | **Choices:*** block
* allow
* exempt
| Action to take for this content type. |
| | | **category** string | | Categories that this content type applies to. |
| | | **pattern** string / required | | Content type (regular expression). |
| | **id** integer / required | | ID. |
| | **name** string | | Name of table. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 content types used by Web filter.
fortios_webfilter_content_header:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_content_header:
comment: "Optional comments."
entries:
-
action: "block"
category: "<your_own_value>"
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)
ansible fortinet.fortios.fortios_system_replacemsg_device_detection_portal – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_device\_detection\_portal – 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_device_detection_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 system\_replacemsg feature and device\_detection\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_replacemsg\_device\_detection\_portal** 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_device_detection_portal:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_device_detection_portal:
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_router_policy6 – Configure IPv6 routing policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_policy6 – Configure IPv6 routing 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_router_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 router 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. |
| **router\_policy6** dictionary | | Configure IPv6 routing policies. |
| | **comments** string | | Optional comments. |
| | **dst** string | | Destination IPv6 prefix. |
| | **end\_port** integer | | End destination port number (1 - 65535). |
| | **gateway** string | | IPv6 address of the gateway. |
| | **input\_device** string | | Incoming interface name. Source system.interface.name. |
| | **output\_device** string | | Outgoing interface name. Source system.interface.name. |
| | **protocol** integer | | Protocol number (0 - 255). |
| | **seq\_num** integer | | Sequence number. |
| | **src** string | | Source IPv6 prefix. |
| | **start\_port** integer | | Start destination port number (1 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy route. |
| | **tos** string | | Type of service bit pattern. |
| | **tos\_mask** string | | Type of service evaluated bits. |
| **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 routing policies.
fortios_router_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_policy6:
comments: "<your_own_value>"
dst: "<your_own_value>"
end_port: "5"
gateway: "<your_own_value>"
input_device: "<your_own_value> (source system.interface.name)"
output_device: "<your_own_value> (source system.interface.name)"
protocol: "9"
seq_num: "10"
src: "<your_own_value>"
start_port: "12"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<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_fortiguard_override_filter – Override filters for FortiCloud in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortiguard\_override\_filter – Override 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_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\_fortiguard 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\_fortiguard\_override\_filter** dictionary | | Override 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: Override filters for FortiCloud.
fortios_log_fortiguard_override_filter:
vdom: "{{ vdom }}"
log_fortiguard_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_wanopt_webcache – Configure global Web cache settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wanopt\_webcache – Configure global Web cache 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_wanopt_webcache`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 webcache category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_webcache** dictionary | | Configure global Web cache settings. |
| | **always\_revalidate** string | **Choices:*** enable
* disable
| Enable/disable revalidation of requested cached objects, which have content on the server, before serving it to the client. |
| | **cache\_by\_default** string | **Choices:*** enable
* disable
| Enable/disable caching content that lacks explicit caching policies from the server. |
| | **cache\_cookie** string | **Choices:*** enable
* disable
| Enable/disable caching cookies. Since cookies contain information for or about individual users, they not usually cached. |
| | **cache\_expired** string | **Choices:*** enable
* disable
| Enable/disable caching type-1 objects that are already expired on arrival. |
| | **default\_ttl** integer | | Default object expiry time . This only applies to those objects that do not have an expiry time set by the web server. |
| | **external** string | **Choices:*** enable
* disable
| Enable/disable external Web caching. |
| | **fresh\_factor** integer | | Frequency that the server is checked to see if any objects have expired (1 - 100). The higher the fresh factor, the less often the checks occur. |
| | **host\_validate** string | **Choices:*** enable
* disable
| Enable/disable validating "Host:" with original server IP. |
| | **ignore\_conditional** string | **Choices:*** enable
* disable
| Enable/disable controlling the behavior of cache-control HTTP 1.1 header values. |
| | **ignore\_ie\_reload** string | **Choices:*** enable
* disable
| Enable/disable ignoring the PNC-interpretation of Internet Explorer"s Accept: / header. |
| | **ignore\_ims** string | **Choices:*** enable
* disable
| Enable/disable ignoring the if-modified-since (IMS) header. |
| | **ignore\_pnc** string | **Choices:*** enable
* disable
| Enable/disable ignoring the pragma no-cache (PNC) header. |
| | **max\_object\_size** integer | | Maximum cacheable object size in kB (1 - 2147483 kb (2GB). All objects that exceed this are delivered to the client but not stored in the web cache. |
| | **max\_ttl** integer | | Maximum time an object can stay in the web cache without checking to see if it has expired on the server . |
| | **min\_ttl** integer | | Minimum time an object can stay in the web cache without checking to see if it has expired on the server . |
| | **neg\_resp\_time** integer | | Time in minutes to cache negative responses or errors (0 - 4294967295). |
| | **reval\_pnc** string | **Choices:*** enable
* disable
| Enable/disable revalidation of pragma-no-cache (PNC) to address bandwidth concerns. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 Web cache settings.
fortios_wanopt_webcache:
vdom: "{{ vdom }}"
wanopt_webcache:
always_revalidate: "enable"
cache_by_default: "enable"
cache_cookie: "enable"
cache_expired: "enable"
default_ttl: "7"
external: "enable"
fresh_factor: "9"
host_validate: "enable"
ignore_conditional: "enable"
ignore_ie_reload: "enable"
ignore_ims: "enable"
ignore_pnc: "enable"
max_object_size: "15"
max_ttl: "16"
min_ttl: "17"
neg_resp_time: "18"
reval_pnc: "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_mm3 – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_mm3 – 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_mm3`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 mm3 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_mm3** dictionary | | Replacement messages. |
| | **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 |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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_mm3:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_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>"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_credential_store_domain_controller – Define known domain controller servers in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_credential\_store\_domain\_controller – Define known domain controller 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_credential_store_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 credential\_store 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. |
| **credential\_store\_domain\_controller** dictionary | | Define known domain controller servers. |
| | **domain\_name** string | | Fully qualified domain name (FQDN). |
| | **hostname** string | | Hostname of the server to connect to. |
| | **ip** string | | IPv4 server address. |
| | **ip6** string | | IPv6 server address. |
| | **password** string | | Password for specified username. |
| | **port** integer | | Port number of service. Port number 0 indicates automatic discovery. |
| | **server\_name** string | | Name of the domain controller. |
| | **username** string | | User name to sign in with. Must have proper permissions for service. |
| **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: Define known domain controller servers.
fortios_credential_store_domain_controller:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
credential_store_domain_controller:
domain_name: "<your_own_value>"
hostname: "myhostname"
ip: "<your_own_value>"
ip6: "<your_own_value>"
password: "<your_own_value>"
port: "8"
server_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_vap – Configure Virtual Access Points (VAPs) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_vap – Configure Virtual Access Points (VAPs) in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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** dictionary | | Configure Virtual Access Points (VAPs). |
| | **access\_control\_list** string | | access-control-list profile name. Source wireless-controller.access-control-list.name. |
| | **acct\_interim\_interval** integer | | WiFi RADIUS accounting interim interval (60 - 86400 sec). |
| | **additional\_akms** list / elements=string | **Choices:*** akm6
| Additional AKMs. |
| | **address\_group** string | | Address group ID. Source wireless-controller.addrgrp.id. |
| | **alias** string | | Alias. |
| | **atf\_weight** integer | | Airtime weight in percentage . |
| | **auth** string | **Choices:*** psk
* radius
* usergroup
| Authentication protocol. |
| | **broadcast\_ssid** string | **Choices:*** enable
* disable
| Enable/disable broadcasting the SSID . |
| | **broadcast\_suppression** list / elements=string | **Choices:*** dhcp-up
* dhcp-down
* dhcp-starvation
* arp-known
* arp-unknown
* arp-reply
* arp-poison
* arp-proxy
* netbios-ns
* netbios-ds
* ipv6
* all-other-mc
* all-other-bc
* dhcp-ucast
| Optional suppression of broadcast messages. For example, you can keep DHCP messages, ARP broadcasts, and so on off of the wireless network. |
| | **bss\_color\_partial** string | **Choices:*** enable
* disable
| Enable/disable 802.11ax partial BSS color . |
| | **bstm\_disassociation\_imminent** string | **Choices:*** enable
* disable
| Enable/disable forcing of disassociation after the BSTM request timer has been reached . |
| | **bstm\_load\_balancing\_disassoc\_timer** integer | | Time interval for client to voluntarily leave AP before forcing a disassociation due to AP load-balancing (0 to 30). |
| | **bstm\_rssi\_disassoc\_timer** integer | | Time interval for client to voluntarily leave AP before forcing a disassociation due to low RSSI (0 to 2000). |
| | **captive\_portal\_ac\_name** string | | Local-bridging captive portal ac-name. |
| | **captive\_portal\_auth\_timeout** integer | | Hard timeout - AP will always clear the session after timeout regardless of traffic (0 - 864000 sec). |
| | **captive\_portal\_macauth\_radius\_secret** string | | Secret key to access the macauth RADIUS server. |
| | **captive\_portal\_macauth\_radius\_server** string | | Captive portal external RADIUS server domain name or IP address. |
| | **captive\_portal\_radius\_secret** string | | Secret key to access the RADIUS server. |
| | **captive\_portal\_radius\_server** string | | Captive portal RADIUS server domain name or IP address. |
| | **captive\_portal\_session\_timeout\_interval** integer | | Session timeout interval (0 - 864000 sec). |
| | **dhcp\_address\_enforcement** string | **Choices:*** enable
* disable
| Enable/disable DHCP address enforcement . |
| | **dhcp\_lease\_time** integer | | DHCP lease time in seconds for NAT IP address. |
| | **dhcp\_option43\_insertion** string | **Choices:*** enable
* disable
| Enable/disable insertion of DHCP option 43 . |
| | **dhcp\_option82\_circuit\_id\_insertion** string | **Choices:*** style-1
* style-2
* disable
* style-3
| Enable/disable DHCP option 82 circuit-id insert . |
| | **dhcp\_option82\_insertion** string | **Choices:*** enable
* disable
| Enable/disable DHCP option 82 insert . |
| | **dhcp\_option82\_remote\_id\_insertion** string | **Choices:*** style-1
* disable
| Enable/disable DHCP option 82 remote-id insert . |
| | **dynamic\_vlan** string | **Choices:*** enable
* disable
| Enable/disable dynamic VLAN assignment. |
| | **eap\_reauth** string | **Choices:*** enable
* disable
| Enable/disable EAP re-authentication for WPA-Enterprise security. |
| | **eap\_reauth\_intv** integer | | EAP re-authentication interval (1800 - 864000 sec). |
| | **eapol\_key\_retries** string | **Choices:*** disable
* enable
| Enable/disable retransmission of EAPOL-Key frames (message 3/4 and group message 1/2) . |
| | **encrypt** string | **Choices:*** TKIP
* AES
* TKIP-AES
| Encryption protocol to use (only available when security is set to a WPA type). |
| | **external\_fast\_roaming** string | **Choices:*** enable
* disable
| Enable/disable fast roaming or pre-authentication with external APs not managed by the FortiGate . |
| | **external\_logout** string | | URL of external authentication logout server. |
| | **external\_web** string | | URL of external authentication web server. |
| | **external\_web\_format** string | **Choices:*** auto-detect
* no-query-string
* partial-query-string
| URL query parameter detection . |
| | **fast\_bss\_transition** string | **Choices:*** disable
* enable
| Enable/disable 802.11r Fast BSS Transition (FT) . |
| | **fast\_roaming** string | **Choices:*** enable
* disable
| Enable/disable fast-roaming, or pre-authentication, where supported by clients . |
| | **ft\_mobility\_domain** integer | | Mobility domain identifier in FT (1 - 65535). |
| | **ft\_over\_ds** string | **Choices:*** disable
* enable
| Enable/disable FT over the Distribution System (DS). |
| | **ft\_r0\_key\_lifetime** integer | | Lifetime of the PMK-R0 key in FT, 1-65535 minutes. |
| | **gas\_comeback\_delay** integer | | GAS comeback delay (0 or 100 - 10000 milliseconds). |
| | **gas\_fragmentation\_limit** integer | | GAS fragmentation limit (512 - 4096). |
| | **gtk\_rekey** string | **Choices:*** enable
* disable
| Enable/disable GTK rekey for WPA security. |
| | **gtk\_rekey\_intv** integer | | GTK rekey interval (1800 - 864000 sec). |
| | **high\_efficiency** string | **Choices:*** enable
* disable
| Enable/disable 802.11ax high efficiency . |
| | **hotspot20\_profile** string | | Hotspot 2.0 profile name. Source wireless-controller.hotspot20.hs-profile.name. |
| | **igmp\_snooping** string | **Choices:*** enable
* disable
| Enable/disable IGMP snooping. |
| | **intra\_vap\_privacy** string | **Choices:*** enable
* disable
| Enable/disable blocking communication between clients on the same SSID (called intra-SSID privacy) . |
| | **ip** string | | IP address and subnet mask for the local standalone NAT subnet. |
| | **ipv6\_rules** list / elements=string | **Choices:*** drop-icmp6ra
* drop-icmp6rs
* drop-llmnr6
* drop-icmp6mld2
* drop-dhcp6s
* drop-dhcp6c
* ndp-proxy
* drop-ns-dad
* drop-ns-nondad
| Optional rules of IPv6 packets. For example, you can keep RA, RS and so on off of the wireless network. |
| | **key** string | | WEP Key. |
| | **keyindex** integer | | WEP key index (1 - 4). |
| | **ldpc** string | **Choices:*** disable
* rx
* tx
* rxtx
| VAP low-density parity-check (LDPC) coding configuration. |
| | **local\_authentication** string | **Choices:*** enable
* disable
| Enable/disable AP local authentication. |
| | **local\_bridging** string | **Choices:*** enable
* disable
| Enable/disable bridging of wireless and Ethernet interfaces on the FortiAP . |
| | **local\_lan** string | **Choices:*** allow
* deny
| Allow/deny traffic destined for a Class A, B, or C private IP address . |
| | **local\_standalone** string | **Choices:*** enable
* disable
| Enable/disable AP local standalone . |
| | **local\_standalone\_nat** string | **Choices:*** enable
* disable
| Enable/disable AP local standalone NAT mode. |
| | **mac\_auth\_bypass** string | **Choices:*** enable
* disable
| Enable/disable MAC authentication bypass. |
| | **mac\_called\_station\_delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC called station delimiter . |
| | **mac\_calling\_station\_delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC calling station delimiter . |
| | **mac\_case** string | **Choices:*** uppercase
* lowercase
| MAC case . |
| | **mac\_filter** string | **Choices:*** enable
* disable
| Enable/disable MAC filtering to block wireless clients by mac address. |
| | **mac\_filter\_list** list / elements=string | | Create a list of MAC addresses for MAC address filtering. |
| | | **id** integer / required | | ID. |
| | | **mac** string | | MAC address. |
| | | **mac\_filter\_policy** string | **Choices:*** allow
* deny
| Deny or allow the client with this MAC address. |
| | **mac\_filter\_policy\_other** string | **Choices:*** allow
* deny
| Allow or block clients with MAC addresses that are not in the filter list. |
| | **mac\_password\_delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC authentication password delimiter . |
| | **mac\_username\_delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC authentication username delimiter . |
| | **max\_clients** integer | | Maximum number of clients that can connect simultaneously to the VAP . |
| | **max\_clients\_ap** integer | | Maximum number of clients that can connect simultaneously to each radio . |
| | **mbo** string | **Choices:*** disable
* enable
| Enable/disable Multiband Operation . |
| | **mbo\_cell\_data\_conn\_pref** string | **Choices:*** excluded
* prefer-not
* prefer-use
| MBO cell data connection preference (0, 1, or 255). |
| | **me\_disable\_thresh** integer | | Disable multicast enhancement when this many clients are receiving multicast traffic. |
| | **mesh\_backhaul** string | **Choices:*** enable
* disable
| Enable/disable using this VAP as a WiFi mesh backhaul . This entry is only available when security is set to a WPA type or open. |
| | **mpsk** string | **Choices:*** enable
* disable
| Enable/disable multiple pre-shared keys (PSKs.) |
| | **mpsk\_concurrent\_clients** integer | | Number of pre-shared keys (PSKs) to allow if multiple pre-shared keys are enabled. |
| | **mpsk\_key** list / elements=string | | Pre-shared keys that can be used to connect to this virtual access point. |
| | | **comment** string | | Comment. |
| | | **concurrent\_clients** string | | Number of clients that can connect using this pre-shared key. |
| | | **key\_name** string | | Pre-shared key name. |
| | | **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. |
| | | **passphrase** string | | WPA Pre-shared key. |
| | **mpsk\_profile** string | | MPSK profile name. Source wireless-controller.mpsk-profile.name. |
| | **mu\_mimo** string | **Choices:*** enable
* disable
| Enable/disable Multi-user MIMO . |
| | **multicast\_enhance** string | **Choices:*** enable
* disable
| Enable/disable converting multicast to unicast to improve performance . |
| | **multicast\_rate** string | **Choices:*** 0
* 6000
* 12000
* 24000
| Multicast rate (0, 6000, 12000, or 24000 kbps). |
| | **nac** string | **Choices:*** enable
* disable
| Enable/disable network access control. |
| | **nac\_profile** string | | NAC profile name. Source wireless-controller.nac-profile.name. |
| | **name** string / required | | Virtual AP name. |
| | **neighbor\_report\_dual\_band** string | **Choices:*** disable
* enable
| Enable/disable dual-band neighbor report . |
| | **okc** string | **Choices:*** disable
* enable
| Enable/disable Opportunistic Key Caching (OKC) . |
| | **owe\_groups** list / elements=string | **Choices:*** 19
* 20
* 21
| OWE-Groups. |
| | **owe\_transition** string | **Choices:*** disable
* enable
| Enable/disable OWE transition mode support. |
| | **owe\_transition\_ssid** string | | OWE transition mode peer SSID. |
| | **passphrase** string | | WPA pre-shard key (PSK) to be used to authenticate WiFi users. |
| | **pmf** string | **Choices:*** disable
* enable
* optional
| Protected Management Frames (PMF) support . |
| | **pmf\_assoc\_comeback\_timeout** integer | | Protected Management Frames (PMF) comeback maximum timeout (1-20 sec). |
| | **pmf\_sa\_query\_retry\_timeout** integer | | Protected Management Frames (PMF) SA query retry timeout interval (1 - 5 100s of msec). |
| | **port\_macauth** string | **Choices:*** disable
* radius
* address-group
| Enable/disable LAN port MAC authentication . |
| | **port\_macauth\_reauth\_timeout** integer | | LAN port MAC authentication re-authentication timeout value . |
| | **port\_macauth\_timeout** integer | | LAN port MAC authentication idle timeout value . |
| | **portal\_message\_override\_group** string | | Replacement message group for this VAP (only available when security is set to a captive portal type). Source system.replacemsg-group .name. |
| | **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. |
| | **portal\_type** string | **Choices:*** auth
* auth+disclaimer
* disclaimer
* email-collect
* cmcc
* cmcc-macauth
* auth-mac
* external-auth
* external-macauth
| Captive portal functionality. Configure how the captive portal authenticates users and whether it includes a disclaimer. |
| | **primary\_wag\_profile** string | | Primary wireless access gateway profile name. Source wireless-controller.wag-profile.name. |
| | **probe\_resp\_suppression** string | **Choices:*** enable
* disable
| Enable/disable probe response suppression (to ignore weak signals) . |
| | **probe\_resp\_threshold** string | | Minimum signal level/threshold in dBm required for the AP response to probe requests (-95 to -20). |
| | **ptk\_rekey** string | **Choices:*** enable
* disable
| Enable/disable PTK rekey for WPA-Enterprise security. |
| | **ptk\_rekey\_intv** integer | | PTK rekey interval (1800 - 864000 sec). |
| | **qos\_profile** string | | Quality of service profile name. Source wireless-controller.qos-profile.name. |
| | **quarantine** string | **Choices:*** enable
* disable
| Enable/disable station quarantine . |
| | **radio\_2g\_threshold** string | | Minimum signal level/threshold in dBm required for the AP response to receive a packet in 2.4G band (-95 to -20). |
| | **radio\_5g\_threshold** string | | Minimum signal level/threshold in dBm required for the AP response to receive a packet in 5G band(-95 to -20). |
| | **radio\_sensitivity** string | **Choices:*** enable
* disable
| Enable/disable software radio sensitivity (to ignore weak signals) . |
| | **radius\_mac\_auth** string | **Choices:*** enable
* disable
| Enable/disable RADIUS-based MAC authentication of clients . |
| | **radius\_mac\_auth\_server** string | | RADIUS-based MAC authentication server. Source user.radius.name. |
| | **radius\_mac\_auth\_usergroups** list / elements=string | | Selective user groups that are permitted for RADIUS mac authentication. |
| | | **name** string / required | | User group name. |
| | **radius\_server** string | | RADIUS server to be used to authenticate WiFi users. Source user.radius.name. |
| | **rates\_11a** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-basic
* 11
* 11-basic
* 6
* 6-basic
* 9
* 9-basic
* 12
* 12-basic
* 18
* 18-basic
* 24
* 24-basic
* 36
* 36-basic
* 48
* 48-basic
* 54
* 54-basic
| Allowed data rates for 802.11a. |
| | **rates\_11ac\_ss12** list / elements=string | **Choices:*** mcs0/1
* mcs1/1
* mcs2/1
* mcs3/1
* mcs4/1
* mcs5/1
* mcs6/1
* mcs7/1
* mcs8/1
* mcs9/1
* mcs10/1
* mcs11/1
* mcs0/2
* mcs1/2
* mcs2/2
* mcs3/2
* mcs4/2
* mcs5/2
* mcs6/2
* mcs7/2
* mcs8/2
* mcs9/2
* mcs10/2
* mcs11/2
| Allowed data rates for 802.11ac with 1 or 2 spatial streams. |
| | **rates\_11ac\_ss34** list / elements=string | **Choices:*** mcs0/3
* mcs1/3
* mcs2/3
* mcs3/3
* mcs4/3
* mcs5/3
* mcs6/3
* mcs7/3
* mcs8/3
* mcs9/3
* mcs10/3
* mcs11/3
* mcs0/4
* mcs1/4
* mcs2/4
* mcs3/4
* mcs4/4
* mcs5/4
* mcs6/4
* mcs7/4
* mcs8/4
* mcs9/4
* mcs10/4
* mcs11/4
| Allowed data rates for 802.11ac with 3 or 4 spatial streams. |
| | **rates\_11bg** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-basic
* 11
* 11-basic
* 6
* 6-basic
* 9
* 9-basic
* 12
* 12-basic
* 18
* 18-basic
* 24
* 24-basic
* 36
* 36-basic
* 48
* 48-basic
* 54
* 54-basic
| Allowed data rates for 802.11b/g. |
| | **rates\_11n\_ss12** list / elements=string | **Choices:*** mcs0/1
* mcs1/1
* mcs2/1
* mcs3/1
* mcs4/1
* mcs5/1
* mcs6/1
* mcs7/1
* mcs8/2
* mcs9/2
* mcs10/2
* mcs11/2
* mcs12/2
* mcs13/2
* mcs14/2
* mcs15/2
| Allowed data rates for 802.11n with 1 or 2 spatial streams. |
| | **rates\_11n\_ss34** list / elements=string | **Choices:*** mcs16/3
* mcs17/3
* mcs18/3
* mcs19/3
* mcs20/3
* mcs21/3
* mcs22/3
* mcs23/3
* mcs24/4
* mcs25/4
* mcs26/4
* mcs27/4
* mcs28/4
* mcs29/4
* mcs30/4
* mcs31/4
| Allowed data rates for 802.11n with 3 or 4 spatial streams. |
| | **sae\_groups** list / elements=string | **Choices:*** 19
* 20
* 21
* 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 27
* 28
* 29
* 30
* 31
| SAE-Groups. |
| | **sae\_password** string | | WPA3 SAE password to be used to authenticate WiFi users. |
| | **schedule** string | | VAP schedule name. |
| | **secondary\_wag\_profile** string | | Secondary wireless access gateway profile name. Source wireless-controller.wag-profile.name. |
| | **security** string | **Choices:*** open
* captive-portal
* wep64
* wep128
* wpa-personal
* wpa-personal+captive-portal
* wpa-enterprise
* wpa-only-personal
* wpa-only-personal+captive-portal
* wpa-only-enterprise
* wpa2-only-personal
* wpa2-only-personal+captive-portal
* wpa2-only-enterprise
* osen
* wpa3-enterprise
* wpa3-sae
* wpa3-sae-transition
* owe
* wpa3-only-enterprise
* wpa3-enterprise-transition
| Security mode for the wireless interface . |
| | **security\_exempt\_list** string | | Optional security exempt list for captive portal authentication. Source user.security-exempt-list.name. |
| | **security\_obsolete\_option** string | **Choices:*** enable
* disable
| Enable/disable obsolete security options. |
| | **security\_redirect\_url** string | | Optional URL for redirecting users after they pass captive portal authentication. |
| | **selected\_usergroups** list / elements=string | | Selective user groups that are permitted to authenticate. |
| | | **name** string / required | | User group name. Source user.group.name. |
| | **split\_tunneling** string | **Choices:*** enable
* disable
| Enable/disable split tunneling . |
| | **ssid** string | | IEEE 802.11 service set identifier (SSID) for the wireless interface. Users who wish to use the wireless network must configure their computers to access this SSID name. |
| | **sticky\_client\_remove** string | **Choices:*** enable
* disable
| Enable/disable sticky client remove to maintain good signal level clients in SSID. . |
| | **sticky\_client\_threshold\_2g** string | | Minimum signal level/threshold in dBm required for the 2G client to be serviced by the AP (-95 to -20). |
| | **sticky\_client\_threshold\_5g** string | | Minimum signal level/threshold in dBm required for the 5G client to be serviced by the AP (-95 to -20). |
| | **target\_wake\_time** string | **Choices:*** enable
* disable
| Enable/disable 802.11ax target wake time . |
| | **tkip\_counter\_measure** string | **Choices:*** enable
* disable
| Enable/disable TKIP counter measure. |
| | **tunnel\_echo\_interval** integer | | The time interval to send echo to both primary and secondary tunnel peers (1 - 65535 sec). |
| | **tunnel\_fallback\_interval** integer | | The time interval for secondary tunnel to fall back to primary tunnel (0 - 65535 sec). |
| | **usergroup** list / elements=string | | Firewall user group to be used to authenticate WiFi users. |
| | | **name** string / required | | User group name. Source user.group.name. |
| | **utm\_profile** string | | UTM profile name. Source wireless-controller.utm-profile.name. |
| | **vdom** string | | Name of the VDOM that the Virtual AP has been added to. Source system.vdom.name. |
| | **vlan\_auto** string | **Choices:*** enable
* disable
| Enable/disable automatic management of SSID VLAN interface. |
| | **vlan\_pool** list / elements=string | | VLAN pool. |
| | | **id** integer / required | | ID. |
| | | **wtp\_group** string | | WTP group name. Source wireless-controller.wtp-group.name. |
| | **vlan\_pooling** string | **Choices:*** wtp-group
* round-robin
* hash
* disable
| Enable/disable VLAN pooling, to allow grouping of multiple wireless controller VLANs into VLAN pools . When set to wtp-group, VLAN pooling occurs with VLAN assignment by wtp-group. |
| | **vlanid** integer | | Optional VLAN ID. |
| | **voice\_enterprise** string | **Choices:*** disable
* enable
| Enable/disable 802.11k and 802.11v assisted Voice-Enterprise roaming . |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 Points (VAPs).
fortios_wireless_controller_vap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_vap:
access_control_list: "<your_own_value> (source wireless-controller.access-control-list.name)"
acct_interim_interval: "4"
additional_akms: "akm6"
address_group: "<your_own_value> (source wireless-controller.addrgrp.id)"
alias: "<your_own_value>"
atf_weight: "8"
auth: "psk"
broadcast_ssid: "enable"
broadcast_suppression: "dhcp-up"
bss_color_partial: "enable"
bstm_disassociation_imminent: "enable"
bstm_load_balancing_disassoc_timer: "14"
bstm_rssi_disassoc_timer: "15"
captive_portal_ac_name: "<your_own_value>"
captive_portal_auth_timeout: "17"
captive_portal_macauth_radius_secret: "<your_own_value>"
captive_portal_macauth_radius_server: "<your_own_value>"
captive_portal_radius_secret: "<your_own_value>"
captive_portal_radius_server: "<your_own_value>"
captive_portal_session_timeout_interval: "22"
dhcp_address_enforcement: "enable"
dhcp_lease_time: "24"
dhcp_option43_insertion: "enable"
dhcp_option82_circuit_id_insertion: "style-1"
dhcp_option82_insertion: "enable"
dhcp_option82_remote_id_insertion: "style-1"
dynamic_vlan: "enable"
eap_reauth: "enable"
eap_reauth_intv: "31"
eapol_key_retries: "disable"
encrypt: "TKIP"
external_fast_roaming: "enable"
external_logout: "<your_own_value>"
external_web: "<your_own_value>"
external_web_format: "auto-detect"
fast_bss_transition: "disable"
fast_roaming: "enable"
ft_mobility_domain: "40"
ft_over_ds: "disable"
ft_r0_key_lifetime: "42"
gas_comeback_delay: "43"
gas_fragmentation_limit: "44"
gtk_rekey: "enable"
gtk_rekey_intv: "46"
high_efficiency: "enable"
hotspot20_profile: "<your_own_value> (source wireless-controller.hotspot20.hs-profile.name)"
igmp_snooping: "enable"
intra_vap_privacy: "enable"
ip: "<your_own_value>"
ipv6_rules: "drop-icmp6ra"
key: "<your_own_value>"
keyindex: "54"
ldpc: "disable"
local_authentication: "enable"
local_bridging: "enable"
local_lan: "allow"
local_standalone: "enable"
local_standalone_nat: "enable"
mac_auth_bypass: "enable"
mac_called_station_delimiter: "hyphen"
mac_calling_station_delimiter: "hyphen"
mac_case: "uppercase"
mac_filter: "enable"
mac_filter_list:
-
id: "67"
mac: "<your_own_value>"
mac_filter_policy: "allow"
mac_filter_policy_other: "allow"
mac_password_delimiter: "hyphen"
mac_username_delimiter: "hyphen"
max_clients: "73"
max_clients_ap: "74"
mbo: "disable"
mbo_cell_data_conn_pref: "excluded"
me_disable_thresh: "77"
mesh_backhaul: "enable"
mpsk: "enable"
mpsk_concurrent_clients: "80"
mpsk_key:
-
comment: "Comment."
concurrent_clients: "<your_own_value>"
key_name: "<your_own_value>"
mpsk_schedules:
-
name: "default_name_86 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
passphrase: "<your_own_value>"
mpsk_profile: "<your_own_value> (source wireless-controller.mpsk-profile.name)"
mu_mimo: "enable"
multicast_enhance: "enable"
multicast_rate: "0"
nac: "enable"
nac_profile: "<your_own_value> (source wireless-controller.nac-profile.name)"
name: "default_name_94"
neighbor_report_dual_band: "disable"
okc: "disable"
owe_groups: "19"
owe_transition: "disable"
owe_transition_ssid: "<your_own_value>"
passphrase: "<your_own_value>"
pmf: "disable"
pmf_assoc_comeback_timeout: "102"
pmf_sa_query_retry_timeout: "103"
port_macauth: "disable"
port_macauth_reauth_timeout: "105"
port_macauth_timeout: "106"
portal_message_override_group: "<your_own_value> (source system.replacemsg-group.name)"
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>"
portal_type: "auth"
primary_wag_profile: "<your_own_value> (source wireless-controller.wag-profile.name)"
probe_resp_suppression: "enable"
probe_resp_threshold: "<your_own_value>"
ptk_rekey: "enable"
ptk_rekey_intv: "118"
qos_profile: "<your_own_value> (source wireless-controller.qos-profile.name)"
quarantine: "enable"
radio_2g_threshold: "<your_own_value>"
radio_5g_threshold: "<your_own_value>"
radio_sensitivity: "enable"
radius_mac_auth: "enable"
radius_mac_auth_server: "<your_own_value> (source user.radius.name)"
radius_mac_auth_usergroups:
-
name: "default_name_127"
radius_server: "<your_own_value> (source user.radius.name)"
rates_11a: "1"
rates_11ac_ss12: "mcs0/1"
rates_11ac_ss34: "mcs0/3"
rates_11bg: "1"
rates_11n_ss12: "mcs0/1"
rates_11n_ss34: "mcs16/3"
sae_groups: "19"
sae_password: "<your_own_value>"
schedule: "<your_own_value>"
secondary_wag_profile: "<your_own_value> (source wireless-controller.wag-profile.name)"
security: "open"
security_exempt_list: "<your_own_value> (source user.security-exempt-list.name)"
security_obsolete_option: "enable"
security_redirect_url: "<your_own_value>"
selected_usergroups:
-
name: "default_name_144 (source user.group.name)"
split_tunneling: "enable"
ssid: "<your_own_value>"
sticky_client_remove: "enable"
sticky_client_threshold_2g: "<your_own_value>"
sticky_client_threshold_5g: "<your_own_value>"
target_wake_time: "enable"
tkip_counter_measure: "enable"
tunnel_echo_interval: "152"
tunnel_fallback_interval: "153"
usergroup:
-
name: "default_name_155 (source user.group.name)"
utm_profile: "<your_own_value> (source wireless-controller.utm-profile.name)"
vdom: "<your_own_value> (source system.vdom.name)"
vlan_auto: "enable"
vlan_pool:
-
id: "160"
wtp_group: "<your_own_value> (source wireless-controller.wtp-group.name)"
vlan_pooling: "wtp-group"
vlanid: "163"
voice_enterprise: "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_vdom_radius_server – Configure a RADIUS server to use as a RADIUS Single Sign On (RSSO) server for this VDOM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_radius\_server – Configure a RADIUS server to use as a RADIUS Single Sign On (RSSO) server 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_system_vdom_radius_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 vdom\_radius\_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\_vdom\_radius\_server** dictionary | | Configure a RADIUS server to use as a RADIUS Single Sign On (RSSO) server for this VDOM. |
| | **name** string / required | | Name of the VDOM that you are adding the RADIUS server to. Source system.vdom.name. |
| | **radius\_server\_vdom** string | | Use this option to select another VDOM containing a VDOM RSSO RADIUS server to use for the current VDOM. Source system.vdom.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable the RSSO RADIUS server for this VDOM. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 a RADIUS server to use as a RADIUS Single Sign On (RSSO) server for this VDOM.
fortios_system_vdom_radius_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom_radius_server:
name: "default_name_3 (source system.vdom.name)"
radius_server_vdom: "<your_own_value> (source system.vdom.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_wireless_controller_hotspot20_anqp_3gpp_cellular – Configure 3GPP public land mobile network (PLMN) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_3gpp\_cellular – Configure 3GPP public land mobile network (PLMN) in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_3gpp_cellular`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_3gpp\_cellular category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_3gpp\_cellular** dictionary | | Configure 3GPP public land mobile network (PLMN). |
| | **mcc\_mnc\_list** list / elements=string | | Mobile Country Code and Mobile Network Code configuration. |
| | | **id** integer / required | | ID. |
| | | **mcc** string | | Mobile country code. |
| | | **mnc** string | | Mobile network code. |
| | **name** string / required | | 3GPP PLMN 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 3GPP public land mobile network (PLMN).
fortios_wireless_controller_hotspot20_anqp_3gpp_cellular:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_3gpp_cellular:
mcc_mnc_list:
-
id: "4"
mcc: "<your_own_value>"
mnc: "<your_own_value>"
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_gtp – Configure GTP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_gtp – Configure 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_firewall_gtp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 gtp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_gtp** dictionary | | Configure GTP. |
| | **addr\_notify** string | | overbilling notify address |
| | **apn** list / elements=string | | APN. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **apnmember** list / elements=string | | APN member. |
| | | | **name** string / required | | APN name. Source gtp.apn.name gtp.apngrp.name. |
| | | **id** integer / required | | ID. |
| | | **selection\_mode** list / elements=string | **Choices:*** ms
* net
* vrf
| APN selection mode. |
| | **apn\_filter** string | **Choices:*** enable
* disable
| apn filter |
| | **authorized\_ggsns** string | | Authorized GGSN group Source firewall.address.name firewall.addrgrp.name. |
| | **authorized\_ggsns6** string | | Authorized GGSN/PGW IPv6 group. Source firewall.address6.name firewall.addrgrp6.name. |
| | **authorized\_sgsns** string | | Authorized SGSN group Source firewall.address.name firewall.addrgrp.name. |
| | **authorized\_sgsns6** string | | Authorized SGSN/SGW IPv6 group. Source firewall.address6.name firewall.addrgrp6.name. |
| | **comment** string | | Comment. |
| | **context\_id** integer | | Overbilling context. |
| | **control\_plane\_message\_rate\_limit** integer | | control plane message rate limit |
| | **default\_apn\_action** string | **Choices:*** allow
* deny
| default apn action |
| | **default\_imsi\_action** string | **Choices:*** allow
* deny
| default imsi action |
| | **default\_ip\_action** string | **Choices:*** allow
* deny
| default action for encapsulated IP traffic |
| | **default\_noip\_action** string | **Choices:*** allow
* deny
| default action for encapsulated non-IP traffic |
| | **default\_policy\_action** string | **Choices:*** allow
* deny
| default advanced policy action |
| | **denied\_log** string | **Choices:*** enable
* disable
| log denied |
| | **echo\_request\_interval** integer | | echo request interval (in seconds) |
| | **extension\_log** string | **Choices:*** enable
* disable
| log in extension format |
| | **forwarded\_log** string | **Choices:*** enable
* disable
| log forwarded |
| | **global\_tunnel\_limit** string | | Global tunnel limit. Source gtp.tunnel-limit.name. |
| | **gtp\_in\_gtp** string | **Choices:*** allow
* deny
| gtp in gtp |
| | **gtpu\_denied\_log** string | **Choices:*** enable
* disable
| Enable/disable logging of denied GTP-U packets. |
| | **gtpu\_forwarded\_log** string | **Choices:*** enable
* disable
| Enable/disable logging of forwarded GTP-U packets. |
| | **gtpu\_log\_freq** integer | | Logging of frequency of GTP-U packets. |
| | **half\_close\_timeout** integer | | Half-close tunnel timeout (in seconds). |
| | **half\_open\_timeout** integer | | Half-open tunnel timeout (in seconds). |
| | **handover\_group** string | | Handover SGSN group Source firewall.address.name firewall.addrgrp.name. |
| | **handover\_group6** string | | Handover SGSN/SGW IPv6 group. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ie\_allow\_list\_v0v1** string | | IE allow list. Source gtp.ie-allow-list.name. |
| | **ie\_allow\_list\_v2** string | | IE allow list. Source gtp.ie-allow-list.name. |
| | **ie\_remove\_policy** list / elements=string | | IE remove policy. |
| | | **id** integer / required | | ID. |
| | | **remove\_ies** string | **Choices:*** apn-restriction
* rat-type
* rai
* uli
* imei
| GTP IEs to be removed. |
| | | **sgsn\_addr** string | | SGSN address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **sgsn\_addr6** string | | SGSN IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ie\_remover** string | **Choices:*** enable
* disable
| IE removal policy. |
| | **ie\_validation** dictionary | | IE validation. |
| | | **apn\_restriction** string | **Choices:*** enable
* disable
| Validate APN restriction. |
| | | **charging\_gateway\_addr** string | **Choices:*** enable
* disable
| Validate charging gateway address. |
| | | **charging\_ID** string | **Choices:*** enable
* disable
| Validate charging ID. |
| | | **end\_user\_addr** string | **Choices:*** enable
* disable
| Validate end user address. |
| | | **gsn\_addr** string | **Choices:*** enable
* disable
| Validate GSN address. |
| | | **imei** string | **Choices:*** enable
* disable
| Validate IMEI(SV). |
| | | **imsi** string | **Choices:*** enable
* disable
| Validate IMSI. |
| | | **mm\_context** string | **Choices:*** enable
* disable
| Validate MM context. |
| | | **ms\_tzone** string | **Choices:*** enable
* disable
| Validate MS time zone. |
| | | **ms\_validated** string | **Choices:*** enable
* disable
| Validate MS validated. |
| | | **msisdn** string | **Choices:*** enable
* disable
| Validate MSISDN. |
| | | **nsapi** string | **Choices:*** enable
* disable
| Validate NSAPI. |
| | | **pdp\_context** string | **Choices:*** enable
* disable
| Validate PDP context. |
| | | **qos\_profile** string | **Choices:*** enable
* disable
| Validate Quality of Service(QoS) profile. |
| | | **rai** string | **Choices:*** enable
* disable
| Validate RAI. |
| | | **rat\_type** string | **Choices:*** enable
* disable
| Validate RAT type. |
| | | **reordering\_required** string | **Choices:*** enable
* disable
| Validate re-ordering required. |
| | | **selection\_mode** string | **Choices:*** enable
* disable
| Validate selection mode. |
| | | **uli** string | **Choices:*** enable
* disable
| Validate user location information. |
| | **ie\_white\_list\_v0v1** string | | IE white list. Source gtp.ie-white-list.name. |
| | **ie\_white\_list\_v2** string | | IE white list. Source gtp.ie-white-list.name. |
| | **imsi** list / elements=string | | IMSI. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **apnmember** list / elements=string | | APN member. |
| | | | **name** string / required | | APN name. Source gtp.apn.name gtp.apngrp.name. |
| | | **id** integer / required | | ID. |
| | | **mcc\_mnc** string | | MCC MNC. |
| | | **msisdn\_prefix** string | | MSISDN prefix. |
| | | **selection\_mode** list / elements=string | **Choices:*** ms
* net
* vrf
| APN selection mode. |
| | **imsi\_filter** string | **Choices:*** enable
* disable
| imsi filter |
| | **interface\_notify** string | | overbilling interface Source system.interface.name. |
| | **invalid\_reserved\_field** string | **Choices:*** allow
* deny
| Invalid reserved field in GTP header |
| | **invalid\_sgsns6\_to\_log** string | | Invalid SGSN IPv6 group to be logged. Source firewall.address6.name firewall.addrgrp6.name. |
| | **invalid\_sgsns\_to\_log** string | | Invalid SGSN group to be logged Source firewall.address.name firewall.addrgrp.name. |
| | **ip\_filter** string | **Choices:*** enable
* disable
| IP filter for encapsulted traffic |
| | **ip\_policy** list / elements=string | | IP policy. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **dstaddr** string | | Destination address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **dstaddr6** string | | Destination IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | | **id** integer / required | | ID. |
| | | **srcaddr** string | | Source address name. Source firewall.address.name firewall.addrgrp.name. |
| | | **srcaddr6** string | | Source IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **log\_freq** integer | | Logging of frequency of GTP-C packets. |
| | **log\_gtpu\_limit** integer | | the user data log limit (0-512 bytes) |
| | **log\_imsi\_prefix** string | | IMSI prefix for selective logging. |
| | **log\_msisdn\_prefix** string | | the msisdn prefix for selective logging |
| | **max\_message\_length** integer | | max message length |
| | **message\_filter\_v0v1** string | | Message filter. Source gtp.message-filter-v0v1.name. |
| | **message\_filter\_v2** string | | Message filter. Source gtp.message-filter-v2.name. |
| | **message\_rate\_limit** dictionary | | Message rate limiting. |
| | | **create\_aa\_pdp\_request** integer | | Rate limit for create AA PDP context request (packets per second). |
| | | **create\_aa\_pdp\_response** integer | | Rate limit for create AA PDP context response (packets per second). |
| | | **create\_mbms\_request** integer | | Rate limit for create MBMS context request (packets per second). |
| | | **create\_mbms\_response** integer | | Rate limit for create MBMS context response (packets per second). |
| | | **create\_pdp\_request** integer | | Rate limit for create PDP context request (packets per second). |
| | | **create\_pdp\_response** integer | | Rate limit for create PDP context response (packets per second). |
| | | **delete\_aa\_pdp\_request** integer | | Rate limit for delete AA PDP context request (packets per second). |
| | | **delete\_aa\_pdp\_response** integer | | Rate limit for delete AA PDP context response (packets per second). |
| | | **delete\_mbms\_request** integer | | Rate limit for delete MBMS context request (packets per second). |
| | | **delete\_mbms\_response** integer | | Rate limit for delete MBMS context response (packets per second). |
| | | **delete\_pdp\_request** integer | | Rate limit for delete PDP context request (packets per second). |
| | | **delete\_pdp\_response** integer | | Rate limit for delete PDP context response (packets per second). |
| | | **echo\_reponse** integer | | Rate limit for echo response (packets per second). |
| | | **echo\_request** integer | | Rate limit for echo requests (packets per second). |
| | | **error\_indication** integer | | Rate limit for error indication (packets per second). |
| | | **failure\_report\_request** integer | | Rate limit for failure report request (packets per second). |
| | | **failure\_report\_response** integer | | Rate limit for failure report response (packets per second). |
| | | **fwd\_reloc\_complete\_ack** integer | | Rate limit for forward relocation complete acknowledge (packets per second). |
| | | **fwd\_relocation\_complete** integer | | Rate limit for forward relocation complete (packets per second). |
| | | **fwd\_relocation\_request** integer | | Rate limit for forward relocation request (packets per second). |
| | | **fwd\_relocation\_response** integer | | Rate limit for forward relocation response (packets per second). |
| | | **fwd\_srns\_context** integer | | Rate limit for forward SRNS context (packets per second). |
| | | **fwd\_srns\_context\_ack** integer | | Rate limit for forward SRNS context acknowledge (packets per second). |
| | | **g\_pdu** integer | | Rate limit for G-PDU (packets per second). |
| | | **identification\_request** integer | | Rate limit for identification request (packets per second). |
| | | **identification\_response** integer | | Rate limit for identification response (packets per second). |
| | | **mbms\_de\_reg\_request** integer | | Rate limit for MBMS de-registration request (packets per second). |
| | | **mbms\_de\_reg\_response** integer | | Rate limit for MBMS de-registration response (packets per second). |
| | | **mbms\_notify\_rej\_request** integer | | Rate limit for MBMS notification reject request (packets per second). |
| | | **mbms\_notify\_rej\_response** integer | | Rate limit for MBMS notification reject response (packets per second). |
| | | **mbms\_notify\_request** integer | | Rate limit for MBMS notification request (packets per second). |
| | | **mbms\_notify\_response** integer | | Rate limit for MBMS notification response (packets per second). |
| | | **mbms\_reg\_request** integer | | Rate limit for MBMS registration request (packets per second). |
| | | **mbms\_reg\_response** integer | | Rate limit for MBMS registration response (packets per second). |
| | | **mbms\_ses\_start\_request** integer | | Rate limit for MBMS session start request (packets per second). |
| | | **mbms\_ses\_start\_response** integer | | Rate limit for MBMS session start response (packets per second). |
| | | **mbms\_ses\_stop\_request** integer | | Rate limit for MBMS session stop request (packets per second). |
| | | **mbms\_ses\_stop\_response** integer | | Rate limit for MBMS session stop response (packets per second). |
| | | **note\_ms\_request** integer | | Rate limit for note MS GPRS present request (packets per second). |
| | | **note\_ms\_response** integer | | Rate limit for note MS GPRS present response (packets per second). |
| | | **pdu\_notify\_rej\_request** integer | | Rate limit for PDU notify reject request (packets per second). |
| | | **pdu\_notify\_rej\_response** integer | | Rate limit for PDU notify reject response (packets per second). |
| | | **pdu\_notify\_request** integer | | Rate limit for PDU notify request (packets per second). |
| | | **pdu\_notify\_response** integer | | Rate limit for PDU notify response (packets per second). |
| | | **ran\_info** integer | | Rate limit for RAN information relay (packets per second). |
| | | **relocation\_cancel\_request** integer | | Rate limit for relocation cancel request (packets per second). |
| | | **relocation\_cancel\_response** integer | | Rate limit for relocation cancel response (packets per second). |
| | | **send\_route\_request** integer | | Rate limit for send routing information for GPRS request (packets per second). |
| | | **send\_route\_response** integer | | Rate limit for send routing information for GPRS response (packets per second). |
| | | **sgsn\_context\_ack** integer | | Rate limit for SGSN context acknowledgement (packets per second). |
| | | **sgsn\_context\_request** integer | | Rate limit for SGSN context request (packets per second). |
| | | **sgsn\_context\_response** integer | | Rate limit for SGSN context response (packets per second). |
| | | **support\_ext\_hdr\_notify** integer | | Rate limit for support extension headers notification (packets per second). |
| | | **update\_mbms\_request** integer | | Rate limit for update MBMS context request (packets per second). |
| | | **update\_mbms\_response** integer | | Rate limit for update MBMS context response (packets per second). |
| | | **update\_pdp\_request** integer | | Rate limit for update PDP context request (packets per second). |
| | | **update\_pdp\_response** integer | | Rate limit for update PDP context response (packets per second). |
| | | **version\_not\_support** integer | | Rate limit for version not supported (packets per second). |
| | **message\_rate\_limit\_v0** dictionary | | Message rate limiting for GTP version 0. |
| | | **create\_pdp\_request** integer | | Rate limit (packets/s) for create PDP context request. |
| | | **delete\_pdp\_request** integer | | Rate limit (packets/s) for delete PDP context request. |
| | | **echo\_request** integer | | Rate limit (packets/s) for echo request. |
| | **message\_rate\_limit\_v1** dictionary | | Message rate limiting for GTP version 1. |
| | | **create\_pdp\_request** integer | | Rate limit (packets/s) for create PDP context request. |
| | | **delete\_pdp\_request** integer | | Rate limit (packets/s) for delete PDP context request. |
| | | **echo\_request** integer | | Rate limit (packets/s) for echo request. |
| | **message\_rate\_limit\_v2** dictionary | | Message rate limiting for GTP version 2. |
| | | **create\_session\_request** integer | | Rate limit (packets/s) for create session request. |
| | | **delete\_session\_request** integer | | Rate limit (packets/s) for delete session request. |
| | | **echo\_request** integer | | Rate limit (packets/s) for echo request. |
| | **min\_message\_length** integer | | min message length |
| | **miss\_must\_ie** string | **Choices:*** allow
* deny
| Missing mandatory information element |
| | **monitor\_mode** string | **Choices:*** enable
* disable
* vdom
| GTP monitor mode |
| | **name** string / required | | Profile name. |
| | **noip\_filter** string | **Choices:*** enable
* disable
| non-IP filter for encapsulted traffic |
| | **noip\_policy** list / elements=string | | No IP policy. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **end** integer | | End of protocol range (0 - 255). |
| | | **id** integer / required | | ID. |
| | | **start** integer | | Start of protocol range (0 - 255). |
| | | **type** string | **Choices:*** etsi
* ietf
| Protocol field type. |
| | **out\_of\_state\_ie** string | **Choices:*** allow
* deny
| Out of state information element. |
| | **out\_of\_state\_message** string | **Choices:*** allow
* deny
| Out of state GTP message |
| | **per\_apn\_shaper** list / elements=string | | Per APN shaper. |
| | | **apn** string | | APN name. Source gtp.apn.name. |
| | | **id** integer / required | | ID. |
| | | **rate\_limit** integer | | Rate limit (packets/s) for create PDP context request. |
| | | **version** integer | | GTP version number: 0 or 1. |
| | **policy** list / elements=string | | Policy. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **apn\_sel\_mode** list / elements=string | **Choices:*** ms
* net
* vrf
| APN selection mode. |
| | | **apnmember** list / elements=string | | APN member. |
| | | | **name** string / required | | APN name. Source gtp.apn.name gtp.apngrp.name. |
| | | **id** integer / required | | ID. |
| | | **imei** string | | IMEI(SV) pattern. |
| | | **imsi** string | | IMSI prefix. |
| | | **imsi\_prefix** string | | IMSI prefix. |
| | | **max\_apn\_restriction** string | **Choices:*** all
* public-1
* public-2
* private-1
* private-2
| Maximum APN restriction value. |
| | | **messages** list / elements=string | **Choices:*** create-req
* create-res
* update-req
* update-res
| GTP messages. |
| | | **msisdn** string | | MSISDN prefix. |
| | | **msisdn\_prefix** string | | MSISDN prefix. |
| | | **rai** string | | RAI pattern. |
| | | **rat\_type** list / elements=string | **Choices:*** any
* utran
* geran
* wlan
* gan
* hspa
* eutran
* virtual
* nbiot
| RAT Type. |
| | | **uli** string | | ULI pattern. |
| | **policy\_filter** string | **Choices:*** enable
* disable
| Advanced policy filter |
| | **policy\_v2** list / elements=string | | Apply allow or deny action to each GTPv2-c packet. |
| | | **action** string | **Choices:*** allow
* deny
| Action. |
| | | **apn\_sel\_mode** string | **Choices:*** ms
* net
* vrf
| APN selection mode. |
| | | **apnmember** list / elements=string | | APN member. |
| | | | **name** string / required | | APN name. Source gtp.apn.name gtp.apngrp.name. |
| | | **id** integer / required | | ID. |
| | | **imsi\_prefix** string | | IMSI prefix. |
| | | **max\_apn\_restriction** string | **Choices:*** all
* public-1
* public-2
* private-1
* private-2
| Maximum APN restriction value. |
| | | **mei** string | | MEI pattern. |
| | | **messages** string | **Choices:*** create-ses-req
* create-ses-res
* modify-bearer-req
* modify-bearer-res
| GTP messages. |
| | | **msisdn\_prefix** string | | MSISDN prefix. |
| | | **rat\_type** string | **Choices:*** any
* utran
* geran
* wlan
* gan
* hspa
* eutran
* virtual
* nbiot
* ltem
* nr
| RAT Type. |
| | | **uli** string | | GTPv2 ULI patterns (in order of CGI SAI RAI TAI ECGI LAI). |
| | **port\_notify** integer | | overbilling notify port |
| | **rate\_limit\_mode** string | **Choices:*** per-profile
* per-stream
* per-apn
| GTP rate limit mode. |
| | **rate\_limited\_log** string | **Choices:*** enable
* disable
| log rate limited |
| | **rate\_sampling\_interval** integer | | rate sampling interval (1-3600 seconds) |
| | **remove\_if\_echo\_expires** string | **Choices:*** enable
* disable
| remove if echo response expires |
| | **remove\_if\_recovery\_differ** string | **Choices:*** enable
* disable
| remove upon different Recovery IE |
| | **reserved\_ie** string | **Choices:*** allow
* deny
| reserved information element |
| | **send\_delete\_when\_timeout** string | **Choices:*** enable
* disable
| send DELETE request to path endpoints when GTPv0/v1 tunnel timeout. |
| | **send\_delete\_when\_timeout\_v2** string | **Choices:*** enable
* disable
| send DELETE request to path endpoints when GTPv2 tunnel timeout. |
| | **spoof\_src\_addr** string | **Choices:*** allow
* deny
| Spoofed source address for Mobile Station. |
| | **state\_invalid\_log** string | **Choices:*** enable
* disable
| log state invalid |
| | **sub\_second\_interval** string | **Choices:*** 0.5
* 0.25
* 0.1
| Sub-second interval (0.1, 0.25, or 0.5 sec). |
| | **sub\_second\_sampling** string | **Choices:*** enable
* disable
| Enable/disable sub-second sampling. |
| | **traffic\_count\_log** string | **Choices:*** enable
* disable
| log tunnel traffic counter |
| | **tunnel\_limit** integer | | tunnel limit |
| | **tunnel\_limit\_log** string | **Choices:*** enable
* disable
| tunnel limit |
| | **tunnel\_timeout** integer | | Established tunnel timeout (in seconds). |
| | **unknown\_version\_action** string | **Choices:*** allow
* deny
| action for unknown gtp version |
| | **user\_plane\_message\_rate\_limit** integer | | user plane message rate limit |
| | **warning\_threshold** integer | | Warning threshold for rate limiting (0 - 99 percent). |
| **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 GTP.
fortios_firewall_gtp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_gtp:
addr_notify: "<your_own_value>"
apn:
-
action: "allow"
apnmember:
-
name: "default_name_7 (source gtp.apn.name gtp.apngrp.name)"
id: "8"
selection_mode: "ms"
apn_filter: "enable"
authorized_ggsns: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
authorized_ggsns6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
authorized_sgsns: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
authorized_sgsns6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
comment: "Comment."
context_id: "16"
control_plane_message_rate_limit: "17"
default_apn_action: "allow"
default_imsi_action: "allow"
default_ip_action: "allow"
default_noip_action: "allow"
default_policy_action: "allow"
denied_log: "enable"
echo_request_interval: "24"
extension_log: "enable"
forwarded_log: "enable"
global_tunnel_limit: "<your_own_value> (source gtp.tunnel-limit.name)"
gtp_in_gtp: "allow"
gtpu_denied_log: "enable"
gtpu_forwarded_log: "enable"
gtpu_log_freq: "31"
half_close_timeout: "32"
half_open_timeout: "33"
handover_group: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
handover_group6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ie_allow_list_v0v1: "<your_own_value> (source gtp.ie-allow-list.name)"
ie_allow_list_v2: "<your_own_value> (source gtp.ie-allow-list.name)"
ie_remove_policy:
-
id: "39"
remove_ies: "apn-restriction"
sgsn_addr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
sgsn_addr6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ie_remover: "enable"
ie_validation:
apn_restriction: "enable"
charging_gateway_addr: "enable"
charging_ID: "enable"
end_user_addr: "enable"
gsn_addr: "enable"
imei: "enable"
imsi: "enable"
mm_context: "enable"
ms_tzone: "enable"
ms_validated: "enable"
msisdn: "enable"
nsapi: "enable"
pdp_context: "enable"
qos_profile: "enable"
rai: "enable"
rat_type: "enable"
reordering_required: "enable"
selection_mode: "enable"
uli: "enable"
ie_white_list_v0v1: "<your_own_value> (source gtp.ie-white-list.name)"
ie_white_list_v2: "<your_own_value> (source gtp.ie-white-list.name)"
imsi:
-
action: "allow"
apnmember:
-
name: "default_name_69 (source gtp.apn.name gtp.apngrp.name)"
id: "70"
mcc_mnc: "<your_own_value>"
msisdn_prefix: "<your_own_value>"
selection_mode: "ms"
imsi_filter: "enable"
interface_notify: "<your_own_value> (source system.interface.name)"
invalid_reserved_field: "allow"
invalid_sgsns_to_log: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
invalid_sgsns6_to_log: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ip_filter: "enable"
ip_policy:
-
action: "allow"
dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
dstaddr6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
id: "84"
srcaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
srcaddr6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
log_freq: "87"
log_gtpu_limit: "88"
log_imsi_prefix: "<your_own_value>"
log_msisdn_prefix: "<your_own_value>"
max_message_length: "91"
message_filter_v0v1: "<your_own_value> (source gtp.message-filter-v0v1.name)"
message_filter_v2: "<your_own_value> (source gtp.message-filter-v2.name)"
message_rate_limit:
create_aa_pdp_request: "95"
create_aa_pdp_response: "96"
create_mbms_request: "97"
create_mbms_response: "98"
create_pdp_request: "99"
create_pdp_response: "100"
delete_aa_pdp_request: "101"
delete_aa_pdp_response: "102"
delete_mbms_request: "103"
delete_mbms_response: "104"
delete_pdp_request: "105"
delete_pdp_response: "106"
echo_reponse: "107"
echo_request: "108"
error_indication: "109"
failure_report_request: "110"
failure_report_response: "111"
fwd_reloc_complete_ack: "112"
fwd_relocation_complete: "113"
fwd_relocation_request: "114"
fwd_relocation_response: "115"
fwd_srns_context: "116"
fwd_srns_context_ack: "117"
g_pdu: "118"
identification_request: "119"
identification_response: "120"
mbms_de_reg_request: "121"
mbms_de_reg_response: "122"
mbms_notify_rej_request: "123"
mbms_notify_rej_response: "124"
mbms_notify_request: "125"
mbms_notify_response: "126"
mbms_reg_request: "127"
mbms_reg_response: "128"
mbms_ses_start_request: "129"
mbms_ses_start_response: "130"
mbms_ses_stop_request: "131"
mbms_ses_stop_response: "132"
note_ms_request: "133"
note_ms_response: "134"
pdu_notify_rej_request: "135"
pdu_notify_rej_response: "136"
pdu_notify_request: "137"
pdu_notify_response: "138"
ran_info: "139"
relocation_cancel_request: "140"
relocation_cancel_response: "141"
send_route_request: "142"
send_route_response: "143"
sgsn_context_ack: "144"
sgsn_context_request: "145"
sgsn_context_response: "146"
support_ext_hdr_notify: "147"
update_mbms_request: "148"
update_mbms_response: "149"
update_pdp_request: "150"
update_pdp_response: "151"
version_not_support: "152"
message_rate_limit_v0:
create_pdp_request: "154"
delete_pdp_request: "155"
echo_request: "156"
message_rate_limit_v1:
create_pdp_request: "158"
delete_pdp_request: "159"
echo_request: "160"
message_rate_limit_v2:
create_session_request: "162"
delete_session_request: "163"
echo_request: "164"
min_message_length: "165"
miss_must_ie: "allow"
monitor_mode: "enable"
name: "default_name_168"
noip_filter: "enable"
noip_policy:
-
action: "allow"
end: "172"
id: "173"
start: "174"
type: "etsi"
out_of_state_ie: "allow"
out_of_state_message: "allow"
per_apn_shaper:
-
apn: "<your_own_value> (source gtp.apn.name)"
id: "180"
rate_limit: "181"
version: "182"
policy:
-
action: "allow"
apn_sel_mode: "ms"
apnmember:
-
name: "default_name_187 (source gtp.apn.name gtp.apngrp.name)"
id: "188"
imei: "<your_own_value>"
imsi: "<your_own_value>"
imsi_prefix: "<your_own_value>"
max_apn_restriction: "all"
messages: "create-req"
msisdn: "<your_own_value>"
msisdn_prefix: "<your_own_value>"
rai: "<your_own_value>"
rat_type: "any"
uli: "<your_own_value>"
policy_filter: "enable"
policy_v2:
-
action: "allow"
apn_sel_mode: "ms"
apnmember:
-
name: "default_name_204 (source gtp.apn.name gtp.apngrp.name)"
id: "205"
imsi_prefix: "<your_own_value>"
max_apn_restriction: "all"
mei: "<your_own_value>"
messages: "create-ses-req"
msisdn_prefix: "<your_own_value>"
rat_type: "any"
uli: "<your_own_value>"
port_notify: "213"
rate_limit_mode: "per-profile"
rate_limited_log: "enable"
rate_sampling_interval: "216"
remove_if_echo_expires: "enable"
remove_if_recovery_differ: "enable"
reserved_ie: "allow"
send_delete_when_timeout: "enable"
send_delete_when_timeout_v2: "enable"
spoof_src_addr: "allow"
state_invalid_log: "enable"
sub_second_interval: "0.5"
sub_second_sampling: "enable"
traffic_count_log: "enable"
tunnel_limit: "227"
tunnel_limit_log: "enable"
tunnel_timeout: "229"
unknown_version_action: "allow"
user_plane_message_rate_limit: "231"
warning_threshold: "232"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_sub_class – Hidden table for datasource in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_waf\_sub\_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_sub_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 sub\_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\_sub\_class** dictionary | | Hidden table for datasource. |
| | **id** integer / required | | Signature subclass ID. |
| | **name** string | | Signature subclass 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_sub_class:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
waf_sub_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_system_replacemsg_spam – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_spam – 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_spam`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 spam category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_spam** 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_spam:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_spam:
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_ssh_local_ca – SSH proxy local CA in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ssh\_local\_ca – SSH proxy local CA in Fortinet’s FortiOS and FortiGate.
============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ca`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ca** dictionary | | SSH proxy local CA. |
| | **name** string / required | | SSH proxy local CA 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 CA 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 CA.
fortios_firewall_ssh_local_ca:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ssh_local_ca:
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_ssh_filter_profile – SSH filter profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ssh\_filter\_profile – SSH filter 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_ssh_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 ssh\_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. |
| **ssh\_filter\_profile** dictionary | | SSH filter profile. |
| | **block** list / elements=string | **Choices:*** x11
* shell
* exec
* port-forward
* tun-forward
* sftp
* unknown
* scp
| SSH blocking options. |
| | **default\_command\_log** string | **Choices:*** enable
* disable
| Enable/disable logging unmatched shell commands. |
| | **file\_filter** dictionary | | File filter. |
| | | **entries** list / elements=string | | File filter entries. |
| | | | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | | | **comment** string | | Comment. |
| | | | **direction** string | **Choices:*** incoming
* outgoing
* any
| Match files transmitted in the session"s originating or reply direction. |
| | | | **file\_type** list / elements=string | | Select file type. |
| | | | | **name** string / required | | File type name. Source antivirus.filetype.name. |
| | | | **filter** string / required | | Add a file filter. |
| | | | **password\_protected** string | **Choices:*** True
* any
| Match password-protected files. |
| | | | **protocol** string | **Choices:*** ssh
| Protocols to apply with. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable file filter logging. |
| | | **scan\_archive\_contents** string | **Choices:*** enable
* disable
| Enable/disable file filter archive contents scan. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable file filter. |
| | **log** list / elements=string | **Choices:*** x11
* shell
* exec
* port-forward
* tun-forward
* sftp
* unknown
* scp
| SSH logging options. |
| | **name** string / required | | SSH filter profile name. |
| | **shell\_commands** list / elements=string | | SSH command filter. |
| | | **action** string | **Choices:*** block
* allow
| Action to take for URL filter matches. |
| | | **alert** string | **Choices:*** enable
* disable
| Enable/disable alert. |
| | | **id** integer / required | | Id. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **pattern** string | | SSH shell command pattern. |
| | | **severity** string | **Choices:*** low
* medium
* high
* critical
| Log severity. |
| | | **type** string | **Choices:*** simple
* regex
| Matching 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 filter profile.
fortios_ssh_filter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ssh_filter_profile:
block: "x11"
default_command_log: "enable"
file_filter:
entries:
-
action: "log"
comment: "Comment."
direction: "incoming"
file_type:
-
name: "default_name_11 (source antivirus.filetype.name)"
filter: "<your_own_value>"
password_protected: "yes"
protocol: "ssh"
log: "enable"
scan_archive_contents: "enable"
status: "enable"
log: "x11"
name: "default_name_19"
shell_commands:
-
action: "block"
alert: "enable"
id: "23"
log: "enable"
pattern: "<your_own_value>"
severity: "low"
type: "simple"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_reputation – Show Internet Service reputation in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_reputation – Show Internet Service reputation in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_reputation`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_reputation category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_reputation** dictionary | | Show Internet Service reputation. |
| | **description** string | | Description. |
| | **id** integer / required | | Internet Service Reputation 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: Show Internet Service reputation.
fortios_firewall_internet_service_reputation:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_reputation:
description: "<your_own_value>"
id: "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_user_device_access_list – Configure device access control lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_device\_access\_list – Configure device access 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_user_device_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 user feature and device\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **user\_device\_access\_list** dictionary | | Configure device access control lists. |
| | **default\_action** string | **Choices:*** accept
* deny
| Accept or deny unknown/unspecified devices. |
| | **device\_list** list / elements=string | | Device list. |
| | | **action** string | **Choices:*** accept
* deny
| Allow or block device. |
| | | **device** string | | Firewall device or device group. Source user.device.alias user.device-group.name user.device-category.name. |
| | | **id** integer / required | | Entry ID. |
| | **name** string / required | | Device access 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 device access control lists.
fortios_user_device_access_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device_access_list:
default_action: "accept"
device_list:
-
action: "accept"
device: "<your_own_value> (source user.device.alias user.device-group.name user.device-category.name)"
id: "7"
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_firewall_internet_service_sld – Internet Service Second Level Domain in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_sld – Internet Service Second Level Domain in Fortinet’s FortiOS and FortiGate.
======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sld`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_sld category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_sld** dictionary | | Internet Service Second Level Domain. |
| | **id** integer / required | | Second Level Domain ID. |
| | **name** string | | Second Level Domain 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 Second Level Domain.
fortios_firewall_internet_service_sld:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_sld:
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_antivirus_profile – Configure AntiVirus profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_profile – Configure AntiVirus 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_antivirus_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 antivirus 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. |
| **antivirus\_profile** dictionary | | Configure AntiVirus profiles. |
| | **analytics\_accept\_filetype** integer | | Only submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. |
| | **analytics\_bl\_filetype** integer | | Only submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. |
| | **analytics\_db** string | **Choices:*** disable
* enable
| Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. |
| | **analytics\_ignore\_filetype** integer | | Do not submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. |
| | **analytics\_max\_upload** integer | | Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes). |
| | **analytics\_wl\_filetype** integer | | Do not submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. |
| | **av\_block\_log** string | **Choices:*** enable
* disable
| Enable/disable logging for AntiVirus file blocking. |
| | **av\_virus\_log** string | **Choices:*** enable
* disable
| Enable/disable AntiVirus logging. |
| | **cifs** dictionary | | Configure CIFS AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable CIFS AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **comment** string | | Comment. |
| | **content\_disarm** dictionary | | AV Content Disarm and Reconstruction settings. |
| | | **cover\_page** string | **Choices:*** disable
* enable
| Enable/disable inserting a cover page into the disarmed document. |
| | | **detect\_only** string | **Choices:*** disable
* enable
| Enable/disable only detect disarmable files, do not alter content. |
| | | **error\_action** string | **Choices:*** block
* log-only
* ignore
| Action to be taken if CDR engine encounters an unrecoverable error. |
| | | **office\_action** string | **Choices:*** disable
* enable
| Enable/disable stripping of PowerPoint action events in Microsoft Office documents. |
| | | **office\_dde** string | **Choices:*** disable
* enable
| Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. |
| | | **office\_embed** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded objects in Microsoft Office documents. |
| | | **office\_hylink** string | **Choices:*** disable
* enable
| Enable/disable stripping of hyperlinks in Microsoft Office documents. |
| | | **office\_linked** string | **Choices:*** disable
* enable
| Enable/disable stripping of linked objects in Microsoft Office documents. |
| | | **office\_macro** string | **Choices:*** disable
* enable
| Enable/disable stripping of macros in Microsoft Office documents. |
| | | **original\_file\_destination** string | **Choices:*** fortisandbox
* quarantine
* discard
| Destination to send original file if active content is removed. |
| | | **pdf\_act\_form** string | **Choices:*** disable
* enable
| Enable/disable stripping of actions that submit data to other targets in PDF documents. |
| | | **pdf\_act\_gotor** string | **Choices:*** disable
* enable
| Enable/disable stripping of links to other PDFs in PDF documents. |
| | | **pdf\_act\_java** string | **Choices:*** disable
* enable
| Enable/disable stripping of actions that execute JavaScript code in PDF documents. |
| | | **pdf\_act\_launch** string | **Choices:*** disable
* enable
| Enable/disable stripping of links to external applications in PDF documents. |
| | | **pdf\_act\_movie** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded movies in PDF documents. |
| | | **pdf\_act\_sound** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded sound files in PDF documents. |
| | | **pdf\_embedfile** string | **Choices:*** disable
* enable
| Enable/disable stripping of embedded files in PDF documents. |
| | | **pdf\_hyperlink** string | **Choices:*** disable
* enable
| Enable/disable stripping of hyperlinks from PDF documents. |
| | | **pdf\_javacode** string | **Choices:*** disable
* enable
| Enable/disable stripping of JavaScript code in PDF documents. |
| | **ems\_threat\_feed** string | **Choices:*** disable
* enable
| Enable/disable use of EMS threat feed when performing AntiVirus scan. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging for antivirus. |
| | **external\_blocklist** list / elements=string | | One or more external malware block lists. |
| | | **name** string / required | | External blocklist. Source system.external-resource.name. |
| | **external\_blocklist\_archive\_scan** string | **Choices:*** disable
* enable
| Enable/disable external-blocklist archive scanning. |
| | **external\_blocklist\_enable\_all** string | **Choices:*** disable
* enable
| Enable/disable all external blocklists. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow/proxy feature set. |
| | **ftgd\_analytics** string | **Choices:*** disable
* suspicious
* everything
| Settings to control which files are uploaded to FortiSandbox. |
| | **ftp** dictionary | | Configure FTP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable FTP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **http** dictionary | | Configure HTTP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **content\_disarm** string | **Choices:*** disable
* enable
| Enable Content Disarm and Reconstruction for this protocol. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable HTTP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **imap** dictionary | | Configure IMAP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **content\_disarm** string | **Choices:*** disable
* enable
| Enable Content Disarm and Reconstruction for this protocol. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **executables** string | **Choices:*** default
* virus
| Treat Windows executable files as viruses for the purpose of blocking or monitoring. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable IMAP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **inspection\_mode** string | **Choices:*** proxy
* flow-based
| Inspection mode. |
| | **mapi** dictionary | | Configure MAPI AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **executables** string | **Choices:*** default
* virus
| Treat Windows executable files as viruses for the purpose of blocking or monitoring. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable MAPI AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **mobile\_malware\_db** string | **Choices:*** disable
* enable
| Enable/disable using the mobile malware signature database. |
| | **nac\_quar** dictionary | | Configure AntiVirus quarantine settings. |
| | | **expiry** string | | Duration of quarantine. |
| | | **infected** string | **Choices:*** none
* quar-src-ip
| Enable/Disable quarantining infected hosts to the banned user list. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable AntiVirus quarantine logging. |
| | **name** string / required | | Profile name. |
| | **nntp** dictionary | | Configure NNTP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable NNTP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **outbreak\_prevention** dictionary | | Configure Virus Outbreak Prevention settings. |
| | | **external\_blocklist** string | **Choices:*** disable
* enable
| Enable/disable external malware blocklist. |
| | | **ftgd\_service** string | **Choices:*** disable
* enable
| Enable/disable FortiGuard Virus outbreak prevention service. |
| | **outbreak\_prevention\_archive\_scan** string | **Choices:*** disable
* enable
| Enable/disable outbreak-prevention archive scanning. |
| | **pop3** dictionary | | Configure POP3 AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **content\_disarm** string | **Choices:*** disable
* enable
| Enable Content Disarm and Reconstruction for this protocol. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **executables** string | **Choices:*** default
* virus
| Treat Windows executable files as viruses for the purpose of blocking or monitoring. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable POP3 AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **replacemsg\_group** string | | Replacement message group customized for this profile. Source system.replacemsg-group.name. |
| | **scan\_mode** string | **Choices:*** quick
* full
* default
* legacy
| Choose between full scan mode and quick scan mode. |
| | **smb** dictionary | | Configure SMB AntiVirus options. |
| | | **archive\_block** string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **options** string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable SMB AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
| Enable FortiGuard Virus Outbreak Prevention service. |
| | **smtp** dictionary | | Configure SMTP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **content\_disarm** string | **Choices:*** disable
* enable
| Enable Content Disarm and Reconstruction for this protocol. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **executables** string | **Choices:*** default
* virus
| Treat Windows executable files as viruses for the purpose of blocking or monitoring. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable SMTP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable FortiGuard Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **ssh** dictionary | | Configure SFTP and SCP AntiVirus options. |
| | | **archive\_block** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to block. |
| | | **archive\_log** list / elements=string | **Choices:*** encrypted
* corrupted
* partiallycorrupted
* multipart
* nested
* mailbomb
* fileslimit
* timeout
* unhandled
| Select the archive types to log. |
| | | **av\_scan** string | **Choices:*** disable
* block
* monitor
| Enable AntiVirus scan service. |
| | | **emulator** string | **Choices:*** enable
* disable
| Enable/disable the virus emulator. |
| | | **external\_blocklist** string | **Choices:*** disable
* block
* monitor
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* avmonitor
* quarantine
| Enable/disable SFTP and SCP AntiVirus scanning, monitoring, and quarantine. |
| | | **outbreak\_prevention** string | **Choices:*** disabled
* files
* full-archive
* disable
* block
* monitor
| Enable Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| **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 AntiVirus profiles.
fortios_antivirus_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
antivirus_profile:
analytics_accept_filetype: "3 (source dlp.filepattern.id)"
analytics_bl_filetype: "4 (source dlp.filepattern.id)"
analytics_db: "disable"
analytics_ignore_filetype: "6 (source dlp.filepattern.id)"
analytics_max_upload: "7"
analytics_wl_filetype: "8 (source dlp.filepattern.id)"
av_block_log: "enable"
av_virus_log: "enable"
cifs:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
emulator: "enable"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
comment: "Comment."
content_disarm:
cover_page: "disable"
detect_only: "disable"
error_action: "block"
office_action: "disable"
office_dde: "disable"
office_embed: "disable"
office_hylink: "disable"
office_linked: "disable"
office_macro: "disable"
original_file_destination: "fortisandbox"
pdf_act_form: "disable"
pdf_act_gotor: "disable"
pdf_act_java: "disable"
pdf_act_launch: "disable"
pdf_act_movie: "disable"
pdf_act_sound: "disable"
pdf_embedfile: "disable"
pdf_hyperlink: "disable"
pdf_javacode: "disable"
ems_threat_feed: "disable"
extended_log: "enable"
external_blocklist:
-
name: "default_name_44 (source system.external-resource.name)"
external_blocklist_archive_scan: "disable"
external_blocklist_enable_all: "disable"
feature_set: "flow"
ftgd_analytics: "disable"
ftp:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
emulator: "enable"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
http:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
content_disarm: "disable"
emulator: "enable"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
imap:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
content_disarm: "disable"
emulator: "enable"
executables: "default"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
inspection_mode: "proxy"
mapi:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
emulator: "enable"
executables: "default"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
mobile_malware_db: "disable"
nac_quar:
expiry: "<your_own_value>"
infected: "none"
log: "enable"
name: "default_name_95"
nntp:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
emulator: "enable"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
outbreak_prevention:
external_blocklist: "disable"
ftgd_service: "disable"
outbreak_prevention_archive_scan: "disable"
pop3:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
content_disarm: "disable"
emulator: "enable"
executables: "default"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_mode: "quick"
smb:
archive_block: "encrypted"
archive_log: "encrypted"
emulator: "enable"
options: "scan"
outbreak_prevention: "disabled"
smtp:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
content_disarm: "disable"
emulator: "enable"
executables: "default"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "disable"
ssh:
archive_block: "encrypted"
archive_log: "encrypted"
av_scan: "disable"
emulator: "enable"
external_blocklist: "disable"
options: "scan"
outbreak_prevention: "disabled"
quarantine: "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_gtp_apngrp – Configure APN groups for GTP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_apngrp – Configure APN groups 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_apngrp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 apngrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_apngrp** dictionary | | Configure APN groups for GTP. |
| | **member** list / elements=string | | APN group member. |
| | | **name** string / required | | APN name. Source gtp.apn.name gtp.apngrp.name. |
| | **name** string / required | | GTP APN 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: Configure APN groups for GTP.
fortios_gtp_apngrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_apngrp:
member:
-
name: "default_name_4 (source gtp.apn.name gtp.apngrp.name)"
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_extender_modem_status – Display detailed extender modem status in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_modem\_status – Display detailed extender modem 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_extender_modem_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 extender feature and modem\_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. |
| **extender\_modem\_status** dictionary | | Display detailed extender modem status. |
| | 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 modem status.
fortios_extender_modem_status:
vdom: "{{ vdom }}"
extender_modem_status:
<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_router_ripng – Configure RIPng in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_ripng – Configure RIPng in Fortinet’s FortiOS and FortiGate.
==============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ripng`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ripng category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ripng** dictionary | | Configure RIPng. |
| | **aggregate\_address** list / elements=string | | Aggregate address. |
| | | **id** integer / required | | Aggregate address entry ID. |
| | | **prefix6** string | | Aggregate address prefix. |
| | **default\_information\_originate** string | **Choices:*** enable
* disable
| Enable/disable generation of default route. |
| | **default\_metric** integer | | Default metric. |
| | **distance** list / elements=string | | distance |
| | | **access\_list6** string | | Access list for route destination. Source router.access-list6.name. |
| | | **distance** integer | | Distance (1 - 255). |
| | | **id** integer / required | | Distance ID. |
| | | **prefix6** string | | Distance prefix6. |
| | **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-list6.name router.prefix-list6.name. |
| | | **status** string | **Choices:*** enable
* disable
| status |
| | **garbage\_timer** integer | | Garbage timer. |
| | **interface** list / elements=string | | RIPng interface configuration. |
| | | **flags** integer | | Flags. |
| | | **name** string / required | | Interface name. Source system.interface.name. |
| | | **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. |
| | | **interface** string | | Interface name. Source system.interface.name. |
| | | **ip6** string | | IPv6 link-local address. |
| | **network** list / elements=string | | Network. |
| | | **id** integer / required | | Network entry ID. |
| | | **prefix** string | | Network IPv6 link-local prefix. |
| | **offset\_list** list / elements=string | | Offset list. |
| | | **access\_list6** string | | IPv6 access list name. Source router.access-list6.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. |
| | **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. |
| | **update\_timer** integer | | Update timer. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 RIPng.
fortios_router_ripng:
vdom: "{{ vdom }}"
router_ripng:
aggregate_address:
-
id: "4"
prefix6: "<your_own_value>"
default_information_originate: "enable"
default_metric: "7"
distance:
-
access_list6: "<your_own_value> (source router.access-list6.name)"
distance: "10"
id: "11"
prefix6: "<your_own_value>"
distribute_list:
-
direction: "in"
id: "15"
interface: "<your_own_value> (source system.interface.name)"
listname: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
status: "enable"
garbage_timer: "19"
interface:
-
flags: "21"
name: "default_name_22 (source system.interface.name)"
split_horizon: "poisoned"
split_horizon_status: "enable"
max_out_metric: "25"
neighbor:
-
id: "27"
interface: "<your_own_value> (source system.interface.name)"
ip6: "<your_own_value>"
network:
-
id: "31"
prefix: "<your_own_value>"
offset_list:
-
access_list6: "<your_own_value> (source router.access-list6.name)"
direction: "in"
id: "36"
interface: "<your_own_value> (source system.interface.name)"
offset: "38"
status: "enable"
passive_interface:
-
name: "default_name_41 (source system.interface.name)"
redistribute:
-
metric: "43"
name: "default_name_44"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout_timer: "47"
update_timer: "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)
ansible fortinet.fortios.fortios_firewall_proxy_addrgrp – Web proxy address group configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_proxy\_addrgrp – Web proxy address 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_proxy_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 firewall feature and proxy\_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. |
| **firewall\_proxy\_addrgrp** dictionary | | Web proxy address group configuration. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (1 - 32). |
| | **comment** string | | Optional comments. |
| | **member** list / elements=string | | Members of address group. |
| | | **name** string / required | | Address name. Source firewall.proxy-address.name firewall.proxy-addrgrp.name. |
| | **name** string / required | | Address 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. |
| | **type** string | **Choices:*** src
* dst
| Source or destination address group type. |
| | **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 group configuration.
fortios_firewall_proxy_addrgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_addrgrp:
color: "3"
comment: "Optional comments."
member:
-
name: "default_name_6 (source firewall.proxy-address.name firewall.proxy-addrgrp.name)"
name: "default_name_7"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_10"
tags:
-
name: "default_name_12 (source system.object-tagging.tags.name)"
type: "src"
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_link_monitor – Configure Link Health Monitor in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_link\_monitor – Configure Link Health 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_link_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 link\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_link\_monitor** dictionary | | Configure Link Health Monitor. |
| | **addr\_mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | **class\_id** integer | | Traffic class ID. Source firewall.traffic-class.class-id. |
| | **diffservcode** string | | Differentiated services code point (DSCP) in the IP header of the probe packet. |
| | **failtime** integer | | Number of retry attempts before the server is considered down (1 - 10) |
| | **gateway\_ip** string | | Gateway IP address used to probe the server. |
| | **gateway\_ip6** string | | Gateway IPv6 address used to probe the server. |
| | **ha\_priority** integer | | HA election priority (1 - 50). |
| | **http\_agent** string | | String in the http-agent field in the HTTP header. |
| | **http\_get** string | | If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string. |
| | **http\_match** string | | String that you expect to see in the HTTP-GET requests of the traffic to be monitored. |
| | **interval** integer | | Detection interval (1 - 3600 sec). |
| | **name** string / required | | Link monitor name. |
| | **packet\_size** integer | | Packet size of a twamp test session, |
| | **password** string | | Twamp controller password in authentication mode |
| | **port** integer | | Port number of the traffic to be used to monitor the server. |
| | **probe\_count** integer | | Number of most recent probes that should be used to calculate latency and jitter (5 - 30). |
| | **probe\_timeout** integer | | Time to wait before a probe packet is considered lost (500 - 5000 msec). |
| | **protocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
* http
* twamp
* ping6
| Protocols used to monitor the server. |
| | **recoverytime** integer | | Number of successful responses received before server is considered recovered (1 - 10). |
| | **route** list / elements=string | | Subnet to monitor. |
| | | **subnet** string / required | | IP and netmask (x.x.x.x/y). |
| | **security\_mode** string | **Choices:*** none
* authentication
| Twamp controller security mode. |
| | **server** list / elements=string | | IP address of the server(s) to be monitored. |
| | | **address** string / required | | Server address. |
| | **service\_detection** string | **Choices:*** enable
* disable
| Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. |
| | **source\_ip** string | | Source IP address used in packet to the server. |
| | **source\_ip6** string | | Source IPv6 address used in packet to the server. |
| | **srcintf** string | | Interface that receives the traffic to be monitored. Source system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this link monitor. |
| | **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. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 Link Health Monitor.
fortios_system_link_monitor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_link_monitor:
addr_mode: "ipv4"
class_id: "4 (source firewall.traffic-class.class-id)"
diffservcode: "<your_own_value>"
failtime: "6"
gateway_ip: "<your_own_value>"
gateway_ip6: "<your_own_value>"
ha_priority: "9"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "13"
name: "default_name_14"
packet_size: "15"
password: "<your_own_value>"
port: "17"
probe_count: "18"
probe_timeout: "19"
protocol: "ping"
recoverytime: "21"
route:
-
subnet: "<your_own_value>"
security_mode: "none"
server:
-
address: "<your_own_value>"
service_detection: "enable"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
srcintf: "<your_own_value> (source system.interface.name)"
status: "enable"
update_cascade_interface: "enable"
update_static_route: "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_global – Configure FortiSwitch global settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_global – Configure FortiSwitch 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_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 switch\_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. |
| **switch\_controller\_global** dictionary | | Configure FortiSwitch global settings. |
| | **allow\_multiple\_interfaces** string | **Choices:*** enable
* disable
| Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate. |
| | **bounce\_quarantined\_link** string | **Choices:*** disable
* enable
| Enable/disable bouncing (administratively bring the link down, up) of a switch port where a quarantined device was seen last. Helps to re-initiate the DHCP process for a device. |
| | **custom\_command** list / elements=string | | List of custom commands to be pushed to all FortiSwitches in the VDOM. |
| | | **command\_entry** string | | List of FortiSwitch commands. |
| | | **command\_name** string | | Name of custom command to push to all FortiSwitches in VDOM. Source switch-controller.custom-command.command-name. |
| | **default\_virtual\_switch\_vlan** string | | Default VLAN for ports when added to the virtual-switch. Source system.interface.name. |
| | **disable\_discovery** list / elements=string | | Prevent this FortiSwitch from discovering. |
| | | **name** string / required | | Managed device ID. |
| | **fips\_enforce** string | **Choices:*** disable
* enable
| Enable/disable enforcement of FIPS on managed FortiSwitch devices. |
| | **https\_image\_push** string | **Choices:*** enable
* disable
| Enable/disable image push to FortiSwitch using HTTPS. |
| | **log\_mac\_limit\_violations** string | **Choices:*** enable
* disable
| Enable/disable logs for Learning Limit Violations. |
| | **mac\_aging\_interval** integer | | Time after which an inactive MAC is aged out (10 - 1000000 sec). |
| | **mac\_event\_logging** string | **Choices:*** enable
* disable
| Enable/disable MAC address event logging. |
| | **mac\_retention\_period** integer | | Time in hours after which an inactive MAC is removed from client DB. |
| | **mac\_violation\_timer** integer | | Set timeout for Learning Limit Violations (0 = disabled). |
| | **quarantine\_mode** string | **Choices:*** by-vlan
* by-redirect
| Quarantine mode. |
| | **sn\_dns\_resolution** string | **Choices:*** enable
* disable
| Enable/disable DNS resolution of the FortiSwitch unit"s IP address by use of its serial number. |
| | **update\_user\_device** list / elements=string | **Choices:*** mac-cache
* lldp
* dhcp-snooping
* l2-db
* l3-db
| Control which sources update the device user list. |
| | **vlan\_all\_mode** string | **Choices:*** all
* defined
| VLAN configuration mode, user-defined-vlans or all-possible-vlans. |
| | **vlan\_optimization** string | **Choices:*** enable
* disable
| FortiLink VLAN optimization. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 global settings.
fortios_switch_controller_global:
vdom: "{{ vdom }}"
switch_controller_global:
allow_multiple_interfaces: "enable"
bounce_quarantined_link: "disable"
custom_command:
-
command_entry: "<your_own_value>"
command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
default_virtual_switch_vlan: "<your_own_value> (source system.interface.name)"
disable_discovery:
-
name: "default_name_10"
fips_enforce: "disable"
https_image_push: "enable"
log_mac_limit_violations: "enable"
mac_aging_interval: "14"
mac_event_logging: "enable"
mac_retention_period: "16"
mac_violation_timer: "17"
quarantine_mode: "by-vlan"
sn_dns_resolution: "enable"
update_user_device: "mac-cache"
vlan_all_mode: "all"
vlan_optimization: "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_ips_custom – Configure IPS custom signature in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_custom – Configure IPS custom signature in Fortinet’s FortiOS and FortiGate.
===========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 ips 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. |
| **ips\_custom** dictionary | | Configure IPS custom signature. |
| | **action** string | **Choices:*** pass
* block
| Default action (pass or block) for this signature. |
| | **application** string | | Applications to be protected. Blank for all applications. |
| | **comment** string | | Comment. |
| | **location** string | | Protect client or server traffic. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | **os** string | | Operating system(s) that the signature protects. Blank for all operating systems. |
| | **protocol** string | | Protocol(s) that the signature scans. Blank for all protocols. |
| | **rule\_id** integer | | Signature ID. |
| | **severity** string | | Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity. |
| | **sig\_name** string | | Signature name. |
| | **signature** string | | Custom signature enclosed in single quotes. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this signature. |
| | **tag** string / required | | Signature tag. |
| **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 custom signature.
fortios_ips_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_custom:
action: "pass"
application: "<your_own_value>"
comment: "Comment."
location: "<your_own_value>"
log: "disable"
log_packet: "disable"
os: "<your_own_value>"
protocol: "<your_own_value>"
rule_id: "11"
severity: "<your_own_value>"
sig_name: "<your_own_value>"
signature: "<your_own_value>"
status: "disable"
tag: "<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_switch_controller_mac_policy – Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_mac\_policy – Configure MAC policy to be applied on the managed FortiSwitch devices 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_mac_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 mac\_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\_mac\_policy** dictionary | | Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device. |
| | **bounce\_port\_link** string | **Choices:*** disable
* enable
| Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. |
| | **count** string | **Choices:*** disable
* enable
| Enable/Disable packet count on the NAC device. |
| | **description** string | | Description for the MAC policy. |
| | **drop** string | **Choices:*** disable
* enable
| Enable/disable dropping of NAC device traffic. |
| | **fortilink** string | | FortiLink interface for which this MAC policy belongs to. Source system.interface.name. |
| | **name** string / required | | MAC policy name. |
| | **traffic\_policy** string | | Traffic policy to be applied when using this MAC policy. Source switch-controller.traffic-policy.name. |
| | **vlan** string | | Ingress traffic VLAN assignment for the MAC address matching this MAC policy. 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 MAC policy to be applied on the managed FortiSwitch devices through NAC device.
fortios_switch_controller_mac_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_mac_policy:
bounce_port_link: "disable"
count: "disable"
description: "<your_own_value>"
drop: "disable"
fortilink: "<your_own_value> (source system.interface.name)"
name: "default_name_8"
traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"
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_user_peergrp – Configure peer groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_peergrp – Configure peer 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_peergrp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 peergrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_peergrp** dictionary | | Configure peer groups. |
| | **member** list / elements=string | | Peer group members. |
| | | **name** string / required | | Peer group member name. Source user.peer.name. |
| | **name** string / required | | Peer 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 peer groups.
fortios_user_peergrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_peergrp:
member:
-
name: "default_name_4 (source user.peer.name)"
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_wireless_controller_hotspot20_qos_map – Configure QoS map set in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_qos\_map – Configure QoS map set in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_qos_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 wireless\_controller\_hotspot20 feature and qos\_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. |
| **vdom** string | **Default:**"root" | Virtual 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\_qos\_map** dictionary | | Configure QoS map set. |
| | **dscp\_except** list / elements=string | | Differentiated Services Code Point (DSCP) exceptions. |
| | | **dscp** integer | | DSCP value. |
| | | **index** integer / required | | DSCP exception index. |
| | | **up** integer | | User priority. |
| | **dscp\_range** list / elements=string | | Differentiated Services Code Point (DSCP) ranges. |
| | | **high** integer | | DSCP high value. |
| | | **index** integer / required | | DSCP range index. |
| | | **low** integer | | DSCP low value. |
| | | **up** integer | | User priority. |
| | **name** string / required | | QOS-MAP 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 QoS map set.
fortios_wireless_controller_hotspot20_qos_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_qos_map:
dscp_except:
-
dscp: "4"
index: "5"
up: "6"
dscp_range:
-
high: "8"
index: "9"
low: "10"
up: "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_system_vdom_netflow – Configure NetFlow per VDOM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_netflow – Configure NetFlow per 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_system_vdom_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 vdom\_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\_vdom\_netflow** dictionary | | Configure NetFlow per VDOM. |
| | **collector\_ip** string | | NetFlow collector IP address. |
| | **collector\_port** integer | | NetFlow collector port number. |
| | **source\_ip** string | | Source IP address for communication with the NetFlow agent. |
| | **vdom\_netflow** string | **Choices:*** enable
* disable
| Enable/disable NetFlow per VDOM. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 per VDOM.
fortios_system_vdom_netflow:
vdom: "{{ vdom }}"
system_vdom_netflow:
collector_ip: "<your_own_value>"
collector_port: "4"
source_ip: "84.230.14.43"
vdom_netflow: "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_fortianalyzer3_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer3\_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_fortianalyzer3_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 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\_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 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. |
| | **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_fortianalyzer3_filter:
vdom: "{{ vdom }}"
log_fortianalyzer3_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_firewall_address6_template – Configure IPv6 address templates in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_address6\_template – Configure IPv6 address templates in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_address6_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 firewall feature and address6\_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. |
| **firewall\_address6\_template** dictionary | | Configure IPv6 address templates. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **ip6** string | | IPv6 address prefix. |
| | **name** string / required | | IPv6 address template name. |
| | **subnet\_segment** list / elements=string | | IPv6 subnet segments. |
| | | **bits** integer | | Number of bits. |
| | | **exclusive** string | **Choices:*** enable
* disable
| Enable/disable exclusive value. |
| | | **id** integer / required | | Subnet segment ID. |
| | | **name** string | | Subnet segment name. |
| | | **values** list / elements=string | | Subnet segment values. |
| | | | **name** string / required | | Subnet segment value name. |
| | | | **value** string | | Subnet segment value. |
| | **subnet\_segment\_count** integer | | Number of IPv6 subnet segments. |
| **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 address templates.
fortios_firewall_address6_template:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_address6_template:
fabric_object: "enable"
ip6: "<your_own_value>"
name: "default_name_5"
subnet_segment:
-
bits: "7"
exclusive: "enable"
id: "9"
name: "default_name_10"
values:
-
name: "default_name_12"
value: "<your_own_value>"
subnet_segment_count: "14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_consolidated_policy – Configure consolidated IPv4/IPv6 policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_consolidated\_policy – Configure consolidated IPv4/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_consolidated_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\_consolidated 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. |
| **firewall\_consolidated\_policy** dictionary | | Configure consolidated IPv4/IPv6 policies. |
| | **action** string | **Choices:*** accept
* deny
* ipsec
| Policy action (allow/deny/ipsec). |
| | **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. |
| | **captive\_portal\_exempt** string | **Choices:*** enable
* disable
| Enable exemption of some users from the captive portal. |
| | **cifs\_profile** string | | Name of an existing CIFS profile. Source cifs.profile.name. |
| | **comments** string | | Comment. |
| | **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. |
| | **dstaddr4** list / elements=string | | Destination IPv4 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .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.vip6.name firewall.vipgrp6.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. |
| | **emailfilter\_profile** string | | Name of an existing email filter profile. Source emailfilter.profile.name. |
| | **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. |
| | **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\_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\_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. |
| | **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. |
| | **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. |
| | **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 (0 - 4294967294). |
| | **poolname4** list / elements=string | | IPv4 pool names. |
| | | **name** string / required | | IPv4 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. |
| | **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. |
| | **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 ). |
| | **srcaddr4** list / elements=string | | Source IPv4 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.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\_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). |
| | **traffic\_shaper** string | | Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **traffic\_shaper\_reverse** string | | Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
| | **users** list / elements=string | | Names of individual users that can authenticate with this policy. |
| | | **name** string / required | | User name. 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). |
| | **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 to server. |
| | **wanopt\_peer** string | | WAN optimization peer. Source wanopt.peer.peer-host-id. |
| | **wanopt\_profile** string | | WAN optimization profile. Source wanopt.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 | | 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. |
| **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 consolidated IPv4/IPv6 policies.
fortios_firewall_consolidated_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_consolidated_policy:
action: "accept"
application_list: "<your_own_value> (source application.list.name)"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
captive_portal_exempt: "enable"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
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)"
dstaddr_negate: "enable"
dstaddr4:
-
name: "default_name_18 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)"
dstaddr6:
-
name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system.external-resource
.name)"
dstintf:
-
name: "default_name_22 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
fixedport: "enable"
fsso_groups:
-
name: "default_name_26 (source user.adgrp.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_29 (source user.group.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
inbound: "enable"
inspection_mode: "proxy"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_36 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_38 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_40 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "42 (source firewall.internet-service.id)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_46 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_48 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_50 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "52 (source firewall.internet-service.id)"
internet_service_src_negate: "enable"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_59"
nat: "enable"
outbound: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
policyid: "63"
poolname4:
-
name: "default_name_65 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_67 (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"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_73 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "75"
srcaddr_negate: "enable"
srcaddr4:
-
name: "default_name_78 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr6:
-
name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_82 (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"
tcp_mss_receiver: "87"
tcp_mss_sender: "88"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
users:
-
name: "default_name_92 (source user.local.name)"
utm_status: "enable"
uuid: "<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)"
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_switch_controller_security_policy_802_1x – Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_security\_policy\_802\_1x – Configure 802.1x MAC Authentication Bypass (MAB) 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_switch_controller_security_policy_802_1x`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_security\_policy feature and 802\_1x category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_security\_policy\_802\_1x** dictionary | | Configure 802.1x MAC Authentication Bypass (MAB) policies. |
| | **auth\_fail\_vlan** string | **Choices:*** disable
* enable
| Enable to allow limited access to clients that cannot authenticate. |
| | **auth\_fail\_vlan\_id** string | | VLAN ID on which authentication failed. Source system.interface.name. |
| | **auth\_fail\_vlanid** integer | | VLAN ID on which authentication failed. |
| | **authserver\_timeout\_period** integer | | Authentication server timeout period (3 - 15 sec). |
| | **authserver\_timeout\_vlan** string | **Choices:*** disable
* enable
| Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. |
| | **authserver\_timeout\_vlanid** string | | Authentication server timeout VLAN name. Source system.interface.name. |
| | **eap\_auto\_untagged\_vlans** string | **Choices:*** disable
* enable
| Enable/disable automatic inclusion of untagged VLANs. |
| | **eap\_passthru** string | **Choices:*** disable
* enable
| Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication. |
| | **framevid\_apply** string | **Choices:*** disable
* enable
| Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. |
| | **guest\_auth\_delay** integer | | Guest authentication delay (1 - 900 sec). |
| | **guest\_vlan** string | **Choices:*** disable
* enable
| Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients. |
| | **guest\_vlan\_id** string | | Guest VLAN name. Source system.interface.name. |
| | **guest\_vlanid** integer | | Guest VLAN ID. |
| | **mac\_auth\_bypass** string | **Choices:*** disable
* enable
| Enable/disable MAB for this policy. |
| | **name** string / required | | Policy name. |
| | **open\_auth** string | **Choices:*** disable
* enable
| Enable/disable open authentication for this policy. |
| | **policy\_type** string | **Choices:*** 802.1X
| Policy type. |
| | **radius\_timeout\_overwrite** string | **Choices:*** disable
* enable
| Enable to override the global RADIUS session timeout. |
| | **security\_mode** string | **Choices:*** 802.1X
* 802.1X-mac-based
| Port or MAC based 802.1X security mode. |
| | **user\_group** list / elements=string | | Name of user-group to assign to this MAC Authentication Bypass (MAB) policy. |
| | | **name** string / required | | Group name. 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 802.1x MAC Authentication Bypass (MAB) policies.
fortios_switch_controller_security_policy_802_1x:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_security_policy_802_1x:
auth_fail_vlan: "disable"
auth_fail_vlan_id: "<your_own_value> (source system.interface.name)"
auth_fail_vlanid: "5"
authserver_timeout_period: "6"
authserver_timeout_vlan: "disable"
authserver_timeout_vlanid: "<your_own_value> (source system.interface.name)"
eap_auto_untagged_vlans: "disable"
eap_passthru: "disable"
framevid_apply: "disable"
guest_auth_delay: "12"
guest_vlan: "disable"
guest_vlan_id: "<your_own_value> (source system.interface.name)"
guest_vlanid: "15"
mac_auth_bypass: "disable"
name: "default_name_17"
open_auth: "disable"
policy_type: "802.1X"
radius_timeout_overwrite: "disable"
security_mode: "802.1X"
user_group:
-
name: "default_name_23 (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_router_bfd6 – Configure IPv6 BFD in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_bfd6 – Configure IPv6 BFD in Fortinet’s FortiOS and FortiGate.
================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_bfd6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bfd6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_bfd6** dictionary | | Configure IPv6 BFD. |
| | **neighbor** list / elements=string | | Configure neighbor of IPv6 BFD. |
| | | **interface** string | | Interface to the BFD neighbor. Source system.interface.name. |
| | | **ip6\_address** string | | IPv6 address of the BFD neighbor. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 BFD.
fortios_router_bfd6:
vdom: "{{ vdom }}"
router_bfd6:
neighbor:
-
interface: "<your_own_value> (source system.interface.name)"
ip6_address: "<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_dpdk_global – Configure global DPDK options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dpdk\_global – Configure global DPDK 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_dpdk_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 dpdk 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. |
| **dpdk\_global** dictionary | | Configure global DPDK options. |
| | **elasticbuffer** string | **Choices:*** disable
* enable
| Enable/disable elasticbuffer support for all DPDK ports. |
| | **hugepage\_percentage** integer | | Percentage of main memory allocated to hugepages, which are available for DPDK operation. |
| | **interface** list / elements=string | | Physical interfaces that enable DPDK. |
| | | **interface\_name** string | | Physical interface name. Source system.interface.name. |
| | **mbufpool\_percentage** integer | | Percentage of main memory allocated to DPDK packet buffer. |
| | **multiqueue** string | **Choices:*** disable
* enable
| Enable/disable multi-queue RX/TX support for all DPDK ports. |
| | **per\_session\_accounting** string | **Choices:*** disable
* traffic-log-only
* enable
| Enable/disable per-session accounting. |
| | **sleep\_on\_idle** string | **Choices:*** disable
* enable
| Enable/disable sleep-on-idle support for all FDH engines. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable DPDK operation for the entire system. |
| **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 global DPDK options.
fortios_dpdk_global:
vdom: "{{ vdom }}"
dpdk_global:
elasticbuffer: "disable"
hugepage_percentage: "4"
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
mbufpool_percentage: "7"
multiqueue: "disable"
per_session_accounting: "disable"
sleep_on_idle: "disable"
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)
ansible fortinet.fortios.fortios_firewall_vipgrp – Configure IPv4 virtual IP groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vipgrp – Configure 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_vipgrp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 vipgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_vipgrp** dictionary | | Configure 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. |
| | **interface** string | | interface Source system.interface.name. |
| | **member** list / elements=string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | | **name** string / required | | VIP name. Source firewall.vip.name. |
| | **name** string / required | | 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 IPv4 virtual IP groups.
fortios_firewall_vipgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vipgrp:
color: "3"
comments: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
member:
-
name: "default_name_7 (source firewall.vip.name)"
name: "default_name_8"
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_log_null_device_setting – Settings for null device logging in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_null\_device\_setting – Settings for null device 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_null_device_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\_null\_device 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\_null\_device\_setting** dictionary | | Settings for null device logging. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable statistics collection for when no external logging destination, such as FortiAnalyzer, is present (data is not saved). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 null device logging.
fortios_log_null_device_setting:
vdom: "{{ vdom }}"
log_null_device_setting:
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_dnsfilter_profile – Configure DNS domain filter profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dnsfilter\_profile – Configure DNS domain 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_dnsfilter_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 dnsfilter 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. |
| **dnsfilter\_profile** dictionary | | Configure DNS domain filter profiles. |
| | **block\_action** string | **Choices:*** block
* redirect
| Action to take for blocked domains. |
| | **block\_botnet** string | **Choices:*** disable
* enable
| Enable/disable blocking botnet C&C DNS lookups. |
| | **comment** string | | Comment. |
| | **dns\_translation** list / elements=string | | DNS translation settings. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
| DNS translation type (IPv4 or IPv6). |
| | | **dst** string | | IPv4 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP address or subnet on the external network, but number of addresses must equal number of mapped IP addresses in src. |
| | | **dst6** string | | IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP address or subnet on the external network, but number of addresses must equal number of mapped IP addresses in src6. |
| | | **id** integer / required | | ID. |
| | | **netmask** string | | If src and dst are subnets rather than single IP addresses, enter the netmask for both src and dst. |
| | | **prefix** integer | | If src6 and dst6 are subnets rather than single IP addresses, enter the prefix for both src6 and dst6 (1 - 128). |
| | | **src** string | | IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved address matches, the resolved address is substituted with dst. |
| | | **src6** string | | IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved address matches, the resolved address is substituted with dst6. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this DNS translation entry. |
| | **domain\_filter** dictionary | | Domain filter settings. |
| | | **domain\_filter\_table** integer | | DNS domain filter table ID. Source dnsfilter.domain-filter.id. |
| | **external\_ip\_blocklist** list / elements=string | | One or more external IP block lists. |
| | | **name** string / required | | External domain block list name. Source system.external-resource.name. |
| | **ftgd\_dns** dictionary | | FortiGuard DNS Filter settings. |
| | | **filters** list / elements=string | | FortiGuard DNS domain filters. |
| | | | **action** string | **Choices:*** block
* monitor
| Action to take for DNS requests matching the category. |
| | | | **category** integer | | Category number. |
| | | | **id** integer / required | | ID number. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable DNS filter logging for this DNS profile. |
| | | **options** string | **Choices:*** error-allow
* ftgd-disable
| FortiGuard DNS filter options. |
| | **log\_all\_domain** string | **Choices:*** enable
* disable
| Enable/disable logging of all domains visited (detailed DNS logging). |
| | **name** string / required | | Profile name. |
| | **redirect\_portal** string | | IP address of the SDNS redirect portal. |
| | **redirect\_portal6** string | | IPv6 address of the SDNS redirect portal. |
| | **safe\_search** string | **Choices:*** disable
* enable
| Enable/disable Google, Bing, and YouTube safe search. |
| | **sdns\_domain\_log** string | **Choices:*** enable
* disable
| Enable/disable domain filtering and botnet domain logging. |
| | **sdns\_ftgd\_err\_log** string | **Choices:*** enable
* disable
| Enable/disable FortiGuard SDNS rating error logging. |
| | **youtube\_restrict** string | **Choices:*** strict
* moderate
| Set safe search for YouTube restriction level. |
| **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 DNS domain filter profiles.
fortios_dnsfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dnsfilter_profile:
block_action: "block"
block_botnet: "disable"
comment: "Comment."
dns_translation:
-
addr_type: "ipv4"
dst: "<your_own_value>"
dst6: "<your_own_value>"
id: "10"
netmask: "<your_own_value>"
prefix: "12"
src: "<your_own_value>"
src6: "<your_own_value>"
status: "enable"
domain_filter:
domain_filter_table: "17 (source dnsfilter.domain-filter.id)"
external_ip_blocklist:
-
name: "default_name_19 (source system.external-resource.name)"
ftgd_dns:
filters:
-
action: "block"
category: "23"
id: "24"
log: "enable"
options: "error-allow"
log_all_domain: "enable"
name: "default_name_28"
redirect_portal: "<your_own_value>"
redirect_portal6: "<your_own_value>"
safe_search: "disable"
sdns_domain_log: "enable"
sdns_ftgd_err_log: "enable"
youtube_restrict: "strict"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_ospf6 – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_ospf6 – Configure IPv6 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_ospf6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ospf6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ospf6** dictionary | | Configure IPv6 OSPF. |
| | **abr\_type** string | **Choices:*** cisco
* ibm
* standard
| Area border router type. |
| | **area** list / elements=string | | OSPF6 area configuration. |
| | | **authentication** string | **Choices:*** none
* ah
* esp
| Authentication mode. |
| | | **default\_cost** integer | | Summary default cost of stub or NSSA area. |
| | | **id** string / required | | Area entry IP address. |
| | | **ipsec\_auth\_alg** string | **Choices:*** md5
* sha1
* sha256
* sha384
* sha512
| Authentication algorithm. |
| | | **ipsec\_enc\_alg** string | **Choices:*** **None** ←
* des
* 3des
* aes128
* aes192
* aes256
| Encryption algorithm. |
| | | **ipsec\_keys** list / elements=string | | IPsec authentication and encryption keys. |
| | | | **auth\_key** string | | Authentication key. |
| | | | **enc\_key** string | | Encryption key. |
| | | | **spi** integer / required | | Security Parameters Index. |
| | | **key\_rollover\_interval** integer | | Key roll-over interval. |
| | | **nssa\_default\_information\_originate** string | **Choices:*** enable
* disable
| Enable/disable originate type 7 default into NSSA area. |
| | | **nssa\_default\_information\_originate\_metric** integer | | OSPFv3 default metric. |
| | | **nssa\_default\_information\_originate\_metric\_type** string | **Choices:*** 1
* 2
| OSPFv3 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 | | OSPF6 area range configuration. |
| | | | **advertise** string | **Choices:*** disable
* enable
| Enable/disable advertise status. |
| | | | **id** integer / required | | Range entry ID. |
| | | | **prefix6** string | | IPv6 prefix. |
| | | **stub\_type** string | **Choices:*** no-summary
* summary
| Stub summary setting. |
| | | **type** string | **Choices:*** regular
* nssa
* stub
| Area type setting. |
| | | **virtual\_link** list / elements=string | | OSPF6 virtual link configuration. |
| | | | **authentication** string | **Choices:*** none
* ah
* esp
* area
| Authentication mode. |
| | | | **dead\_interval** integer | | Dead interval. |
| | | | **hello\_interval** integer | | Hello interval. |
| | | | **ipsec\_auth\_alg** string | **Choices:*** md5
* sha1
* sha256
* sha384
* sha512
| Authentication algorithm. |
| | | | **ipsec\_enc\_alg** string | **Choices:*** **None** ←
* des
* 3des
* aes128
* aes192
* aes256
| Encryption algorithm. |
| | | | **ipsec\_keys** list / elements=string | | IPsec authentication and encryption keys. |
| | | | | **auth\_key** string | | Authentication key. |
| | | | | **enc\_key** string | | Encryption key. |
| | | | | **spi** integer / required | | Security Parameters Index. |
| | | | **key\_rollover\_interval** integer | | Key roll-over interval. |
| | | | **name** string / required | | Virtual link entry name. |
| | | | **peer** string | | A.B.C.D, peer router ID. |
| | | | **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
| Enable/disable Bidirectional Forwarding Detection (BFD). |
| | **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. |
| | **log\_neighbour\_changes** string | **Choices:*** enable
* disable
| Enable logging of OSPFv3 neighbour"s changes |
| | **ospf6\_interface** list / elements=string | | OSPF6 interface configuration. |
| | | **area\_id** string | | A.B.C.D, in IPv4 address format. |
| | | **authentication** string | **Choices:*** none
* ah
* esp
* area
| Authentication mode. |
| | | **bfd** string | **Choices:*** global
* enable
* disable
| Enable/disable Bidirectional Forwarding Detection (BFD). |
| | | **cost** integer | | Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
| | | **dead\_interval** integer | | Dead interval. |
| | | **hello\_interval** integer | | Hello interval. |
| | | **interface** string | | Configuration interface name. Source system.interface.name. |
| | | **ipsec\_auth\_alg** string | **Choices:*** md5
* sha1
* sha256
* sha384
* sha512
| Authentication algorithm. |
| | | **ipsec\_enc\_alg** string | **Choices:*** **None** ←
* des
* 3des
* aes128
* aes192
* aes256
| Encryption algorithm. |
| | | **ipsec\_keys** list / elements=string | | IPsec authentication and encryption keys. |
| | | | **auth\_key** string | | Authentication key. |
| | | | **enc\_key** string | | Encryption key. |
| | | | **spi** integer / required | | Security Parameters Index. |
| | | **key\_rollover\_interval** integer | | Key roll-over interval. |
| | | **mtu** integer | | MTU for OSPFv3 packets. |
| | | **mtu\_ignore** string | **Choices:*** enable
* disable
| Enable/disable ignoring MTU field in DBD packets. |
| | | **name** string / required | | Interface entry name. |
| | | **neighbor** list / elements=string | | OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media |
| | | | **cost** integer | | Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
| | | | **ip6** string / required | | IPv6 link local address of the neighbor. |
| | | | **poll\_interval** integer | | Poll interval time in seconds. |
| | | | **priority** integer | | priority |
| | | **network\_type** string | **Choices:*** broadcast
* point-to-point
* non-broadcast
* point-to-multipoint
* point-to-multipoint-non-broadcast
| Network type. |
| | | **priority** integer | | priority |
| | | **retransmit\_interval** integer | | Retransmit interval. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable OSPF6 routing on this interface. |
| | | **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 |
| | **router\_id** string | | A.B.C.D, in IPv4 address format. |
| | **spf\_timers** string | | SPF calculation frequency. |
| | **summary\_address** list / elements=string | | IPv6 address summary configuration. |
| | | **advertise** string | **Choices:*** disable
* enable
| Enable/disable advertise status. |
| | | **id** integer / required | | Summary address entry ID. |
| | | **prefix6** string | | IPv6 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 IPv6 OSPF.
fortios_router_ospf6:
vdom: "{{ vdom }}"
router_ospf6:
abr_type: "cisco"
area:
-
authentication: "none"
default_cost: "6"
id: "7"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "13"
key_rollover_interval: "14"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "16"
nssa_default_information_originate_metric_type: "1"
nssa_redistribution: "enable"
nssa_translator_role: "candidate"
range:
-
advertise: "disable"
id: "22"
prefix6: "<your_own_value>"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
dead_interval: "28"
hello_interval: "29"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "35"
key_rollover_interval: "36"
name: "default_name_37"
peer: "<your_own_value>"
retransmit_interval: "39"
transmit_delay: "40"
auto_cost_ref_bandwidth: "41"
bfd: "enable"
default_information_metric: "43"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "47"
log_neighbour_changes: "enable"
ospf6_interface:
-
area_id: "<your_own_value>"
authentication: "none"
bfd: "global"
cost: "53"
dead_interval: "54"
hello_interval: "55"
interface: "<your_own_value> (source system.interface.name)"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "62"
key_rollover_interval: "63"
mtu: "64"
mtu_ignore: "enable"
name: "default_name_66"
neighbor:
-
cost: "68"
ip6: "<your_own_value>"
poll_interval: "70"
priority: "71"
network_type: "broadcast"
priority: "73"
retransmit_interval: "74"
status: "disable"
transmit_delay: "76"
passive_interface:
-
name: "default_name_78 (source system.interface.name)"
redistribute:
-
metric: "80"
metric_type: "1"
name: "default_name_82"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
router_id: "<your_own_value>"
spf_timers: "<your_own_value>"
summary_address:
-
advertise: "disable"
id: "89"
prefix6: "<your_own_value>"
tag: "91"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_region – Define region table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_region – Define region 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_region`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 region category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_region** dictionary | | Define region table. |
| | **city** list / elements=string | | City ID list. |
| | | **id** integer / required | | City ID. |
| | **id** integer / required | | Region ID. |
| | **name** string | | Region 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: Define region table.
fortios_firewall_region:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_region:
city:
-
id: "4"
id: "5"
name: "default_name_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_system_gre_tunnel – Configure GRE tunnel in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_gre\_tunnel – Configure GRE 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_gre_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 gre\_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\_gre\_tunnel** dictionary | | Configure GRE tunnel. |
| | **checksum\_reception** string | **Choices:*** disable
* enable
| Enable/disable validating checksums in received GRE packets. |
| | **checksum\_transmission** string | **Choices:*** disable
* enable
| Enable/disable including checksums in transmitted GRE packets. |
| | **diffservcode** string | | DiffServ setting to be applied to GRE tunnel outer IP header. |
| | **dscp\_copying** string | **Choices:*** disable
* enable
| Enable/disable DSCP copying. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **ip\_version** string | **Choices:*** 4
* 6
| IP version to use for VPN interface. |
| | **keepalive\_failtimes** integer | | Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255). |
| | **keepalive\_interval** integer | | Keepalive message interval (0 - 32767, 0 = disabled). |
| | **key\_inbound** integer | | Require received GRE packets contain this key (0 - 4294967295). |
| | **key\_outbound** integer | | Include this key in transmitted GRE packets (0 - 4294967295). |
| | **local\_gw** string | | IP address of the local gateway. |
| | **local\_gw6** string | | IPv6 address of the local gateway. |
| | **name** string / required | | Tunnel name. |
| | **remote\_gw** string | | IP address of the remote gateway. |
| | **remote\_gw6** string | | IPv6 address of the remote gateway. |
| | **sequence\_number\_reception** string | **Choices:*** disable
* enable
| Enable/disable validating sequence numbers in received GRE packets. |
| | **sequence\_number\_transmission** string | **Choices:*** disable
* enable
| Enable/disable including of sequence numbers in transmitted GRE packets. |
| | **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 GRE tunnel.
fortios_system_gre_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_gre_tunnel:
checksum_reception: "disable"
checksum_transmission: "disable"
diffservcode: "<your_own_value>"
dscp_copying: "disable"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "4"
keepalive_failtimes: "9"
keepalive_interval: "10"
key_inbound: "11"
key_outbound: "12"
local_gw: "<your_own_value>"
local_gw6: "<your_own_value>"
name: "default_name_15"
remote_gw: "<your_own_value>"
remote_gw6: "<your_own_value>"
sequence_number_reception: "disable"
sequence_number_transmission: "disable"
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_central_management – Configure central management in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_central\_management – Configure central management in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_central_management`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 central\_management category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_central\_management** dictionary | | Configure central management. |
| | **allow\_monitor** string | **Choices:*** enable
* disable
| Enable/disable allowing the central management server to remotely monitor this FortiGate |
| | **allow\_push\_configuration** string | **Choices:*** enable
* disable
| Enable/disable allowing the central management server to push configuration changes to this FortiGate. |
| | **allow\_push\_firmware** string | **Choices:*** enable
* disable
| Enable/disable allowing the central management server to push firmware updates to this FortiGate. |
| | **allow\_remote\_firmware\_upgrade** string | **Choices:*** enable
* disable
| Enable/disable remotely upgrading the firmware on this FortiGate from the central management server. |
| | **ca\_cert** string | | CA certificate to be used by FGFM protocol. |
| | **enc\_algorithm** string | **Choices:*** default
* high
* low
| Encryption strength for communications between the FortiGate and central management. |
| | **fmg** string | | IP address or FQDN of the FortiManager. |
| | **fmg\_source\_ip** string | | IPv4 source address that this FortiGate uses when communicating with FortiManager. |
| | **fmg\_source\_ip6** string | | IPv6 source address that this FortiGate uses when communicating with FortiManager. |
| | **fmg\_update\_port** string | **Choices:*** 8890
* 443
| Port used to communicate with FortiManager that is acting as a FortiGuard update server. |
| | **include\_default\_servers** string | **Choices:*** enable
* disable
| Enable/disable inclusion of public FortiGuard servers in the override server list. |
| | **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. |
| | **local\_cert** string | | Certificate to be used by FGFM protocol. |
| | **mode** string | **Choices:*** normal
* backup
| Central management mode. |
| | **schedule\_config\_restore** string | **Choices:*** enable
* disable
| Enable/disable allowing the central management server to restore the configuration of this FortiGate. |
| | **schedule\_script\_restore** string | **Choices:*** enable
* disable
| Enable/disable allowing the central management server to restore the scripts stored on this FortiGate. |
| | **serial\_number** string | | Serial number. |
| | **server\_list** list / elements=string | | Additional severs that the FortiGate can use for updates (for AV, IPS, updates) and ratings (for web filter and antispam ratings) servers. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
* fqdn
| Indicate whether the FortiGate communicates with the override server using an IPv4 address, an IPv6 address or a FQDN. |
| | | **fqdn** string | | FQDN address of override server. |
| | | **id** integer / required | | ID. |
| | | **server\_address** string | | IPv4 address of override server. |
| | | **server\_address6** string | | IPv6 address of override server. |
| | | **server\_type** string | **Choices:*** update
* rating
| FortiGuard service type. |
| | **type** string | **Choices:*** fortimanager
* fortiguard
* none
| Central management type. |
| | **vdom** string | | Virtual domain (VDOM) name to use when communicating with FortiManager. 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 central management.
fortios_system_central_management:
vdom: "{{ vdom }}"
system_central_management:
allow_monitor: "enable"
allow_push_configuration: "enable"
allow_push_firmware: "enable"
allow_remote_firmware_upgrade: "enable"
ca_cert: "<your_own_value>"
enc_algorithm: "default"
fmg: "<your_own_value>"
fmg_source_ip: "<your_own_value>"
fmg_source_ip6: "<your_own_value>"
fmg_update_port: "8890"
include_default_servers: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
local_cert: "<your_own_value>"
mode: "normal"
schedule_config_restore: "enable"
schedule_script_restore: "enable"
serial_number: "<your_own_value>"
server_list:
-
addr_type: "ipv4"
fqdn: "<your_own_value>"
id: "24"
server_address: "<your_own_value>"
server_address6: "<your_own_value>"
server_type: "update"
type: "fortimanager"
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_system_autoupdate_push_update – Configure push updates in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_autoupdate\_push\_update – Configure push updates in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_autoupdate_push_update`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_autoupdate feature and push\_update category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_autoupdate\_push\_update** dictionary | | Configure push updates. |
| | **address** string | | Push update override server. |
| | **override** string | **Choices:*** enable
* disable
| Enable/disable push update override server. |
| | **port** integer | | Push update override port. (Do not overlap with other service ports) |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable push updates. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 push updates.
fortios_system_autoupdate_push_update:
vdom: "{{ vdom }}"
system_autoupdate_push_update:
address: "<your_own_value>"
override: "enable"
port: "5"
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_fsso_polling – Configure Fortinet Single Sign On (FSSO) server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fsso\_polling – Configure Fortinet Single Sign On (FSSO) 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_system_fsso_polling`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fsso\_polling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fsso\_polling** dictionary | | Configure Fortinet Single Sign On (FSSO) server. |
| | **auth\_password** string | | Password to connect to FSSO Agent. |
| | **authentication** string | **Choices:*** enable
* disable
| Enable/disable FSSO Agent Authentication. |
| | **listening\_port** integer | | Listening port to accept clients (1 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FSSO Polling 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 Fortinet Single Sign On (FSSO) server.
fortios_system_fsso_polling:
vdom: "{{ vdom }}"
system_fsso_polling:
auth_password: "<your_own_value>"
authentication: "enable"
listening_port: "5"
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_npu – Configure NPU attributes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_npu – Configure NPU 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_npu`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 npu category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_npu** dictionary | | Configure NPU attributes. |
| | **capwap\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading managed FortiAP and FortiLink CAPWAP sessions. |
| | **dedicated\_management\_cpu** string | **Choices:*** enable
* disable
| Enable to dedicate one CPU for GUI and CLI connections when NPs are busy. |
| | **fastpath** string | **Choices:*** disable
* enable
| Enable/disable NP6 offloading (also called fast path). |
| | **gtp\_enhanced\_cpu\_range** string | **Choices:*** 0
* 1
* 2
| GTP enhanced CPU range option. |
| | **gtp\_enhanced\_mode** string | **Choices:*** enable
* disable
| Enable/disable GTP enhanced mode. |
| | **intf\_shaping\_offload** string | **Choices:*** enable
* disable
| Enable/disable NPU offload when doing interface-based traffic shaping according to the egress-shaping-profile. |
| | **ipsec\_dec\_subengine\_mask** string | | IPsec decryption subengine mask (0x1 - 0xff). |
| | **ipsec\_enc\_subengine\_mask** string | | IPsec encryption subengine mask (0x1 - 0xff). |
| | **ipsec\_inbound\_cache** string | **Choices:*** enable
* disable
| Enable/disable IPsec inbound cache for anti-replay. |
| | **ipsec\_mtu\_override** string | **Choices:*** disable
* enable
| Enable/disable NP6 IPsec MTU override. |
| | **ipsec\_over\_vlink** string | **Choices:*** enable
* disable
| Enable/disable IPSEC over vlink. |
| | **isf\_np\_queues** dictionary | | Configure queues of switch port connected to NP6 XAUI on ingress 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. |
| | **lag\_out\_port\_select** string | **Choices:*** disable
* enable
| Enable/disable LAG outgoing port selection based on incoming traffic port. |
| | **mcast\_session\_accounting** string | **Choices:*** tpe-based
* session-based
* disable
| Enable/disable traffic accounting for each multicast session through TAE counter. |
| | **port\_cpu\_map** list / elements=string | | Configure NPU interface to CPU core mapping. |
| | | **cpu\_core** string | | The CPU core to map to an interface. |
| | | **interface** string / required | | The interface to map to a CPU core. |
| | **port\_npu\_map** list / elements=string | | Configure port to NPU group mapping. |
| | | **interface** string / required | | Set npu interface port to NPU group map. |
| | | **npu\_group\_index** integer | | Mapping NPU group index. |
| | **priority\_protocol** string | | Configure NPU priority protocol. |
| | | **bfd** string | **Choices:*** enable
* disable
| Enable/disable NPU BFD priority protocol. |
| | | **bgp** string | **Choices:*** enable
* disable
| Enable/disable NPU BGP priority protocol. |
| | | **slbc** string | **Choices:*** enable
* disable
| Enable/disable NPU SLBC priority protocol. |
| | **qos\_mode** string | **Choices:*** disable
* priority
* round-robin
| QoS mode on switch and NP. |
| | **rdp\_offload** string | **Choices:*** enable
* disable
| Enable/disable rdp offload. |
| | **session\_denied\_offload** string | **Choices:*** disable
* enable
| Enable/disable offloading of denied sessions. Requires ses-denied-traffic to be set. |
| | **sse\_backpressure** string | **Choices:*** enable
* disable
| Enable/disable sse backpressure. |
| | **strip\_clear\_text\_padding** string | **Choices:*** enable
* disable
| Enable/disable stripping clear text padding. |
| | **strip\_esp\_padding** string | **Choices:*** enable
* disable
| Enable/disable stripping ESP padding. |
| | **sw\_np\_bandwidth** string | **Choices:*** 0G
* 2G
* 4G
* 5G
* 6G
| Bandwidth from switch to NP. |
| | **uesp\_offload** string | **Choices:*** enable
* disable
| Enable/disable UDP-encapsulated ESP offload . |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 NPU attributes.
fortios_system_npu:
vdom: "{{ vdom }}"
system_npu:
capwap_offload: "enable"
dedicated_management_cpu: "enable"
fastpath: "disable"
gtp_enhanced_cpu_range: "0"
gtp_enhanced_mode: "enable"
intf_shaping_offload: "enable"
ipsec_dec_subengine_mask: "<your_own_value>"
ipsec_enc_subengine_mask: "<your_own_value>"
ipsec_inbound_cache: "enable"
ipsec_mtu_override: "disable"
ipsec_over_vlink: "enable"
isf_np_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)"
lag_out_port_select: "disable"
mcast_session_accounting: "tpe-based"
port_cpu_map:
-
cpu_core: "<your_own_value>"
interface: "<your_own_value>"
port_npu_map:
-
interface: "<your_own_value>"
npu_group_index: "30"
priority_protocol:
bfd: "enable"
bgp: "enable"
slbc: "enable"
qos_mode: "disable"
rdp_offload: "enable"
session_denied_offload: "disable"
sse_backpressure: "enable"
strip_clear_text_padding: "enable"
strip_esp_padding: "enable"
sw_np_bandwidth: "0G"
uesp_offload: "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_switch – Configure virtual hardware switch interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_virtual\_switch – Configure virtual hardware switch 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_virtual_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 virtual\_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\_virtual\_switch** dictionary | | Configure virtual hardware switch interfaces. |
| | **name** string / required | | Name of the virtual switch. |
| | **physical\_switch** string | | Physical switch parent. Source system.physical-switch.name. |
| | **port** list / elements=string | | Configure member ports. |
| | | **alias** string | | Alias. |
| | | **mediatype** string | **Choices:*** cfp2-sr10
* cfp2-lr4
| Select SFP media interface type. |
| | | **name** string / required | | Physical interface name. |
| | | **speed** string | **Choices:*** auto
* 10full
* 10half
* 100full
* 100half
* 1000full
* 1000half
* 1000auto
* 10000full
* 10000auto
* 40000full
* 100Gfull
| Interface speed. |
| | | **status** string | **Choices:*** up
* down
| Interface status. |
| | **span** string | **Choices:*** disable
* enable
| Enable/disable SPAN. |
| | **span\_dest\_port** string | | SPAN destination port. |
| | **span\_direction** string | **Choices:*** rx
* tx
* both
| SPAN direction. |
| | **span\_source\_port** string | | SPAN source ports. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 hardware switch interfaces.
fortios_system_virtual_switch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_virtual_switch:
name: "default_name_3"
physical_switch: "<your_own_value> (source system.physical-switch.name)"
port:
-
alias: "<your_own_value>"
mediatype: "cfp2-sr10"
name: "default_name_8"
speed: "auto"
status: "up"
span: "disable"
span_dest_port: "<your_own_value>"
span_direction: "rx"
span_source_port: "<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_vpn_ipsec_phase1_interface – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_phase1\_interface – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_phase1_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 phase1\_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\_phase1\_interface** dictionary | | Configure VPN remote gateway. |
| | **acct\_verify** string | **Choices:*** enable
* disable
| Enable/disable verification of RADIUS accounting record. |
| | **add\_gw\_route** string | **Choices:*** enable
* disable
| Enable/disable automatically add a route to the remote gateway. |
| | **add\_route** string | **Choices:*** disable
* enable
| Enable/disable control addition of a route to peer destination selector. |
| | **aggregate\_member** string | **Choices:*** enable
* disable
| Enable/disable use as an aggregate member. |
| | **aggregate\_weight** integer | | Link weight for aggregate. |
| | **assign\_ip** string | **Choices:*** disable
* enable
| Enable/disable assignment of IP to IPsec interface via configuration method. |
| | **assign\_ip\_from** string | **Choices:*** range
* usrgrp
* dhcp
* name
| Method by which the IP address will be assigned. |
| | **authmethod** string | **Choices:*** psk
* signature
| Authentication method. |
| | **authmethod\_remote** string | **Choices:*** psk
* signature
| Authentication method (remote side). |
| | **authpasswd** string | | XAuth password (max 35 characters). |
| | **authusr** string | | XAuth user name. |
| | **authusrgrp** string | | Authentication user group. Source user.group.name. |
| | **auto\_discovery\_forwarder** string | **Choices:*** enable
* disable
| Enable/disable forwarding auto-discovery short-cut messages. |
| | **auto\_discovery\_psk** string | **Choices:*** enable
* disable
| Enable/disable use of pre-shared secrets for authentication of auto-discovery tunnels. |
| | **auto\_discovery\_receiver** string | **Choices:*** enable
* disable
| Enable/disable accepting auto-discovery short-cut messages. |
| | **auto\_discovery\_sender** string | **Choices:*** enable
* disable
| Enable/disable sending auto-discovery short-cut messages. |
| | **auto\_discovery\_shortcuts** string | **Choices:*** independent
* dependent
| Control deletion of child short-cut tunnels when the parent tunnel goes down. |
| | **auto\_negotiate** string | **Choices:*** enable
* disable
| Enable/disable automatic initiation of IKE SA negotiation. |
| | **backup\_gateway** list / elements=string | | Instruct unity clients about the backup gateway address(es). |
| | | **address** string / required | | Address of backup gateway. |
| | **banner** string | | Message that unity client should display after connecting. |
| | **cert\_id\_validation** string | **Choices:*** enable
* disable
| Enable/disable cross validation of peer ID and the identity in the peer"s certificate as specified in RFC 4945. |
| | **certificate** list / elements=string | | The names of up to 4 signed personal certificates. |
| | | **name** string / required | | Certificate name. Source vpn.certificate.local.name. |
| | **childless\_ike** string | **Choices:*** enable
* disable
| Enable/disable childless IKEv2 initiation (RFC 6023). |
| | **client\_auto\_negotiate** string | **Choices:*** disable
* enable
| Enable/disable allowing the VPN client to bring up the tunnel when there is no traffic. |
| | **client\_keep\_alive** string | **Choices:*** disable
* enable
| Enable/disable allowing the VPN client to keep the tunnel up when there is no traffic. |
| | **comments** string | | Comment. |
| | **default\_gw** string | | IPv4 address of default route gateway to use for traffic exiting the interface. |
| | **default\_gw\_priority** integer | | Priority for default gateway route. A higher priority number signifies a less preferred route. |
| | **dhcp6\_ra\_linkaddr** string | | Relay agent IPv6 link address to use in DHCP6 requests. |
| | **dhcp\_ra\_giaddr** string | | Relay agent gateway IP address to use in the giaddr field of DHCP requests. |
| | **dhgrp** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
* 32
| DH group. |
| | **digital\_signature\_auth** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 Digital Signature Authentication (RFC 7427). |
| | **distance** integer | | Distance for routes added by IKE (1 - 255). |
| | **dns\_mode** string | **Choices:*** manual
* auto
| DNS server mode. |
| | **domain** string | | Instruct unity clients about the default DNS domain. |
| | **dpd** string | **Choices:*** disable
* on-idle
* on-demand
| Dead Peer Detection mode. |
| | **dpd\_retrycount** integer | | Number of DPD retry attempts. |
| | **dpd\_retryinterval** string | | DPD retry interval. |
| | **eap** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 EAP authentication. |
| | **eap\_exclude\_peergrp** string | | Peer group excluded from EAP authentication. Source user.peergrp.name. |
| | **eap\_identity** string | **Choices:*** use-id-payload
* send-request
| IKEv2 EAP peer identity type. |
| | **encap\_local\_gw4** string | | Local IPv4 address of GRE/VXLAN tunnel. |
| | **encap\_local\_gw6** string | | Local IPv6 address of GRE/VXLAN tunnel. |
| | **encap\_remote\_gw4** string | | Remote IPv4 address of GRE/VXLAN tunnel. |
| | **encap\_remote\_gw6** string | | Remote IPv6 address of GRE/VXLAN tunnel. |
| | **encapsulation** string | **Choices:*** none
* gre
* vxlan
| Enable/disable GRE/VXLAN encapsulation. |
| | **encapsulation\_address** string | **Choices:*** ike
* ipv4
* ipv6
| Source for GRE/VXLAN tunnel address. |
| | **enforce\_unique\_id** string | **Choices:*** disable
* keep-new
* keep-old
| Enable/disable peer ID uniqueness check. |
| | **esn** string | **Choices:*** require
* allow
* disable
| Extended sequence number (ESN) negotiation. |
| | **exchange\_interface\_ip** string | **Choices:*** enable
* disable
| Enable/disable exchange of IPsec interface IP address. |
| | **exchange\_ip\_addr4** string | | IPv4 address to exchange with peers. |
| | **exchange\_ip\_addr6** string | | IPv6 address to exchange with peers |
| | **fec\_base** integer | | Number of base Forward Error Correction packets (1 - 100). |
| | **fec\_codec** integer | | ipsec fec encoding/decoding algorithm (0: reed-solomon, 1: xor). |
| | **fec\_egress** string | **Choices:*** enable
* disable
| Enable/disable Forward Error Correction for egress IPsec traffic. |
| | **fec\_ingress** string | **Choices:*** enable
* disable
| Enable/disable Forward Error Correction for ingress IPsec traffic. |
| | **fec\_receive\_timeout** integer | | Timeout in milliseconds before dropping Forward Error Correction packets (1 - 10000). |
| | **fec\_redundant** integer | | Number of redundant Forward Error Correction packets (1 - 100). |
| | **fec\_send\_timeout** integer | | Timeout in milliseconds before sending Forward Error Correction packets (1 - 1000). |
| | **forticlient\_enforcement** string | **Choices:*** enable
* disable
| Enable/disable FortiClient enforcement. |
| | **fragmentation** string | **Choices:*** enable
* disable
| Enable/disable fragment IKE message on re-transmission. |
| | **fragmentation\_mtu** integer | | IKE fragmentation MTU (500 - 16000). |
| | **group\_authentication** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 IDi group authentication. |
| | **group\_authentication\_secret** string | | Password for IKEv2 IDi group authentication. (ASCII string or hexadecimal indicated by a leading 0x.) |
| | **ha\_sync\_esp\_seqno** string | **Choices:*** enable
* disable
| Enable/disable sequence number jump ahead for IPsec HA. |
| | **idle\_timeout** string | **Choices:*** enable
* disable
| Enable/disable IPsec tunnel idle timeout. |
| | **idle\_timeoutinterval** integer | | IPsec tunnel idle timeout in minutes (5 - 43200). |
| | **ike\_version** string | **Choices:*** 1
* 2
| IKE protocol version. |
| | **include\_local\_lan** string | **Choices:*** disable
* enable
| Enable/disable allow local LAN access on unity clients. |
| | **interface** string | | Local physical, aggregate, or VLAN outgoing interface. Source system.interface.name. |
| | **ip\_fragmentation** string | **Choices:*** pre-encapsulation
* post-encapsulation
| Determine whether IP packets are fragmented before or after IPsec encapsulation. |
| | **ip\_version** string | **Choices:*** 4
* 6
| IP version to use for VPN interface. |
| | **ipv4\_dns\_server1** string | | IPv4 DNS server 1. |
| | **ipv4\_dns\_server2** string | | IPv4 DNS server 2. |
| | **ipv4\_dns\_server3** string | | IPv4 DNS server 3. |
| | **ipv4\_end\_ip** string | | End of IPv4 range. |
| | **ipv4\_exclude\_range** list / elements=string | | Configuration Method IPv4 exclude ranges. |
| | | **end\_ip** string | | End of IPv4 exclusive range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IPv4 exclusive range. |
| | **ipv4\_name** string | | IPv4 address name. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_netmask** string | | IPv4 Netmask. |
| | **ipv4\_split\_exclude** string | | IPv4 subnets that should not be sent over the IPsec tunnel. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_split\_include** string | | IPv4 split-include subnets. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_start\_ip** string | | Start of IPv4 range. |
| | **ipv4\_wins\_server1** string | | WINS server 1. |
| | **ipv4\_wins\_server2** string | | WINS server 2. |
| | **ipv6\_dns\_server1** string | | IPv6 DNS server 1. |
| | **ipv6\_dns\_server2** string | | IPv6 DNS server 2. |
| | **ipv6\_dns\_server3** string | | IPv6 DNS server 3. |
| | **ipv6\_end\_ip** string | | End of IPv6 range. |
| | **ipv6\_exclude\_range** list / elements=string | | Configuration method IPv6 exclude ranges. |
| | | **end\_ip** string | | End of IPv6 exclusive range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IPv6 exclusive range. |
| | **ipv6\_name** string | | IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_prefix** integer | | IPv6 prefix. |
| | **ipv6\_split\_exclude** string | | IPv6 subnets that should not be sent over the IPsec tunnel. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_split\_include** string | | IPv6 split-include subnets. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_start\_ip** string | | Start of IPv6 range. |
| | **keepalive** integer | | NAT-T keep alive interval. |
| | **keylife** integer | | Time to wait in seconds before phase 1 encryption key expires. |
| | **local\_gw** string | | IPv4 address of the local gateway"s external interface. |
| | **local\_gw6** string | | IPv6 address of the local gateway"s external interface. |
| | **localid** string | | Local ID. |
| | **localid\_type** string | **Choices:*** auto
* fqdn
* user-fqdn
* keyid
* address
* asn1dn
| Local ID type. |
| | **loopback\_asymroute** string | **Choices:*** enable
* disable
| Enable/disable asymmetric routing for IKE traffic on loopback interface. |
| | **mesh\_selector\_type** string | **Choices:*** disable
* subnet
* host
| Add selectors containing subsets of the configuration depending on traffic. |
| | **mode** string | **Choices:*** aggressive
* main
| The ID protection mode used to establish a secure channel. |
| | **mode\_cfg** string | **Choices:*** disable
* enable
| Enable/disable configuration method. |
| | **monitor** string | | IPsec interface as backup for primary interface. Source vpn.ipsec.phase1-interface.name. |
| | **monitor\_hold\_down\_delay** integer | | Time to wait in seconds before recovery once primary re-establishes. |
| | **monitor\_hold\_down\_time** string | | Time of day at which to fail back to primary after it re-establishes. |
| | **monitor\_hold\_down\_type** string | **Choices:*** immediate
* delay
* time
| Recovery time method when primary interface re-establishes. |
| | **monitor\_hold\_down\_weekday** string | **Choices:*** everyday
* sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Day of the week to recover once primary re-establishes. |
| | **name** string / required | | IPsec remote gateway name. |
| | **nattraversal** string | **Choices:*** enable
* disable
* forced
| Enable/disable NAT traversal. |
| | **negotiate\_timeout** integer | | IKE SA negotiation timeout in seconds (1 - 300). |
| | **net\_device** string | **Choices:*** enable
* disable
| Enable/disable kernel device creation for dialup instances. |
| | **network\_id** integer | | VPN gateway network ID. |
| | **network\_overlay** string | **Choices:*** disable
* enable
| Enable/disable network overlays. |
| | **npu\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading NPU. |
| | **passive\_mode** string | **Choices:*** enable
* disable
| Enable/disable IPsec passive mode for static tunnels. |
| | **peer** string | | Accept this peer certificate. Source user.peer.name. |
| | **peergrp** string | | Accept this peer certificate group. Source user.peergrp.name. |
| | **peerid** string | | Accept this peer identity. |
| | **peertype** string | **Choices:*** any
* one
* dialup
* peer
* peergrp
| Accept this peer type. |
| | **ppk** string | **Choices:*** disable
* allow
* require
| Enable/disable IKEv2 Postquantum Preshared Key (PPK). |
| | **ppk\_identity** string | | IKEv2 Postquantum Preshared Key Identity. |
| | **ppk\_secret** string | | IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). |
| | **priority** integer | | Priority for routes added by IKE (0 - 4294967295). |
| | **proposal** list / elements=string | **Choices:*** des-md5
* des-sha1
* des-sha256
* des-sha384
* des-sha512
* 3des-md5
* 3des-sha1
* 3des-sha256
* 3des-sha384
* 3des-sha512
* aes128-md5
* aes128-sha1
* aes128-sha256
* aes128-sha384
* aes128-sha512
* aes128gcm-prfsha1
* aes128gcm-prfsha256
* aes128gcm-prfsha384
* aes128gcm-prfsha512
* aes192-md5
* aes192-sha1
* aes192-sha256
* aes192-sha384
* aes192-sha512
* aes256-md5
* aes256-sha1
* aes256-sha256
* aes256-sha384
* aes256-sha512
* aes256gcm-prfsha1
* aes256gcm-prfsha256
* aes256gcm-prfsha384
* aes256gcm-prfsha512
* chacha20poly1305-prfsha1
* chacha20poly1305-prfsha256
* chacha20poly1305-prfsha384
* chacha20poly1305-prfsha512
* aria128-md5
* aria128-sha1
* aria128-sha256
* aria128-sha384
* aria128-sha512
* aria192-md5
* aria192-sha1
* aria192-sha256
* aria192-sha384
* aria192-sha512
* aria256-md5
* aria256-sha1
* aria256-sha256
* aria256-sha384
* aria256-sha512
* seed-md5
* seed-sha1
* seed-sha256
* seed-sha384
* seed-sha512
| Phase1 proposal. |
| | **psksecret** string | | Pre-shared secret for PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
| | **psksecret\_remote** string | | Pre-shared secret for remote side PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
| | **reauth** string | **Choices:*** disable
* enable
| Enable/disable re-authentication upon IKE SA lifetime expiration. |
| | **rekey** string | **Choices:*** enable
* disable
| Enable/disable phase1 rekey. |
| | **remote\_gw** string | | IPv4 address of the remote gateway"s external interface. |
| | **remote\_gw6** string | | IPv6 address of the remote gateway"s external interface. |
| | **remotegw\_ddns** string | | Domain name of remote gateway (eg. name.DDNS.com). |
| | **rsa\_signature\_format** string | **Choices:*** pkcs1
* pss
| Digital Signature Authentication RSA signature format. |
| | **save\_password** string | **Choices:*** disable
* enable
| Enable/disable saving XAuth username and password on VPN clients. |
| | **send\_cert\_chain** string | **Choices:*** enable
* disable
| Enable/disable sending certificate chain. |
| | **signature\_hash\_alg** list / elements=string | **Choices:*** sha1
* sha2-256
* sha2-384
* sha2-512
| Digital Signature Authentication hash algorithms. |
| | **split\_include\_service** string | | Split-include services. Source firewall.service.group.name firewall.service.custom.name. |
| | **suite\_b** string | **Choices:*** disable
* suite-b-gcm-128
* suite-b-gcm-256
| Use Suite-B. |
| | **tunnel\_search** string | **Choices:*** selectors
* nexthop
| Tunnel search method for when the interface is shared. |
| | **type** string | **Choices:*** static
* dynamic
* ddns
| Remote gateway type. |
| | **unity\_support** string | **Choices:*** disable
* enable
| Enable/disable support for Cisco UNITY Configuration Method extensions. |
| | **usrgrp** string | | User group name for dialup peers. Source user.group.name. |
| | **vni** integer | | VNI of VXLAN tunnel. |
| | **wizard\_type** string | **Choices:*** custom
* dialup-forticlient
* dialup-ios
* dialup-android
* dialup-windows
* dialup-cisco
* static-fortigate
* dialup-fortigate
* static-cisco
* dialup-cisco-fw
* simplified-static-fortigate
* hub-fortigate-auto-discovery
* spoke-fortigate-auto-discovery
| GUI VPN Wizard Type. |
| | **xauthtype** string | **Choices:*** disable
* client
* pap
* chap
* auto
| XAuth type. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 remote gateway.
fortios_vpn_ipsec_phase1_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_phase1_interface:
acct_verify: "enable"
add_gw_route: "enable"
add_route: "disable"
aggregate_member: "enable"
aggregate_weight: "7"
assign_ip: "disable"
assign_ip_from: "range"
authmethod: "psk"
authmethod_remote: "psk"
authpasswd: "<your_own_value>"
authusr: "<your_own_value>"
authusrgrp: "<your_own_value> (source user.group.name)"
auto_discovery_forwarder: "enable"
auto_discovery_psk: "enable"
auto_discovery_receiver: "enable"
auto_discovery_sender: "enable"
auto_discovery_shortcuts: "independent"
auto_negotiate: "enable"
backup_gateway:
-
address: "<your_own_value>"
banner: "<your_own_value>"
cert_id_validation: "enable"
certificate:
-
name: "default_name_26 (source vpn.certificate.local.name)"
childless_ike: "enable"
client_auto_negotiate: "disable"
client_keep_alive: "disable"
comments: "<your_own_value>"
default_gw: "<your_own_value>"
default_gw_priority: "32"
dhcp_ra_giaddr: "<your_own_value>"
dhcp6_ra_linkaddr: "<your_own_value>"
dhgrp: "1"
digital_signature_auth: "enable"
distance: "37"
dns_mode: "manual"
domain: "<your_own_value>"
dpd: "disable"
dpd_retrycount: "41"
dpd_retryinterval: "<your_own_value>"
eap: "enable"
eap_exclude_peergrp: "<your_own_value> (source user.peergrp.name)"
eap_identity: "use-id-payload"
encap_local_gw4: "<your_own_value>"
encap_local_gw6: "<your_own_value>"
encap_remote_gw4: "<your_own_value>"
encap_remote_gw6: "<your_own_value>"
encapsulation: "none"
encapsulation_address: "ike"
enforce_unique_id: "disable"
esn: "require"
exchange_interface_ip: "enable"
exchange_ip_addr4: "<your_own_value>"
exchange_ip_addr6: "<your_own_value>"
fec_base: "57"
fec_codec: "58"
fec_egress: "enable"
fec_ingress: "enable"
fec_receive_timeout: "61"
fec_redundant: "62"
fec_send_timeout: "63"
forticlient_enforcement: "enable"
fragmentation: "enable"
fragmentation_mtu: "66"
group_authentication: "enable"
group_authentication_secret: "<your_own_value>"
ha_sync_esp_seqno: "enable"
idle_timeout: "enable"
idle_timeoutinterval: "71"
ike_version: "1"
include_local_lan: "disable"
interface: "<your_own_value> (source system.interface.name)"
ip_fragmentation: "pre-encapsulation"
ip_version: "4"
ipv4_dns_server1: "<your_own_value>"
ipv4_dns_server2: "<your_own_value>"
ipv4_dns_server3: "<your_own_value>"
ipv4_end_ip: "<your_own_value>"
ipv4_exclude_range:
-
end_ip: "<your_own_value>"
id: "83"
start_ip: "<your_own_value>"
ipv4_name: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_netmask: "<your_own_value>"
ipv4_split_exclude: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_split_include: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_start_ip: "<your_own_value>"
ipv4_wins_server1: "<your_own_value>"
ipv4_wins_server2: "<your_own_value>"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
ipv6_dns_server3: "<your_own_value>"
ipv6_end_ip: "<your_own_value>"
ipv6_exclude_range:
-
end_ip: "<your_own_value>"
id: "98"
start_ip: "<your_own_value>"
ipv6_name: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_prefix: "101"
ipv6_split_exclude: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_split_include: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_start_ip: "<your_own_value>"
keepalive: "105"
keylife: "106"
local_gw: "<your_own_value>"
local_gw6: "<your_own_value>"
localid: "<your_own_value>"
localid_type: "auto"
loopback_asymroute: "enable"
mesh_selector_type: "disable"
mode: "aggressive"
mode_cfg: "disable"
monitor: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
monitor_hold_down_delay: "116"
monitor_hold_down_time: "<your_own_value>"
monitor_hold_down_type: "immediate"
monitor_hold_down_weekday: "everyday"
name: "default_name_120"
nattraversal: "enable"
negotiate_timeout: "122"
net_device: "enable"
network_id: "124"
network_overlay: "disable"
npu_offload: "enable"
passive_mode: "enable"
peer: "<your_own_value> (source user.peer.name)"
peergrp: "<your_own_value> (source user.peergrp.name)"
peerid: "<your_own_value>"
peertype: "any"
ppk: "disable"
ppk_identity: "<your_own_value>"
ppk_secret: "<your_own_value>"
priority: "135"
proposal: "des-md5"
psksecret: "<your_own_value>"
psksecret_remote: "<your_own_value>"
reauth: "disable"
rekey: "enable"
remote_gw: "<your_own_value>"
remote_gw6: "<your_own_value>"
remotegw_ddns: "<your_own_value>"
rsa_signature_format: "pkcs1"
save_password: "disable"
send_cert_chain: "enable"
signature_hash_alg: "sha1"
split_include_service: "<your_own_value> (source firewall.service.group.name firewall.service.custom.name)"
suite_b: "disable"
tunnel_search: "selectors"
type: "static"
unity_support: "disable"
usrgrp: "<your_own_value> (source user.group.name)"
vni: "154"
wizard_type: "custom"
xauthtype: "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_dnsfilter_domain_filter – Configure DNS domain filters in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_dnsfilter\_domain\_filter – Configure DNS domain 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_dnsfilter_domain_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 dnsfilter feature and domain\_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. |
| **dnsfilter\_domain\_filter** dictionary | | Configure DNS domain filters. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | DNS domain filter entries. |
| | | **action** string | **Choices:*** block
* allow
* monitor
| Action to take for domain filter matches. |
| | | **domain** string | | Domain entries to be filtered. |
| | | **id** integer / required | | Id. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this domain filter. |
| | | **type** string | **Choices:*** simple
* regex
* wildcard
| DNS domain filter type. |
| | **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 DNS domain filters.
fortios_dnsfilter_domain_filter:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dnsfilter_domain_filter:
comment: "Optional comments."
entries:
-
action: "block"
domain: "<your_own_value>"
id: "7"
status: "enable"
type: "simple"
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_vpn_pptp – Configure PPTP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_pptp – Configure PPTP in Fortinet’s FortiOS and FortiGate.
=========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_pptp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 pptp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_pptp** dictionary | | Configure PPTP. |
| | **eip** string | | End IP. |
| | **ip\_mode** string | **Choices:*** range
* usrgrp
| IP assignment mode for PPTP client. |
| | **local\_ip** string | | Local IP to be used for peer"s remote IP. |
| | **sip** string | | Start IP. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FortiGate as a PPTP gateway. |
| | **usrgrp** string | | User group. 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 PPTP.
fortios_vpn_pptp:
vdom: "{{ vdom }}"
vpn_pptp:
eip: "<your_own_value>"
ip_mode: "range"
local_ip: "<your_own_value>"
sip: "<your_own_value>"
status: "enable"
usrgrp: "<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_wireless_controller_qos_profile – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_qos\_profile – Configure WiFi quality of service (QoS) 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_qos_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 qos\_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\_qos\_profile** dictionary | | Configure WiFi quality of service (QoS) profiles. |
| | **bandwidth\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WMM bandwidth admission control. |
| | **bandwidth\_capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps). |
| | **burst** string | **Choices:*** enable
* disable
| Enable/disable client rate burst. |
| | **call\_admission\_control** string | **Choices:*** enable
* disable
| Enable/disable WMM call admission control. |
| | **call\_capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60). |
| | **comment** string | | Comment. |
| | **downlink** integer | | Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). |
| | **downlink\_sta** integer | | Maximum downlink bandwidth for clients (0 - 2097152 Kbps). |
| | **dscp\_wmm\_be** list / elements=string | | DSCP mapping for best effort access . |
| | | **id** integer / required | | DSCP WMM mapping numbers (0 - 63). |
| | **dscp\_wmm\_bk** list / elements=string | | DSCP mapping for background access . |
| | | **id** integer / required | | DSCP WMM mapping numbers (0 - 63). |
| | **dscp\_wmm\_mapping** string | **Choices:*** enable
* disable
| Enable/disable Differentiated Services Code Point (DSCP) mapping. |
| | **dscp\_wmm\_vi** list / elements=string | | DSCP mapping for video access . |
| | | **id** integer / required | | DSCP WMM mapping numbers (0 - 63). |
| | **dscp\_wmm\_vo** list / elements=string | | DSCP mapping for voice access . |
| | | **id** integer / required | | DSCP WMM mapping numbers (0 - 63). |
| | **name** string / required | | WiFi QoS profile name. |
| | **uplink** integer | | Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). |
| | **uplink\_sta** integer | | Maximum uplink bandwidth for clients (0 - 2097152 Kbps). |
| | **wmm** string | **Choices:*** enable
* disable
| Enable/disable WiFi multi-media (WMM) control. |
| | **wmm\_be\_dscp** integer | | DSCP marking for best effort access . |
| | **wmm\_bk\_dscp** integer | | DSCP marking for background access . |
| | **wmm\_dscp\_marking** string | **Choices:*** enable
* disable
| Enable/disable WMM Differentiated Services Code Point (DSCP) marking. |
| | **wmm\_uapsd** string | **Choices:*** enable
* disable
| Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. |
| | **wmm\_vi\_dscp** integer | | DSCP marking for video access . |
| | **wmm\_vo\_dscp** integer | | DSCP marking for voice 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: Configure WiFi quality of service (QoS) profiles.
fortios_wireless_controller_qos_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_qos_profile:
bandwidth_admission_control: "enable"
bandwidth_capacity: "4"
burst: "enable"
call_admission_control: "enable"
call_capacity: "7"
comment: "Comment."
downlink: "9"
downlink_sta: "10"
dscp_wmm_be:
-
id: "12"
dscp_wmm_bk:
-
id: "14"
dscp_wmm_mapping: "enable"
dscp_wmm_vi:
-
id: "17"
dscp_wmm_vo:
-
id: "19"
name: "default_name_20"
uplink: "21"
uplink_sta: "22"
wmm: "enable"
wmm_be_dscp: "24"
wmm_bk_dscp: "25"
wmm_dscp_marking: "enable"
wmm_uapsd: "enable"
wmm_vi_dscp: "28"
wmm_vo_dscp: "29"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_status – Display rating info in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_status – Display rating 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_webfilter_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 webfilter feature and 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. |
| **webfilter\_status** dictionary | | Display rating info. |
| | string | | Frequency to refresh the server list (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: Display rating info.
fortios_webfilter_status:
vdom: "{{ vdom }}"
webfilter_status:
<refresh_rate>: "<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_fortianalyzer3_override_setting – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer3\_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_fortianalyzer3_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\_fortianalyzer3 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\_fortianalyzer3\_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_fortianalyzer3_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer3_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)
ansible fortinet.fortios.fortios_waf_signature – Hidden table for datasource in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_waf\_signature – 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_signature`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 signature category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_signature** dictionary | | Hidden table for datasource. |
| | **desc** string | | Signature description. |
| | **id** integer / required | | Signature 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: Hidden table for datasource.
fortios_waf_signature:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
waf_signature:
desc: "<your_own_value>"
id: "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_dns – Configure DNS in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dns – Configure DNS in Fortinet’s FortiOS and FortiGate.
==========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dns`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dns** dictionary | | Configure DNS. |
| | **cache\_notfound\_responses** string | **Choices:*** disable
* enable
| Enable/disable response from the DNS server when a record is not in cache. |
| | **dns\_cache\_limit** integer | | Maximum number of records in the DNS cache. |
| | **dns\_cache\_ttl** integer | | Duration in seconds that the DNS cache retains information. |
| | **dns\_over\_tls** string | **Choices:*** disable
* enable
* enforce
| Enable/disable/enforce DNS over TLS. |
| | **domain** list / elements=string | | Search suffix list for hostname lookup. |
| | | **domain** string / required | | DNS search domain list separated by space (maximum 8 domains) |
| | **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\_primary** string | | Primary DNS server IPv6 address. |
| | **ip6\_secondary** string | | Secondary DNS server IPv6 address. |
| | **primary** string | | Primary DNS server IP address. |
| | **protocol** list / elements=string | **Choices:*** cleartext
* dot
* doh
| DNS protocols. |
| | **retry** integer | | Number of times to retry (0 - 5). |
| | **secondary** string | | Secondary DNS server IP address. |
| | **server\_hostname** list / elements=string | | DNS server host name list. |
| | | **hostname** string / required | | DNS server host name list separated by space (maximum 4 domains). |
| | **source\_ip** string | | IP address used by the DNS server as its source IP. |
| | **ssl\_certificate** string | | Name of local certificate for SSL connections. Source certificate.local.name. |
| | **timeout** integer | | DNS query timeout interval in seconds (1 - 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
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 DNS.
fortios_system_dns:
vdom: "{{ vdom }}"
system_dns:
cache_notfound_responses: "disable"
dns_cache_limit: "4"
dns_cache_ttl: "5"
dns_over_tls: "disable"
domain:
-
domain: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip6_primary: "<your_own_value>"
ip6_secondary: "<your_own_value>"
primary: "<your_own_value>"
protocol: "cleartext"
retry: "15"
secondary: "<your_own_value>"
server_hostname:
-
hostname: "myhostname"
source_ip: "84.230.14.43"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
timeout: "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_firewall_ipv6_eh_filter – Configure IPv6 extension header filter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ipv6\_eh\_filter – Configure IPv6 extension header 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_firewall_ipv6_eh_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 firewall feature and ipv6\_eh\_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. |
| **firewall\_ipv6\_eh\_filter** dictionary | | Configure IPv6 extension header filter. |
| | **auth** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with the Authentication header . |
| | **dest\_opt** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with Destination Options headers . |
| | **fragment** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with the Fragment header . |
| | **hdopt\_type** integer | | Block specific Hop-by-Hop and/or Destination Option types (max. 7 types, each between 0 and 255). |
| | **hop\_opt** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with the Hop-by-Hop Options header . |
| | **no\_next** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with the No Next header |
| | **routing** string | **Choices:*** enable
* disable
| Enable/disable blocking packets with Routing headers . |
| | **routing\_type** integer | | Block specific Routing header types (max. 7 types, each between 0 and 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 IPv6 extension header filter.
fortios_firewall_ipv6_eh_filter:
vdom: "{{ vdom }}"
firewall_ipv6_eh_filter:
auth: "enable"
dest_opt: "enable"
fragment: "enable"
hdopt_type: "6"
hop_opt: "enable"
no_next: "enable"
routing: "enable"
routing_type: "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_dnstranslation – Configure DNS translation in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_dnstranslation – Configure DNS translation in Fortinet’s FortiOS and FortiGate.
===================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dnstranslation`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dnstranslation category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dnstranslation** dictionary | | Configure DNS translation. |
| | **dst** string | | IPv4 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP address or subnet on the external network, but number of addresses must equal number of mapped IP addresses in src. |
| | **id** integer / required | | ID. |
| | **netmask** string | | If src and dst are subnets rather than single IP addresses, enter the netmask for both src and dst. |
| | **src** string | | IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved address matches, the resolved address is substituted with dst. |
| **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 DNS translation.
fortios_firewall_dnstranslation:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_dnstranslation:
dst: "<your_own_value>"
id: "4"
netmask: "<your_own_value>"
src: "<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_poe – List PoE end-points status in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_poe – List PoE end-points 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_switch_controller_poe`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 poe category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_poe** dictionary | | List PoE end-points status. |
| | string | | FortiSwitch device 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: List PoE end-points status.
fortios_switch_controller_poe:
vdom: "{{ vdom }}"
switch_controller_poe:
<fortiswitch_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_3g_modem_custom – 3G MODEM custom in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_3g\_modem\_custom – 3G MODEM custom in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_3g_modem_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 system\_3g\_modem 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. |
| **system\_3g\_modem\_custom** dictionary | | 3G MODEM custom. |
| | **class\_id** string | | USB interface class in hexadecimal format (00-ff). |
| | **id** integer / required | | ID. |
| | **init\_string** string | | Init string in hexadecimal format (even length). |
| | **model** string | | MODEM model name. |
| | **modeswitch\_string** string | | Usb modeswitch arguments. e.g: "-v 1410 -p 9030 -V 1410 -P 9032 -u 3" |
| | **product\_id** string | | USB product ID in hexadecimal format (0000-ffff). |
| | **vendor** string | | MODEM vendor name. |
| | **vendor\_id** string | | USB vendor ID in hexadecimal format (0000-ffff). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: 3G MODEM custom.
fortios_system_3g_modem_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_3g_modem_custom:
class_id: "<your_own_value>"
id: "4"
init_string: "<your_own_value>"
model: "<your_own_value>"
modeswitch_string: "<your_own_value>"
product_id: "<your_own_value>"
vendor: "<your_own_value>"
vendor_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_report_theme – Report themes configuratio in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_report\_theme – Report themes configuratio in Fortinet’s FortiOS and FortiGate.
=========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_theme`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 theme category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_theme** dictionary | | Report themes configuration |
| | **bullet\_list\_style** string | | Bullet list style. |
| | **column\_count** string | **Choices:*** 1
* 2
* 3
| Report page column count. |
| | **default\_html\_style** string | | Default HTML report style. |
| | **default\_pdf\_style** string | | Default PDF report style. |
| | **graph\_chart\_style** string | | Graph chart style. |
| | **heading1\_style** string | | Report heading style. |
| | **heading2\_style** string | | Report heading style. |
| | **heading3\_style** string | | Report heading style. |
| | **heading4\_style** string | | Report heading style. |
| | **hline\_style** string | | Horizontal line style. |
| | **image\_style** string | | Image style. |
| | **name** string / required | | Report theme name. |
| | **normal\_text\_style** string | | Normal text style. |
| | **numbered\_list\_style** string | | Numbered list style. |
| | **page\_footer\_style** string | | Report page footer style. |
| | **page\_header\_style** string | | Report page header style. |
| | **page\_orient** string | **Choices:*** portrait
* landscape
| Report page orientation. |
| | **page\_style** string | | Report page style. |
| | **report\_subtitle\_style** string | | Report subtitle style. |
| | **report\_title\_style** string | | Report title style. |
| | **table\_chart\_caption\_style** string | | Table chart caption style. |
| | **table\_chart\_even\_row\_style** string | | Table chart even row style. |
| | **table\_chart\_head\_style** string | | Table chart head row style. |
| | **table\_chart\_odd\_row\_style** string | | Table chart odd row style. |
| | **table\_chart\_style** string | | Table chart style. |
| | **toc\_heading1\_style** string | | Table of contents heading style. |
| | **toc\_heading2\_style** string | | Table of contents heading style. |
| | **toc\_heading3\_style** string | | Table of contents heading style. |
| | **toc\_heading4\_style** string | | Table of contents heading style. |
| | **toc\_title\_style** string | | Table of contents title style. |
| **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 themes configuration
fortios_report_theme:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_theme:
bullet_list_style: "<your_own_value>"
column_count: "1"
default_html_style: "<your_own_value>"
default_pdf_style: "<your_own_value>"
graph_chart_style: "<your_own_value>"
heading1_style: "<your_own_value>"
heading2_style: "<your_own_value>"
heading3_style: "<your_own_value>"
heading4_style: "<your_own_value>"
hline_style: "<your_own_value>"
image_style: "<your_own_value>"
name: "default_name_14"
normal_text_style: "<your_own_value>"
numbered_list_style: "<your_own_value>"
page_footer_style: "<your_own_value>"
page_header_style: "<your_own_value>"
page_orient: "portrait"
page_style: "<your_own_value>"
report_subtitle_style: "<your_own_value>"
report_title_style: "<your_own_value>"
table_chart_caption_style: "<your_own_value>"
table_chart_even_row_style: "<your_own_value>"
table_chart_head_style: "<your_own_value>"
table_chart_odd_row_style: "<your_own_value>"
table_chart_style: "<your_own_value>"
toc_heading1_style: "<your_own_value>"
toc_heading2_style: "<your_own_value>"
toc_heading3_style: "<your_own_value>"
toc_heading4_style: "<your_own_value>"
toc_title_style: "<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_certificate_remote – Remote certificate as a PEM file in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_certificate\_remote – Remote certificate 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_remote`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 remote category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_remote** dictionary | | Remote certificate as a PEM file. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either the global or VDOM IP address range for the remote certificate. |
| | **remote** string | | Remote certificate. |
| | **source** string | **Choices:*** factory
* user
* bundle
| Remote certificate source type. |
| **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: Remote certificate as a PEM file.
fortios_certificate_remote:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_remote:
name: "default_name_3"
range: "global"
remote: "<your_own_value>"
source: "factory"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_auto_install – Configure USB auto installation in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_auto\_install – Configure USB auto installation in Fortinet’s FortiOS and FortiGate.
======================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_install`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_install category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_auto\_install** dictionary | | Configure USB auto installation. |
| | **auto\_install\_config** string | **Choices:*** enable
* disable
| Enable/disable auto install the config in USB disk. |
| | **auto\_install\_image** string | **Choices:*** enable
* disable
| Enable/disable auto install the image in USB disk. |
| | **default\_config\_file** string | | Default config file name in USB disk. |
| | **default\_image\_file** string | | Default image file name in USB disk. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 USB auto installation.
fortios_system_auto_install:
vdom: "{{ vdom }}"
system_auto_install:
auto_install_config: "enable"
auto_install_image: "enable"
default_config_file: "<your_own_value>"
default_image_file: "<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_heuristic – Configure global heuristic options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_antivirus\_heuristic – Configure global heuristic 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_heuristic`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 heuristic category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_heuristic** dictionary | | Configure global heuristic options. |
| | **mode** string | **Choices:*** pass
* block
* disable
| Enable/disable heuristics and determine how the system behaves if heuristics detects a problem. |
| **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 global heuristic options.
fortios_antivirus_heuristic:
vdom: "{{ vdom }}"
antivirus_heuristic:
mode: "pass"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_utm_profile – Configure UTM (Unified Threat Management) profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_utm\_profile – Configure UTM (Unified Threat Management) 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_utm_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 utm\_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\_utm\_profile** dictionary | | Configure UTM (Unified Threat Management) profile. |
| | **antivirus\_profile** string | | AntiVirus profile name. Source antivirus.profile.name. |
| | **application\_list** string | | Application control list name. Source application.list.name. |
| | **comment** string | | Comment. |
| | **ips\_sensor** string | | IPS sensor name. Source ips.sensor.name. |
| | **name** string / required | | UTM profile name. |
| | **scan\_botnet\_connections** string | **Choices:*** disable
* monitor
* block
| Block or monitor connections to Botnet servers or disable Botnet scanning. |
| | **utm\_log** string | **Choices:*** enable
* disable
| Enable/disable UTM logging. |
| | **webfilter\_profile** string | | WebFilter profile name. Source webfilter.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 UTM (Unified Threat Management) profile.
fortios_wireless_controller_utm_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_utm_profile:
antivirus_profile: "<your_own_value> (source antivirus.profile.name)"
application_list: "<your_own_value> (source application.list.name)"
comment: "Comment."
ips_sensor: "<your_own_value> (source ips.sensor.name)"
name: "default_name_7"
scan_botnet_connections: "disable"
utm_log: "enable"
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_firewall_multicast_policy6 – Configure IPv6 multicast NAT policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_multicast\_policy6 – Configure IPv6 multicast NAT 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_multicast_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 multicast\_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\_multicast\_policy6** dictionary | | Configure IPv6 multicast NAT policies. |
| | **action** string | **Choices:*** accept
* deny
| Accept or deny traffic matching the policy. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading policy traffic for hardware acceleration. |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | IPv6 destination address name. |
| | | **name** string / required | | Address name. Source firewall.multicast-address6.name. |
| | **dstintf** string | | IPv6 destination interface name. Source system.interface.name system.zone.name. |
| | **end\_port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535). |
| | **id** integer / required | | Policy ID. |
| | **logtraffic** string | **Choices:*** enable
* disable
| Enable/disable logging traffic accepted by this policy. |
| | **name** string | | Policy name. |
| | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **srcaddr** list / elements=string | | IPv6 source address name. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **srcintf** string | | IPv6 source interface name. Source system.interface.name system.zone.name. |
| | **start\_port** integer | | Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this policy. |
| | **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 multicast NAT policies.
fortios_firewall_multicast_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_multicast_policy6:
action: "accept"
auto_asic_offload: "enable"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_7 (source firewall.multicast-address6.name)"
dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
end_port: "9"
id: "10"
logtraffic: "enable"
name: "default_name_12"
protocol: "13"
srcaddr:
-
name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
start_port: "17"
status: "enable"
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_speed_test_server – Configure speed test server list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_speed\_test\_server – Configure speed test server 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_system_speed_test_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 speed\_test\_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\_speed\_test\_server** dictionary | | Configure speed test server list. |
| | **host** list / elements=string | | Hosts of the server. |
| | | **id** integer / required | | Server host ID. |
| | | **ip** string | | Server host IPv4 address. |
| | | **password** string | | Speed test host password. |
| | | **port** integer | | Server host port number to communicate with client. |
| | | **user** string | | Speed test host user name. |
| | **name** string / required | | Speed test server name. |
| | **timestamp** integer | | Speed test server timestamp. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 speed test server list.
fortios_system_speed_test_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_speed_test_server:
host:
-
id: "4"
ip: "<your_own_value>"
password: "<your_own_value>"
port: "7"
user: "<your_own_value>"
name: "default_name_9"
timestamp: "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_firewall_proute – List policy routing in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_proute – List policy routing in Fortinet’s FortiOS and FortiGate.
=====================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_proute`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 proute category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_proute** dictionary | | List policy routing. |
| | string | | 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: List policy routing.
fortios_firewall_proute:
vdom: "{{ vdom }}"
firewall_proute:
<policy route 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_syslogd_override_setting – Override settings for remote syslog server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd\_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_syslogd_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\_syslogd 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\_syslogd\_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_syslogd_override_setting:
vdom: "{{ vdom }}"
log_syslogd_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_firewall_local_in_policy – Configure user defined IPv4 local-in policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_local\_in\_policy – Configure user defined IPv4 local-in 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_local_in_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 local\_in\_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\_local\_in\_policy** dictionary | | Configure user defined IPv4 local-in policies. |
| | **action** string | **Choices:*** accept
* deny
| Action performed on traffic matching the policy . |
| | **comments** string | | Comment. |
| | **dstaddr** list / elements=string | | Destination address object from available options. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **ha\_mgmt\_intf\_only** string | **Choices:*** enable
* disable
| Enable/disable dedicating the HA management interface only for local-in policy. |
| | **intf** string | | Incoming interface name from available options. Source system.zone.name system.interface.name. |
| | **policyid** integer / required | | User defined local in policy 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 from available options. |
| | | **name** string / required | | Service 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. |
| | **srcaddr** list / elements=string | | Source address object from available options. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **srcaddr\_negate** string | **Choices:*** enable
* disable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this local-in policy. |
| | **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 user defined IPv4 local-in policies.
fortios_firewall_local_in_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_local_in_policy:
action: "accept"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_6 (source firewall.address.name firewall.addrgrp.name)"
dstaddr_negate: "enable"
ha_mgmt_intf_only: "enable"
intf: "<your_own_value> (source system.zone.name system.interface.name)"
policyid: "10"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_13 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
srcaddr:
-
name: "default_name_16 (source firewall.address.name firewall.addrgrp.name)"
srcaddr_negate: "enable"
status: "enable"
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_switch_controller_custom_command – Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_custom\_command – Configure the FortiGate switch controller to send custom commands to managed FortiSwitch 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_switch_controller_custom_command`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 custom\_command category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_custom\_command** dictionary | | Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices. |
| | **command** string | | String of commands to send to FortiSwitch devices (For example (%0a = return key): config switch trunk %0a edit myTrunk %0a set members port1 port2 %0a end %0a). |
| | **command\_name** string | | Command name called by the FortiGate switch controller in the execute command. |
| | **description** string | | Description. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 FortiGate switch controller to send custom commands to managed FortiSwitch devices.
fortios_switch_controller_custom_command:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_custom_command:
command: "<your_own_value>"
command_name: "<your_own_value>"
description: "<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_sysinfo – Configure FortiSwitch SNMP system information globally in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_snmp\_sysinfo – Configure FortiSwitch SNMP system information 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_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 switch\_controller feature and snmp\_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. |
| **switch\_controller\_snmp\_sysinfo** dictionary | | Configure FortiSwitch SNMP system information globally. |
| | **contact\_info** string | | Contact information. |
| | **description** string | | System description. |
| | **engine\_id** string | | Local SNMP engine ID string (max 24 char). |
| | **location** string | | System location. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SNMP. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 system information globally.
fortios_switch_controller_snmp_sysinfo:
vdom: "{{ vdom }}"
switch_controller_snmp_sysinfo:
contact_info: "<your_own_value>"
description: "<your_own_value>"
engine_id: "<your_own_value>"
location: "<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)
ansible fortinet.fortios.fortios_system_tos_based_priority – Configure Type of Service (ToS) based priority table to set network traffic priorities in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_tos\_based\_priority – Configure Type of Service (ToS) based priority table to set network traffic priorities in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_tos_based_priority`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 tos\_based\_priority category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_tos\_based\_priority** dictionary | | Configure Type of Service (ToS) based priority table to set network traffic priorities. |
| | **id** integer / required | | Item ID. |
| | **priority** string | **Choices:*** low
* medium
* high
| ToS based priority level to low, medium or high (these priorities match firewall traffic shaping priorities) . |
| | **tos** integer | | Value of the ToS byte in the IP datagram header (0-15, 8: minimize delay, 4: maximize throughput, 2: maximize reliability, 1: minimize monetary cost, and 0: ). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 Type of Service (ToS) based priority table to set network traffic priorities.
fortios_system_tos_based_priority:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_tos_based_priority:
id: "3"
priority: "low"
tos: "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_wireless_controller_wag_profile – Configure wireless access gateway (WAG) profiles used for tunnels on AP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_wag\_profile – Configure wireless access gateway (WAG) profiles used for tunnels on AP in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_wag_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 wag\_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\_wag\_profile** dictionary | | Configure wireless access gateway (WAG) profiles used for tunnels on AP. |
| | **comment** string | | Comment. |
| | **dhcp\_ip\_addr** string | | IP address of the monitoring DHCP request packet sent through the tunnel. |
| | **name** string / required | | Tunnel profile name. |
| | **ping\_interval** integer | | Interval between two tunnel monitoring echo packets (1 - 65535 sec). |
| | **ping\_number** integer | | Number of the tunnel monitoring echo packets (1 - 65535). |
| | **return\_packet\_timeout** integer | | Window of time for the return packets from the tunnel"s remote end (1 - 65535 sec). |
| | **tunnel\_type** string | **Choices:*** l2tpv3
* gre
| Tunnel type. |
| | **wag\_ip** string | | IP Address of the wireless access gateway. |
| | **wag\_port** integer | | UDP port of the wireless access gateway. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 access gateway (WAG) profiles used for tunnels on AP.
fortios_wireless_controller_wag_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wag_profile:
comment: "Comment."
dhcp_ip_addr: "<your_own_value>"
name: "default_name_5"
ping_interval: "6"
ping_number: "7"
return_packet_timeout: "8"
tunnel_type: "l2tpv3"
wag_ip: "<your_own_value>"
wag_port: "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)
| programming_docs |
ansible fortinet.fortios.fortios_emailfilter_profile – Configure Email Filter profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_profile – Configure Email 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_emailfilter_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 emailfilter 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. |
| **emailfilter\_profile** dictionary | | Configure Email Filter profiles. |
| | **comment** string | | Comment. |
| | **external** string | **Choices:*** enable
* disable
| Enable/disable external Email inspection. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow/proxy feature set. |
| | **file\_filter** dictionary | | File filter. |
| | | **entries** list / elements=string | | File filter entries. |
| | | | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | | | **comment** string | | Comment. |
| | | | **file\_type** list / elements=string | | Select file type. |
| | | | | **name** string / required | | File type name. Source antivirus.filetype.name. |
| | | | **filter** string / required | | Add a file filter. |
| | | | **password\_protected** string | **Choices:*** True
* any
| Match password-protected files. |
| | | | **protocol** string | **Choices:*** smtp
* imap
* pop3
| Protocols to apply with. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable file filter logging. |
| | | **scan\_archive\_contents** string | **Choices:*** enable
* disable
| Enable/disable file filter archive contents scan. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable file filter. |
| | **gmail** dictionary | | Gmail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | **imap** dictionary | | IMAP. |
| | | **action** string | **Choices:*** pass
* tag
| Action for spam email. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | | **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. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | **msn\_hotmail** dictionary | | MSN Hotmail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | **name** string / required | | Profile name. |
| | **options** list / elements=string | **Choices:*** bannedword
* spambwl
* spamfsip
* spamfssubmit
* spamfschksum
* spamfsurl
* spamhelodns
* spamraddrdns
* spamrbl
* spamhdrcheck
* spamfsphish
* spambal
| Options. |
| | **other\_webmails** dictionary | | Other supported webmails. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | **pop3** dictionary | | POP3. |
| | | **action** string | **Choices:*** pass
* tag
| Action for spam email. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | | **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. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| | | **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\_bal\_table** integer | | Anti-spam block/allow list table ID. Source emailfilter.block-allow-list.id. |
| | **spam\_bwl\_table** integer | | Anti-spam black/white list table ID. Source emailfilter.bwl.id. |
| | **spam\_bword\_table** integer | | Anti-spam banned word table ID. Source emailfilter.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 emailfilter.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 emailfilter.mheader.id. |
| | **spam\_rbl\_table** integer | | Anti-spam DNSBL table ID. Source emailfilter.dnsbl.id. |
| | **yahoo\_mail** dictionary | | Yahoo! Mail. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | **log\_all** string | **Choices:*** disable
* enable
| Enable/disable logging of all email traffic. |
| **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 Email Filter profiles.
fortios_emailfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_profile:
comment: "Comment."
external: "enable"
feature_set: "flow"
file_filter:
entries:
-
action: "log"
comment: "Comment."
file_type:
-
name: "default_name_11 (source antivirus.filetype.name)"
filter: "<your_own_value>"
password_protected: "yes"
protocol: "smtp"
log: "enable"
scan_archive_contents: "enable"
status: "enable"
gmail:
log: "enable"
log_all: "disable"
imap:
action: "pass"
log: "enable"
log_all: "disable"
tag_msg: "<your_own_value>"
tag_type: "subject"
mapi:
action: "pass"
log: "enable"
log_all: "disable"
msn_hotmail:
log: "enable"
log_all: "disable"
name: "default_name_34"
options: "bannedword"
other_webmails:
log_all: "disable"
pop3:
action: "pass"
log: "enable"
log_all: "disable"
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"
log_all: "disable"
tag_msg: "<your_own_value>"
tag_type: "subject"
spam_bal_table: "53 (source emailfilter.block-allow-list.id)"
spam_bwl_table: "54 (source emailfilter.bwl.id)"
spam_bword_table: "55 (source emailfilter.bword.id)"
spam_bword_threshold: "56"
spam_filtering: "enable"
spam_iptrust_table: "58 (source emailfilter.iptrust.id)"
spam_log: "disable"
spam_log_fortiguard_response: "disable"
spam_mheader_table: "61 (source emailfilter.mheader.id)"
spam_rbl_table: "62 (source emailfilter.dnsbl.id)"
yahoo_mail:
log: "enable"
log_all: "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_user_adgrp – Configure FSSO groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_adgrp – Configure FSSO 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_adgrp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 adgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_adgrp** dictionary | | Configure FSSO groups. |
| | **connector\_source** string | | FSSO connector source. |
| | **id** integer | | Group ID. |
| | **name** string / required | | Name. |
| | **server\_name** string | | FSSO agent name. Source user.fsso.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 FSSO groups.
fortios_user_adgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_adgrp:
connector_source: "<your_own_value>"
id: "4"
name: "default_name_5"
server_name: "<your_own_value> (source user.fsso.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_ipsec_phase1 – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_phase1 – Configure VPN remote gateway in Fortinet’s FortiOS and FortiGate.
================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_phase1`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 phase1 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_phase1** dictionary | | Configure VPN remote gateway. |
| | **acct\_verify** string | **Choices:*** enable
* disable
| Enable/disable verification of RADIUS accounting record. |
| | **add\_gw\_route** string | **Choices:*** enable
* disable
| Enable/disable automatically add a route to the remote gateway. |
| | **add\_route** string | **Choices:*** disable
* enable
| Enable/disable control addition of a route to peer destination selector. |
| | **assign\_ip** string | **Choices:*** disable
* enable
| Enable/disable assignment of IP to IPsec interface via configuration method. |
| | **assign\_ip\_from** string | **Choices:*** range
* usrgrp
* dhcp
* name
| Method by which the IP address will be assigned. |
| | **authmethod** string | **Choices:*** psk
* signature
| Authentication method. |
| | **authmethod\_remote** string | **Choices:*** psk
* signature
| Authentication method (remote side). |
| | **authpasswd** string | | XAuth password (max 35 characters). |
| | **authusr** string | | XAuth user name. |
| | **authusrgrp** string | | Authentication user group. Source user.group.name. |
| | **auto\_negotiate** string | **Choices:*** enable
* disable
| Enable/disable automatic initiation of IKE SA negotiation. |
| | **backup\_gateway** list / elements=string | | Instruct unity clients about the backup gateway address(es). |
| | | **address** string / required | | Address of backup gateway. |
| | **banner** string | | Message that unity client should display after connecting. |
| | **cert\_id\_validation** string | **Choices:*** enable
* disable
| Enable/disable cross validation of peer ID and the identity in the peer"s certificate as specified in RFC 4945. |
| | **certificate** list / elements=string | | Names of up to 4 signed personal certificates. |
| | | **name** string / required | | Certificate name. Source vpn.certificate.local.name. |
| | **childless\_ike** string | **Choices:*** enable
* disable
| Enable/disable childless IKEv2 initiation (RFC 6023). |
| | **client\_auto\_negotiate** string | **Choices:*** disable
* enable
| Enable/disable allowing the VPN client to bring up the tunnel when there is no traffic. |
| | **client\_keep\_alive** string | **Choices:*** disable
* enable
| Enable/disable allowing the VPN client to keep the tunnel up when there is no traffic. |
| | **comments** string | | Comment. |
| | **dhcp6\_ra\_linkaddr** string | | Relay agent IPv6 link address to use in DHCP6 requests. |
| | **dhcp\_ra\_giaddr** string | | Relay agent gateway IP address to use in the giaddr field of DHCP requests. |
| | **dhgrp** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
* 32
| DH group. |
| | **digital\_signature\_auth** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 Digital Signature Authentication (RFC 7427). |
| | **distance** integer | | Distance for routes added by IKE (1 - 255). |
| | **dns\_mode** string | **Choices:*** manual
* auto
| DNS server mode. |
| | **domain** string | | Instruct unity clients about the default DNS domain. |
| | **dpd** string | **Choices:*** disable
* on-idle
* on-demand
| Dead Peer Detection mode. |
| | **dpd\_retrycount** integer | | Number of DPD retry attempts. |
| | **dpd\_retryinterval** string | | DPD retry interval. |
| | **eap** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 EAP authentication. |
| | **eap\_exclude\_peergrp** string | | Peer group excluded from EAP authentication. Source user.peergrp.name. |
| | **eap\_identity** string | **Choices:*** use-id-payload
* send-request
| IKEv2 EAP peer identity type. |
| | **enforce\_unique\_id** string | **Choices:*** disable
* keep-new
* keep-old
| Enable/disable peer ID uniqueness check. |
| | **esn** string | **Choices:*** require
* allow
* disable
| Extended sequence number (ESN) negotiation. |
| | **fec\_base** integer | | Number of base Forward Error Correction packets (1 - 100). |
| | **fec\_codec** integer | | ipsec fec encoding/decoding algorithm (0: reed-solomon, 1: xor). |
| | **fec\_egress** string | **Choices:*** enable
* disable
| Enable/disable Forward Error Correction for egress IPsec traffic. |
| | **fec\_ingress** string | **Choices:*** enable
* disable
| Enable/disable Forward Error Correction for ingress IPsec traffic. |
| | **fec\_receive\_timeout** integer | | Timeout in milliseconds before dropping Forward Error Correction packets (1 - 10000). |
| | **fec\_redundant** integer | | Number of redundant Forward Error Correction packets (1 - 100). |
| | **fec\_send\_timeout** integer | | Timeout in milliseconds before sending Forward Error Correction packets (1 - 1000). |
| | **forticlient\_enforcement** string | **Choices:*** enable
* disable
| Enable/disable FortiClient enforcement. |
| | **fragmentation** string | **Choices:*** enable
* disable
| Enable/disable fragment IKE message on re-transmission. |
| | **fragmentation\_mtu** integer | | IKE fragmentation MTU (500 - 16000). |
| | **group\_authentication** string | **Choices:*** enable
* disable
| Enable/disable IKEv2 IDi group authentication. |
| | **group\_authentication\_secret** string | | Password for IKEv2 IDi group authentication. (ASCII string or hexadecimal indicated by a leading 0x.) |
| | **ha\_sync\_esp\_seqno** string | **Choices:*** enable
* disable
| Enable/disable sequence number jump ahead for IPsec HA. |
| | **idle\_timeout** string | **Choices:*** enable
* disable
| Enable/disable IPsec tunnel idle timeout. |
| | **idle\_timeoutinterval** integer | | IPsec tunnel idle timeout in minutes (5 - 43200). |
| | **ike\_version** string | **Choices:*** 1
* 2
| IKE protocol version. |
| | **include\_local\_lan** string | **Choices:*** disable
* enable
| Enable/disable allow local LAN access on unity clients. |
| | **interface** string | | Local physical, aggregate, or VLAN outgoing interface. Source system.interface.name. |
| | **ipv4\_dns\_server1** string | | IPv4 DNS server 1. |
| | **ipv4\_dns\_server2** string | | IPv4 DNS server 2. |
| | **ipv4\_dns\_server3** string | | IPv4 DNS server 3. |
| | **ipv4\_end\_ip** string | | End of IPv4 range. |
| | **ipv4\_exclude\_range** list / elements=string | | Configuration Method IPv4 exclude ranges. |
| | | **end\_ip** string | | End of IPv4 exclusive range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IPv4 exclusive range. |
| | **ipv4\_name** string | | IPv4 address name. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_netmask** string | | IPv4 Netmask. |
| | **ipv4\_split\_exclude** string | | IPv4 subnets that should not be sent over the IPsec tunnel. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_split\_include** string | | IPv4 split-include subnets. Source firewall.address.name firewall.addrgrp.name. |
| | **ipv4\_start\_ip** string | | Start of IPv4 range. |
| | **ipv4\_wins\_server1** string | | WINS server 1. |
| | **ipv4\_wins\_server2** string | | WINS server 2. |
| | **ipv6\_dns\_server1** string | | IPv6 DNS server 1. |
| | **ipv6\_dns\_server2** string | | IPv6 DNS server 2. |
| | **ipv6\_dns\_server3** string | | IPv6 DNS server 3. |
| | **ipv6\_end\_ip** string | | End of IPv6 range. |
| | **ipv6\_exclude\_range** list / elements=string | | Configuration method IPv6 exclude ranges. |
| | | **end\_ip** string | | End of IPv6 exclusive range. |
| | | **id** integer / required | | ID. |
| | | **start\_ip** string | | Start of IPv6 exclusive range. |
| | **ipv6\_name** string | | IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_prefix** integer | | IPv6 prefix. |
| | **ipv6\_split\_exclude** string | | IPv6 subnets that should not be sent over the IPsec tunnel. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_split\_include** string | | IPv6 split-include subnets. Source firewall.address6.name firewall.addrgrp6.name. |
| | **ipv6\_start\_ip** string | | Start of IPv6 range. |
| | **keepalive** integer | | NAT-T keep alive interval. |
| | **keylife** integer | | Time to wait in seconds before phase 1 encryption key expires. |
| | **local\_gw** string | | Local VPN gateway. |
| | **localid** string | | Local ID. |
| | **localid\_type** string | **Choices:*** auto
* fqdn
* user-fqdn
* keyid
* address
* asn1dn
| Local ID type. |
| | **loopback\_asymroute** string | **Choices:*** enable
* disable
| Enable/disable asymmetric routing for IKE traffic on loopback interface. |
| | **mesh\_selector\_type** string | **Choices:*** disable
* subnet
* host
| Add selectors containing subsets of the configuration depending on traffic. |
| | **mode** string | **Choices:*** aggressive
* main
| ID protection mode used to establish a secure channel. |
| | **mode\_cfg** string | **Choices:*** disable
* enable
| Enable/disable configuration method. |
| | **name** string / required | | IPsec remote gateway name. |
| | **nattraversal** string | **Choices:*** enable
* disable
* forced
| Enable/disable NAT traversal. |
| | **negotiate\_timeout** integer | | IKE SA negotiation timeout in seconds (1 - 300). |
| | **network\_id** integer | | VPN gateway network ID. |
| | **network\_overlay** string | **Choices:*** disable
* enable
| Enable/disable network overlays. |
| | **npu\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading NPU. |
| | **peer** string | | Accept this peer certificate. Source user.peer.name. |
| | **peergrp** string | | Accept this peer certificate group. Source user.peergrp.name. |
| | **peerid** string | | Accept this peer identity. |
| | **peertype** string | **Choices:*** any
* one
* dialup
* peer
* peergrp
| Accept this peer type. |
| | **ppk** string | **Choices:*** disable
* allow
* require
| Enable/disable IKEv2 Postquantum Preshared Key (PPK). |
| | **ppk\_identity** string | | IKEv2 Postquantum Preshared Key Identity. |
| | **ppk\_secret** string | | IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). |
| | **priority** integer | | Priority for routes added by IKE (0 - 4294967295). |
| | **proposal** list / elements=string | **Choices:*** des-md5
* des-sha1
* des-sha256
* des-sha384
* des-sha512
* 3des-md5
* 3des-sha1
* 3des-sha256
* 3des-sha384
* 3des-sha512
* aes128-md5
* aes128-sha1
* aes128-sha256
* aes128-sha384
* aes128-sha512
* aes128gcm-prfsha1
* aes128gcm-prfsha256
* aes128gcm-prfsha384
* aes128gcm-prfsha512
* aes192-md5
* aes192-sha1
* aes192-sha256
* aes192-sha384
* aes192-sha512
* aes256-md5
* aes256-sha1
* aes256-sha256
* aes256-sha384
* aes256-sha512
* aes256gcm-prfsha1
* aes256gcm-prfsha256
* aes256gcm-prfsha384
* aes256gcm-prfsha512
* chacha20poly1305-prfsha1
* chacha20poly1305-prfsha256
* chacha20poly1305-prfsha384
* chacha20poly1305-prfsha512
* aria128-md5
* aria128-sha1
* aria128-sha256
* aria128-sha384
* aria128-sha512
* aria192-md5
* aria192-sha1
* aria192-sha256
* aria192-sha384
* aria192-sha512
* aria256-md5
* aria256-sha1
* aria256-sha256
* aria256-sha384
* aria256-sha512
* seed-md5
* seed-sha1
* seed-sha256
* seed-sha384
* seed-sha512
| Phase1 proposal. |
| | **psksecret** string | | Pre-shared secret for PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
| | **psksecret\_remote** string | | Pre-shared secret for remote side PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
| | **reauth** string | **Choices:*** disable
* enable
| Enable/disable re-authentication upon IKE SA lifetime expiration. |
| | **rekey** string | **Choices:*** enable
* disable
| Enable/disable phase1 rekey. |
| | **remote\_gw** string | | Remote VPN gateway. |
| | **remotegw\_ddns** string | | Domain name of remote gateway (eg. name.DDNS.com). |
| | **rsa\_signature\_format** string | **Choices:*** pkcs1
* pss
| Digital Signature Authentication RSA signature format. |
| | **save\_password** string | **Choices:*** disable
* enable
| Enable/disable saving XAuth username and password on VPN clients. |
| | **send\_cert\_chain** string | **Choices:*** enable
* disable
| Enable/disable sending certificate chain. |
| | **signature\_hash\_alg** list / elements=string | **Choices:*** sha1
* sha2-256
* sha2-384
* sha2-512
| Digital Signature Authentication hash algorithms. |
| | **split\_include\_service** string | | Split-include services. Source firewall.service.group.name firewall.service.custom.name. |
| | **suite\_b** string | **Choices:*** disable
* suite-b-gcm-128
* suite-b-gcm-256
| Use Suite-B. |
| | **type** string | **Choices:*** static
* dynamic
* ddns
| Remote gateway type. |
| | **unity\_support** string | **Choices:*** disable
* enable
| Enable/disable support for Cisco UNITY Configuration Method extensions. |
| | **usrgrp** string | | User group name for dialup peers. Source user.group.name. |
| | **wizard\_type** string | **Choices:*** custom
* dialup-forticlient
* dialup-ios
* dialup-android
* dialup-windows
* dialup-cisco
* static-fortigate
* dialup-fortigate
* static-cisco
* dialup-cisco-fw
* simplified-static-fortigate
* hub-fortigate-auto-discovery
* spoke-fortigate-auto-discovery
| GUI VPN Wizard Type. |
| | **xauthtype** string | **Choices:*** disable
* client
* pap
* chap
* auto
| XAuth type. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 remote gateway.
fortios_vpn_ipsec_phase1:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_phase1:
acct_verify: "enable"
add_gw_route: "enable"
add_route: "disable"
assign_ip: "disable"
assign_ip_from: "range"
authmethod: "psk"
authmethod_remote: "psk"
authpasswd: "<your_own_value>"
authusr: "<your_own_value>"
authusrgrp: "<your_own_value> (source user.group.name)"
auto_negotiate: "enable"
backup_gateway:
-
address: "<your_own_value>"
banner: "<your_own_value>"
cert_id_validation: "enable"
certificate:
-
name: "default_name_19 (source vpn.certificate.local.name)"
childless_ike: "enable"
client_auto_negotiate: "disable"
client_keep_alive: "disable"
comments: "<your_own_value>"
dhcp_ra_giaddr: "<your_own_value>"
dhcp6_ra_linkaddr: "<your_own_value>"
dhgrp: "1"
digital_signature_auth: "enable"
distance: "28"
dns_mode: "manual"
domain: "<your_own_value>"
dpd: "disable"
dpd_retrycount: "32"
dpd_retryinterval: "<your_own_value>"
eap: "enable"
eap_exclude_peergrp: "<your_own_value> (source user.peergrp.name)"
eap_identity: "use-id-payload"
enforce_unique_id: "disable"
esn: "require"
fec_base: "39"
fec_codec: "40"
fec_egress: "enable"
fec_ingress: "enable"
fec_receive_timeout: "43"
fec_redundant: "44"
fec_send_timeout: "45"
forticlient_enforcement: "enable"
fragmentation: "enable"
fragmentation_mtu: "48"
group_authentication: "enable"
group_authentication_secret: "<your_own_value>"
ha_sync_esp_seqno: "enable"
idle_timeout: "enable"
idle_timeoutinterval: "53"
ike_version: "1"
include_local_lan: "disable"
interface: "<your_own_value> (source system.interface.name)"
ipv4_dns_server1: "<your_own_value>"
ipv4_dns_server2: "<your_own_value>"
ipv4_dns_server3: "<your_own_value>"
ipv4_end_ip: "<your_own_value>"
ipv4_exclude_range:
-
end_ip: "<your_own_value>"
id: "63"
start_ip: "<your_own_value>"
ipv4_name: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_netmask: "<your_own_value>"
ipv4_split_exclude: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_split_include: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv4_start_ip: "<your_own_value>"
ipv4_wins_server1: "<your_own_value>"
ipv4_wins_server2: "<your_own_value>"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
ipv6_dns_server3: "<your_own_value>"
ipv6_end_ip: "<your_own_value>"
ipv6_exclude_range:
-
end_ip: "<your_own_value>"
id: "78"
start_ip: "<your_own_value>"
ipv6_name: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_prefix: "81"
ipv6_split_exclude: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_split_include: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_start_ip: "<your_own_value>"
keepalive: "85"
keylife: "86"
local_gw: "<your_own_value>"
localid: "<your_own_value>"
localid_type: "auto"
loopback_asymroute: "enable"
mesh_selector_type: "disable"
mode: "aggressive"
mode_cfg: "disable"
name: "default_name_94"
nattraversal: "enable"
negotiate_timeout: "96"
network_id: "97"
network_overlay: "disable"
npu_offload: "enable"
peer: "<your_own_value> (source user.peer.name)"
peergrp: "<your_own_value> (source user.peergrp.name)"
peerid: "<your_own_value>"
peertype: "any"
ppk: "disable"
ppk_identity: "<your_own_value>"
ppk_secret: "<your_own_value>"
priority: "107"
proposal: "des-md5"
psksecret: "<your_own_value>"
psksecret_remote: "<your_own_value>"
reauth: "disable"
rekey: "enable"
remote_gw: "<your_own_value>"
remotegw_ddns: "<your_own_value>"
rsa_signature_format: "pkcs1"
save_password: "disable"
send_cert_chain: "enable"
signature_hash_alg: "sha1"
split_include_service: "<your_own_value> (source firewall.service.group.name firewall.service.custom.name)"
suite_b: "disable"
type: "static"
unity_support: "disable"
usrgrp: "<your_own_value> (source user.group.name)"
wizard_type: "custom"
xauthtype: "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_wireless_controller_hotspot20_anqp_ip_address_type – Configure IP address type availability in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_ip\_address\_type – Configure IP address type availability in Fortinet’s FortiOS and FortiGate.
================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ip_address_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\_ip\_address\_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\_ip\_address\_type** dictionary | | Configure IP address type availability. |
| | **ipv4\_address\_type** string | **Choices:*** not-available
* public
* port-restricted
* single-NATed-private
* double-NATed-private
* port-restricted-and-single-NATed
* port-restricted-and-double-NATed
* not-known
| IPv4 address type. |
| | **ipv6\_address\_type** string | **Choices:*** not-available
* available
* not-known
| IPv6 address type. |
| | **name** string / required | | IP type 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 IP address type availability.
fortios_wireless_controller_hotspot20_anqp_ip_address_type:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_ip_address_type:
ipv4_address_type: "not-available"
ipv6_address_type: "not-available"
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_system_dns_database – Configure DNS databases in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_dns\_database – Configure DNS databases in Fortinet’s FortiOS and FortiGate.
==============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dns_database`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dns\_database category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dns\_database** dictionary | | Configure DNS databases. |
| | **allow\_transfer** string | | DNS zone transfer IP address list. |
| | **authoritative** string | **Choices:*** enable
* disable
| Enable/disable authoritative zone. |
| | **contact** string | | Email address of the administrator for this zone. You can specify only the username (e.g. admin) or full email address (e.g. admin@test .com) When using a simple username, the domain of the email will be this zone. |
| | **dns\_entry** list / elements=string | | DNS entry. |
| | | **canonical\_name** string | | Canonical name of the host. |
| | | **hostname** string | | Name of the host. |
| | | **id** integer / required | | DNS entry ID. |
| | | **ip** string | | IPv4 address of the host. |
| | | **ipv6** string | | IPv6 address of the host. |
| | | **preference** integer | | DNS entry preference, 0 is the highest preference (0 - 65535) |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable resource record status. |
| | | **ttl** integer | | Time-to-live for this entry (0 to 2147483647 sec). |
| | | **type** string | **Choices:*** A
* NS
* CNAME
* MX
* AAAA
* PTR
* PTR\_V6
| Resource record type. |
| | **domain** string | | Domain name. |
| | **forwarder** string | | DNS zone forwarder IP address list. |
| | **ip\_master** string | | IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone. |
| | **ip\_primary** string | | IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone. |
| | **name** string / required | | Zone name. |
| | **primary\_name** string | | Domain name of the default DNS server for this zone. |
| | **rr\_max** integer | | Maximum number of resource records (10 - 65536, 0 means infinite). |
| | **source\_ip** string | | Source IP for forwarding to DNS server. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this DNS zone. |
| | **ttl** integer | | Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec). |
| | **type** string | **Choices:*** master
* slave
* primary
* secondary
| Zone type (master to manage entries directly, slave to import entries from other zones). |
| | **view** string | **Choices:*** shadow
* public
| Zone view (public to serve public clients, shadow to serve internal clients). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 DNS databases.
fortios_system_dns_database:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_dns_database:
allow_transfer: "<your_own_value>"
authoritative: "enable"
contact: "<your_own_value>"
dns_entry:
-
canonical_name: "<your_own_value>"
hostname: "myhostname"
id: "9"
ip: "<your_own_value>"
ipv6: "<your_own_value>"
preference: "12"
status: "enable"
ttl: "14"
type: "A"
domain: "<your_own_value>"
forwarder: "<your_own_value>"
ip_master: "<your_own_value>"
ip_primary: "<your_own_value>"
name: "default_name_20"
primary_name: "<your_own_value>"
rr_max: "22"
source_ip: "84.230.14.43"
status: "enable"
ttl: "25"
type: "master"
view: "shadow"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_override_setting – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_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_fortianalyzer_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 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\_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
| 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). |
| | **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_fortianalyzer_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_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_system_autoupdate_tunneling – Configure web proxy tunnelling for the FDN in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_autoupdate\_tunneling – Configure web proxy tunnelling for the FDN in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_autoupdate_tunneling`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_autoupdate feature and tunneling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_autoupdate\_tunneling** dictionary | | Configure web proxy tunnelling for the FDN. |
| | **address** string | | Web proxy IP address or FQDN. |
| | **password** string | | Web proxy password. |
| | **port** integer | | Web proxy port. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable web proxy tunnelling. |
| | **username** string | | Web proxy username. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 web proxy tunnelling for the FDN.
fortios_system_autoupdate_tunneling:
vdom: "{{ vdom }}"
system_autoupdate_tunneling:
address: "<your_own_value>"
password: "<your_own_value>"
port: "5"
status: "enable"
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_emailfilter_fortishield – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_fortishield – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fortishield`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fortishield category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_fortishield** dictionary | | Configure FortiGuard - AntiSpam. |
| | **spam\_submit\_force** string | **Choices:*** enable
* disable
| Enable/disable force insertion of a new mime entity for the submission text. |
| | **spam\_submit\_srv** string | | Hostname of the spam submission server. |
| | **spam\_submit\_txt2htm** string | **Choices:*** enable
* disable
| Enable/disable conversion of text email to HTML 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 FortiGuard - AntiSpam.
fortios_emailfilter_fortishield:
vdom: "{{ vdom }}"
emailfilter_fortishield:
spam_submit_force: "enable"
spam_submit_srv: "<your_own_value>"
spam_submit_txt2htm: "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_vpn_ike_gateway – List gateways in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ike\_gateway – List gateways in Fortinet’s FortiOS and FortiGate.
================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ike_gateway`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_ike feature and gateway category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ike\_gateway** dictionary | | List gateways. |
| | string | | Name of IKE gateway to list. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: List gateways.
fortios_vpn_ike_gateway:
vdom: "{{ vdom }}"
vpn_ike_gateway:
<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_user_fsso – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_fsso – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.
===========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fsso`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fsso category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fsso** dictionary | | Configure Fortinet Single Sign On (FSSO) agents. |
| | **group\_poll\_interval** integer | | Interval in minutes within to fetch groups from FSSO server, or unset to disable. |
| | **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. |
| | **ldap\_poll** string | **Choices:*** enable
* disable
| Enable/disable automatic fetching of groups from LDAP server. |
| | **ldap\_poll\_filter** string | | Filter used to fetch groups. |
| | **ldap\_poll\_interval** integer | | Interval in minutes within to fetch groups from LDAP server. |
| | **ldap\_server** string | | LDAP server to get group information. Source user.ldap.name. |
| | **name** string / required | | Name. |
| | **password** string | | Password of the first FSSO collector agent. |
| | **password2** string | | Password of the second FSSO collector agent. |
| | **password3** string | | Password of the third FSSO collector agent. |
| | **password4** string | | Password of the fourth FSSO collector agent. |
| | **password5** string | | Password of the fifth FSSO collector agent. |
| | **port** integer | | Port of the first FSSO collector agent. |
| | **port2** integer | | Port of the second FSSO collector agent. |
| | **port3** integer | | Port of the third FSSO collector agent. |
| | **port4** integer | | Port of the fourth FSSO collector agent. |
| | **port5** integer | | Port of the fifth FSSO collector agent. |
| | **server** string | | Domain name or IP address of the first FSSO collector agent. |
| | **server2** string | | Domain name or IP address of the second FSSO collector agent. |
| | **server3** string | | Domain name or IP address of the third FSSO collector agent. |
| | **server4** string | | Domain name or IP address of the fourth FSSO collector agent. |
| | **server5** string | | Domain name or IP address of the fifth FSSO collector agent. |
| | **source\_ip** string | | Source IP for communications to FSSO agent. |
| | **source\_ip6** string | | IPv6 source for communications to FSSO agent. |
| | **ssl** string | **Choices:*** enable
* disable
| Enable/disable use of SSL. |
| | **ssl\_trusted\_cert** string | | Trusted server certificate or CA certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name. |
| | **type** string | **Choices:*** default
* fortiems
* fortinac
* fortiems-cloud
| Server type. |
| | **user\_info\_server** string | | LDAP server to get user information. Source user.ldap.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 Fortinet Single Sign On (FSSO) agents.
fortios_user_fsso:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fsso:
group_poll_interval: "3"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ldap_poll: "enable"
ldap_poll_filter: "<your_own_value>"
ldap_poll_interval: "8"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_10"
password: "<your_own_value>"
password2: "<your_own_value>"
password3: "<your_own_value>"
password4: "<your_own_value>"
password5: "<your_own_value>"
port: "16"
port2: "17"
port3: "18"
port4: "19"
port5: "20"
server: "192.168.100.40"
server2: "<your_own_value>"
server3: "<your_own_value>"
server4: "<your_own_value>"
server5: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
ssl: "enable"
ssl_trusted_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
type: "default"
user_info_server: "<your_own_value> (source user.ldap.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_gtp_message_filter_v2 – Message filter for GTPv2 messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_gtp\_message\_filter\_v2 – Message filter for GTPv2 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_gtp_message_filter_v2`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 message\_filter\_v2 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_message\_filter\_v2** dictionary | | Message filter for GTPv2 messages. |
| | **bearer\_resource\_cmd\_fail** string | **Choices:*** allow
* deny
| Bearer resource (command 68, failure indication 69). |
| | **change\_notification** string | **Choices:*** allow
* deny
| Change notification (req 38, resp 39). |
| | **create\_bearer** string | **Choices:*** allow
* deny
| Create bearer (req 95, resp 96). |
| | **create\_session** string | **Choices:*** allow
* deny
| Create session (req 32, resp 33). |
| | **delete\_bearer\_cmd\_fail** string | **Choices:*** allow
* deny
| Delete bearer (command 66, failure indication 67). |
| | **delete\_bearer\_req\_resp** string | **Choices:*** allow
* deny
| Delete bearer (req 99, resp 100). |
| | **delete\_pdn\_connection\_set** string | **Choices:*** allow
* deny
| Delete PDN connection set (req 101, resp 102). |
| | **delete\_session** string | **Choices:*** allow
* deny
| Delete session (req 36, resp 37). |
| | **echo** string | **Choices:*** allow
* deny
| Echo (req 1, resp 2). |
| | **modify\_bearer\_cmd\_fail** string | **Choices:*** allow
* deny
| Modify bearer (command 64 , failure indication 65). |
| | **modify\_bearer\_req\_resp** string | **Choices:*** allow
* deny
| Modify bearer (req 34, resp 35). |
| | **name** string / required | | Message filter name. |
| | **resume** string | **Choices:*** allow
* deny
| Resume (notify 164 , ack 165). |
| | **suspend** string | **Choices:*** allow
* deny
| Suspend (notify 162, ack 163). |
| | **trace\_session** string | **Choices:*** allow
* deny
| Trace session (activation 71, deactivation 72). |
| | **unknown\_message** string | **Choices:*** allow
* deny
| Allow or Deny unknown messages. |
| | **unknown\_message\_white\_list** list / elements=string | | White list (to allow) of unknown messages. |
| | | **id** integer / required | | Message IDs. |
| | **update\_bearer** string | **Choices:*** allow
* deny
| Update bearer (req 97, resp 98). |
| | **update\_pdn\_connection\_set** string | **Choices:*** allow
* deny
| Update PDN connection set (req 200, resp 201). |
| | **version\_not\_support** string | **Choices:*** allow
* deny
| Version not supported (3). |
| **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: Message filter for GTPv2 messages.
fortios_gtp_message_filter_v2:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_message_filter_v2:
bearer_resource_cmd_fail: "allow"
change_notification: "allow"
create_bearer: "allow"
create_session: "allow"
delete_bearer_cmd_fail: "allow"
delete_bearer_req_resp: "allow"
delete_pdn_connection_set: "allow"
delete_session: "allow"
echo: "allow"
modify_bearer_cmd_fail: "allow"
modify_bearer_req_resp: "allow"
name: "default_name_14"
resume: "allow"
suspend: "allow"
trace_session: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "20"
update_bearer: "allow"
update_pdn_connection_set: "allow"
version_not_support: "allow"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_bword – Configure AntiSpam banned word list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_bword – Configure AntiSpam banned word 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_emailfilter_bword`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bword category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_bword** dictionary | | Configure AntiSpam banned word list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Spam filter banned word. |
| | | **action** string | **Choices:*** spam
* clear
| Mark spam or good. |
| | | **id** integer / required | | Banned word entry ID. |
| | | **language** string | **Choices:*** western
* simch
* trach
* japanese
* korean
* french
* thai
* spanish
| Language for the banned word. |
| | | **pattern** string | | Pattern for the banned word. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **score** integer | | Score value. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | | **where** string | **Choices:*** subject
* body
* all
| Component of the email to be scanned. |
| | **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 banned word list.
fortios_emailfilter_bword:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_bword:
comment: "Optional comments."
entries:
-
action: "spam"
id: "6"
language: "western"
pattern: "<your_own_value>"
pattern_type: "wildcard"
score: "10"
status: "enable"
where: "subject"
id: "13"
name: "default_name_14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_forticlient_registration_sync – Configure FortiClient registration synchronization settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_forticlient\_registration\_sync – Configure FortiClient registration synchronization 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_endpoint_control_forticlient_registration_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 endpoint\_control feature and forticlient\_registration\_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. |
| **endpoint\_control\_forticlient\_registration\_sync** dictionary | | Configure FortiClient registration synchronization settings. |
| | **peer\_ip** string | | IP address of the peer FortiGate for endpoint license synchronization. |
| | **peer\_name** string | | Peer 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 registration synchronization settings.
fortios_endpoint_control_forticlient_registration_sync:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_forticlient_registration_sync:
peer_ip: "<your_own_value>"
peer_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_system_vdom_link – Configure VDOM links in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_link – Configure VDOM links in Fortinet’s FortiOS and FortiGate.
========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 vdom\_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. |
| **state** string / required | **Choices:*** present
* absent
| Indicates whether to create or remove the object. |
| **system\_vdom\_link** dictionary | | Configure VDOM links. |
| | **name** string / required | | VDOM link name (maximum = 8 characters). |
| | **type** string | **Choices:*** ppp
* ethernet
| VDOM link type: PPP or Ethernet. |
| | **vcluster** string | **Choices:*** vcluster1
* vcluster2
| Virtual cluster. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 links.
fortios_system_vdom_link:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom_link:
name: "default_name_3"
type: "ppp"
vcluster: "vcluster1"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_security_policy – Configure NGFW IPv4/IPv6 application policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_security\_policy – Configure NGFW IPv4/IPv6 application 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_security_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 security\_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\_security\_policy** dictionary | | Configure NGFW IPv4/IPv6 application policies. |
| | **action** string | **Choices:*** accept
* deny
| Policy action (accept/deny). |
| | **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. |
| | **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. |
| | **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. |
| | **dstaddr** list / elements=string | | Destination IPv4 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. |
| | **dstaddr4** list / elements=string | | Destination IPv4 address name 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.vip6.name firewall.vipgrp6.name. |
| | **dstaddr\_negate** string | **Choices:*** enable
* disable
| When enabled dstaddr/dstaddr6 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. |
| | **enforce\_default\_app\_port** string | **Choices:*** enable
* disable
| Enable/disable default application port enforcement for allowed applications. |
| | **file\_filter\_profile** string | | Name of an existing file-filter profile. Source file-filter.profile.name. |
| | **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 | | User group name. Source user.group.name. |
| | **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 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. |
| | **ips\_sensor** string | | Name of an existing IPS sensor. Source ips.sensor.name. |
| | **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. |
| | **mms\_profile** string | | Name of an existing MMS profile. Source firewall.mms-profile.name. |
| | **name** string | | Policy name. |
| | **policyid** integer / required | | Policy ID. |
| | **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. |
| | **schedule** string | | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
| | **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 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. |
| | **srcaddr** list / elements=string | | Source IPv4 address name and address group names. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. |
| | **srcaddr4** list / elements=string | | Source IPv4 address name 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. |
| | **srcaddr\_negate** string | **Choices:*** enable
* disable
| When enabled srcaddr/srcaddr6 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. |
| | **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. |
| | **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 | | User name. Source user.local.name. |
| | **utm\_status** string | **Choices:*** enable
* disable
| Enable security profiles. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **uuid\_idx** integer | | uuid-idx |
| | **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. |
| | **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 NGFW IPv4/IPv6 application policies.
fortios_firewall_security_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_security_policy:
action: "accept"
app_category:
-
id: "5"
app_group:
-
name: "default_name_7 (source application.group.name)"
application:
-
id: "9"
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>"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dstaddr:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)"
dstaddr_negate: "enable"
dstaddr4:
-
name: "default_name_20 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)"
dstaddr6:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name)"
dstintf:
-
name: "default_name_24 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
enforce_default_app_port: "enable"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
fsso_groups:
-
name: "default_name_29 (source user.adgrp.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_32 (source user.group.name)"
icap_profile: "<your_own_value> (source icap.profile.name)"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_36 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_38 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_40 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "42 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_44 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_48 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_50 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_52 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "54 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_56 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
learning_mode: "enable"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_63"
policyid: "64"
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"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
send_deny_packet: "disable"
service:
-
name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
srcaddr:
-
name: "default_name_74 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr_negate: "enable"
srcaddr4:
-
name: "default_name_77 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_79 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_81 (source system.interface.name system.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
url_category:
-
id: "86"
users:
-
name: "default_name_88 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
uuid_idx: "91"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
voip_profile: "<your_own_value> (source voip.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_system_api_user – Configure API users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_api\_user – Configure API 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_api_user`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 api\_user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_api\_user** dictionary | | Configure API users. |
| | **accprofile** string | | Admin user access profile. Source system.accprofile.name. |
| | **api\_key** string | | Admin user password. |
| | **comments** string | | Comment. |
| | **cors\_allow\_origin** string | | Value for Access-Control-Allow-Origin on API responses. Avoid using "\*" if possible. |
| | **name** string / required | | User name. |
| | **peer\_auth** string | **Choices:*** enable
* disable
| Enable/disable peer authentication. |
| | **peer\_group** string | | Peer group name. |
| | **schedule** string | | Schedule name. |
| | **trusthost** list / elements=string | | Trusthost. |
| | | **id** integer / required | | Table ID. |
| | | **ipv4\_trusthost** string | | IPv4 trusted host address. |
| | | **ipv6\_trusthost** string | | IPv6 trusted host address. |
| | | **type** string | **Choices:*** ipv4-trusthost
* ipv6-trusthost
| Trusthost type. |
| | **vdom** list / elements=string | | Virtual domains. |
| | | **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 API users.
fortios_system_api_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_api_user:
accprofile: "<your_own_value> (source system.accprofile.name)"
api_key: "<your_own_value>"
comments: "<your_own_value>"
cors_allow_origin: "<your_own_value>"
name: "default_name_7"
peer_auth: "enable"
peer_group: "<your_own_value>"
schedule: "<your_own_value>"
trusthost:
-
id: "12"
ipv4_trusthost: "<your_own_value>"
ipv6_trusthost: "<your_own_value>"
type: "ipv4-trusthost"
vdom:
-
name: "default_name_17 (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_interface_policy6 – Configure IPv6 interface policies in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_interface\_policy6 – Configure IPv6 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_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 interface\_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\_interface\_policy6** dictionary | | Configure IPv6 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. |
| | **dstaddr6** list / elements=string | | IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.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. |
| | **service6** list / elements=string | | Service name. |
| | | **name** string / required | | Address 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. |
| | **srcaddr6** list / elements=string | | IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range. |
| | | **name** string / required | | Address name. Source firewall.address6.name firewall.addrgrp6.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 IPv6 interface policies.
fortios_firewall_interface_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_interface_policy6:
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"
dstaddr6:
-
name: "default_name_13 (source firewall.address6.name firewall.addrgrp6.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"
service6:
-
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"
srcaddr6:
-
name: "default_name_28 (source firewall.address6.name firewall.addrgrp6.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)
ansible fortinet.fortios.fortios_log_syslogd4_override_filter – Override filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd4\_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_syslogd4_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\_syslogd4 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\_syslogd4\_override\_filter** dictionary | | Override filters for remote system server. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **filter** string | | Syslog 4 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_syslogd4_override_filter:
vdom: "{{ vdom }}"
log_syslogd4_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_log_fortianalyzer_override_filter – Override filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_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_fortianalyzer_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 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\_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. |
| | **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: Override filters for FortiAnalyzer.
fortios_log_fortianalyzer_override_filter:
vdom: "{{ vdom }}"
log_fortianalyzer_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)
| programming_docs |
ansible fortinet.fortios.fortios_switch_controller_lldp_profile – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_lldp\_profile – Configure FortiSwitch LLDP 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_switch_controller_lldp_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 lldp\_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\_lldp\_profile** dictionary | | Configure FortiSwitch LLDP profiles. |
| | **auto\_isl** string | **Choices:*** disable
* enable
| Enable/disable auto inter-switch LAG. |
| | **auto\_isl\_hello\_timer** integer | | Auto inter-switch LAG hello timer duration (1 - 30 sec). |
| | **auto\_isl\_port\_group** integer | | Auto inter-switch LAG port group ID (0 - 9). |
| | **auto\_isl\_receive\_timeout** integer | | Auto inter-switch LAG timeout if no response is received (3 - 90 sec). |
| | **auto\_mclag\_icl** string | **Choices:*** disable
* enable
| Enable/disable MCLAG inter chassis link. |
| | **custom\_tlvs** list / elements=string | | Configuration method to edit custom TLV entries. |
| | | **information\_string** string | | Organizationally defined information string (0 - 507 hexadecimal bytes). |
| | | **name** string / required | | TLV name (not sent). |
| | | **oui** string | | Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. |
| | | **subtype** integer | | Organizationally defined subtype (0 - 255). |
| | **med\_location\_service** list / elements=string | | Configuration method to edit Media Endpoint Discovery (MED) location service type-length-value (TLV) categories. |
| | | **name** string / required | | Location service type name. |
| | | **status** string | **Choices:*** disable
* enable
| Enable or disable this TLV. |
| | | **sys\_location\_id** string | | Location service ID. Source switch-controller.location.name. |
| | **med\_network\_policy** list / elements=string | | Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories. |
| | | **assign\_vlan** string | **Choices:*** disable
* enable
| Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port. |
| | | **dscp** integer | | Advertised Differentiated Services Code Point (DSCP) value, a packet header value indicating the level of service requested for traffic, such as high priority or best effort delivery. |
| | | **name** string / required | | Policy type name. |
| | | **priority** integer | | Advertised Layer 2 priority (0 - 7; from lowest to highest priority). |
| | | **status** string | **Choices:*** disable
* enable
| Enable or disable this TLV. |
| | | **vlan** integer | | ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). |
| | | **vlan\_intf** string | | VLAN interface to advertise; if configured on port. Source system.interface.name. |
| | **med\_tlvs** list / elements=string | **Choices:*** inventory-management
* network-policy
* power-management
* location-identification
| Transmitted LLDP-MED TLVs (type-length-value descriptions): inventory management TLV and/or network policy TLV. |
| | **name** string / required | | Profile name. |
| | **tlvs\_802dot1** string | **Choices:*** port-vlan-id
| Transmitted IEEE 802.1 TLVs. |
| | **tlvs\_802dot3** string | **Choices:*** max-frame-size
* power-negotiation
| Transmitted IEEE 802.3 TLVs. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 profiles.
fortios_switch_controller_lldp_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_lldp_profile:
tlvs_802dot1: "port-vlan-id"
tlvs_802dot3: "max-frame-size"
auto_isl: "disable"
auto_isl_hello_timer: "6"
auto_isl_port_group: "7"
auto_isl_receive_timeout: "8"
auto_mclag_icl: "disable"
custom_tlvs:
-
information_string: "<your_own_value>"
name: "default_name_12"
oui: "<your_own_value>"
subtype: "14"
med_location_service:
-
name: "default_name_16"
status: "disable"
sys_location_id: "<your_own_value> (source switch-controller.location.name)"
med_network_policy:
-
assign_vlan: "disable"
dscp: "21"
name: "default_name_22"
priority: "23"
status: "disable"
vlan: "25"
vlan_intf: "<your_own_value> (source system.interface.name)"
med_tlvs: "inventory-management"
name: "default_name_28"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_sit_tunnel – Configure IPv6 tunnel over IPv4 in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sit\_tunnel – Configure IPv6 tunnel over 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_system_sit_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 sit\_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\_sit\_tunnel** dictionary | | Configure IPv6 tunnel over IPv4. |
| | **auto\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable tunnel ASIC offloading. |
| | **destination** string | | Destination IP address of the tunnel. |
| | **interface** string | | Interface name. Source system.interface.name. |
| | **ip6** string | | IPv6 address of the tunnel. |
| | **name** string / required | | Tunnel name. |
| | **source** string | | Source IP 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 tunnel over IPv4.
fortios_system_sit_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sit_tunnel:
auto_asic_offload: "enable"
destination: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
ip6: "<your_own_value>"
name: "default_name_7"
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_wireless_controller_ap_status – Configure access point status (rogue | accepted | suppressed) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_ap\_status – Configure access point status (rogue | accepted | suppressed) in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ap_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 ap\_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. |
| **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\_ap\_status** dictionary | | Configure access point status (rogue | accepted | suppressed). |
| | **bssid** string | | Access Point"s (AP"s) BSSID. |
| | **id** integer / required | | AP ID. |
| | **ssid** string | | Access Point"s (AP"s) SSID. |
| | **status** string | **Choices:*** rogue
* accepted
* suppressed
| Access Point"s (AP"s) status: rogue, accepted, or supressed. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 point status (rogue | accepted | suppressed).
fortios_wireless_controller_ap_status:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_ap_status:
bssid: "<your_own_value>"
id: "4"
ssid: "<your_own_value>"
status: "rogue"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_multicast6 – Configure IPv6 multicast in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_multicast6 – Configure IPv6 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_multicast6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 multicast6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_multicast6** dictionary | | Configure IPv6 multicast. |
| | **interface** list / elements=string | | Protocol Independent Multicast (PIM) interfaces. |
| | | **hello\_holdtime** integer | | Time before old neighbour information expires (1 - 65535 sec). |
| | | **hello\_interval** integer | | Interval between sending PIM hello messages (1 - 65535 sec).. |
| | | **name** string / required | | Interface name. Source system.interface.name. |
| | **multicast\_pmtu** string | **Choices:*** enable
* disable
| Enable/disable PMTU for IPv6 multicast. |
| | **multicast\_routing** string | **Choices:*** enable
* disable
| Enable/disable IPv6 multicast routing. |
| | **pim\_sm\_global** dictionary | | PIM sparse-mode global settings. |
| | | **register\_rate\_limit** integer | | Limit of packets/sec per source registered through this RP (0 means unlimited). |
| | | **rp\_address** list / elements=string | | Statically configured RP addresses. |
| | | | **id** integer / required | | ID of the entry. |
| | | | **ip6\_address** string | | RP router IPv6 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 IPv6 multicast.
fortios_router_multicast6:
vdom: "{{ vdom }}"
router_multicast6:
interface:
-
hello_holdtime: "4"
hello_interval: "5"
name: "default_name_6 (source system.interface.name)"
multicast_pmtu: "enable"
multicast_routing: "enable"
pim_sm_global:
register_rate_limit: "10"
rp_address:
-
id: "12"
ip6_address: "<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_authentication_setting – Configure authentication setting in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_authentication\_setting – Configure 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_authentication_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 authentication 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. |
| **authentication\_setting** dictionary | | Configure authentication setting. |
| | **active\_auth\_scheme** string | | Active authentication method (scheme name). Source authentication.scheme.name. |
| | **auth\_https** string | **Choices:*** enable
* disable
| Enable/disable redirecting HTTP user authentication to HTTPS. |
| | **captive\_portal** string | | Captive portal host name. Source firewall.address.name. |
| | **captive\_portal6** string | | IPv6 captive portal host name. Source firewall.address6.name. |
| | **captive\_portal\_ip** string | | Captive portal IP address. |
| | **captive\_portal\_ip6** string | | Captive portal IPv6 address. |
| | **captive\_portal\_port** integer | | Captive portal port number (1 - 65535). |
| | **captive\_portal\_ssl\_port** integer | | Captive portal SSL port number (1 - 65535). |
| | **captive\_portal\_type** string | **Choices:*** fqdn
* ip
| Captive portal type. |
| | **dev\_range** list / elements=string | | Address range for the IP based device query. |
| | | **name** string / required | | Address name. Source firewall.address.name firewall.addrgrp.name. |
| | **sso\_auth\_scheme** string | | Single-Sign-On authentication method (scheme name). Source authentication.scheme.name. |
| | **user\_cert\_ca** string | | CA certificate used for client certificate verification. |
| | | **name** string / required | | CA certificate list. Source vpn.certificate.ca.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: Configure authentication setting.
fortios_authentication_setting:
vdom: "{{ vdom }}"
authentication_setting:
active_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
auth_https: "enable"
captive_portal: "<your_own_value> (source firewall.address.name)"
captive_portal_ip: "<your_own_value>"
captive_portal_ip6: "<your_own_value>"
captive_portal_port: "8"
captive_portal_ssl_port: "9"
captive_portal_type: "fqdn"
captive_portal6: "<your_own_value> (source firewall.address6.name)"
dev_range:
-
name: "default_name_13 (source firewall.address.name firewall.addrgrp.name)"
sso_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
user_cert_ca:
-
name: "default_name_16 (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_monitor – Ansible Module for FortiOS Monitor API fortinet.fortios.fortios\_monitor – Ansible Module for FortiOS Monitor API
==========================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.
To install it, use: `ansible-galaxy collection install fortinet.fortios`.
To use it in a playbook, specify: `fortinet.fortios.fortios_monitor`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Request FortiOS appliances to perform specific actions or procedures. This module contain all the FortiOS monitor API.
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. |
| **params** dictionary | | the parameter for each selector, see definition in above list. |
| **selector** string / required | **Choices:*** format.system.logdisk
* update.switch-controller.managed-switch
* update.system.ha-peer
* add-license.registration.vdom
* geoip.geoip-query
* clear-statistics.system.fortiguard
* enable-app-bandwidth-tracking.system.traffic-history
* upgrade.license.database
* run.system.compliance
* clear\_counters.firewall.policy
* test-availability.system.fortiguard
* download.wifi.firmware
* provision.user.fortitoken
* reset.firewall.per-ip-shaper
* start.system.sniffer
* update.system.modem
* update.web-ui.custom-language
* stop.wifi.vlan-probe
* import.vpn-certificate.local
* create.registration.forticare
* save.system.config
* tunnel\_reset\_stats.vpn.ipsec
* toggle-vdom-mode.system.admin
* register-device.registration.forticloud
* quarantine.endpoint-control.registration
* set\_status.wifi.rogue\_ap
* email.user.guest
* add.firewall.clearpass-address
* transfer.registration.forticare
* import.vpn-certificate.crl
* clear.vpn.ike
* disassociate.wifi.client
* reset.webfilter.category-quota
* upgrade.system.firmware
* tunnel\_up.vpn.ipsec
* read-info.system.certificate
* deregister.endpoint-control.registration
* clear-soft-out.router.bgp
* factory-reset.switch-controller.managed-switch
* clear-soft-in.router.bgp
* stop.system.sniffer
* delete.log.local-report
* add-license.registration.forticare
* verify-cert.endpoint-control.ems
* cancel.fortiview.session
* restart.wifi.managed\_ap
* delete.webfilter.override
* unblock.endpoint-control.registration
* stop.system.usb-log
* close.firewall.session
* reset.firewall.shaper
* clear\_all.firewall.session
* clear\_counters.firewall.acl
* reset.wifi.euclid
* revoke.system.dhcp
* add\_users.user.banned
* start.system.fsck
* clear\_counters.firewall.multicast-policy6
* clear\_counters.firewall.policy6
* change-vdom-mode.system.admin
* refresh-server.user.fsso
* clear\_counters.firewall.consolidated-policy
* trigger.system.security-rating
* webhook.system.automation-stitch
* generate.vpn-certificate.csr
* upload.system.vmlicense
* reset.firewall.multicast-policy6
* push.wifi.firmware
* eject.system.usb-device
* reboot.system.os
* reset.firewall.consolidated-policy
* set.system.time
* remove.user.device
* import.vpn-certificate.remote
* upload.webproxy.pacfile
* push.switch-controller.fsw-firmware
* reset.wanopt.peer\_stats
* delete.vpn.ssl
* block.endpoint-control.registration
* backup-action.system.fortimanager
* start.system.usb-log
* system.change-password
* reset.firewall.multicast-policy
* tunnel\_down.vpn.ipsec
* clear\_all.wifi.rogue\_ap
* import-seed.user.fortitoken
* poe-reset.switch-controller.managed-switch
* logout.registration.forticloud
* clear\_counters.firewall.acl6
* restore.system.config
* import.vpn-certificate.ca
* upload.switch-controller.fsw-firmware
* test.user.tacacs-plus
* upload.system.config-script
* system.password-policy-conform
* sms.user.guest
* delete.system.config-script
* reset.wanopt.history
* reset.firewall.policy6
* import-mobile.user.fortitoken
* download.switch-controller.fsw-firmware
* stop.wifi.spectrum
* login.registration.forticare
* create.registration.forticloud
* upload.wifi.firmware
* start.wifi.spectrum
* disconnect.system.modem
* disconnect.system.ha-peer
* keep-alive.wifi.spectrum
* reset.system.modem
* activate.user.fortitoken
* register-appliance.system.csf
* refresh.azure.application-list
* start.wifi.vlan-probe
* clear.system.sniffer
* reset.extender-controller.extender
* validate-gcp-key.system.sdn-connector
* restart.system.sniffer
* import.web-ui.language
* import-trial.user.fortitoken
* dump.system.com-log
* diagnose.extender-controller.extender
* update-comments.system.config-revision
* refresh.user.fortitoken
* reset.firewall.policy
* shutdown.system.os
* reset.log.stats
* revoke.system.dhcp6
* login.registration.forticloud
* reset.wanopt.webcache
* save.system.config-revision
* set\_status.wifi.managed\_ap
* deauth.user.firewall
* upgrade.extender-controller.extender
* delete.system.config-revision
* clear\_users.user.banned
* send-activation.user.fortitoken
* reset.webcache.stats
* clear\_counters.firewall.proxy-policy
* utm.rating-lookup
* test.system.automation-stitch
* refresh.system.external-resource
* auth.user.firewall
* dhcp-renew.system.interface
* migrate.registration.forticloud
* clear\_counters.firewall.multicast-policy
* connect.wifi.network
* test-connect.user.radius
* speed-test-trigger.system.interface
* generate-key.system.api-user
* upload.wifi.region-image
* run.system.config-script
* clear\_tunnel.vpn.ssl
* add.nsx.service
* update.system.fortiguard
* restart.switch-controller.managed-switch
* unquarantine.endpoint-control.registration
* led-blink.wifi.managed\_ap
* update.system.sdn-connector
* config.system.fortimanager
* system.disconnect-admins
* provision-user.vpn.ssl
* create.web-ui.custom-language
* check.endpoint-control.registration-password
* scan.wifi.network
* clear\_counters.firewall.security-policy
* clear\_all.user.banned
* delete.firewall.clearpass-address
* connect.system.modem
* generate-keys.wifi.ssid
| selector of the retrieved fortimanager facts |
| **vdom** string | **Default:**"root" | Virtual domain, among 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.
* Not all parameters are required for a selector.
* This module is exclusivly for FortiOS monitor API.
* The result of API request is stored in results.
Examples
--------
```
- hosts: fortigate03
connection: httpapi
collections:
- fortinet.fortios
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Activate FortiToken
fortios_monitor:
vdom: "root"
access_token: "<fortios_access_token>"
selector: 'activate.user.fortitoken'
params:
tokens: '<token string>'
- name: Reboot This Device
fortios_monitor:
vdom: "root"
access_token: "<fortios_access_token>"
selector: 'reboot.system.os'
params:
event_log_message: 'Reboot Request From Ansible'
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** 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)
ansible fortinet.fortios.fortios_system_replacemsg_auth – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_auth – 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_auth`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 auth category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_auth** 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_auth:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_auth:
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_router_bfd – Configure BFD in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_bfd – Configure BFD in Fortinet’s FortiOS and FortiGate.
==========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_bfd`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bfd category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_bfd** dictionary | | Configure BFD. |
| | **neighbor** list / elements=string | | neighbor |
| | | **interface** string | | Interface name. Source system.interface.name. |
| | | **ip** string / required | | IPv4 address of the BFD neighbor. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 BFD.
fortios_router_bfd:
vdom: "{{ vdom }}"
router_bfd:
neighbor:
-
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)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_roaming_consortium – Configure roaming consortium in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_anqp\_roaming\_consortium – Configure roaming consortium in Fortinet’s FortiOS and FortiGate.
========================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_roaming_consortium`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_roaming\_consortium category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_roaming\_consortium** dictionary | | Configure roaming consortium. |
| | **name** string / required | | Roaming consortium name. |
| | **oi\_list** list / elements=string | | Organization identifier list. |
| | | **comment** string | | Comment. |
| | | **index** integer / required | | OI index. |
| | | **oi** string | | Organization identifier. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 roaming consortium.
fortios_wireless_controller_hotspot20_anqp_roaming_consortium:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_anqp_roaming_consortium:
name: "default_name_3"
oi_list:
-
comment: "Comment."
index: "6"
oi: "<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_default – Policies which are applied automatically to all ISL/ICL/FortiLink interfaces in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_auto\_config\_default – Policies which are applied automatically to all ISL/ICL/FortiLink 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_default`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 default category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_auto\_config\_default** dictionary | | Policies which are applied automatically to all ISL/ICL/FortiLink interfaces. |
| | **fgt\_policy** string | | Default FortiLink auto-config policy. Source switch-controller.auto-config.policy.name. |
| | **icl\_policy** string | | Default ICL auto-config policy. Source switch-controller.auto-config.policy.name. |
| | **isl\_policy** string | | Default ISL auto-config policy. Source switch-controller.auto-config.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: Policies which are applied automatically to all ISL/ICL/FortiLink interfaces.
fortios_switch_controller_auto_config_default:
vdom: "{{ vdom }}"
switch_controller_auto_config_default:
fgt_policy: "<your_own_value> (source switch-controller.auto-config.policy.name)"
icl_policy: "<your_own_value> (source switch-controller.auto-config.policy.name)"
isl_policy: "<your_own_value> (source switch-controller.auto-config.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_internet_service_ipbl_reason – IP blacklist reason in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_ipbl\_reason – IP blacklist reason in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_reason`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_reason category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_reason** dictionary | | IP blacklist reason. |
| | **id** integer / required | | IP blacklist reason ID. |
| | **name** string | | IP blacklist reason 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 reason.
fortios_firewall_internet_service_ipbl_reason:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_ipbl_reason:
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_firewall_internet_service_definition – Configure Internet Service definition in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_definition – Configure Internet Service definition in Fortinet’s FortiOS and FortiGate.
==============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_definition`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_definition category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_definition** dictionary | | Configure Internet Service definition. |
| | **entry** list / elements=string | | Protocol and port information in an Internet Service entry. |
| | | **category\_id** integer | | Internet Service category ID. |
| | | **name** string | | Internet Service name. |
| | | **port\_range** list / elements=string | | Port ranges in the definition entry. |
| | | | **end\_port** integer | | Ending TCP/UDP/SCTP destination port (1 to 65535). |
| | | | **id** integer / required | | Custom entry port range ID. |
| | | | **start\_port** integer | | Starting TCP/UDP/SCTP destination port (1 to 65535). |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | | **seq\_num** integer | | Entry sequence number. |
| | **id** integer / required | | Internet Service application list 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 Service definition.
fortios_firewall_internet_service_definition:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_definition:
entry:
-
category_id: "4"
name: "default_name_5"
port_range:
-
end_port: "7"
id: "8"
start_port: "9"
protocol: "10"
seq_num: "11"
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)
ansible fortinet.fortios.fortios_vpn_ipsec_concentrator – Concentrator configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_concentrator – Concentrator 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_vpn_ipsec_concentrator`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 concentrator category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_concentrator** dictionary | | Concentrator configuration. |
| | **member** list / elements=string | | Names of up to 3 VPN tunnels to add to the concentrator. |
| | | **name** string / required | | Member name. Source vpn.ipsec.manualkey.name vpn.ipsec.phase1.name. |
| | **name** string / required | | Concentrator name. |
| | **src\_check** string | **Choices:*** disable
* enable
| Enable to check source address of phase 2 selector. Disable to check only the destination selector. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Concentrator configuration.
fortios_vpn_ipsec_concentrator:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_concentrator:
member:
-
name: "default_name_4 (source vpn.ipsec.manualkey.name vpn.ipsec.phase1.name)"
name: "default_name_5"
src_check: "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_spamfilter_options – Configure AntiSpam options in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_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_spamfilter_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 spamfilter 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **spamfilter\_options** dictionary | | Configure AntiSpam options. |
| | **dns\_timeout** integer | | DNS 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 AntiSpam options.
fortios_spamfilter_options:
vdom: "{{ vdom }}"
spamfilter_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_system_vdom_sflow – Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow collector in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom\_sflow – Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow collector in Fortinet’s FortiOS and FortiGate.
=====================================================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sflow`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_vdom\_sflow** dictionary | | Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow collector. |
| | **collector\_ip** string | | IP address of the sFlow collector that sFlow agents added to interfaces in this VDOM send sFlow datagrams to . |
| | **collector\_port** integer | | UDP port number used for sending sFlow datagrams (configure only if required by your sFlow collector or your network configuration) (0 - 65535). |
| | **source\_ip** string | | Source IP address for sFlow agent. |
| | **vdom\_sflow** string | **Choices:*** enable
* disable
| Enable/disable the sFlow configuration for the current VDOM. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an
sFlow collector.
fortios_system_vdom_sflow:
vdom: "{{ vdom }}"
system_vdom_sflow:
collector_ip: "<your_own_value>"
collector_port: "4"
source_ip: "84.230.14.43"
vdom_sflow: "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_disk_filter – Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_disk\_filter – Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and 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_log_disk_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\_disk 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\_disk\_filter** dictionary | | Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type. |
| | **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. |
| | **dlp\_archive** string | **Choices:*** enable
* disable
| Enable/disable DLP archive logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **event** string | **Choices:*** enable
* disable
| Enable/disable event logging. |
| | **filter** string | | Disk 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 to disk 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: Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type.
fortios_log_disk_filter:
vdom: "{{ vdom }}"
log_disk_filter:
admin: "enable"
anomaly: "enable"
auth: "enable"
cpu_memory_usage: "enable"
dhcp: "enable"
dlp_archive: "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: "18"
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_wireless_controller_nac_profile – Configure WiFi network access control (NAC) profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_nac\_profile – Configure WiFi network access control (NAC) 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_nac_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 nac\_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\_nac\_profile** dictionary | | Configure WiFi network access control (NAC) profiles. |
| | **comment** string | | Comment. |
| | **name** string / required | | Name. |
| | **onboarding\_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 network access control (NAC) profiles.
fortios_wireless_controller_nac_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_nac_profile:
comment: "Comment."
name: "default_name_4"
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)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_internet_service_name – Define internet service names in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_name – Define internet service names in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 firewall feature and internet\_service\_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. |
| **firewall\_internet\_service\_name** dictionary | | Define internet service names. |
| | **city\_id** integer | | City ID. Source firewall.city.id. |
| | **country\_id** integer | | Country or Area ID. Source firewall.country.id. |
| | **internet\_service\_id** integer | | Internet Service ID. Source firewall.internet-service.id. |
| | **name** string / required | | Internet Service name. |
| | **region\_id** integer | | Region ID. Source firewall.region.id. |
| | **type** string | **Choices:*** default
* location
| Internet Service name 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: Define internet service names.
fortios_firewall_internet_service_name:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_name:
city_id: "3 (source firewall.city.id)"
country_id: "4 (source firewall.country.id)"
internet_service_id: "5 (source firewall.internet-service.id)"
name: "default_name_6"
region_id: "7 (source firewall.region.id)"
type: "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)
ansible fortinet.fortios.fortios_firewall_internet_service_list – Internet Service list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_list – Internet Service 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_internet_service_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 firewall feature and internet\_service\_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. |
| **firewall\_internet\_service\_list** dictionary | | Internet Service list. |
| | **id** integer / required | | Internet Service category ID. |
| | **name** string | | Internet 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: Internet Service list.
fortios_firewall_internet_service_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_list:
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_hotspot20_icon – Configure OSU provider icon in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_icon – Configure OSU provider icon in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_icon`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 icon category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_icon** dictionary | | Configure OSU provider icon. |
| | **icon\_list** list / elements=string | | Icon list. |
| | | **file** string | | Icon file. |
| | | **height** integer | | Icon height. |
| | | **lang** string | | Language code. |
| | | **name** string / required | | Icon name. |
| | | **type** string | **Choices:*** bmp
* gif
* jpeg
* png
* tiff
| Icon type. |
| | | **width** integer | | Icon width. |
| | **name** string / required | | Icon list 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 OSU provider icon.
fortios_wireless_controller_hotspot20_icon:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_icon:
icon_list:
-
file: "<your_own_value>"
height: "5"
lang: "<your_own_value>"
name: "default_name_7"
type: "bmp"
width: "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_switch_controller_vlan_policy – Configure VLAN policy to be applied on the managed FortiSwitch ports through port-policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_vlan\_policy – Configure VLAN policy to be applied on the managed FortiSwitch ports through port-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_vlan_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 vlan\_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\_vlan\_policy** dictionary | | Configure VLAN policy to be applied on the managed FortiSwitch ports through port-policy. |
| | **allowed\_vlans** list / elements=string | | Allowed VLANs to be applied when using this VLAN policy. |
| | | **vlan\_name** string | | VLAN name. Source system.interface.name. |
| | **allowed\_vlans\_all** string | **Choices:*** enable
* disable
| Enable/disable all defined VLANs when using this VLAN policy. |
| | **description** string | | Description for the VLAN policy. |
| | **discard\_mode** string | **Choices:*** none
* all-untagged
* all-tagged
| Discard mode to be applied when using this VLAN policy. |
| | **fortilink** string | | FortiLink interface for which this VLAN policy belongs to. Source system.interface.name. |
| | **name** string / required | | VLAN policy name. |
| | **untagged\_vlans** list / elements=string | | Untagged VLANs to be applied when using this VLAN policy. |
| | | **vlan\_name** string | | VLAN name. Source system.interface.name. |
| | **vlan** string | | Native VLAN to be applied when using this VLAN policy. 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 VLAN policy to be applied on the managed FortiSwitch ports through port-policy.
fortios_switch_controller_vlan_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_vlan_policy:
allowed_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
allowed_vlans_all: "enable"
description: "<your_own_value>"
discard_mode: "none"
fortilink: "<your_own_value> (source system.interface.name)"
name: "default_name_9"
untagged_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
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)
| programming_docs |
ansible fortinet.fortios.fortios_vpn_ssl_web_user_group_bookmark – Configure SSL VPN user group bookmark in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ssl\_web\_user\_group\_bookmark – Configure SSL VPN user group 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_group_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\_group\_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\_group\_bookmark** dictionary | | Configure SSL VPN user group 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. |
| | **name** string / required | | Group name. 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 SSL VPN user group bookmark.
fortios_vpn_ssl_web_user_group_bookmark:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_user_group_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"
name: "default_name_31 (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_firewall_schedule_recurring – Recurring schedule configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_schedule\_recurring – Recurring 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_recurring`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 recurring category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_recurring** dictionary | | Recurring schedule configuration. |
| | **color** integer | | Color of icon on the GUI. |
| | **day** list / elements=string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
* none
| One or more days of the week on which the schedule is valid. Separate the names of the days with a space. |
| | **end** string | | Time of day to end the schedule, format hh:mm. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **name** string / required | | Recurring schedule name. |
| | **start** string | | Time of day to start the schedule, format hh:mm. |
| **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: Recurring schedule configuration.
fortios_firewall_schedule_recurring:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_schedule_recurring:
color: "3"
day: "sunday"
end: "<your_own_value>"
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_system_ipsec_aggregate – Configure an aggregate of IPsec tunnels in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_ipsec\_aggregate – Configure an aggregate of IPsec tunnels in Fortinet’s FortiOS and FortiGate.
=================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ipsec_aggregate`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ipsec\_aggregate category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ipsec\_aggregate** dictionary | | Configure an aggregate of IPsec tunnels. |
| | **algorithm** string | **Choices:*** L3
* L4
* round-robin
* redundant
* weighted-round-robin
| Frame distribution algorithm. |
| | **member** list / elements=string | | Member tunnels of the aggregate. |
| | | **tunnel\_name** string | | Tunnel name. Source vpn.ipsec.phase1-interface.name. |
| | **name** string / required | | IPsec aggregate 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 an aggregate of IPsec tunnels.
fortios_system_ipsec_aggregate:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_ipsec_aggregate:
algorithm: "L3"
member:
-
tunnel_name: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
name: "default_name_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_system_fm – Configure FM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_fm – Configure FM in Fortinet’s FortiOS and FortiGate.
========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fm`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fm** dictionary | | Configure FM. |
| | **auto\_backup** string | **Choices:*** enable
* disable
| Enable/disable automatic backup. |
| | **id** string | | ID. |
| | **ip** string | | IP address. |
| | **ipsec** string | **Choices:*** enable
* disable
| Enable/disable IPsec. |
| | **scheduled\_config\_restore** string | **Choices:*** enable
* disable
| Enable/disable scheduled configuration restore. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable FM. |
| | **vdom** string | | VDOM. 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 FM.
fortios_system_fm:
vdom: "{{ vdom }}"
system_fm:
auto_backup: "enable"
id: "4"
ip: "<your_own_value>"
ipsec: "enable"
scheduled_config_restore: "enable"
status: "enable"
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_system_speed_test_schedule – Speed test schedule for each interface in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_speed\_test\_schedule – Speed test schedule for each 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_system_speed_test_schedule`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 speed\_test\_schedule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_speed\_test\_schedule** dictionary | | Speed test schedule for each interface. |
| | **diffserv** string | | DSCP used for speed test. |
| | **interface** string / required | | Interface name. Source system.interface.name. |
| | **schedules** list / elements=string | | Schedules for the interface. |
| | | **name** string / required | | Name of a firewall recurring schedule. Source firewall.schedule.recurring.name. |
| | **server\_name** string | | Speed test server name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable scheduled speed test. |
| | **update\_inbandwidth** string | **Choices:*** disable
* enable
| Enable/disable bypassing interface"s inbound bandwidth setting. |
| | **update\_inbandwidth\_maximum** integer | | Maximum downloading bandwidth (kbps) to be used in a speed test. |
| | **update\_inbandwidth\_minimum** integer | | Minimum downloading bandwidth (kbps) to be considered effective. |
| | **update\_outbandwidth** string | **Choices:*** disable
* enable
| Enable/disable bypassing interface"s outbound bandwidth setting. |
| | **update\_outbandwidth\_maximum** integer | | Maximum uploading bandwidth (kbps) to be used in a speed test. |
| | **update\_outbandwidth\_minimum** integer | | Minimum uploading bandwidth (kbps) to be considered effective. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: Speed test schedule for each interface.
fortios_system_speed_test_schedule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_speed_test_schedule:
diffserv: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
schedules:
-
name: "default_name_6 (source firewall.schedule.recurring.name)"
server_name: "<your_own_value>"
status: "disable"
update_inbandwidth: "disable"
update_inbandwidth_maximum: "10"
update_inbandwidth_minimum: "11"
update_outbandwidth: "disable"
update_outbandwidth_maximum: "13"
update_outbandwidth_minimum: "14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_custom – Configure custom services in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_service\_custom – Configure custom 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_firewall_service_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\_service 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\_service\_custom** dictionary | | Configure custom services. |
| | **app\_category** list / elements=string | | Application category ID. |
| | | **id** integer / required | | Application category id. |
| | **app\_service\_type** string | **Choices:*** disable
* app-id
* app-category
| Application service type. |
| | **application** list / elements=string | | Application ID. |
| | | **id** integer / required | | Application id. |
| | **category** string | | Service category. Source firewall.service.category.name. |
| | **check\_reset\_range** string | **Choices:*** disable
* strict
* default
| Configure the type of ICMP error message verification. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **fqdn** string | | Fully qualified domain name. |
| | **helper** string | **Choices:*** auto
* disable
* 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. |
| | **icmpcode** integer | | ICMP code. |
| | **icmptype** integer | | ICMP type. |
| | **iprange** string | | Start and end of the IP range associated with service. |
| | **name** string / required | | Custom service name. |
| | **protocol** string | **Choices:*** TCP/UDP/SCTP
* ICMP
* ICMP6
* IP
* HTTP
* FTP
* CONNECT
* SOCKS-TCP
* SOCKS-UDP
* ALL
| Protocol type based on IANA numbers. |
| | **protocol\_number** integer | | IP protocol number. |
| | **proxy** string | **Choices:*** enable
* disable
| Enable/disable web proxy service. |
| | **sctp\_portrange** string | | Multiple SCTP port ranges. |
| | **session\_ttl** integer | | Session TTL (300 - 604800, 0 = default). |
| | **tcp\_halfclose\_timer** integer | | Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). |
| | **tcp\_halfopen\_timer** integer | | Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). |
| | **tcp\_portrange** string | | Multiple TCP port ranges. |
| | **tcp\_rst\_timer** integer | | Set the length of the TCP CLOSE state in seconds (5 - 300 sec, 0 = default). |
| | **tcp\_timewait\_timer** integer | | Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). |
| | **udp\_idle\_timer** integer | | UDP half close timeout (0 - 86400 sec, 0 = default). |
| | **udp\_portrange** string | | Multiple UDP port ranges. |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable the visibility of the service 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 custom services.
fortios_firewall_service_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_service_custom:
app_category:
-
id: "4"
app_service_type: "disable"
application:
-
id: "7"
category: "<your_own_value> (source firewall.service.category.name)"
check_reset_range: "disable"
color: "10"
comment: "Comment."
fabric_object: "enable"
fqdn: "<your_own_value>"
helper: "auto"
icmpcode: "15"
icmptype: "16"
iprange: "<your_own_value>"
name: "default_name_18"
protocol: "TCP/UDP/SCTP"
protocol_number: "20"
proxy: "enable"
sctp_portrange: "<your_own_value>"
session_ttl: "23"
tcp_halfclose_timer: "24"
tcp_halfopen_timer: "25"
tcp_portrange: "<your_own_value>"
tcp_rst_timer: "27"
tcp_timewait_timer: "28"
udp_idle_timer: "29"
udp_portrange: "<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_firewall_addrgrp6 – Configure IPv6 address groups in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_addrgrp6 – Configure IPv6 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_addrgrp6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 addrgrp6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_addrgrp6** dictionary | | Configure IPv6 address groups. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (1 - 32). |
| | **comment** string | | Comment. |
| | **fabric\_object** string | **Choices:*** enable
* disable
| Security Fabric global object setting. |
| | **member** list / elements=string | | Address objects contained within the group. |
| | | **name** string / required | | Address6/addrgrp6 name. Source firewall.address6.name firewall.addrgrp6.name. |
| | **name** string / required | | IPv6 address 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. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable address group6 visibility 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: Configure IPv6 address groups.
fortios_firewall_addrgrp6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_addrgrp6:
color: "3"
comment: "Comment."
fabric_object: "enable"
member:
-
name: "default_name_7 (source firewall.address6.name firewall.addrgrp6.name)"
name: "default_name_8"
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)"
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_firewall_city – Define city table in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_city – Define city 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_city`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 city category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_city** dictionary | | Define city table. |
| | **id** integer / required | | City ID. |
| | **name** string | | City 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: Define city table.
fortios_firewall_city:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_city:
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)
| programming_docs |
ansible fortinet.fortios.fortios_ips_global – Configure IPS global parameter in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_global – Configure IPS global 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_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 ips 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. |
| **ips\_global** dictionary | | Configure IPS global parameter. |
| | **anomaly\_mode** string | **Choices:*** periodical
* continuous
| Global blocking mode for rate-based anomalies. |
| | **cp\_accel\_mode** string | **Choices:*** none
* basic
* advanced
| IPS Pattern matching acceleration/offloading to CPx processors. |
| | **database** string | **Choices:*** regular
* extended
| Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. |
| | **deep\_app\_insp\_db\_limit** integer | | Limit on number of entries in deep application inspection database (1 - 2147483647, 0 = use recommended setting) |
| | **deep\_app\_insp\_timeout** integer | | Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting). |
| | **engine\_count** integer | | Number of IPS engines running. If set to the default value of 0, FortiOS sets the number to optimize performance depending on the number of CPU cores. |
| | **exclude\_signatures** string | **Choices:*** none
* industrial
| Excluded signatures. |
| | **fail\_open** string | **Choices:*** enable
* disable
| Enable to allow traffic if the IPS process crashes. Default is disable and IPS traffic is blocked when the IPS process crashes. |
| | **intelligent\_mode** string | **Choices:*** enable
* disable
| Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. |
| | **ips\_reserve\_cpu** string | **Choices:*** disable
* enable
| Enable/disable IPS daemon"s use of CPUs other than CPU 0 |
| | **ngfw\_max\_scan\_range** integer | | NGFW policy-mode app detection threshold. |
| | **np\_accel\_mode** string | **Choices:*** none
* basic
| Acceleration mode for IPS processing by NPx processors. |
| | **packet\_log\_queue\_depth** integer | | Packet/pcap log queue depth per IPS engine. |
| | **session\_limit\_mode** string | **Choices:*** accurate
* heuristic
| Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). |
| | **skype\_client\_public\_ipaddr** string | | Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas. |
| | **socket\_size** integer | | IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance. |
| | **sync\_session\_ttl** string | **Choices:*** enable
* disable
| Enable/disable use of kernel session TTL for IPS sessions. |
| | **tls\_active\_probe** dictionary | | TLS active probe configuration. |
| | | **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. |
| | | **source\_ip** string | | Source IP address used for TLS active probe. |
| | | **source\_ip6** string | | Source IPv6 address used for TLS active probe. |
| | | **vdom** string | | Virtual domain name for TLS active probe. Source system.vdom.name. |
| | **traffic\_submit** string | **Choices:*** enable
* disable
| Enable/disable submitting attack data found by this FortiGate to FortiGuard. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 global parameter.
fortios_ips_global:
vdom: "{{ vdom }}"
ips_global:
anomaly_mode: "periodical"
cp_accel_mode: "none"
database: "regular"
deep_app_insp_db_limit: "6"
deep_app_insp_timeout: "7"
engine_count: "8"
exclude_signatures: "none"
fail_open: "enable"
intelligent_mode: "enable"
ips_reserve_cpu: "disable"
ngfw_max_scan_range: "13"
np_accel_mode: "none"
packet_log_queue_depth: "15"
session_limit_mode: "accurate"
skype_client_public_ipaddr: "<your_own_value>"
socket_size: "18"
sync_session_ttl: "enable"
tls_active_probe:
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
vdom: "<your_own_value> (source system.vdom.name)"
traffic_submit: "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_spamfilter_bwl – Configure anti-spam black/white list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_bwl – Configure anti-spam black/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_spamfilter_bwl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 bwl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_bwl** dictionary | | Configure anti-spam black/white list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Anti-spam black/white list entries. |
| | | **action** string | **Choices:*** reject
* spam
* clear
| Reject, mark as spam or good email. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
| IP address type. |
| | | **email\_pattern** string | | Email address pattern. |
| | | **id** integer / required | | Entry ID. |
| | | **ip4\_subnet** string | | IPv4 network address/subnet mask bits. |
| | | **ip6\_subnet** string | | IPv6 network address/subnet mask bits. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | | **type** string | **Choices:*** ip
* email
| Entry type. |
| | **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 anti-spam black/white list.
fortios_spamfilter_bwl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_bwl:
comment: "Optional comments."
entries:
-
action: "reject"
addr_type: "ipv4"
email_pattern: "<your_own_value>"
id: "8"
ip4_subnet: "<your_own_value>"
ip6_subnet: "<your_own_value>"
pattern_type: "wildcard"
status: "enable"
type: "ip"
id: "14"
name: "default_name_15"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_identity_based_route – Configure identity based routing in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_identity\_based\_route – Configure identity based routing in Fortinet’s FortiOS and FortiGate.
==================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_identity_based_route`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 identity\_based\_route category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_identity\_based\_route** dictionary | | Configure identity based routing. |
| | **comments** string | | Comments. |
| | **name** string / required | | Name. |
| | **rule** list / elements=string | | Rule. |
| | | **device** string | | Outgoing interface for the rule. Source system.interface.name. |
| | | **gateway** string | | IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx ). |
| | | **groups** list / elements=string | | Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space. |
| | | | **name** string / required | | Group name. Source user.group.name. |
| | | **id** integer / required | | Rule 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 identity based routing.
fortios_firewall_identity_based_route:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_identity_based_route:
comments: "<your_own_value>"
name: "default_name_4"
rule:
-
device: "<your_own_value> (source system.interface.name)"
gateway: "<your_own_value>"
groups:
-
name: "default_name_9 (source user.group.name)"
id: "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_emailfilter_block_allow_list – Configure anti-spam block/allow list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_emailfilter\_block\_allow\_list – Configure anti-spam block/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_emailfilter_block_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 emailfilter feature and block\_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. |
| **emailfilter\_block\_allow\_list** dictionary | | Configure anti-spam block/allow list. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Anti-spam block/allow entries. |
| | | **action** string | **Choices:*** reject
* spam
* clear
| Reject, mark as spam or good email. |
| | | **addr\_type** string | **Choices:*** ipv4
* ipv6
| IP address type. |
| | | **email\_pattern** string | | Email address pattern. |
| | | **id** integer / required | | Entry ID. |
| | | **ip4\_subnet** string | | IPv4 network address/subnet mask bits. |
| | | **ip6\_subnet** string | | IPv6 network address/subnet mask bits. |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable status. |
| | | **type** string | **Choices:*** ip
* email
| Entry type. |
| | **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 anti-spam block/allow list.
fortios_emailfilter_block_allow_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_block_allow_list:
comment: "Optional comments."
entries:
-
action: "reject"
addr_type: "ipv4"
email_pattern: "<your_own_value>"
id: "8"
ip4_subnet: "<your_own_value>"
ip6_subnet: "<your_own_value>"
pattern_type: "wildcard"
status: "enable"
type: "ip"
id: "14"
name: "default_name_15"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_community – SNMP community configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_snmp\_community – SNMP community 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_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 system\_snmp feature and 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. |
| **system\_snmp\_community** dictionary | | SNMP community configuration. |
| | **events** list / elements=string | **Choices:*** cpu-high
* mem-low
* log-full
* intf-ip
* vpn-tun-up
* vpn-tun-down
* ha-switch
* ha-hb-failure
* ips-signature
* ips-anomaly
* av-virus
* av-oversize
* av-pattern
* av-fragmented
* fm-if-change
* fm-conf-change
* bgp-established
* bgp-backward-transition
* ha-member-up
* ha-member-down
* ent-conf-change
* av-conserve
* av-bypass
* av-oversize-passed
* av-oversize-blocked
* ips-pkg-update
* ips-fail-open
* temperature-high
* voltage-alert
* power-supply-failure
* faz-disconnect
* fan-failure
* wc-ap-up
* wc-ap-down
* fswctl-session-up
* fswctl-session-down
* load-balance-real-server-down
* device-new
* per-cpu-high
* dhcp
* ospf-nbr-state-change
* ospf-virtnbr-state-change
| SNMP trap events. |
| | **hosts** list / elements=string | | Configure IPv4 SNMP managers (hosts). |
| | | **ha\_direct** string | **Choices:*** enable
* disable
| Enable/disable direct management of HA cluster members. |
| | | **host\_type** string | **Choices:*** any
* query
* trap
| Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. |
| | | **id** integer / required | | Host entry ID. |
| | | **ip** string | | IPv4 address of the SNMP manager (host). |
| | | **source\_ip** string | | Source IPv4 address for SNMP traps. |
| | **hosts6** list / elements=string | | Configure IPv6 SNMP managers. |
| | | **ha\_direct** string | **Choices:*** enable
* disable
| Enable/disable direct management of HA cluster members. |
| | | **host\_type** string | **Choices:*** any
* query
* trap
| Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. |
| | | **id** integer / required | | Host6 entry ID. |
| | | **ipv6** string | | SNMP manager IPv6 address prefix. |
| | | **source\_ipv6** string | | Source IPv6 address for SNMP traps. |
| | **id** integer / required | | Community ID. |
| | **name** string | | Community name. |
| | **query\_v1\_port** integer | | SNMP v1 query port . |
| | **query\_v1\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v1 queries. |
| | **query\_v2c\_port** integer | | SNMP v2c query port . |
| | **query\_v2c\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v2c queries. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this SNMP community. |
| | **trap\_v1\_lport** integer | | SNMP v1 trap local port . |
| | **trap\_v1\_rport** integer | | SNMP v1 trap remote port . |
| | **trap\_v1\_status** string | **Choices:*** enable
* disable
| 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:*** enable
* disable
| 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: SNMP community configuration.
fortios_system_snmp_community:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_snmp_community:
events: "cpu-high"
hosts:
-
ha_direct: "enable"
host_type: "any"
id: "7"
ip: "<your_own_value>"
source_ip: "84.230.14.43"
hosts6:
-
ha_direct: "enable"
host_type: "any"
id: "13"
ipv6: "<your_own_value>"
source_ipv6: "<your_own_value>"
id: "16"
name: "default_name_17"
query_v1_port: "18"
query_v1_status: "enable"
query_v2c_port: "20"
query_v2c_status: "enable"
status: "enable"
trap_v1_lport: "23"
trap_v1_rport: "24"
trap_v1_status: "enable"
trap_v2c_lport: "26"
trap_v2c_rport: "27"
trap_v2c_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_carrier_endpoint_bwl – Carrier end point black/white list tables in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_carrier\_endpoint\_bwl – Carrier end point black/white list 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_firewall_carrier_endpoint_bwl`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 carrier\_endpoint\_bwl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_carrier\_endpoint\_bwl** dictionary | | Carrier end point black/white list tables. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | Carrier end point black/white list. |
| | | **action** list / elements=string | **Choices:*** block
* exempt
* exempt-mass-mms
| Action to take on this end point |
| | | **carrier\_endpoint** string | | End point to act on. |
| | | **log\_action** list / elements=string | **Choices:*** archive
| Action to take on this end point |
| | | **pattern\_type** string | **Choices:*** wildcard
* regexp
* simple
| Wildcard pattern or regular expression. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable specified action(s) for this end point. |
| | **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: Carrier end point black/white list tables.
fortios_firewall_carrier_endpoint_bwl:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_carrier_endpoint_bwl:
comment: "Optional comments."
entries:
-
action: "block"
carrier_endpoint: "<your_own_value>"
log_action: "archive"
pattern_type: "wildcard"
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_system_automation_stitch – Automation stitches in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_automation\_stitch – Automation stitches in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_stitch`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_stitch category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_stitch** dictionary | | Automation stitches. |
| | **action** list / elements=string | | Action names. |
| | | **name** string / required | | Action name. Source system.automation-action.name. |
| | **description** string | | Description. |
| | **destination** list / elements=string | | Serial number/HA group-name of destination devices. |
| | | **name** string / required | | Destination name. Source system.automation-destination.name. |
| | **name** string / required | | Name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable this stitch. |
| | **trigger** string | | Trigger name. Source system.automation-trigger.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: Automation stitches.
fortios_system_automation_stitch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_automation_stitch:
action:
-
name: "default_name_4 (source system.automation-action.name)"
description: "<your_own_value>"
destination:
-
name: "default_name_7 (source system.automation-destination.name)"
name: "default_name_8"
status: "enable"
trigger: "<your_own_value> (source system.automation-trigger.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_router_community_list – Configure community lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_router\_community\_list – Configure community 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_community_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 community\_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\_community\_list** dictionary | | Configure community lists. |
| | **name** string / required | | Community list name. |
| | **rule** list / elements=string | | Community list rule. |
| | | **action** string | **Choices:*** deny
* permit
| Permit or deny route-based operations, based on the route"s COMMUNITY attribute. |
| | | **id** integer / required | | ID. |
| | | **match** string | | Community specifications for matching a reserved community. |
| | | **regexp** string | | Ordered list of COMMUNITY attributes as a regular expression. |
| | **type** string | **Choices:*** standard
* expanded
| Community list type (standard or expanded). |
| **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 community lists.
fortios_router_community_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_community_list:
name: "default_name_3"
rule:
-
action: "deny"
id: "6"
match: "<your_own_value>"
regexp: "<your_own_value>"
type: "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)
| programming_docs |
ansible fortinet.fortios.fortios_firewall_ipmacbinding_setting – Configure IP to MAC binding settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ipmacbinding\_setting – Configure IP to MAC binding 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_ipmacbinding_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\_ipmacbinding 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\_ipmacbinding\_setting** dictionary | | Configure IP to MAC binding settings. |
| | **bindthroughfw** string | **Choices:*** enable
* disable
| Enable/disable use of IP/MAC binding to filter packets that would normally go through the firewall. |
| | **bindtofw** string | **Choices:*** enable
* disable
| Enable/disable use of IP/MAC binding to filter packets that would normally go to the firewall. |
| | **undefinedhost** string | **Choices:*** allow
* block
| Select action to take on packets with IP/MAC addresses not in the binding list . |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 binding settings.
fortios_firewall_ipmacbinding_setting:
vdom: "{{ vdom }}"
firewall_ipmacbinding_setting:
bindthroughfw: "enable"
bindtofw: "enable"
undefinedhost: "allow"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_urlfilter – Configure URL filter lists in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_urlfilter – Configure URL filter 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_webfilter_urlfilter`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 urlfilter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_urlfilter** dictionary | | Configure URL filter lists. |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | URL filter entries. |
| | | **action** string | **Choices:*** exempt
* block
* allow
* monitor
| Action to take for URL filter matches. |
| | | **antiphish\_action** string | **Choices:*** block
* log
| Action to take for AntiPhishing matches. |
| | | **dns\_address\_family** string | **Choices:*** ipv4
* ipv6
* both
| Resolve IPv4 address, IPv6 address, or both from DNS server. |
| | | **exempt** list / elements=string | **Choices:*** av
* web-content
* activex-java-cookie
* dlp
* fortiguard
* range-block
* pass
* all
* antiphish
| If action is set to exempt, select the security profile operations that exempt URLs skip. Separate multiple options with a space. |
| | | **id** integer / required | | Id. |
| | | **referrer\_host** string | | Referrer host name. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this URL filter. |
| | | **type** string | **Choices:*** simple
* regex
* wildcard
| Filter type (simple, regex, or wildcard). |
| | | **url** string | | URL to be filtered. |
| | | **web\_proxy\_profile** string | | Web proxy profile. Source web-proxy.profile.name. |
| | **id** integer / required | | ID. |
| | **ip\_addr\_block** string | **Choices:*** enable
* disable
| Enable/disable blocking URLs when the hostname appears as an IP address. |
| | **name** string | | Name of URL filter list. |
| | **one\_arm\_ips\_urlfilter** string | **Choices:*** enable
* disable
| Enable/disable DNS resolver for one-arm IPS URL filter operation. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 URL filter lists.
fortios_webfilter_urlfilter:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_urlfilter:
comment: "Optional comments."
entries:
-
action: "exempt"
antiphish_action: "block"
dns_address_family: "ipv4"
exempt: "av"
id: "9"
referrer_host: "myhostname"
status: "enable"
type: "simple"
url: "myurl.com"
web_proxy_profile: "<your_own_value> (source web-proxy.profile.name)"
id: "15"
ip_addr_block: "enable"
name: "default_name_17"
one_arm_ips_urlfilter: "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_webfilter_ips_urlfilter_cache_setting – Configure IPS URL filter cache settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_ips\_urlfilter\_cache\_setting – Configure IPS URL filter cache 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_webfilter_ips_urlfilter_cache_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 webfilter feature and ips\_urlfilter\_cache\_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. |
| **webfilter\_ips\_urlfilter\_cache\_setting** dictionary | | Configure IPS URL filter cache settings. |
| | **dns\_retry\_interval** integer | | Retry interval. Refresh DNS faster than TTL to capture multiple IPs for hosts. 0 means use DNS server"s TTL only. |
| | **extended\_ttl** integer | | Extend time to live beyond reported by DNS. 0 means use DNS server"s TTL |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 cache settings.
fortios_webfilter_ips_urlfilter_cache_setting:
vdom: "{{ vdom }}"
webfilter_ips_urlfilter_cache_setting:
dns_retry_interval: "3"
extended_ttl: "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_snmp_user – Configure FortiSwitch SNMP v3 users globally in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_snmp\_user – Configure FortiSwitch SNMP v3 users 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_user`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_user** dictionary | | Configure FortiSwitch SNMP v3 users globally. |
| | **auth\_proto** string | **Choices:*** md5
* sha
* sha1
* sha224
* sha256
* sha384
* sha512
| Authentication protocol. |
| | **auth\_pwd** string | | Password for authentication protocol. |
| | **name** string / required | | SNMP user name. |
| | **priv\_proto** string | **Choices:*** aes
* des
* aes128
* aes192
* aes192c
* aes256
* aes256c
| Privacy (encryption) protocol. |
| | **priv\_pwd** string | | Password for privacy (encryption) protocol. |
| | **queries** string | **Choices:*** disable
* enable
| Enable/disable SNMP queries for this user. |
| | **query\_port** integer | | SNMPv3 query port . |
| | **security\_level** string | **Choices:*** no-auth-no-priv
* auth-no-priv
* auth-priv
| Security level for message authentication and encryption. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 v3 users globally.
fortios_switch_controller_snmp_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
name: "default_name_5"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "disable"
query_port: "9"
security_level: "no-auth-no-priv"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_region – Configure FortiAP regions (for floor plans and maps) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_region – Configure FortiAP regions (for floor plans and 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_wireless_controller_region`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 region category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_region** dictionary | | Configure FortiAP regions (for floor plans and maps). |
| | **comments** string | | Comments. |
| | **grayscale** string | **Choices:*** enable
* disable
| Region image grayscale. |
| | **image\_type** string | **Choices:*** png
* jpeg
* gif
| FortiAP region image type (png|jpeg|gif). |
| | **name** string / required | | FortiAP region name. |
| | **opacity** integer | | Region image opacity (0 - 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 FortiAP regions (for floor plans and maps).
fortios_wireless_controller_region:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_region:
comments: "<your_own_value>"
grayscale: "enable"
image_type: "png"
name: "default_name_6"
opacity: "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_log_syslogd2_filter – Filters for remote system server in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_syslogd2\_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_syslogd2_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 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\_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 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. |
| | **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_syslogd2_filter:
vdom: "{{ vdom }}"
log_syslogd2_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_wireless_controller_address – Configure the client with its MAC address in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_address – Configure the client with its MAC 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_wireless_controller_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 wireless\_controller 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. |
| **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\_address** dictionary | | Configure the client with its MAC address. |
| | **id** string / required | | ID. |
| | **mac** string | | MAC address. |
| | **policy** string | **Choices:*** allow
* deny
| Allow or block the client with this MAC address. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 client with its MAC address.
fortios_wireless_controller_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_address:
id: "3"
mac: "<your_own_value>"
policy: "allow"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_rule – Configure IPS rules in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_ips\_rule – Configure IPS 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_ips_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 ips 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **ips\_rule** dictionary | | Configure IPS rules. |
| | **action** string | **Choices:*** pass
* block
| Action. |
| | **application** string | | Vulnerable applications. |
| | **date** integer | | Date. |
| | **group** string | | Group. |
| | **location** string | | Vulnerable location. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **log\_packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | **metadata** list / elements=string | | Meta data. |
| | | **id** integer / required | | ID. |
| | | **metaid** integer | | Meta ID. |
| | | **valueid** integer | | Value ID. |
| | **name** string / required | | Rule name. |
| | **os** string | | Vulnerable operation systems. |
| | **rev** integer | | Revision. |
| | **rule\_id** integer | | Rule ID. |
| | **service** string | | Vulnerable service. |
| | **severity** string | | Severity. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable 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 IPS rules.
fortios_ips_rule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_rule:
action: "pass"
application: "<your_own_value>"
date: "5"
group: "<your_own_value>"
location: "<your_own_value>"
log: "disable"
log_packet: "disable"
metadata:
-
id: "11"
metaid: "12"
valueid: "13"
name: "default_name_14"
os: "<your_own_value>"
rev: "16"
rule_id: "17"
service: "<your_own_value>"
severity: "<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_vpn_ipsec_manualkey_interface – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_vpn\_ipsec\_manualkey\_interface – 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_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 manualkey\_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\_manualkey\_interface** dictionary | | Configure IPsec manual keys. |
| | **addr\_type** string | **Choices:*** 4
* 6
| IP version to use for IP packets. |
| | **auth\_alg** string | **Choices:*** **None** ←
* md5
* sha1
* sha256
* sha384
* sha512
| Authentication algorithm. Must be the same for both ends of the tunnel. |
| | **auth\_key** string | | Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens. |
| | **enc\_alg** string | **Choices:*** **None** ←
* des
* 3des
* aes128
* aes192
* aes256
* aria128
* aria192
* aria256
* seed
| Encryption algorithm. Must be the same for both ends of the tunnel. |
| | **enc\_key** string | | Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens. |
| | **interface** string | | Name of the physical, aggregate, or VLAN interface. Source system.interface.name. |
| | **ip\_version** string | **Choices:*** 4
* 6
| IP version to use for VPN interface. |
| | **local\_gw** string | | IPv4 address of the local gateway"s external interface. |
| | **local\_gw6** string | | Local IPv6 address of VPN gateway. |
| | **local\_spi** 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 offloading IPsec VPN manual key sessions to NPUs. |
| | **remote\_gw** string | | IPv4 address of the remote gateway"s external interface. |
| | **remote\_gw6** string | | Remote IPv6 address of VPN gateway. |
| | **remote\_spi** 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_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ipsec_manualkey_interface:
addr_type: "4"
auth_alg: "null"
auth_key: "<your_own_value>"
enc_alg: "null"
enc_key: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "4"
local_gw: "<your_own_value>"
local_gw6: "<your_own_value>"
local_spi: "<your_own_value>"
name: "default_name_13"
npu_offload: "enable"
remote_gw: "<your_own_value>"
remote_gw6: "<your_own_value>"
remote_spi: "<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_global – Configure global attributes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_global – Configure 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_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 system 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. |
| **system\_global** dictionary | | Configure global attributes. |
| | **admin\_concurrent** string | **Choices:*** enable
* disable
| Enable/disable concurrent administrator logins. (Use policy-auth-concurrent for firewall authenticated users.) |
| | **admin\_console\_timeout** integer | | Console login timeout that overrides the admintimeout value. (15 - 300 seconds) (15 seconds to 5 minutes). 0 the default, disables this timeout. |
| | **admin\_forticloud\_sso\_login** string | **Choices:*** enable
* disable
| Enable/disable FortiCloud admin login via SSO. |
| | **admin\_hsts\_max\_age** integer | | HTTPS Strict-Transport-Security header max-age in seconds. A value of 0 will reset any HSTS records in the browser.When admin-https-redirect is disabled the header max-age will be 0. |
| | **admin\_https\_pki\_required** string | **Choices:*** enable
* disable
| Enable/disable admin login method. Enable to force administrators to provide a valid certificate to log in if PKI is enabled. Disable to allow administrators to log in with a certificate or password. |
| | **admin\_https\_redirect** string | **Choices:*** enable
* disable
| Enable/disable redirection of HTTP administration access to HTTPS. |
| | **admin\_https\_ssl\_versions** list / elements=string | **Choices:*** tlsv1-0
* tlsv1-1
* tlsv1-2
* tlsv1-3
| Allowed TLS versions for web administration. |
| | **admin\_lockout\_duration** integer | | Amount of time in seconds that an administrator account is locked out after reaching the admin-lockout-threshold for repeated failed login attempts. |
| | **admin\_lockout\_threshold** integer | | Number of failed login attempts before an administrator account is locked out for the admin-lockout-duration. |
| | **admin\_login\_max** integer | | Maximum number of administrators who can be logged in at the same time (1 - 100) |
| | **admin\_maintainer** string | **Choices:*** enable
* disable
| Enable/disable maintainer administrator login. When enabled, the maintainer account can be used to log in from the console after a hard reboot. The password is "bcpb" followed by the FortiGate unit serial number. You have limited time to complete this login. |
| | **admin\_port** integer | | Administrative access port for HTTP. (1 - 65535). |
| | **admin\_restrict\_local** string | **Choices:*** enable
* disable
| Enable/disable local admin authentication restriction when remote authenticator is up and running. |
| | **admin\_scp** string | **Choices:*** enable
* disable
| Enable/disable using SCP to download the system configuration. You can use SCP as an alternative method for backing up the configuration. |
| | **admin\_server\_cert** string | | Server certificate that the FortiGate uses for HTTPS administrative connections. Source certificate.local.name. |
| | **admin\_sport** integer | | Administrative access port for HTTPS. (1 - 65535). |
| | **admin\_ssh\_grace\_time** integer | | Maximum time in seconds permitted between making an SSH connection to the FortiGate unit and authenticating (10 - 3600 sec (1 hour)). |
| | **admin\_ssh\_password** string | **Choices:*** enable
* disable
| Enable/disable password authentication for SSH admin access. |
| | **admin\_ssh\_port** integer | | Administrative access port for SSH. (1 - 65535). |
| | **admin\_ssh\_v1** string | **Choices:*** enable
* disable
| Enable/disable SSH v1 compatibility. |
| | **admin\_telnet** string | **Choices:*** enable
* disable
| Enable/disable TELNET service. |
| | **admin\_telnet\_port** integer | | Administrative access port for TELNET. (1 - 65535). |
| | **admintimeout** integer | | Number of minutes before an idle administrator session times out (5 - 480 minutes (8 hours)). A shorter idle timeout is more secure. |
| | **alias** string | | Alias for your FortiGate unit. |
| | **allow\_traffic\_redirect** string | **Choices:*** enable
* disable
| Disable to allow traffic to be routed back on a different interface. |
| | **anti\_replay** string | **Choices:*** disable
* loose
* strict
| Level of checking for packet replay and TCP sequence checking. |
| | **arp\_max\_entry** integer | | Maximum number of dynamically learned MAC addresses that can be added to the ARP table (131072 - 2147483647). |
| | **asymroute** string | **Choices:*** enable
* disable
| Enable/disable asymmetric route. |
| | **auth\_cert** string | | Server certificate that the FortiGate uses for HTTPS firewall authentication connections. Source certificate.local.name. |
| | **auth\_http\_port** integer | | User authentication HTTP port. (1 - 65535). |
| | **auth\_https\_port** integer | | User authentication HTTPS port. (1 - 65535). |
| | **auth\_keepalive** string | **Choices:*** enable
* disable
| Enable to prevent user authentication sessions from timing out when idle. |
| | **auth\_session\_limit** string | **Choices:*** block-new
* logout-inactive
| Action to take when the number of allowed user authenticated sessions is reached. |
| | **auto\_auth\_extension\_device** string | **Choices:*** enable
* disable
| Enable/disable automatic authorization of dedicated Fortinet extension devices. |
| | **autorun\_log\_fsck** string | **Choices:*** enable
* disable
| Enable/disable automatic log partition check after ungraceful shutdown. |
| | **av\_affinity** string | | Affinity setting for AV scanning (hexadecimal value up to 256 bits in the format of xxxxxxxxxxxxxxxx). |
| | **av\_failopen** string | **Choices:*** pass
* False
* one-shot
| Set the action to take if the FortiGate is running low on memory or the proxy connection limit has been reached. |
| | **av\_failopen\_session** string | **Choices:*** enable
* disable
| When enabled and a proxy for a protocol runs out of room in its session table, that protocol goes into failopen mode and enacts the action specified by av-failopen. |
| | **batch\_cmdb** string | **Choices:*** enable
* disable
| Enable/disable batch mode, allowing you to enter a series of CLI commands that will execute as a group once they are loaded. |
| | **block\_session\_timer** integer | | Duration in seconds for blocked sessions (1 - 300 sec (5 minutes)). |
| | **br\_fdb\_max\_entry** integer | | Maximum number of bridge forwarding database (FDB) entries. |
| | **cert\_chain\_max** integer | | Maximum number of certificates that can be traversed in a certificate chain. |
| | **cfg\_revert\_timeout** integer | | Time-out for reverting to the last saved configuration. |
| | **cfg\_save** string | **Choices:*** automatic
* manual
* revert
| Configuration file save mode for CLI changes. |
| | **check\_protocol\_header** string | **Choices:*** loose
* strict
| Level of checking performed on protocol headers. Strict checking is more thorough but may affect performance. Loose checking is ok in most cases. |
| | **check\_reset\_range** string | **Choices:*** strict
* disable
| Configure ICMP error message verification. You can either apply strict RST range checking or disable it. |
| | **cli\_audit\_log** string | **Choices:*** enable
* disable
| Enable/disable CLI audit log. |
| | **cloud\_communication** string | **Choices:*** enable
* disable
| Enable/disable all cloud communication. |
| | **clt\_cert\_req** string | **Choices:*** enable
* disable
| Enable/disable requiring administrators to have a client certificate to log into the GUI using HTTPS. |
| | **compliance\_check** string | **Choices:*** enable
* disable
| Enable/disable global PCI DSS compliance check. |
| | **compliance\_check\_time** string | | Time of day to run scheduled PCI DSS compliance checks. |
| | **cpu\_use\_threshold** integer | | Threshold at which CPU usage is reported. (% of total CPU). |
| | **csr\_ca\_attribute** string | **Choices:*** enable
* disable
| Enable/disable the CA attribute in certificates. Some CA servers reject CSRs that have the CA attribute. |
| | **daily\_restart** string | **Choices:*** enable
* disable
| Enable/disable daily restart of FortiGate unit. Use the restart-time option to set the time of day for the restart. |
| | **default\_service\_source\_port** string | | Default service source port range. |
| | **device\_identification\_active\_scan\_delay** integer | | Number of seconds to passively scan a device before performing an active scan. (20 - 3600 sec, (20 sec to 1 hour)). |
| | **device\_idle\_timeout** integer | | Time in seconds that a device must be idle to automatically log the device user out. (30 - 31536000 sec (30 sec to 1 year)). |
| | **dh\_params** string | **Choices:*** 1024
* 1536
* 2048
* 3072
* 4096
* 6144
* 8192
| Number of bits to use in the Diffie-Hellman exchange for HTTPS/SSH protocols. |
| | **dnsproxy\_worker\_count** integer | | DNS proxy worker count. |
| | **dst** string | **Choices:*** enable
* disable
| Enable/disable daylight saving time. |
| | **edit\_vdom\_prompt** string | **Choices:*** enable
* disable
| Enable/disable edit new VDOM prompt. |
| | **endpoint\_control\_fds\_access** string | **Choices:*** enable
* disable
| Enable/disable access to the FortiGuard network for non-compliant endpoints. |
| | **endpoint\_control\_portal\_port** integer | | Endpoint control portal port (1 - 65535). |
| | **failtime** integer | | Fail-time for server lost. |
| | **faz\_disk\_buffer\_size** integer | | Maximum disk buffer size to temporarily store logs destined for FortiAnalyzer. To be used in the event that FortiAnalyzer is unavailalble. |
| | **fds\_statistics** string | **Choices:*** enable
* disable
| Enable/disable sending IPS, Application Control, and AntiVirus data to FortiGuard. This data is used to improve FortiGuard services and is not shared with external parties and is protected by Fortinet"s privacy policy. |
| | **fds\_statistics\_period** integer | | FortiGuard statistics collection period in minutes. (1 - 1440 min (1 min to 24 hours)). |
| | **fec\_port** integer | | Local UDP port for Forward Error Correction (49152 - 65535). |
| | **fgd\_alert\_subscription** list / elements=string | **Choices:*** advisory
* latest-threat
* latest-virus
* latest-attack
* new-antivirus-db
* new-attack-db
| Type of alert to retrieve from FortiGuard. |
| | **fortiextender** string | **Choices:*** enable
* disable
| Enable/disable FortiExtender. |
| | **fortiextender\_data\_port** integer | | FortiExtender data port (1024 - 49150). |
| | **fortiextender\_vlan\_mode** string | **Choices:*** enable
* disable
| Enable/disable FortiExtender VLAN mode. |
| | **fortiipam\_integration** string | **Choices:*** enable
* disable
| Enable/disable integration with the FortiIPAM cloud service. |
| | **fortiservice\_port** integer | | FortiService port (1 - 65535). Used by FortiClient endpoint compliance. Older versions of FortiClient used a different port. |
| | **fortitoken\_cloud** string | **Choices:*** enable
* disable
| Enable/disable FortiToken Cloud service. |
| | **gui\_allow\_default\_hostname** string | **Choices:*** enable
* disable
| Enable/disable the GUI warning about using a default hostname |
| | **gui\_certificates** string | **Choices:*** enable
* disable
| Enable/disable the System > Certificate GUI page, allowing you to add and configure certificates from the GUI. |
| | **gui\_custom\_language** string | **Choices:*** enable
* disable
| Enable/disable custom languages in GUI. |
| | **gui\_date\_format** string | **Choices:*** yyyy/MM/dd
* dd/MM/yyyy
* MM/dd/yyyy
* yyyy-MM-dd
* dd-MM-yyyy
* MM-dd-yyyy
| Default date format used throughout GUI. |
| | **gui\_date\_time\_source** string | **Choices:*** system
* browser
| Source from which the FortiGate GUI uses to display date and time entries. |
| | **gui\_device\_latitude** string | | Add the latitude of the location of this FortiGate to position it on the Threat Map. |
| | **gui\_device\_longitude** string | | Add the longitude of the location of this FortiGate to position it on the Threat Map. |
| | **gui\_display\_hostname** string | **Choices:*** enable
* disable
| Enable/disable displaying the FortiGate"s hostname on the GUI login page. |
| | **gui\_firmware\_upgrade\_warning** string | **Choices:*** enable
* disable
| Enable/disable the firmware upgrade warning on the GUI. |
| | **gui\_forticare\_registration\_setup\_warning** string | **Choices:*** enable
* disable
| Enable/disable the FortiCare registration setup warning on the GUI. |
| | **gui\_fortigate\_cloud\_sandbox** string | **Choices:*** enable
* disable
| Enable/disable displaying FortiGate Cloud Sandbox on the GUI. |
| | **gui\_fortisandbox\_cloud** string | **Choices:*** enable
* disable
| Enable/disable displaying FortiSandbox Cloud on the GUI. |
| | **gui\_ipv6** string | **Choices:*** enable
* disable
| Enable/disable IPv6 settings on the GUI. |
| | **gui\_lines\_per\_page** integer | | Number of lines to display per page for web administration. |
| | **gui\_local\_out** string | **Choices:*** enable
* disable
| Enable/disable Local-out traffic on the GUI. |
| | **gui\_replacement\_message\_groups** string | **Choices:*** enable
* disable
| Enable/disable replacement message groups on the GUI. |
| | **gui\_rest\_api\_cache** string | **Choices:*** enable
* disable
| Enable/disable REST API result caching on FortiGate. |
| | **gui\_theme** string | **Choices:*** green
* red
* blue
* melongene
* mariner
* neutrino
* jade
* graphite
* retro
* dark-matter
* onyx
* eclipse
| Color scheme for the administration GUI. |
| | **gui\_wireless\_opensecurity** string | **Choices:*** enable
* disable
| Enable/disable wireless open security option on the GUI. |
| | **honor\_df** string | **Choices:*** enable
* disable
| Enable/disable honoring of Don"t-Fragment (DF) flag. |
| | **hostname** string | | FortiGate unit"s hostname. Most models will truncate names longer than 24 characters. Some models support hostnames up to 35 characters. |
| | **igmp\_state\_limit** integer | | Maximum number of IGMP memberships (96 - 64000). |
| | **interval** integer | | Dead gateway detection interval. |
| | **ip\_src\_port\_range** string | | IP source port range used for traffic originating from the FortiGate unit. |
| | **ips\_affinity** string | | Affinity setting for IPS (hexadecimal value up to 256 bits in the format of xxxxxxxxxxxxxxxx; allowed CPUs must be less than total number of IPS engine daemons). |
| | **ipsec\_asic\_offload** string | **Choices:*** enable
* disable
| Enable/disable ASIC offloading (hardware acceleration) for IPsec VPN traffic. Hardware acceleration can offload IPsec VPN sessions and accelerate encryption and decryption. |
| | **ipsec\_ha\_seqjump\_rate** integer | | ESP jump ahead rate (1G - 10G pps equivalent). |
| | **ipsec\_hmac\_offload** string | **Choices:*** enable
* disable
| Enable/disable offloading (hardware acceleration) of HMAC processing for IPsec VPN. |
| | **ipsec\_soft\_dec\_async** string | **Choices:*** enable
* disable
| Enable/disable software decryption asynchronization (using multiple CPUs to do decryption) for IPsec VPN traffic. |
| | **ipv6\_accept\_dad** integer | | Enable/disable acceptance of IPv6 Duplicate Address Detection (DAD). |
| | **ipv6\_allow\_anycast\_probe** string | **Choices:*** enable
* disable
| Enable/disable IPv6 address probe through Anycast. |
| | **ipv6\_allow\_traffic\_redirect** string | **Choices:*** enable
* disable
| Disable to prevent IPv6 traffic with same local ingress and egress interface from being forwarded without policy check. |
| | **irq\_time\_accounting** string | **Choices:*** auto
* force
| Configure CPU IRQ time accounting mode. |
| | **language** string | **Choices:*** english
* french
* spanish
* portuguese
* japanese
* trach
* simch
* korean
| GUI display language. |
| | **ldapconntimeout** integer | | Global timeout for connections with remote LDAP servers in milliseconds (1 - 300000). |
| | **lldp\_reception** string | **Choices:*** enable
* disable
| Enable/disable Link Layer Discovery Protocol (LLDP) reception. |
| | **lldp\_transmission** string | **Choices:*** enable
* disable
| Enable/disable Link Layer Discovery Protocol (LLDP) transmission. |
| | **log\_ssl\_connection** string | **Choices:*** enable
* disable
| Enable/disable logging of SSL connection events. |
| | **log\_uuid** string | **Choices:*** disable
* policy-only
* extended
| Whether UUIDs are added to traffic logs. You can disable UUIDs, add firewall policy UUIDs to traffic logs, or add all UUIDs to traffic logs. |
| | **log\_uuid\_address** string | **Choices:*** enable
* disable
| Enable/disable insertion of address UUIDs to traffic logs. |
| | **log\_uuid\_policy** string | **Choices:*** enable
* disable
| Enable/disable insertion of policy UUIDs to traffic logs. |
| | **login\_timestamp** string | **Choices:*** enable
* disable
| Enable/disable login time recording. |
| | **long\_vdom\_name** string | **Choices:*** enable
* disable
| Enable/disable long VDOM name support. |
| | **management\_ip** string | | Management IP address of this FortiGate. Used to log into this FortiGate from another FortiGate in the Security Fabric. |
| | **management\_port** integer | | Overriding port for management connection (Overrides admin port). |
| | **management\_vdom** string | | Management virtual domain name. Source system.vdom.name. |
| | **max\_dlpstat\_memory** integer | | Maximum DLP stat memory (0 - 4294967295). |
| | **max\_route\_cache\_size** integer | | Maximum number of IP route cache entries (0 - 2147483647). |
| | **mc\_ttl\_notchange** string | **Choices:*** enable
* disable
| Enable/disable no modification of multicast TTL. |
| | **memory\_use\_threshold\_extreme** integer | | Threshold at which memory usage is considered extreme (new sessions are dropped) (% of total RAM). |
| | **memory\_use\_threshold\_green** integer | | Threshold at which memory usage forces the FortiGate to exit conserve mode (% of total RAM). |
| | **memory\_use\_threshold\_red** integer | | Threshold at which memory usage forces the FortiGate to enter conserve mode (% of total RAM). |
| | **miglog\_affinity** string | | Affinity setting for logging (64-bit hexadecimal value in the format of xxxxxxxxxxxxxxxx). |
| | **miglogd\_children** integer | | Number of logging (miglogd) processes to be allowed to run. Higher number can reduce performance; lower number can slow log processing time. No logs will be dropped or lost if the number is changed. |
| | **multi\_factor\_authentication** string | **Choices:*** optional
* mandatory
| Enforce all login methods to require an additional authentication factor . |
| | **multicast\_forward** string | **Choices:*** enable
* disable
| Enable/disable multicast forwarding. |
| | **ndp\_max\_entry** integer | | Maximum number of NDP table entries (set to 65,536 or higher; if set to 0, kernel holds 65,536 entries). |
| | **per\_user\_bal** string | **Choices:*** enable
* disable
| Enable/disable per-user block/allow list filter. |
| | **per\_user\_bwl** string | **Choices:*** enable
* disable
| Enable/disable per-user black/white list filter. |
| | **policy\_auth\_concurrent** integer | | Number of concurrent firewall use logins from the same user (1 - 100). |
| | **post\_login\_banner** string | **Choices:*** disable
* enable
| Enable/disable displaying the administrator access disclaimer message after an administrator successfully logs in. |
| | **pre\_login\_banner** string | **Choices:*** enable
* disable
| Enable/disable displaying the administrator access disclaimer message on the login page before an administrator logs in. |
| | **private\_data\_encryption** string | **Choices:*** disable
* enable
| Enable/disable private data encryption using an AES 128-bit key. |
| | **proxy\_auth\_lifetime** string | **Choices:*** enable
* disable
| Enable/disable authenticated users lifetime control. This is a cap on the total time a proxy user can be authenticated for after which re-authentication will take place. |
| | **proxy\_auth\_lifetime\_timeout** integer | | Lifetime timeout in minutes for authenticated users (5 - 65535 min). |
| | **proxy\_auth\_timeout** integer | | Authentication timeout in minutes for authenticated users (1 - 300 min). |
| | **proxy\_cipher\_hardware\_acceleration** string | **Choices:*** disable
* enable
| Enable/disable using content processor (CP8 or CP9) hardware acceleration to encrypt and decrypt IPsec and SSL traffic. |
| | **proxy\_hardware\_acceleration** string | **Choices:*** disable
* enable
| Enable/disable email proxy hardware acceleration. |
| | **proxy\_kxp\_hardware\_acceleration** string | **Choices:*** disable
* enable
| Enable/disable using the content processor to accelerate KXP traffic. |
| | **proxy\_re\_authentication\_mode** string | **Choices:*** session
* traffic
* absolute
| Control if users must re-authenticate after a session is closed, traffic has been idle, or from the point at which the user was first created. |
| | **proxy\_resource\_mode** string | **Choices:*** enable
* disable
| Enable/disable use of the maximum memory usage on the FortiGate unit"s proxy processing of resources, such as block lists, allow lists, and external resources. |
| | **proxy\_worker\_count** integer | | Proxy worker count. |
| | **radius\_port** integer | | RADIUS service port number. |
| | **reboot\_upon\_config\_restore** string | **Choices:*** enable
* disable
| Enable/disable reboot of system upon restoring configuration. |
| | **refresh** integer | | Statistics refresh interval in GUI. |
| | **remoteauthtimeout** integer | | Number of seconds that the FortiGate waits for responses from remote RADIUS, LDAP, or TACACS+ authentication servers. (0-300 sec). |
| | **reset\_sessionless\_tcp** string | **Choices:*** enable
* disable
| Action to perform if the FortiGate receives a TCP packet but cannot find a corresponding session in its session table. NAT/Route mode only. |
| | **restart\_time** string | | Daily restart time (hh:mm). |
| | **revision\_backup\_on\_logout** string | **Choices:*** enable
* disable
| Enable/disable back-up of the latest configuration revision when an administrator logs out of the CLI or GUI. |
| | **revision\_image\_auto\_backup** string | **Choices:*** enable
* disable
| Enable/disable back-up of the latest configuration revision after the firmware is upgraded. |
| | **scanunit\_count** integer | | Number of scanunits. The range and the default depend on the number of CPUs. Only available on FortiGate units with multiple CPUs. |
| | **security\_rating\_result\_submission** string | **Choices:*** enable
* disable
| Enable/disable the submission of Security Rating results to FortiGuard. |
| | **security\_rating\_run\_on\_schedule** string | **Choices:*** enable
* disable
| Enable/disable scheduled runs of Security Rating. |
| | **send\_pmtu\_icmp** string | **Choices:*** enable
* disable
| Enable/disable sending of path maximum transmission unit (PMTU) - ICMP destination unreachable packet and to support PMTUD protocol on your network to reduce fragmentation of packets. |
| | **snat\_route\_change** string | **Choices:*** enable
* disable
| Enable/disable the ability to change the static NAT route. |
| | **special\_file\_23\_support** string | **Choices:*** disable
* enable
| Enable/disable IPS detection of HIBUN format files when using Data Leak Protection. |
| | **split\_port** string | | Split port(s) to multiple 10Gbps ports. |
| | **ssd\_trim\_date** integer | | Date within a month to run ssd trim. |
| | **ssd\_trim\_freq** string | **Choices:*** never
* hourly
* daily
* weekly
* monthly
| How often to run SSD Trim . SSD Trim prevents SSD drive data loss by finding and isolating errors. |
| | **ssd\_trim\_hour** integer | | Hour of the day on which to run SSD Trim (0 - 23). |
| | **ssd\_trim\_min** integer | | Minute of the hour on which to run SSD Trim (0 - 59, 60 for random). |
| | **ssd\_trim\_weekday** string | **Choices:*** sunday
* monday
* tuesday
* wednesday
* thursday
* friday
* saturday
| Day of week to run SSD Trim. |
| | **ssh\_cbc\_cipher** string | **Choices:*** enable
* disable
| Enable/disable CBC cipher for SSH access. |
| | **ssh\_hmac\_md5** string | **Choices:*** enable
* disable
| Enable/disable HMAC-MD5 for SSH access. |
| | **ssh\_kex\_sha1** string | **Choices:*** enable
* disable
| Enable/disable SHA1 key exchange for SSH access. |
| | **ssh\_mac\_weak** string | **Choices:*** enable
* disable
| Enable/disable HMAC-SHA1 and UMAC-64-ETM for SSH access. |
| | **ssl\_min\_proto\_version** string | **Choices:*** SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
* TLSv1-3
| Minimum supported protocol version for SSL/TLS connections . |
| | **ssl\_static\_key\_ciphers** string | **Choices:*** enable
* disable
| Enable/disable static key ciphers in SSL/TLS connections (e.g. AES128-SHA, AES256-SHA, AES128-SHA256, AES256-SHA256). |
| | **sslvpn\_cipher\_hardware\_acceleration** string | **Choices:*** enable
* disable
| Enable/disable SSL VPN hardware acceleration. |
| | **sslvpn\_ems\_sn\_check** string | **Choices:*** enable
* disable
| Enable/disable verification of EMS serial number in SSL-VPN connection. |
| | **sslvpn\_kxp\_hardware\_acceleration** string | **Choices:*** enable
* disable
| Enable/disable SSL VPN KXP hardware acceleration. |
| | **sslvpn\_max\_worker\_count** integer | | Maximum number of SSL VPN processes. Upper limit for this value is the number of CPUs and depends on the model. |
| | **sslvpn\_plugin\_version\_check** string | **Choices:*** enable
* disable
| Enable/disable checking browser"s plugin version by SSL VPN. |
| | **strict\_dirty\_session\_check** string | **Choices:*** enable
* disable
| Enable to check the session against the original policy when revalidating. This can prevent dropping of redirected sessions when web-filtering and authentication are enabled together. If this option is enabled, the FortiGate unit deletes a session if a routing or policy change causes the session to no longer match the policy that originally allowed the session. |
| | **strong\_crypto** string | **Choices:*** enable
* disable
| Enable to use strong encryption and only allow strong ciphers (AES, 3DES) and digest (SHA1) for HTTPS/SSH/TLS/SSL functions. |
| | **switch\_controller** string | **Choices:*** disable
* enable
| Enable/disable switch controller feature. Switch controller allows you to manage FortiSwitch from the FortiGate itself. |
| | **switch\_controller\_reserved\_network** string | | Enable reserved network subnet for controlled switches. This is available when the switch controller is enabled. |
| | **sys\_perf\_log\_interval** integer | | Time in minutes between updates of performance statistics logging. (1 - 15 min). |
| | **tcp\_halfclose\_timer** integer | | Number of seconds the FortiGate unit should wait to close a session after one peer has sent a FIN packet but the other has not responded (1 - 86400 sec (1 day)). |
| | **tcp\_halfopen\_timer** integer | | Number of seconds the FortiGate unit should wait to close a session after one peer has sent an open session packet but the other has not responded (1 - 86400 sec (1 day)). |
| | **tcp\_option** string | **Choices:*** enable
* disable
| Enable SACK, timestamp and MSS TCP options. |
| | **tcp\_rst\_timer** integer | | Length of the TCP CLOSE state in seconds (5 - 300 sec). |
| | **tcp\_timewait\_timer** integer | | Length of the TCP TIME-WAIT state in seconds. |
| | **tftp** string | **Choices:*** enable
* disable
| Enable/disable TFTP. |
| | **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
| Number corresponding to your time zone from 00 to 86. Enter set timezone ? to view the list of time zones and the numbers that represent them. |
| | **tp\_mc\_skip\_policy** string | **Choices:*** enable
* disable
| Enable/disable skip policy check and allow multicast through. |
| | **traffic\_priority** string | **Choices:*** tos
* dscp
| Choose Type of Service (ToS) or Differentiated Services Code Point (DSCP) for traffic prioritization in traffic shaping. |
| | **traffic\_priority\_level** string | **Choices:*** low
* medium
* high
| Default system-wide level of priority for traffic prioritization. |
| | **two\_factor\_email\_expiry** integer | | Email-based two-factor authentication session timeout (30 - 300 seconds (5 minutes)). |
| | **two\_factor\_fac\_expiry** integer | | FortiAuthenticator token authentication session timeout (10 - 3600 seconds (1 hour)). |
| | **two\_factor\_ftk\_expiry** integer | | FortiToken authentication session timeout (60 - 600 sec (10 minutes)). |
| | **two\_factor\_ftm\_expiry** integer | | FortiToken Mobile session timeout (1 - 168 hours (7 days)). |
| | **two\_factor\_sms\_expiry** integer | | SMS-based two-factor authentication session timeout (30 - 300 sec). |
| | **udp\_idle\_timer** integer | | UDP connection session timeout. This command can be useful in managing CPU and memory resources (1 - 86400 seconds (1 day)). |
| | **url\_filter\_affinity** string | | URL filter CPU affinity. |
| | **url\_filter\_count** integer | | URL filter daemon count. |
| | **user\_device\_store\_max\_devices** integer | | Maximum number of devices allowed in user device store. |
| | **user\_device\_store\_max\_users** integer | | Maximum number of users allowed in user device store. |
| | **user\_server\_cert** string | | Certificate to use for https user authentication. Source certificate.local.name. |
| | **vdom\_admin** string | **Choices:*** enable
* disable
| Enable/disable support for multiple virtual domains (VDOMs). |
| | **vdom\_mode** string | **Choices:*** no-vdom
* split-vdom
* multi-vdom
| Enable/disable support for split/multiple virtual domains (VDOMs). |
| | **vip\_arp\_range** string | **Choices:*** unlimited
* restricted
| Controls the number of ARPs that the FortiGate sends for a Virtual IP (VIP) address range. |
| | **virtual\_server\_count** integer | | Maximum number of virtual server processes to create. The maximum is the number of CPU cores. This is not available on single-core CPUs. |
| | **virtual\_server\_hardware\_acceleration** string | **Choices:*** disable
* enable
| Enable/disable virtual server hardware acceleration. |
| | **wad\_affinity** string | | Affinity setting for wad (hexadecimal value up to 256 bits in the format of xxxxxxxxxxxxxxxx). |
| | **wad\_csvc\_cs\_count** integer | | Number of concurrent WAD-cache-service object-cache processes. |
| | **wad\_csvc\_db\_count** integer | | Number of concurrent WAD-cache-service byte-cache processes. |
| | **wad\_memory\_change\_granularity** integer | | Minimum percentage change in system memory usage detected by the wad daemon prior to adjusting TCP window size for any active connection. |
| | **wad\_source\_affinity** string | **Choices:*** disable
* enable
| Enable/disable dispatching traffic to WAD workers based on source affinity. |
| | **wad\_worker\_count** integer | | Number of explicit proxy WAN optimization daemon (WAD) processes. By default WAN optimization, explicit proxy, and web caching is handled by all of the CPU cores in a FortiGate unit. |
| | **wifi\_ca\_certificate** string | | CA certificate that verifies the WiFi certificate. Source certificate.ca.name. |
| | **wifi\_certificate** string | | Certificate to use for WiFi authentication. Source certificate.local.name. |
| | **wimax\_4g\_usb** string | **Choices:*** enable
* disable
| Enable/disable comparability with WiMAX 4G USB devices. |
| | **wireless\_controller** string | **Choices:*** enable
* disable
| Enable/disable the wireless controller feature to use the FortiGate unit to manage FortiAPs. |
| | **wireless\_controller\_port** integer | | Port used for the control channel in wireless controller mode (wireless-mode is ac). The data channel port is the control channel port number plus one (1024 - 49150). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 attributes.
fortios_system_global:
vdom: "{{ vdom }}"
system_global:
admin_concurrent: "enable"
admin_console_timeout: "4"
admin_forticloud_sso_login: "enable"
admin_hsts_max_age: "6"
admin_https_pki_required: "enable"
admin_https_redirect: "enable"
admin_https_ssl_versions: "tlsv1-0"
admin_lockout_duration: "10"
admin_lockout_threshold: "11"
admin_login_max: "12"
admin_maintainer: "enable"
admin_port: "14"
admin_restrict_local: "enable"
admin_scp: "enable"
admin_server_cert: "<your_own_value> (source certificate.local.name)"
admin_sport: "18"
admin_ssh_grace_time: "19"
admin_ssh_password: "enable"
admin_ssh_port: "21"
admin_ssh_v1: "enable"
admin_telnet: "enable"
admin_telnet_port: "24"
admintimeout: "25"
alias: "<your_own_value>"
allow_traffic_redirect: "enable"
anti_replay: "disable"
arp_max_entry: "29"
asymroute: "enable"
auth_cert: "<your_own_value> (source certificate.local.name)"
auth_http_port: "32"
auth_https_port: "33"
auth_keepalive: "enable"
auth_session_limit: "block-new"
auto_auth_extension_device: "enable"
autorun_log_fsck: "enable"
av_affinity: "<your_own_value>"
av_failopen: "pass"
av_failopen_session: "enable"
batch_cmdb: "enable"
block_session_timer: "42"
br_fdb_max_entry: "43"
cert_chain_max: "44"
cfg_revert_timeout: "45"
cfg_save: "automatic"
check_protocol_header: "loose"
check_reset_range: "strict"
cli_audit_log: "enable"
cloud_communication: "enable"
clt_cert_req: "enable"
compliance_check: "enable"
compliance_check_time: "<your_own_value>"
cpu_use_threshold: "54"
csr_ca_attribute: "enable"
daily_restart: "enable"
default_service_source_port: "<your_own_value>"
device_identification_active_scan_delay: "58"
device_idle_timeout: "59"
dh_params: "1024"
dnsproxy_worker_count: "61"
dst: "enable"
edit_vdom_prompt: "enable"
endpoint_control_fds_access: "enable"
endpoint_control_portal_port: "65"
failtime: "66"
faz_disk_buffer_size: "67"
fds_statistics: "enable"
fds_statistics_period: "69"
fec_port: "70"
fgd_alert_subscription: "advisory"
fortiextender: "enable"
fortiextender_data_port: "73"
fortiextender_vlan_mode: "enable"
fortiipam_integration: "enable"
fortiservice_port: "76"
fortitoken_cloud: "enable"
gui_allow_default_hostname: "enable"
gui_certificates: "enable"
gui_custom_language: "enable"
gui_date_format: "yyyy/MM/dd"
gui_date_time_source: "system"
gui_device_latitude: "<your_own_value>"
gui_device_longitude: "<your_own_value>"
gui_display_hostname: "enable"
gui_firmware_upgrade_warning: "enable"
gui_forticare_registration_setup_warning: "enable"
gui_fortigate_cloud_sandbox: "enable"
gui_fortisandbox_cloud: "enable"
gui_ipv6: "enable"
gui_lines_per_page: "91"
gui_local_out: "enable"
gui_replacement_message_groups: "enable"
gui_rest_api_cache: "enable"
gui_theme: "green"
gui_wireless_opensecurity: "enable"
honor_df: "enable"
hostname: "myhostname"
igmp_state_limit: "99"
interval: "100"
ip_src_port_range: "<your_own_value>"
ips_affinity: "<your_own_value>"
ipsec_asic_offload: "enable"
ipsec_ha_seqjump_rate: "104"
ipsec_hmac_offload: "enable"
ipsec_soft_dec_async: "enable"
ipv6_accept_dad: "107"
ipv6_allow_anycast_probe: "enable"
ipv6_allow_traffic_redirect: "enable"
irq_time_accounting: "auto"
language: "english"
ldapconntimeout: "112"
lldp_reception: "enable"
lldp_transmission: "enable"
log_ssl_connection: "enable"
log_uuid: "disable"
log_uuid_address: "enable"
log_uuid_policy: "enable"
login_timestamp: "enable"
long_vdom_name: "enable"
management_ip: "<your_own_value>"
management_port: "122"
management_vdom: "<your_own_value> (source system.vdom.name)"
max_dlpstat_memory: "124"
max_route_cache_size: "125"
mc_ttl_notchange: "enable"
memory_use_threshold_extreme: "127"
memory_use_threshold_green: "128"
memory_use_threshold_red: "129"
miglog_affinity: "<your_own_value>"
miglogd_children: "131"
multi_factor_authentication: "optional"
multicast_forward: "enable"
ndp_max_entry: "134"
per_user_bal: "enable"
per_user_bwl: "enable"
policy_auth_concurrent: "137"
post_login_banner: "disable"
pre_login_banner: "enable"
private_data_encryption: "disable"
proxy_auth_lifetime: "enable"
proxy_auth_lifetime_timeout: "142"
proxy_auth_timeout: "143"
proxy_cipher_hardware_acceleration: "disable"
proxy_hardware_acceleration: "disable"
proxy_kxp_hardware_acceleration: "disable"
proxy_re_authentication_mode: "session"
proxy_resource_mode: "enable"
proxy_worker_count: "149"
radius_port: "150"
reboot_upon_config_restore: "enable"
refresh: "152"
remoteauthtimeout: "153"
reset_sessionless_tcp: "enable"
restart_time: "<your_own_value>"
revision_backup_on_logout: "enable"
revision_image_auto_backup: "enable"
scanunit_count: "158"
security_rating_result_submission: "enable"
security_rating_run_on_schedule: "enable"
send_pmtu_icmp: "enable"
snat_route_change: "enable"
special_file_23_support: "disable"
split_port: "<your_own_value>"
ssd_trim_date: "165"
ssd_trim_freq: "never"
ssd_trim_hour: "167"
ssd_trim_min: "168"
ssd_trim_weekday: "sunday"
ssh_cbc_cipher: "enable"
ssh_hmac_md5: "enable"
ssh_kex_sha1: "enable"
ssh_mac_weak: "enable"
ssl_min_proto_version: "SSLv3"
ssl_static_key_ciphers: "enable"
sslvpn_cipher_hardware_acceleration: "enable"
sslvpn_ems_sn_check: "enable"
sslvpn_kxp_hardware_acceleration: "enable"
sslvpn_max_worker_count: "179"
sslvpn_plugin_version_check: "enable"
strict_dirty_session_check: "enable"
strong_crypto: "enable"
switch_controller: "disable"
switch_controller_reserved_network: "<your_own_value>"
sys_perf_log_interval: "185"
tcp_halfclose_timer: "186"
tcp_halfopen_timer: "187"
tcp_option: "enable"
tcp_rst_timer: "189"
tcp_timewait_timer: "190"
tftp: "enable"
timezone: "01"
tp_mc_skip_policy: "enable"
traffic_priority: "tos"
traffic_priority_level: "low"
two_factor_email_expiry: "196"
two_factor_fac_expiry: "197"
two_factor_ftk_expiry: "198"
two_factor_ftm_expiry: "199"
two_factor_sms_expiry: "200"
udp_idle_timer: "201"
url_filter_affinity: "<your_own_value>"
url_filter_count: "203"
user_device_store_max_devices: "204"
user_device_store_max_users: "205"
user_server_cert: "<your_own_value> (source certificate.local.name)"
vdom_admin: "enable"
vdom_mode: "no-vdom"
vip_arp_range: "unlimited"
virtual_server_count: "210"
virtual_server_hardware_acceleration: "disable"
wad_affinity: "<your_own_value>"
wad_csvc_cs_count: "213"
wad_csvc_db_count: "214"
wad_memory_change_granularity: "215"
wad_source_affinity: "disable"
wad_worker_count: "217"
wifi_ca_certificate: "<your_own_value> (source certificate.ca.name)"
wifi_certificate: "<your_own_value> (source certificate.local.name)"
wimax_4g_usb: "enable"
wireless_controller: "enable"
wireless_controller_port: "222"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_ippool6 – Configure IPv6 IP pools in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ippool6 – Configure IPv6 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_ippool6`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ippool6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ippool6** dictionary | | Configure IPv6 IP pools. |
| | **comments** string | | Comment. |
| | **endip** string | | Final IPv6 address (inclusive) in the range for the address pool (format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **name** string / required | | IPv6 IP pool name. |
| | **startip** string | | First IPv6 address (inclusive) in the range for the address pool (format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| **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 IP pools.
fortios_firewall_ippool6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ippool6:
comments: "<your_own_value>"
endip: "<your_own_value>"
name: "default_name_5"
startip: "<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_tacacsplus – Configure TACACS+ server entries in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_tacacsplus – Configure TACACS+ 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_tacacsplus`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 tacacsplus category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_tacacsplus** dictionary | | Configure TACACS+ server entries. |
| | **authen\_type** string | **Choices:*** mschap
* chap
* pap
* ascii
* auto
| Allowed authentication protocols/methods. |
| | **authorization** string | **Choices:*** enable
* disable
| Enable/disable TACACS+ authorization. |
| | **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 to access the primary server. |
| | **name** string / required | | TACACS+ server entry name. |
| | **port** integer | | Port number of the TACACS+ server. |
| | **secondary\_key** string | | Key to access the secondary server. |
| | **secondary\_server** string | | Secondary TACACS+ server CN domain name or IP address. |
| | **server** string | | Primary TACACS+ server CN domain name or IP address. |
| | **source\_ip** string | | source IP for communications to TACACS+ server. |
| | **tertiary\_key** string | | Key to access the tertiary server. |
| | **tertiary\_server** string | | Tertiary TACACS+ server CN domain name or IP 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 TACACS+ server entries.
fortios_user_tacacsplus:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_tacacsplus:
authen_type: "mschap"
authorization: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
key: "<your_own_value>"
name: "default_name_8"
port: "9"
secondary_key: "<your_own_value>"
secondary_server: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
tertiary_key: "<your_own_value>"
tertiary_server: "<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_action – Action for automation stitches in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_automation\_action – Action for automation stitches in Fortinet’s FortiOS and FortiGate.
==========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_action`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_action category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_action** dictionary | | Action for automation stitches. |
| | **accprofile** string | | Access profile for CLI script action to access FortiGate features. Source system.accprofile.name. |
| | **action\_type** string | **Choices:*** email
* ios-notification
* alert
* disable-ssid
* quarantine
* quarantine-forticlient
* ban-ip
* aws-lambda
* webhook
* quarantine-nsx
* azure-function
* google-cloud-function
* alicloud-function
* cli-script
* quarantine-fortinac
* slack-notification
* fortiexplorer-notification
* microsoft-teams-notification
| Action type. |
| | **alicloud\_access\_key\_id** string | | AliCloud AccessKey ID. |
| | **alicloud\_access\_key\_secret** string | | AliCloud AccessKey secret. |
| | **alicloud\_account\_id** string | | AliCloud account ID. |
| | **alicloud\_function** string | | AliCloud function name. |
| | **alicloud\_function\_authorization** string | **Choices:*** anonymous
* function
| AliCloud function authorization type. |
| | **alicloud\_function\_domain** string | | AliCloud function domain. |
| | **alicloud\_region** string | | AliCloud region. |
| | **alicloud\_service** string | | AliCloud service name. |
| | **alicloud\_version** string | | AliCloud version. |
| | **aws\_api\_id** string | | AWS API Gateway ID. |
| | **aws\_api\_key** string | | AWS API Gateway API key. |
| | **aws\_api\_path** string | | AWS API Gateway path. |
| | **aws\_api\_stage** string | | AWS API Gateway deployment stage name. |
| | **aws\_domain** string | | AWS domain. |
| | **aws\_region** string | | AWS region. |
| | **azure\_api\_key** string | | Azure function API key. |
| | **azure\_app** string | | Azure function application name. |
| | **azure\_domain** string | | Azure function domain. |
| | **azure\_function** string | | Azure function name. |
| | **azure\_function\_authorization** string | **Choices:*** anonymous
* function
* admin
| Azure function authorization level. |
| | **delay** integer | | Delay before execution (in seconds). |
| | **description** string | | Description. |
| | **email\_body** string | | Email body. |
| | **email\_from** string | | Email sender name. |
| | **email\_subject** string | | Email subject. |
| | **email\_to** list / elements=string | | Email addresses. |
| | | **name** string / required | | Email address. |
| | **gcp\_function** string | | Google Cloud function name. |
| | **gcp\_function\_domain** string | | Google Cloud function domain. |
| | **gcp\_function\_region** string | | Google Cloud function region. |
| | **gcp\_project** string | | Google Cloud Platform project name. |
| | **headers** list / elements=string | | Request headers. |
| | | **header** string / required | | Request header. |
| | **http\_body** string | | Request body (if necessary). Should be serialized json string. |
| | **message** string | | Message content. |
| | **message\_type** string | **Choices:*** text
* json
| Message type. |
| | **method** string | **Choices:*** post
* put
* get
* patch
* delete
| Request method (GET, POST or PUT). |
| | **minimum\_interval** integer | | Limit execution to no more than once in this interval (in seconds). |
| | **name** string / required | | Name. |
| | **port** integer | | Protocol port. |
| | **protocol** string | **Choices:*** http
* https
| Request protocol. |
| | **replacement\_message** string | **Choices:*** enable
* disable
| Enable/disable replacement message. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **required** string | **Choices:*** enable
* disable
| Required in action chain. |
| | **script** string | | CLI script. |
| | **sdn\_connector** list / elements=string | | NSX SDN connector names. |
| | | **name** string / required | | SDN connector name. Source system.sdn-connector.name. |
| | **security\_tag** string | | NSX security tag. |
| | **tls\_certificate** string | | Custom TLS certificate for API request. Source certificate.local.name. |
| | **uri** string | | Request API URI. |
| | **verify\_host\_cert** string | **Choices:*** enable
* disable
| Enable/disable verification of the remote host certificate. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: Action for automation stitches.
fortios_system_automation_action:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_automation_action:
accprofile: "<your_own_value> (source system.accprofile.name)"
action_type: "email"
alicloud_access_key_id: "<your_own_value>"
alicloud_access_key_secret: "<your_own_value>"
alicloud_account_id: "<your_own_value>"
alicloud_function: "<your_own_value>"
alicloud_function_authorization: "anonymous"
alicloud_function_domain: "<your_own_value>"
alicloud_region: "<your_own_value>"
alicloud_service: "<your_own_value>"
alicloud_version: "<your_own_value>"
aws_api_id: "<your_own_value>"
aws_api_key: "<your_own_value>"
aws_api_path: "<your_own_value>"
aws_api_stage: "<your_own_value>"
aws_domain: "<your_own_value>"
aws_region: "<your_own_value>"
azure_api_key: "<your_own_value>"
azure_app: "<your_own_value>"
azure_domain: "<your_own_value>"
azure_function: "<your_own_value>"
azure_function_authorization: "anonymous"
delay: "25"
description: "<your_own_value>"
email_body: "<your_own_value>"
email_from: "<your_own_value>"
email_subject: "<your_own_value>"
email_to:
-
name: "default_name_31"
gcp_function: "<your_own_value>"
gcp_function_domain: "<your_own_value>"
gcp_function_region: "<your_own_value>"
gcp_project: "<your_own_value>"
headers:
-
header: "<your_own_value>"
http_body: "<your_own_value>"
message: "<your_own_value>"
message_type: "text"
method: "post"
minimum_interval: "42"
name: "default_name_43"
port: "44"
protocol: "http"
replacement_message: "enable"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
required: "enable"
script: "<your_own_value>"
sdn_connector:
-
name: "default_name_51 (source system.sdn-connector.name)"
security_tag: "<your_own_value>"
tls_certificate: "<your_own_value> (source certificate.local.name)"
uri: "<your_own_value>"
verify_host_cert: "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_custom_field – Configure custom log fields in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_custom\_field – Configure custom log fields in Fortinet’s FortiOS and FortiGate.
===============================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_custom_field`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 custom\_field category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_custom\_field** dictionary | | Configure custom log fields. |
| | **id** string / required | | field ID <string>. |
| | **name** string | | Field name (max: 15 characters). |
| | **value** string | | Field value (max: 15 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 custom log fields.
fortios_log_custom_field:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
log_custom_field:
id: "3"
name: "default_name_4"
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_extender_controller_dataplan – FortiExtender dataplan configuration in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_extender\_controller\_dataplan – FortiExtender dataplan 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_dataplan`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 dataplan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_dataplan** dictionary | | FortiExtender dataplan configuration. |
| | **APN** string | | APN configuration. |
| | **apn** string | | APN configuration. |
| | **auth\_type** string | **Choices:*** none
* pap
* chap
| Authentication type. |
| | **billing\_date** integer | | Billing day of the month (1 - 31). |
| | **capacity** integer | | Capacity in MB (0 - 102400000). |
| | **carrier** string | | Carrier configuration. |
| | **iccid** string | | ICCID configuration. |
| | **modem\_id** string | **Choices:*** modem1
* modem2
* all
| Dataplan"s modem specifics, if any. |
| | **monthly\_fee** integer | | Monthly fee of dataplan (0 - 100000, in local currency). |
| | **name** string / required | | FortiExtender dataplan name |
| | **overage** string | **Choices:*** disable
* enable
| Enable/disable dataplan overage detection. |
| | **password** string | | Password. |
| | **PDN** string | **Choices:*** ipv4-only
* ipv6-only
* ipv4-ipv6
| PDN type. |
| | **pdn** string | **Choices:*** ipv4-only
* ipv6-only
* ipv4-ipv6
| PDN type. |
| | **preferred\_subnet** integer | | Preferred subnet mask (8 - 32). |
| | **private\_network** string | **Choices:*** disable
* enable
| Enable/disable dataplan private network support. |
| | **signal\_period** integer | | Signal period (600 to 18000 seconds). |
| | **signal\_threshold** integer | | Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100 dBm. |
| | **slot** string | **Choices:*** sim1
* sim2
| SIM slot configuration. |
| | **type** string | **Choices:*** carrier
* slot
* iccid
* generic
| Type preferences configuration. |
| | **username** string | | Username. |
| **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: FortiExtender dataplan configuration.
fortios_extender_controller_dataplan:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extender_controller_dataplan:
apn: "<your_own_value>"
APN: "<your_own_value>"
auth_type: "none"
billing_date: "6"
capacity: "7"
carrier: "<your_own_value>"
iccid: "<your_own_value>"
modem_id: "modem1"
monthly_fee: "11"
name: "default_name_12"
overage: "disable"
password: "<your_own_value>"
pdn: "ipv4-only"
PDN: "ipv4-only"
preferred_subnet: "17"
private_network: "disable"
signal_period: "19"
signal_threshold: "20"
slot: "sim1"
type: "carrier"
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_snmp – Configure SNMP in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_snmp – Configure SNMP in Fortinet’s FortiOS and FortiGate.
==========================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_snmp`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 snmp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_snmp** dictionary | | Configure SNMP. |
| | **community** list / elements=string | | SNMP Community Configuration. |
| | | **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 | | Community ID. |
| | | **name** string | | Community name. |
| | | **query\_v1\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v1 queries. |
| | | **query\_v2c\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v2c queries. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable this SNMP community. |
| | | **trap\_v1\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v1 traps. |
| | | **trap\_v2c\_status** string | **Choices:*** enable
* disable
| Enable/disable SNMP v2c traps. |
| | **contact\_info** string | | Contact Information. |
| | **engine\_id** string | | AC SNMP engineId string (maximum 24 characters). |
| | **trap\_high\_cpu\_threshold** integer | | CPU usage when trap is sent. |
| | **trap\_high\_mem\_threshold** integer | | Memory usage when trap is sent. |
| | **user** list / elements=string | | SNMP User Configuration. |
| | | **auth\_proto** string | **Choices:*** md5
* sha
| Authentication protocol. |
| | | **auth\_pwd** string | | Password for authentication protocol. |
| | | **name** string / required | | SNMP User Name |
| | | **notify\_hosts** string | | Configure SNMP User Notify Hosts. |
| | | **priv\_proto** string | **Choices:*** aes
* des
* aes256
* aes256cisco
| Privacy (encryption) protocol. |
| | | **priv\_pwd** string | | Password for privacy (encryption) protocol. |
| | | **queries** string | **Choices:*** enable
* disable
| Enable/disable SNMP queries for this user. |
| | | **security\_level** string | **Choices:*** no-auth-no-priv
* auth-no-priv
* auth-priv
| Security level for message authentication and encryption. |
| | | **status** string | **Choices:*** enable
* disable
| SNMP User Enable |
| | | **trap\_status** string | **Choices:*** enable
* disable
| Enable/disable traps for this SNMP user. |
Notes
-----
Note
* Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
```
- hosts: fortigates
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 SNMP.
fortios_wireless_controller_snmp:
vdom: "{{ vdom }}"
wireless_controller_snmp:
community:
-
hosts:
-
id: "5"
ip: "<your_own_value>"
id: "7"
name: "default_name_8"
query_v1_status: "enable"
query_v2c_status: "enable"
status: "enable"
trap_v1_status: "enable"
trap_v2c_status: "enable"
contact_info: "<your_own_value>"
engine_id: "<your_own_value>"
trap_high_cpu_threshold: "16"
trap_high_mem_threshold: "17"
user:
-
auth_proto: "md5"
auth_pwd: "<your_own_value>"
name: "default_name_21"
notify_hosts: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
security_level: "no-auth-no-priv"
status: "enable"
trap_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_certificate_ca – CA certificate in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_certificate\_ca – CA certificate in Fortinet’s FortiOS and FortiGate.
===============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ca`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host 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\_ca** dictionary | | CA certificate. |
| | **auto\_update\_days** integer | | Number of days to wait before requesting an updated CA certificate (0 - 4294967295, 0 = disabled). |
| | **auto\_update\_days\_warning** integer | | Number of days before an expiry-warning message is generated (0 - 4294967295, 0 = disabled). |
| | **ca** string | | CA certificate as a PEM file. |
| | **last\_updated** integer | | Time at which CA was last updated. |
| | **name** string / required | | Name. |
| | **range** string | **Choices:*** global
* vdom
| Either global or VDOM IP address range for the CA certificate. |
| | **scep\_url** string | | URL of the SCEP server. |
| | **source** string | **Choices:*** factory
* user
* bundle
| CA certificate source type. |
| | **source\_ip** string | | Source IP address for communications to the SCEP server. |
| | **ssl\_inspection\_trusted** string | **Choices:*** enable
* disable
| Enable/disable this CA as a trusted CA for SSL inspection. |
| | **trusted** string | **Choices:*** enable
* disable
| Enable/disable as a trusted CA. |
| **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: CA certificate.
fortios_certificate_ca:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_ca:
auto_update_days: "3"
auto_update_days_warning: "4"
ca: "<your_own_value>"
last_updated: "6"
name: "default_name_7"
range: "global"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
ssl_inspection_trusted: "enable"
trusted: "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_rf_analysis – Wireless controller rf-analysis in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_rf\_analysis – Wireless controller rf-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_rf_analysis`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 rf\_analysis category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_rf\_analysis** dictionary | | Wireless controller rf-analysis. |
| | 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 rf-analysis.
fortios_wireless_controller_rf_analysis:
vdom: "{{ vdom }}"
wireless_controller_rf_analysis:
<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_firewall_multicast_address – Configure multicast addresses in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_multicast\_address – Configure multicast 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_multicast_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 multicast\_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\_multicast\_address** dictionary | | Configure multicast addresses. |
| | **associated\_interface** string | | Interface associated with the address object. When setting up a policy, only addresses associated with this interface are available. Source system.interface.name. |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (1 - 32). |
| | **comment** string | | Comment. |
| | **end\_ip** string | | Final IPv4 address (inclusive) in the range for the address. |
| | **name** string / required | | Multicast address name. |
| | **start\_ip** string | | First IPv4 address (inclusive) in the range for the address. |
| | **subnet** string | | Broadcast address and subnet. |
| | **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:*** multicastrange
* broadcastmask
| Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. |
| | **visibility** string | **Choices:*** enable
* disable
| Enable/disable visibility of the 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 multicast addresses.
fortios_firewall_multicast_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_multicast_address:
associated_interface: "<your_own_value> (source system.interface.name)"
color: "4"
comment: "Comment."
end_ip: "<your_own_value>"
name: "default_name_7"
start_ip: "<your_own_value>"
subnet: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_12"
tags:
-
name: "default_name_14 (source system.object-tagging.tags.name)"
type: "multicastrange"
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_switch_controller_fortilink_settings – Configure integrated FortiLink settings for FortiSwitch in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_fortilink\_settings – Configure integrated FortiLink 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_fortilink_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 fortilink\_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\_fortilink\_settings** dictionary | | Configure integrated FortiLink settings for FortiSwitch. |
| | **inactive\_timer** integer | | Time interval(minutes) to be included in the inactive devices expiry calculation (mac age-out + inactive-time + periodic scan interval). |
| | **link\_down\_flush** string | **Choices:*** disable
* enable
| Clear NAC and dynamic devices on switch ports on link down event. |
| | **nac\_ports** dictionary | | NAC specific configuration. |
| | | **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. |
| | | **onboarding\_vlan** string | | Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name. |
| | **name** string / required | | FortiLink settings 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 FortiLink settings for FortiSwitch.
fortios_switch_controller_fortilink_settings:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_fortilink_settings:
inactive_timer: "3"
link_down_flush: "disable"
nac_ports:
bounce_nac_port: "disable"
onboarding_vlan: "<your_own_value> (source system.interface.name)"
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_switch_controller_mac_sync_settings – Configure global MAC synchronization settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_mac\_sync\_settings – Configure global MAC synchronization 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_mac_sync_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 mac\_sync\_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\_mac\_sync\_settings** dictionary | | Configure global MAC synchronization settings. |
| | **mac\_sync\_interval** integer | | Time interval between MAC synchronizations (30 - 1800 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 global MAC synchronization settings.
fortios_switch_controller_mac_sync_settings:
vdom: "{{ vdom }}"
switch_controller_mac_sync_settings:
mac_sync_interval: "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_system_replacemsg_image – Configure replacement message images in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_image – Configure replacement message images in Fortinet’s FortiOS and FortiGate.
===============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_image`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_image category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_image** dictionary | | Configure replacement message images. |
| | **image\_base64** string | | Image data. |
| | **image\_type** string | **Choices:*** gif
* jpg
* tiff
* png
| Image type. |
| | **name** string / required | | Image 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 replacement message images.
fortios_system_replacemsg_image:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_image:
image_base64: "<your_own_value>"
image_type: "gif"
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_system_vdom – Configure virtual domain in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_vdom – Configure virtual domain in Fortinet’s FortiOS and FortiGate.
======================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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** dictionary | | Configure virtual domain. |
| | **flag** integer | | Flag. |
| | **name** string / required | | VDOM name. |
| | **short\_name** string | | VDOM short name. |
| | **temporary** integer | | Temporary. |
| | **vcluster\_id** integer | | Virtual cluster ID (0 - 4294967295). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 domain.
fortios_system_vdom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom:
flag: "3"
name: "default_name_4"
short_name: "<your_own_value>"
temporary: "6"
vcluster_id: "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_wireless_controller_hotspot20_hs_profile – Configure hotspot profile in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_hs\_profile – Configure hotspot 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_hotspot20_hs_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\_hotspot20 feature and hs\_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\_hotspot20\_hs\_profile** dictionary | | Configure hotspot profile. |
| | **access\_network\_asra** string | **Choices:*** enable
* disable
| Enable/disable additional step required for access (ASRA). |
| | **access\_network\_esr** string | **Choices:*** enable
* disable
| Enable/disable emergency services reachable (ESR). |
| | **access\_network\_internet** string | **Choices:*** enable
* disable
| Enable/disable connectivity to the Internet. |
| | **access\_network\_type** string | **Choices:*** private-network
* private-network-with-guest-access
* chargeable-public-network
* free-public-network
* personal-device-network
* emergency-services-only-network
* test-or-experimental
* wildcard
| Access network type. |
| | **access\_network\_uesa** string | **Choices:*** enable
* disable
| Enable/disable unauthenticated emergency service accessible (UESA). |
| | **anqp\_domain\_id** integer | | ANQP Domain ID (0-65535). |
| | **bss\_transition** string | **Choices:*** enable
* disable
| Enable/disable basic service set (BSS) transition Support. |
| | **conn\_cap** string | | Connection capability name. Source wireless-controller.hotspot20.h2qp-conn-capability.name. |
| | **deauth\_request\_timeout** integer | | Deauthentication request timeout (in seconds). |
| | **dgaf** string | **Choices:*** enable
* disable
| Enable/disable downstream group-addressed forwarding (DGAF). |
| | **domain\_name** string | | Domain name. |
| | **gas\_comeback\_delay** integer | | GAS comeback delay (0 or 100 - 4000 milliseconds). |
| | **gas\_fragmentation\_limit** integer | | GAS fragmentation limit (512 - 4096). |
| | **hessid** string | | Homogeneous extended service set identifier (HESSID). |
| | **ip\_addr\_type** string | | IP address type name. Source wireless-controller.hotspot20.anqp-ip-address-type.name. |
| | **l2tif** string | **Choices:*** enable
* disable
| Enable/disable Layer 2 traffic inspection and filtering. |
| | **nai\_realm** string | | NAI realm list name. Source wireless-controller.hotspot20.anqp-nai-realm.name. |
| | **name** string / required | | Hotspot profile name. |
| | **network\_auth** string | | Network authentication name. Source wireless-controller.hotspot20.anqp-network-auth-type.name. |
| | **oper\_friendly\_name** string | | Operator friendly name. Source wireless-controller.hotspot20.h2qp-operator-name.name. |
| | **osu\_provider** list / elements=string | | Manually selected list of OSU provider(s). |
| | | **name** string / required | | OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name. |
| | **osu\_ssid** string | | Online sign up (OSU) SSID. |
| | **pame\_bi** string | **Choices:*** disable
* enable
| Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). |
| | **plmn\_3gpp** string | | 3GPP PLMN name. Source wireless-controller.hotspot20.anqp-3gpp-cellular.name. |
| | **proxy\_arp** string | **Choices:*** enable
* disable
| Enable/disable Proxy ARP. |
| | **qos\_map** string | | QoS MAP set ID. Source wireless-controller.hotspot20.qos-map.name. |
| | **roaming\_consortium** string | | Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.name. |
| | **venue\_group** string | **Choices:*** unspecified
* assembly
* business
* educational
* factory
* institutional
* mercantile
* residential
* storage
* utility
* vehicular
* outdoor
| Venue group. |
| | **venue\_name** string | | Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name. |
| | **venue\_type** string | **Choices:*** unspecified
* arena
* stadium
* passenger-terminal
* amphitheater
* amusement-park
* place-of-worship
* convention-center
* library
* museum
* restaurant
* theater
* bar
* coffee-shop
* zoo-or-aquarium
* emergency-center
* doctor-office
* bank
* fire-station
* police-station
* post-office
* professional-office
* research-facility
* attorney-office
* primary-school
* secondary-school
* university-or-college
* factory
* hospital
* long-term-care-facility
* rehab-center
* group-home
* prison-or-jail
* retail-store
* grocery-market
* auto-service-station
* shopping-mall
* gas-station
* private
* hotel-or-motel
* dormitory
* boarding-house
* automobile
* airplane
* bus
* ferry
* ship-or-boat
* train
* motor-bike
* muni-mesh-network
* city-park
* rest-area
* traffic-control
* bus-stop
* kiosk
| Venue type. |
| | **wan\_metrics** string | | WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name. |
| | **wnm\_sleep\_mode** string | **Choices:*** enable
* disable
| Enable/disable wireless network management (WNM) sleep 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 hotspot profile.
fortios_wireless_controller_hotspot20_hs_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_hs_profile:
plmn_3gpp: "<your_own_value> (source wireless-controller.hotspot20.anqp-3gpp-cellular.name)"
access_network_asra: "enable"
access_network_esr: "enable"
access_network_internet: "enable"
access_network_type: "private-network"
access_network_uesa: "enable"
anqp_domain_id: "9"
bss_transition: "enable"
conn_cap: "<your_own_value> (source wireless-controller.hotspot20.h2qp-conn-capability.name)"
deauth_request_timeout: "12"
dgaf: "enable"
domain_name: "<your_own_value>"
gas_comeback_delay: "15"
gas_fragmentation_limit: "16"
hessid: "<your_own_value>"
ip_addr_type: "<your_own_value> (source wireless-controller.hotspot20.anqp-ip-address-type.name)"
l2tif: "enable"
nai_realm: "<your_own_value> (source wireless-controller.hotspot20.anqp-nai-realm.name)"
name: "default_name_21"
network_auth: "<your_own_value> (source wireless-controller.hotspot20.anqp-network-auth-type.name)"
oper_friendly_name: "<your_own_value> (source wireless-controller.hotspot20.h2qp-operator-name.name)"
osu_provider:
-
name: "default_name_25 (source wireless-controller.hotspot20.h2qp-osu-provider.name)"
osu_ssid: "<your_own_value>"
pame_bi: "disable"
proxy_arp: "enable"
qos_map: "<your_own_value> (source wireless-controller.hotspot20.qos-map.name)"
roaming_consortium: "<your_own_value> (source wireless-controller.hotspot20.anqp-roaming-consortium.name)"
venue_group: "unspecified"
venue_name: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-name.name)"
venue_type: "unspecified"
wan_metrics: "<your_own_value> (source wireless-controller.hotspot20.h2qp-wan-metric.name)"
wnm_sleep_mode: "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_apcfg_profile – Configure AP local configuration profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_apcfg\_profile – Configure AP local configuration 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_apcfg_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 apcfg\_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\_apcfg\_profile** dictionary | | Configure AP local configuration profiles. |
| | **ac\_ip** string | | IP address of the validation controller that AP must be able to join after applying AP local configuration. |
| | **ac\_port** integer | | Port of the validation controller that AP must be able to join after applying AP local configuration (1024 - 49150). |
| | **ac\_timer** integer | | Maximum waiting time for the AP to join the validation controller after applying AP local configuration (3 - 30 min). |
| | **ac\_type** string | **Choices:*** default
* specify
* apcfg
| Validation controller type . |
| | **command\_list** list / elements=string | | AP local configuration command list. |
| | | **id** integer / required | | Command ID. |
| | | **name** string | | AP local configuration command name. |
| | | **passwd\_value** string | | AP local configuration command password value. |
| | | **type** string | **Choices:*** non-password
* password
| The command type . |
| | | **value** string | | AP local configuration command value. |
| | **comment** string | | Comment. |
| | **name** string / required | | AP local configuration 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 AP local configuration profiles.
fortios_wireless_controller_apcfg_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_apcfg_profile:
ac_ip: "<your_own_value>"
ac_port: "4"
ac_timer: "5"
ac_type: "default"
command_list:
-
id: "8"
name: "default_name_9"
passwd_value: "<your_own_value>"
type: "non-password"
value: "<your_own_value>"
comment: "Comment."
name: "default_name_14"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_settings – Configure endpoint control settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_endpoint\_control\_settings – Configure endpoint control 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_endpoint_control_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 endpoint\_control 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. |
| **endpoint\_control\_settings** dictionary | | Configure endpoint control settings. |
| | **download\_custom\_link** string | | Customized URL for downloading FortiClient. |
| | **download\_location** string | **Choices:*** fortiguard
* custom
| FortiClient download location (FortiGuard or custom). |
| | **forticlient\_avdb\_update\_interval** integer | | Period of time between FortiClient AntiVirus database updates (0 - 24 hours). |
| | **forticlient\_dereg\_unsupported\_client** string | **Choices:*** enable
* disable
| Enable/disable deregistering unsupported FortiClient endpoints. |
| | **forticlient\_disconnect\_unsupported\_client** string | **Choices:*** enable
* disable
| Enable/disable disconnecting of unsupported FortiClient endpoints. |
| | **forticlient\_ems\_rest\_api\_call\_timeout** integer | | FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds). |
| | **forticlient\_keepalive\_interval** integer | | Interval between two KeepAlive messages from FortiClient (20 - 300 sec). |
| | **forticlient\_offline\_grace** string | **Choices:*** enable
* disable
| Enable/disable grace period for offline registered clients. |
| | **forticlient\_offline\_grace\_interval** integer | | Grace period for offline registered FortiClient (60 - 600 sec). |
| | **forticlient\_reg\_key** string | | FortiClient registration key. |
| | **forticlient\_reg\_key\_enforce** string | **Choices:*** enable
* disable
| Enable/disable requiring or enforcing FortiClient registration keys. |
| | **forticlient\_reg\_timeout** integer | | FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited). |
| | **forticlient\_sys\_update\_interval** integer | | Interval between two system update messages from FortiClient (30 - 1440 min). |
| | **forticlient\_user\_avatar** string | **Choices:*** enable
* disable
| Enable/disable uploading FortiClient user avatars. |
| | **forticlient\_warning\_interval** integer | | Period of time between FortiClient portal warnings (0 - 24 hours). |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 settings.
fortios_endpoint_control_settings:
vdom: "{{ vdom }}"
endpoint_control_settings:
download_custom_link: "<your_own_value>"
download_location: "fortiguard"
forticlient_avdb_update_interval: "5"
forticlient_dereg_unsupported_client: "enable"
forticlient_disconnect_unsupported_client: "enable"
forticlient_ems_rest_api_call_timeout: "8"
forticlient_keepalive_interval: "9"
forticlient_offline_grace: "enable"
forticlient_offline_grace_interval: "11"
forticlient_reg_key: "<your_own_value>"
forticlient_reg_key_enforce: "enable"
forticlient_reg_timeout: "14"
forticlient_sys_update_interval: "15"
forticlient_user_avatar: "enable"
forticlient_warning_interval: "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_spamfilter_fortishield – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_fortishield – Configure FortiGuard - AntiSpam in Fortinet’s FortiOS and FortiGate.
========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fortishield`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fortishield category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fortishield** dictionary | | Configure FortiGuard - AntiSpam. |
| | **spam\_submit\_force** string | **Choices:*** enable
* disable
| Enable/disable force insertion of a new mime entity for the submission text. |
| | **spam\_submit\_srv** string | | Hostname of the spam submission server. |
| | **spam\_submit\_txt2htm** string | **Choices:*** enable
* disable
| Enable/disable conversion of text email to HTML email. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 - AntiSpam.
fortios_spamfilter_fortishield:
vdom: "{{ vdom }}"
spamfilter_fortishield:
spam_submit_force: "enable"
spam_submit_srv: "<your_own_value>"
spam_submit_txt2htm: "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_application_custom – Configure custom application signatures in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_application\_custom – Configure custom 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_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 application 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. |
| **application\_custom** dictionary | | Configure custom application signatures. |
| | **behavior** string | | Custom application signature behavior. |
| | **category** integer | | Custom application category ID (use ? to view available options). |
| | **comment** string | | Comment. |
| | **id** integer | | Custom application category ID (use ? to view available options). |
| | **name** string | | Name of this custom application signature. |
| | **protocol** string | | Custom application signature protocol. |
| | **signature** string | | The text that makes up the actual custom application signature. |
| | **tag** string / required | | Signature tag. |
| | **technology** string | | Custom application signature technology. |
| | **vendor** string | | Custom application signature vendor. |
| **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 custom application signatures.
fortios_application_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_custom:
behavior: "<your_own_value>"
category: "4"
comment: "Comment."
id: "6"
name: "default_name_7"
protocol: "<your_own_value>"
signature: "<your_own_value>"
tag: "<your_own_value>"
technology: "<your_own_value>"
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_firewall_internet_service_group – Configure group of Internet Service in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_group – Configure group of Internet Service in Fortinet’s FortiOS and FortiGate.
=======================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 internet\_service\_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\_internet\_service\_group** dictionary | | Configure group of Internet Service. |
| | **comment** string | | Comment. |
| | **direction** string | **Choices:*** source
* destination
* both
| How this service may be used (source, destination or both). |
| | **member** list / elements=string | | Internet Service group member. |
| | | **id** integer / required | | Internet Service ID. Source firewall.internet-service.id. |
| | | **name** string | | Internet Service name. Source firewall.internet-service-name.name. |
| | **name** string / required | | Internet Service 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: Configure group of Internet Service.
fortios_firewall_internet_service_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_group:
comment: "Comment."
direction: "source"
member:
-
id: "6 (source firewall.internet-service.id)"
name: "default_name_7 (source firewall.internet-service-name.name)"
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)
| programming_docs |
ansible fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_osu_provider – Configure online sign up (OSU) provider list in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_wireless\_controller\_hotspot20\_h2qp\_osu\_provider – Configure online sign up (OSU) provider 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_hotspot20_h2qp_osu_provider`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_osu\_provider category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_osu\_provider** dictionary | | Configure online sign up (OSU) provider list. |
| | **friendly\_name** list / elements=string | | OSU provider friendly name. |
| | | **friendly\_name** string | | OSU provider friendly name. |
| | | **index** integer / required | | OSU provider friendly name index. |
| | | **lang** string | | Language code. |
| | **icon** string | | OSU provider icon. Source wireless-controller.hotspot20.icon.name. |
| | **name** string / required | | OSU provider ID. |
| | **osu\_method** list / elements=string | **Choices:*** oma-dm
* soap-xml-spp
* reserved
| OSU method list. |
| | **osu\_nai** string | | OSU NAI. |
| | **server\_uri** string | | Server URI. |
| | **service\_description** list / elements=string | | OSU service name. |
| | | **lang** string | | Language code. |
| | | **service\_description** string | | Service description. |
| | | **service\_id** integer | | OSU service 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 online sign up (OSU) provider list.
fortios_wireless_controller_hotspot20_h2qp_osu_provider:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_h2qp_osu_provider:
friendly_name:
-
friendly_name: "<your_own_value>"
index: "5"
lang: "<your_own_value>"
icon: "<your_own_value> (source wireless-controller.hotspot20.icon.name)"
name: "default_name_8"
osu_method: "oma-dm"
osu_nai: "<your_own_value>"
server_uri: "<your_own_value>"
service_description:
-
lang: "<your_own_value>"
service_description: "<your_own_value>"
service_id: "15"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_filter – Filters for FortiAnalyzer Cloud in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_fortianalyzer\_cloud\_filter – 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_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 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\_filter** dictionary | | 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: Filters for FortiAnalyzer Cloud.
fortios_log_fortianalyzer_cloud_filter:
vdom: "{{ vdom }}"
log_fortianalyzer_cloud_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_system_virtual_wire_pair – Configure virtual wire pairs in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_virtual\_wire\_pair – Configure virtual wire pairs in Fortinet’s FortiOS and FortiGate.
=========================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_wire_pair`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_wire\_pair category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_virtual\_wire\_pair** dictionary | | Configure virtual wire pairs. |
| | **member** list / elements=string | | Interfaces belong to the virtual-wire-pair. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **name** string / required | | Virtual-wire-pair name. Must be a unique interface name. |
| | **vlan\_filter** string | | Set VLAN filters. |
| | **wildcard\_vlan** string | **Choices:*** enable
* disable
| Enable/disable wildcard VLAN. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 wire pairs.
fortios_system_virtual_wire_pair:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_virtual_wire_pair:
member:
-
interface_name: "<your_own_value> (source system.interface.name)"
name: "default_name_5"
vlan_filter: "<your_own_value>"
wildcard_vlan: "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_extension – Configure Internet Services Extension in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_extension – Configure Internet Services Extension in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_extension`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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\_extension category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_extension** dictionary | | Configure Internet Services Extension. |
| | **comment** string | | Comment. |
| | **disable\_entry** list / elements=string | | Disable entries in the Internet Service database. |
| | | **id** integer / required | | Disable entry ID. |
| | | **ip\_range** list / elements=string | | IP ranges in the disable entry. |
| | | | **end\_ip** string | | End IP address. |
| | | | **id** integer / required | | Disable entry range ID. |
| | | | **start\_ip** string | | Start IP address. |
| | | **port\_range** list / elements=string | | Port ranges in the disable entry. |
| | | | **end\_port** integer | | Ending TCP/UDP/SCTP destination port (1 to 65535). |
| | | | **id** integer / required | | Custom entry port range ID. |
| | | | **start\_port** integer | | Starting TCP/UDP/SCTP destination port (1 to 65535). |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **entry** list / elements=string | | Entries added to the Internet Service extension database. |
| | | **dst** list / elements=string | | Destination address or address group name. |
| | | | **name** string / required | | Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name. |
| | | **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 Extension.
fortios_firewall_internet_service_extension:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_extension:
comment: "Comment."
disable_entry:
-
id: "5"
ip_range:
-
end_ip: "<your_own_value>"
id: "8"
start_ip: "<your_own_value>"
port_range:
-
end_port: "11"
id: "12"
start_port: "13"
protocol: "14"
entry:
-
dst:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
id: "18"
port_range:
-
end_port: "20"
id: "21"
start_port: "22"
protocol: "23"
id: "24 (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)
| programming_docs |
ansible fortinet.fortios.fortios_system_modem – Configure MODEM in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_modem – Configure MODEM in Fortinet’s FortiOS and FortiGate.
==============================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_modem`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 modem category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_modem** dictionary | | Configure MODEM. |
| | **action** string | **Choices:*** dial
* stop
* none
| Dial up/stop MODEM. |
| | **altmode** string | **Choices:*** enable
* disable
| Enable/disable altmode for installations using PPP in China. |
| | **authtype1** list / elements=string | **Choices:*** pap
* chap
* mschap
* mschapv2
| Allowed authentication types for ISP 1. |
| | **authtype2** list / elements=string | **Choices:*** pap
* chap
* mschap
* mschapv2
| Allowed authentication types for ISP 2. |
| | **authtype3** list / elements=string | **Choices:*** pap
* chap
* mschap
* mschapv2
| Allowed authentication types for ISP 3. |
| | **auto\_dial** string | **Choices:*** enable
* disable
| Enable/disable auto-dial after a reboot or disconnection. |
| | **connect\_timeout** integer | | Connection completion timeout (30 - 255 sec). |
| | **dial\_cmd1** string | | Dial command (this is often an ATD or ATDT command). |
| | **dial\_cmd2** string | | Dial command (this is often an ATD or ATDT command). |
| | **dial\_cmd3** string | | Dial command (this is often an ATD or ATDT command). |
| | **dial\_on\_demand** string | **Choices:*** enable
* disable
| Enable/disable to dial the modem when packets are routed to the modem interface. |
| | **distance** integer | | Distance of learned routes (1 - 255). |
| | **dont\_send\_CR1** string | **Choices:*** enable
* disable
| Do not send CR when connected (ISP1). |
| | **dont\_send\_CR2** string | **Choices:*** enable
* disable
| Do not send CR when connected (ISP2). |
| | **dont\_send\_CR3** string | **Choices:*** enable
* disable
| Do not send CR when connected (ISP3). |
| | **extra\_init1** string | | Extra initialization string to ISP 1. |
| | **extra\_init2** string | | Extra initialization string to ISP 2. |
| | **extra\_init3** string | | Extra initialization string to ISP 3. |
| | **holddown\_timer** integer | | Hold down timer in seconds (1 - 60 sec). |
| | **idle\_timer** integer | | MODEM connection idle time (1 - 9999 min). |
| | **interface** string | | Name of redundant interface. Source system.interface.name. |
| | **lockdown\_lac** string | | Allow connection only to the specified Location Area Code (LAC). |
| | **mode** string | **Choices:*** standalone
* redundant
| Set MODEM operation mode to redundant or standalone. |
| | **network\_init** string | | AT command to set the Network name/type (AT+COPS=<mode>,[<format>,<oper>[,<AcT>]]). |
| | **passwd1** string | | Password to access the specified dialup account. |
| | **passwd2** string | | Password to access the specified dialup account. |
| | **passwd3** string | | Password to access the specified dialup account. |
| | **peer\_modem1** string | **Choices:*** generic
* actiontec
* ascend\_TNT
| Specify peer MODEM type for phone1. |
| | **peer\_modem2** string | **Choices:*** generic
* actiontec
* ascend\_TNT
| Specify peer MODEM type for phone2. |
| | **peer\_modem3** string | **Choices:*** generic
* actiontec
* ascend\_TNT
| Specify peer MODEM type for phone3. |
| | **phone1** string | | Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
| | **phone2** string | | Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
| | **phone3** string | | Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
| | **pin\_init** string | | AT command to set the PIN (AT+PIN=<pin>). |
| | **ppp\_echo\_request1** string | **Choices:*** enable
* disable
| Enable/disable PPP echo-request to ISP 1. |
| | **ppp\_echo\_request2** string | **Choices:*** enable
* disable
| Enable/disable PPP echo-request to ISP 2. |
| | **ppp\_echo\_request3** string | **Choices:*** enable
* disable
| Enable/disable PPP echo-request to ISP 3. |
| | **priority** integer | | Priority of learned routes (0 - 4294967295). |
| | **redial** string | **Choices:*** none
* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10
| Redial limit (1 - 10 attempts, none = redial forever). |
| | **reset** integer | | Number of dial attempts before resetting modem (0 = never reset). |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable Modem support (equivalent to bringing an interface up or down). |
| | **traffic\_check** string | **Choices:*** enable
* disable
| Enable/disable traffic-check. |
| | **username1** string | | User name to access the specified dialup account. |
| | **username2** string | | User name to access the specified dialup account. |
| | **username3** string | | User name to access the specified dialup account. |
| | **wireless\_port** integer | | Enter wireless port number, 0 for default, 1 for first port, ... (0 - 4294967295) |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 MODEM.
fortios_system_modem:
vdom: "{{ vdom }}"
system_modem:
action: "dial"
altmode: "enable"
authtype1: "pap"
authtype2: "pap"
authtype3: "pap"
auto_dial: "enable"
connect_timeout: "9"
dial_cmd1: "<your_own_value>"
dial_cmd2: "<your_own_value>"
dial_cmd3: "<your_own_value>"
dial_on_demand: "enable"
distance: "14"
dont_send_CR1: "enable"
dont_send_CR2: "enable"
dont_send_CR3: "enable"
extra_init1: "<your_own_value>"
extra_init2: "<your_own_value>"
extra_init3: "<your_own_value>"
holddown_timer: "21"
idle_timer: "22"
interface: "<your_own_value> (source system.interface.name)"
lockdown_lac: "<your_own_value>"
mode: "standalone"
network_init: "<your_own_value>"
passwd1: "<your_own_value>"
passwd2: "<your_own_value>"
passwd3: "<your_own_value>"
peer_modem1: "generic"
peer_modem2: "generic"
peer_modem3: "generic"
phone1: "<your_own_value>"
phone2: "<your_own_value>"
phone3: "<your_own_value>"
pin_init: "<your_own_value>"
ppp_echo_request1: "enable"
ppp_echo_request2: "enable"
ppp_echo_request3: "enable"
priority: "40"
redial: "none"
reset: "42"
status: "enable"
traffic_check: "enable"
username1: "<your_own_value>"
username2: "<your_own_value>"
username3: "<your_own_value>"
wireless_port: "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)
ansible fortinet.fortios.fortios_user_fsso_polling – Configure FSSO active directory servers for polling mode in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_fsso\_polling – Configure FSSO active directory servers for polling mode in Fortinet’s FortiOS and FortiGate.
=============================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fsso_polling`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 fsso\_polling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_fsso\_polling** dictionary | | Configure FSSO active directory servers for polling mode. |
| | **adgrp** list / elements=string | | LDAP Group Info. |
| | | **name** string / required | | Name. |
| | **default\_domain** string | | Default domain managed by this Active Directory server. |
| | **id** integer / required | | Active Directory server ID. |
| | **ldap\_server** string | | LDAP server name used in LDAP connection strings. Source user.ldap.name. |
| | **logon\_history** integer | | Number of hours of logon history to keep, 0 means keep all history. |
| | **password** string | | Password required to log into this Active Directory server |
| | **polling\_frequency** integer | | Polling frequency (every 1 to 30 seconds). |
| | **port** integer | | Port to communicate with this Active Directory server. |
| | **server** string | | Host name or IP address of the Active Directory server. |
| | **smb\_ntlmv1\_auth** string | **Choices:*** enable
* disable
| Enable/disable support of NTLMv1 for Samba authentication. |
| | **smbv1** string | **Choices:*** enable
* disable
| Enable/disable support of SMBv1 for Samba. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable polling for the status of this Active Directory server. |
| | **user** string | | User name required to log into this Active Directory 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 FSSO active directory servers for polling mode.
fortios_user_fsso_polling:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fsso_polling:
adgrp:
-
name: "default_name_4"
default_domain: "<your_own_value>"
id: "6"
ldap_server: "<your_own_value> (source user.ldap.name)"
logon_history: "8"
password: "<your_own_value>"
polling_frequency: "10"
port: "11"
server: "192.168.100.40"
smb_ntlmv1_auth: "enable"
smbv1: "enable"
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_firewall_ip_translation – Configure firewall IP-translation in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_ip\_translation – Configure firewall IP-translation in Fortinet’s FortiOS and FortiGate.
============================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ip_translation`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 ip\_translation category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_ip\_translation** dictionary | | Configure firewall IP-translation. |
| | **endip** string | | Final IPv4 address (inclusive) in the range of the addresses to be translated (format xxx.xxx.xxx.xxx). |
| | **map\_startip** string | | Address to be used as the starting point for translation in the range (format xxx.xxx.xxx.xxx). |
| | **startip** string | | First IPv4 address (inclusive) in the range of the addresses to be translated (format xxx.xxx.xxx.xxx). |
| | **transid** integer / required | | IP translation ID. |
| | **type** string | **Choices:*** SCTP
| IP translation type (option: SCTP). |
| **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 IP-translation.
fortios_firewall_ip_translation:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ip_translation:
endip: "<your_own_value>"
map_startip: "<your_own_value>"
startip: "<your_own_value>"
transid: "6"
type: "SCTP"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **http\_method** string | always | Last method used to provision the content into FortiGate **Sample:** PUT |
| **http\_status** string | always | Last result given by FortiGate on last operation applied **Sample:** 200 |
| **mkey** string | success | Master key (id) used in the last call to FortiGate **Sample:** id |
| **name** string | always | Name of the table used to fulfill the request **Sample:** urlfilter |
| **path** string | always | Path of the table used to fulfill the request **Sample:** webfilter |
| **revision** string | always | Internal revision number **Sample:** 17.0.2.10658 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **vdom** string | always | Virtual domain used **Sample:** root |
| **version** string | always | Version of the FortiGate **Sample:** 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_vendor_mac – Show vendor and the MAC address they have in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_vendor\_mac – Show vendor and the MAC address they have in Fortinet’s FortiOS and FortiGate.
================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_vendor_mac`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 vendor\_mac category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_vendor\_mac** dictionary | | Show vendor and the MAC address they have. |
| | **id** integer / required | | Vendor ID. |
| | **mac\_number** integer | | Total number of MAC addresses. |
| | **name** string | | 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: Show vendor and the MAC address they have.
fortios_firewall_vendor_mac:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vendor_mac:
id: "3"
mac_number: "4"
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_system_nd_proxy – Configure IPv6 neighbor discovery proxy (RFC4389) in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_nd\_proxy – Configure IPv6 neighbor discovery proxy (RFC4389) in Fortinet’s FortiOS and FortiGate.
====================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_nd_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 system feature and nd\_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. |
| **system\_nd\_proxy** dictionary | | Configure IPv6 neighbor discovery proxy (RFC4389). |
| | **member** list / elements=string | | Interfaces using the neighbor discovery proxy. |
| | | **interface\_name** string | | Interface name. Source system.interface.name. |
| | **status** string | **Choices:*** enable
* disable
| Enable/disable neighbor discovery 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 IPv6 neighbor discovery proxy (RFC4389).
fortios_system_nd_proxy:
vdom: "{{ vdom }}"
system_nd_proxy:
member:
-
interface_name: "<your_own_value> (source system.interface.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_user_password_policy – Configure user password policy in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_user\_password\_policy – Configure user password 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_user_password_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 password\_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\_password\_policy** dictionary | | Configure user password policy. |
| | **expire\_days** integer | | Time in days before the user"s password expires. |
| | **expired\_password\_renewal** string | **Choices:*** enable
* disable
| Enable/disable renewal of a password that already is expired. |
| | **name** string / required | | Password policy name. |
| | **warn\_days** integer | | Time in days before a password expiration warning message is displayed to the user upon login. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 password policy.
fortios_user_password_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_password_policy:
expire_days: "3"
expired_password_renewal: "enable"
name: "default_name_5"
warn_days: "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_log_fact – Retrieve log data of fortios log objects. fortinet.fortios.fortios\_log\_fact – Retrieve log data of fortios log 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_log_fact`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return Values](#return-values)
Synopsis
--------
* Retrieve log related to disk, memory, fortianalyzer and forticloud.
Requirements
------------
The below requirements are needed on the host that executes this module.
* install galaxy collection fortinet.fortios >= 2.1.0.
Parameters
----------
| Parameter | Choices/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:*** memory\_event\_connector
* memory\_virus\_archive
* forticloud\_event\_router
* forticloud\_app-ctrl\_raw
* memory\_cifs\_raw
* disk\_waf\_raw
* forticloud\_emailfilter\_raw
* disk\_traffic\_sniffer
* memory\_traffic\_multicast
* fortianalyzer\_event\_vpn
* disk\_ips\_archive-download
* disk\_gtp\_raw
* memory\_app-ctrl\_archive
* forticloud\_webfilter\_raw
* fortianalyzer\_ips\_archive
* disk\_app-ctrl\_archive-download
* memory\_emailfilter\_raw
* fortianalyzer\_traffic\_fortiview
* forticloud\_event\_security-rating
* disk\_event\_security-rating
* memory\_event\_user
* fortianalyzer\_event\_router
* fortianalyzer\_event\_compliance-check
* disk\_ips\_raw
* fortianalyzer\_app-ctrl\_archive
* disk\_event\_router
* disk\_event\_wireless
* fortianalyzer\_traffic\_threat
* forticloud\_event\_user
* forticloud\_ips\_archive
* forticloud\_dns\_raw
* fortianalyzer\_event\_system
* forticloud\_event\_wireless
* forticloud\_event\_connector
* forticloud\_traffic\_local
* fortianalyzer\_app-ctrl\_archive-download
* memory\_virus\_raw
* fortianalyzer\_event\_connector
* forticloud\_app-ctrl\_archive-download
* memory\_event\_endpoint
* disk\_traffic\_forward
* disk\_dlp\_raw
* memory\_waf\_raw
* disk\_app-ctrl\_archive
* disk\_event\_fortiextender
* memory\_ssl\_raw
* memory\_event\_vpn
* memory\_voip\_raw
* forticloud\_traffic\_sniffer
* memory\_event\_fortiextender
* forticloud\_traffic\_threat
* disk\_ips\_archive
* fortianalyzer\_event\_wireless
* memory\_traffic\_forward
* memory\_event\_system
* disk\_traffic\_local
* fortianalyzer\_cifs\_raw
* memory\_traffic\_local
* memory\_anomaly\_raw
* disk\_webfilter\_raw
* forticloud\_dlp\_raw
* fortianalyzer\_voip\_raw
* fortianalyzer\_traffic\_multicast
* forticloud\_cifs\_raw
* disk\_voip\_raw
* fortianalyzer\_file-filter\_raw
* disk\_app-ctrl\_raw
* disk\_event\_ha
* disk\_event\_vpn
* memory\_event\_router
* memory\_event\_ha
* forticloud\_traffic\_fortiview
* forticloud\_virus\_archive
* fortianalyzer\_app-ctrl\_raw
* fortianalyzer\_traffic\_forward
* fortianalyzer\_dns\_raw
* forticloud\_ips\_raw
* disk\_ssh\_raw
* fortianalyzer\_ips\_archive-download
* disk\_anomaly\_raw
* disk\_ssl\_raw
* memory\_event\_compliance-check
* forticloud\_event\_wad
* fortianalyzer\_gtp\_raw
* memory\_ssh\_raw
* disk\_virus\_archive
* forticloud\_traffic\_forward
* forticloud\_ssh\_raw
* forticloud\_ssl\_raw
* memory\_ips\_archive
* forticloud\_event\_fortiextender
* forticloud\_waf\_raw
* disk\_traffic\_fortiview
* memory\_traffic\_sniffer
* forticloud\_gtp\_raw
* fortianalyzer\_emailfilter\_raw
* forticloud\_file-filter\_raw
* fortianalyzer\_event\_wad
* disk\_virus\_raw
* disk\_dns\_raw
* memory\_ips\_raw
* forticloud\_anomaly\_raw
* forticloud\_app-ctrl\_archive
* memory\_app-ctrl\_raw
* fortianalyzer\_event\_user
* disk\_traffic\_multicast
* fortianalyzer\_anomaly\_raw
* memory\_traffic\_threat
* fortianalyzer\_virus\_archive
* memory\_event\_wireless
* memory\_webfilter\_raw
* forticloud\_virus\_raw
* memory\_event\_security-rating
* fortianalyzer\_dlp\_raw
* forticloud\_voip\_raw
* memory\_file-filter\_raw
* forticloud\_event\_compliance-check
* fortianalyzer\_webfilter\_raw
* disk\_file-filter\_raw
* disk\_event\_wad
* fortianalyzer\_virus\_raw
* fortianalyzer\_ssh\_raw
* forticloud\_event\_ha
* memory\_gtp\_raw
* forticloud\_event\_vpn
* memory\_event\_wad
* fortianalyzer\_ips\_raw
* disk\_event\_endpoint
* disk\_event\_system
* memory\_dlp\_raw
* forticloud\_event\_system
* disk\_event\_connector
* fortianalyzer\_event\_ha
* forticloud\_ips\_archive-download
* fortianalyzer\_ssl\_raw
* fortianalyzer\_traffic\_local
* disk\_emailfilter\_raw
* memory\_traffic\_fortiview
* forticloud\_traffic\_multicast
* fortianalyzer\_event\_security-rating
* disk\_event\_compliance-check
* fortianalyzer\_event\_fortiextender
* disk\_event\_user
* disk\_traffic\_threat
* forticloud\_event\_endpoint
* fortianalyzer\_traffic\_sniffer
* fortianalyzer\_event\_endpoint
* memory\_dns\_raw
* memory\_ips\_archive-download
* fortianalyzer\_waf\_raw
* disk\_cifs\_raw
* memory\_app-ctrl\_archive-download
| selector of the retrieved log type |
| **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
* Not all parameters are required for a slector.
* This module is exclusivly for FortiOS Log API.
Examples
--------
```
- hosts: fortigate03
connection: httpapi
collections:
- fortinet.fortios
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Get system event log with logid==0100032038
fortios_log_fact:
filters:
- logid==0100032038
selector: "disk_event_system"
params:
rows: 100
- name: Get a description of the quarantined virus file
fortios_log_fact:
selector: "forticloud_virus_archive"
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **build** string | always | Build number of the fortigate image **Sample:** 1547 |
| **rows** integer | always | Number of rows to return **Sample:** 400 |
| **serial** string | always | Serial number of the unit **Sample:** FGVMEVYYQT3AB5352 |
| **session\_id** integer | always | session id for the request **Sample:** 7 |
| **start** integer | always | Row number for the first row to return |
| **status** string | always | Indication of the operation's result **Sample:** success |
| **subcategory** string | always | Type of log that can be retrieved **Sample:** system |
| **total\_lines** integer | always | Total lines returned from the result **Sample:** 510 |
| **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_internet_service_custom_group – Configure custom Internet Service group in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_internet\_service\_custom\_group – Configure custom Internet Service 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_firewall_internet_service_custom_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 internet\_service\_custom\_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\_internet\_service\_custom\_group** dictionary | | Configure custom Internet Service group. |
| | **comment** string | | Comment. |
| | **member** list / elements=string | | Custom Internet Service group members. |
| | | **name** string / required | | Group member name. Source firewall.internet-service-custom.name. |
| | **name** string / required | | Custom Internet Service 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: Configure custom Internet Service group.
fortios_firewall_internet_service_custom_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_custom_group:
comment: "Comment."
member:
-
name: "default_name_5 (source firewall.internet-service-custom.name)"
name: "default_name_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_webfilter_profile – Configure Web filter profiles in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_webfilter\_profile – Configure Web 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_webfilter_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 webfilter 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. |
| **webfilter\_profile** dictionary | | Configure Web filter profiles. |
| | **antiphish** dictionary | | AntiPhishing profile. |
| | | **authentication** string | **Choices:*** domain-controller
* ldap
| Authentication methods. |
| | | **check\_basic\_auth** string | **Choices:*** enable
* disable
| Enable/disable checking of HTTP Basic Auth field for known credentials. |
| | | **check\_uri** string | **Choices:*** enable
* disable
| Enable/disable checking of GET URI parameters for known credentials. |
| | | **check\_username\_only** string | **Choices:*** enable
* disable
| Enable/disable acting only on valid username credentials. Action will be taken for valid usernames regardless of password validity. |
| | | **custom\_patterns** list / elements=string | | Custom username and password regex patterns. |
| | | | **category** string | **Choices:*** username
* password
| Category that the pattern matches. |
| | | | **pattern** string / required | | Target pattern. |
| | | | **type** string | **Choices:*** regex
* literal
| Pattern will be treated either as a regex pattern or literal string. |
| | | **default\_action** string | **Choices:*** exempt
* log
* block
| Action to be taken when there is no matching rule. |
| | | **domain\_controller** string | | Domain for which to verify received credentials against. Source credential-store.domain-controller.server-name. |
| | | **inspection\_entries** list / elements=string | | AntiPhishing entries. |
| | | | **action** string | **Choices:*** exempt
* log
* block
| Action to be taken upon an AntiPhishing match. |
| | | | **fortiguard\_category** string | | FortiGuard category to match. |
| | | | **name** string / required | | Inspection target name. |
| | | **ldap** string | | LDAP server for which to verify received credentials against. Source user.ldap.name. |
| | | **max\_body\_len** integer | | Maximum size of a POST body to check for credentials. |
| | | **status** string | **Choices:*** enable
* disable
| Toggle AntiPhishing functionality. |
| | **comment** string | | Optional comments. |
| | **extended\_log** string | **Choices:*** enable
* disable
| Enable/disable extended logging for web filtering. |
| | **feature\_set** string | **Choices:*** flow
* proxy
| Flow/proxy feature set. |
| | **file\_filter** dictionary | | File filter. |
| | | **entries** list / elements=string | | File filter entries. |
| | | | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | | | **comment** string | | Comment. |
| | | | **direction** string | **Choices:*** incoming
* outgoing
* any
| Match files transmitted in the session"s originating or reply direction. |
| | | | **file\_type** list / elements=string | | Select file type. |
| | | | | **name** string / required | | File type name. Source antivirus.filetype.name. |
| | | | **filter** string / required | | Add a file filter. |
| | | | **password\_protected** string | **Choices:*** True
* any
| Match password-protected files. |
| | | | **protocol** string | **Choices:*** http
* ftp
| Protocols to apply with. |
| | | **log** string | **Choices:*** enable
* disable
| Enable/disable file filter logging. |
| | | **scan\_archive\_contents** string | **Choices:*** enable
* disable
| Enable/disable file filter archive contents scan. |
| | | **status** string | **Choices:*** enable
* disable
| Enable/disable file filter. |
| | **ftgd\_wf** dictionary | | FortiGuard Web Filter settings. |
| | | **exempt\_quota** string | | Do not stop quota for these categories. |
| | | **filters** list / elements=string | | FortiGuard filters. |
| | | | **action** string | **Choices:*** block
* authenticate
* monitor
* warning
| Action to take for matches. |
| | | | **auth\_usr\_grp** string | | Groups with permission to authenticate. |
| | | | | **name** string / required | | User group name. Source user.group.name. |
| | | | **category** integer | | Categories and groups the filter examines. |
| | | | **id** integer / required | | ID number. |
| | | | **log** string | **Choices:*** enable
* disable
| Enable/disable logging. |
| | | | **override\_replacemsg** string | | Override replacement message. |
| | | | **warn\_duration** string | | Duration of warnings. |
| | | | **warning\_duration\_type** string | **Choices:*** session
* timeout
| Re-display warning after closing browser or after a timeout. |
| | | | **warning\_prompt** string | **Choices:*** per-domain
* per-category
| Warning prompts in each category or each domain. |
| | | **max\_quota\_timeout** integer | | Maximum FortiGuard quota used by single page view in seconds (excludes streams). |
| | | **options** string | **Choices:*** error-allow
* rate-server-ip
* connect-request-bypass
* ftgd-disable
| Options for FortiGuard Web Filter. |
| | | **ovrd** string | | Allow web filter profile overrides. |
| | | **quota** list / elements=string | | FortiGuard traffic quota settings. |
| | | | **category** string | | FortiGuard categories to apply quota to (category action must be set to monitor). |
| | | | **duration** string | | Duration of quota. |
| | | | **id** integer / required | | ID number. |
| | | | **override\_replacemsg** string | | Override replacement message. |
| | | | **type** string | **Choices:*** time
* traffic
| Quota type. |
| | | | **unit** string | **Choices:*** B
* KB
* MB
* GB
| Traffic quota unit of measurement. |
| | | | **value** integer | | Traffic quota value. |
| | | **rate\_crl\_urls** string | **Choices:*** disable
* enable
| Enable/disable rating CRL by URL. |
| | | **rate\_css\_urls** string | **Choices:*** disable
* enable
| Enable/disable rating CSS by URL. |
| | | **rate\_image\_urls** string | **Choices:*** disable
* enable
| Enable/disable rating images by URL. |
| | | **rate\_javascript\_urls** string | **Choices:*** disable
* enable
| Enable/disable rating JavaScript by URL. |
| | **https\_replacemsg** string | **Choices:*** enable
* disable
| Enable replacement messages for HTTPS. |
| | **inspection\_mode** string | **Choices:*** proxy
* flow-based
| Web filtering inspection mode. |
| | **log\_all\_url** string | **Choices:*** enable
* disable
| Enable/disable logging all URLs visited. |
| | **name** string / required | | Profile name. |
| | **options** list / elements=string | **Choices:*** activexfilter
* cookiefilter
* javafilter
* block-invalid-url
* jscript
* js
* vbs
* unknown
* intrinsic
* wf-referer
* wf-cookie
* per-user-bwl
* per-user-bal
| Options. |
| | **override** dictionary | | Web Filter override settings. |
| | | **ovrd\_cookie** string | **Choices:*** allow
* deny
| Allow/deny browser-based (cookie) overrides. |
| | | **ovrd\_dur** string | | Override duration. |
| | | **ovrd\_dur\_mode** string | **Choices:*** constant
* ask
| Override duration mode. |
| | | **ovrd\_scope** string | **Choices:*** user
* user-group
* ip
* browser
* ask
| Override scope. |
| | | **ovrd\_user\_group** string | | User groups with permission to use the override. |
| | | | **name** string / required | | User group name. Source user.group.name. |
| | | **profile** list / elements=string | | Web filter profile with permission to create overrides. |
| | | | **name** string / required | | Web profile. Source webfilter.profile.name. |
| | | **profile\_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
| Profile attribute to retrieve from the RADIUS server. |
| | | **profile\_type** string | **Choices:*** list
* radius
| Override profile type. |
| | **ovrd\_perm** list / elements=string | **Choices:*** bannedword-override
* urlfilter-override
* fortiguard-wf-override
* contenttype-check-override
| Permitted override types. |
| | **post\_action** string | **Choices:*** normal
* block
| Action taken for HTTP POST traffic. |
| | **replacemsg\_group** string | | Replacement message group. Source system.replacemsg-group.name. |
| | **url\_extraction** dictionary | | Configure URL Extraction |
| | | **redirect\_header** string | | HTTP header name to use for client redirect on blocked requests |
| | | **redirect\_no\_content** string | **Choices:*** enable
* disable
| Enable / Disable empty message-body entity in HTTP response |
| | | **redirect\_url** string | | HTTP header value to use for client redirect on blocked requests |
| | | **server\_fqdn** string | | URL extraction server FQDN (fully qualified domain name) |
| | | **status** string | **Choices:*** enable
* disable
| Enable URL Extraction |
| | **web** dictionary | | Web content filtering settings. |
| | | **allowlist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| FortiGuard allowlist settings. |
| | | **blacklist** string | **Choices:*** enable
* disable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blacklist. |
| | | **blocklist** string | **Choices:*** enable
* disable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blocklist. |
| | | **bword\_table** integer | | Banned word table ID. Source webfilter.content.id. |
| | | **bword\_threshold** integer | | Banned word score threshold. |
| | | **content\_header\_list** integer | | Content header list. Source webfilter.content-header.id. |
| | | **keyword\_match** string | | Search keywords to log when match is found. |
| | | | **pattern** string / required | | Pattern/keyword to search for. |
| | | **log\_search** string | **Choices:*** enable
* disable
| Enable/disable logging all search phrases. |
| | | **safe\_search** list / elements=string | **Choices:*** url
* header
| Safe search type. |
| | | **urlfilter\_table** integer | | URL filter table ID. Source webfilter.urlfilter.id. |
| | | **whitelist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| FortiGuard whitelist settings. |
| | | **youtube\_restrict** string | **Choices:*** none
* strict
* moderate
| YouTube EDU filter level. |
| | **web\_antiphishing\_log** string | **Choices:*** enable
* disable
| Enable/disable logging of AntiPhishing checks. |
| | **web\_content\_log** string | **Choices:*** enable
* disable
| Enable/disable logging logging blocked web content. |
| | **web\_extended\_all\_action\_log** string | **Choices:*** enable
* disable
| Enable/disable extended any filter action logging for web filtering. |
| | **web\_filter\_activex\_log** string | **Choices:*** enable
* disable
| Enable/disable logging ActiveX. |
| | **web\_filter\_applet\_log** string | **Choices:*** enable
* disable
| Enable/disable logging Java applets. |
| | **web\_filter\_command\_block\_log** string | **Choices:*** enable
* disable
| Enable/disable logging blocked commands. |
| | **web\_filter\_cookie\_log** string | **Choices:*** enable
* disable
| Enable/disable logging cookie filtering. |
| | **web\_filter\_cookie\_removal\_log** string | **Choices:*** enable
* disable
| Enable/disable logging blocked cookies. |
| | **web\_filter\_js\_log** string | **Choices:*** enable
* disable
| Enable/disable logging Java scripts. |
| | **web\_filter\_jscript\_log** string | **Choices:*** enable
* disable
| Enable/disable logging JScripts. |
| | **web\_filter\_referer\_log** string | **Choices:*** enable
* disable
| Enable/disable logging referrers. |
| | **web\_filter\_unknown\_log** string | **Choices:*** enable
* disable
| Enable/disable logging unknown scripts. |
| | **web\_filter\_vbs\_log** string | **Choices:*** enable
* disable
| Enable/disable logging VBS scripts. |
| | **web\_ftgd\_err\_log** string | **Choices:*** enable
* disable
| Enable/disable logging rating errors. |
| | **web\_ftgd\_quota\_usage** string | **Choices:*** enable
* disable
| Enable/disable logging daily quota usage. |
| | **web\_invalid\_domain\_log** string | **Choices:*** enable
* disable
| Enable/disable logging invalid domain names. |
| | **web\_url\_log** string | **Choices:*** enable
* disable
| Enable/disable logging URL filtering. |
| | **wisp** string | **Choices:*** enable
* disable
| Enable/disable web proxy WISP. |
| | **wisp\_algorithm** string | **Choices:*** primary-secondary
* round-robin
* auto-learning
| WISP server selection algorithm. |
| | **wisp\_servers** list / elements=string | | WISP servers. |
| | | **name** string / required | | Server name. Source web-proxy.wisp.name. |
| | **youtube\_channel\_filter** list / elements=string | | YouTube channel filter. |
| | | **channel\_id** string | | YouTube channel ID to be filtered. |
| | | **comment** string | | Comment. |
| | | **id** integer / required | | ID. |
| | **youtube\_channel\_status** string | **Choices:*** disable
* blacklist
* whitelist
| YouTube channel filter 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 Web filter profiles.
fortios_webfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_profile:
antiphish:
authentication: "domain-controller"
check_basic_auth: "enable"
check_uri: "enable"
check_username_only: "enable"
custom_patterns:
-
category: "username"
pattern: "<your_own_value>"
type: "regex"
default_action: "exempt"
domain_controller: "<your_own_value> (source credential-store.domain-controller.server-name)"
inspection_entries:
-
action: "exempt"
fortiguard_category: "<your_own_value>"
name: "default_name_17"
ldap: "<your_own_value> (source user.ldap.name)"
max_body_len: "19"
status: "enable"
comment: "Optional comments."
extended_log: "enable"
feature_set: "flow"
file_filter:
entries:
-
action: "log"
comment: "Comment."
direction: "incoming"
file_type:
-
name: "default_name_30 (source antivirus.filetype.name)"
filter: "<your_own_value>"
password_protected: "yes"
protocol: "http"
log: "enable"
scan_archive_contents: "enable"
status: "enable"
ftgd_wf:
exempt_quota: "<your_own_value>"
filters:
-
action: "block"
auth_usr_grp:
-
name: "default_name_42 (source user.group.name)"
category: "43"
id: "44"
log: "enable"
override_replacemsg: "<your_own_value>"
warn_duration: "<your_own_value>"
warning_duration_type: "session"
warning_prompt: "per-domain"
max_quota_timeout: "50"
options: "error-allow"
ovrd: "<your_own_value>"
quota:
-
category: "<your_own_value>"
duration: "<your_own_value>"
id: "56"
override_replacemsg: "<your_own_value>"
type: "time"
unit: "B"
value: "60"
rate_crl_urls: "disable"
rate_css_urls: "disable"
rate_image_urls: "disable"
rate_javascript_urls: "disable"
https_replacemsg: "enable"
inspection_mode: "proxy"
log_all_url: "enable"
name: "default_name_68"
options: "activexfilter"
override:
ovrd_cookie: "allow"
ovrd_dur: "<your_own_value>"
ovrd_dur_mode: "constant"
ovrd_scope: "user"
ovrd_user_group:
-
name: "default_name_76 (source user.group.name)"
profile:
-
name: "default_name_78 (source webfilter.profile.name)"
profile_attribute: "User-Name"
profile_type: "list"
ovrd_perm: "bannedword-override"
post_action: "normal"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
url_extraction:
redirect_header: "<your_own_value>"
redirect_no_content: "enable"
redirect_url: "<your_own_value>"
server_fqdn: "<your_own_value>"
status: "enable"
web:
allowlist: "exempt-av"
blacklist: "enable"
blocklist: "enable"
bword_table: "94 (source webfilter.content.id)"
bword_threshold: "95"
content_header_list: "96 (source webfilter.content-header.id)"
keyword_match:
-
pattern: "<your_own_value>"
log_search: "enable"
safe_search: "url"
urlfilter_table: "101 (source webfilter.urlfilter.id)"
whitelist: "exempt-av"
youtube_restrict: "none"
web_antiphishing_log: "enable"
web_content_log: "enable"
web_extended_all_action_log: "enable"
web_filter_activex_log: "enable"
web_filter_applet_log: "enable"
web_filter_command_block_log: "enable"
web_filter_cookie_log: "enable"
web_filter_cookie_removal_log: "enable"
web_filter_js_log: "enable"
web_filter_jscript_log: "enable"
web_filter_referer_log: "enable"
web_filter_unknown_log: "enable"
web_filter_vbs_log: "enable"
web_ftgd_err_log: "enable"
web_ftgd_quota_usage: "enable"
web_invalid_domain_log: "enable"
web_url_log: "enable"
wisp: "enable"
wisp_algorithm: "primary-secondary"
wisp_servers:
-
name: "default_name_124 (source web-proxy.wisp.name)"
youtube_channel_filter:
-
channel_id: "<your_own_value>"
comment: "Comment."
id: "128"
youtube_channel_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_spamfilter_iptrust – Configure AntiSpam IP trust in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_spamfilter\_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_spamfilter_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 spamfilter 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **spamfilter\_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. |
| **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_spamfilter_iptrust:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_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_firewall_iprope_list – lis in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_firewall\_iprope\_list – lis in Fortinet’s FortiOS and FortiGate.
===========================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_iprope_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 firewall\_iprope 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. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task. |
| **firewall\_iprope\_list** dictionary | | list |
| | string | | Number, hexadecimal. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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: list
fortios_firewall_iprope_list:
vdom: "{{ vdom }}"
firewall_iprope_list:
<group_number>: "<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_network_monitor_settings – Configure network monitor settings in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_switch\_controller\_network\_monitor\_settings – Configure network monitor 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_network_monitor_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 network\_monitor\_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\_network\_monitor\_settings** dictionary | | Configure network monitor settings. |
| | **network\_monitoring** string | **Choices:*** enable
* disable
| Enable/disable passive gathering of information by FortiSwitch units concerning other network devices. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 network monitor settings.
fortios_switch_controller_network_monitor_settings:
vdom: "{{ vdom }}"
switch_controller_network_monitor_settings:
network_monitoring: "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_null_device_filter – Filters for null device logging in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_log\_null\_device\_filter – Filters for null device 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_null_device_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\_null\_device 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\_null\_device\_filter** dictionary | | Filters for null device logging. |
| | **anomaly** string | **Choices:*** enable
* disable
| Enable/disable anomaly logging. |
| | **dns** string | **Choices:*** enable
* disable
| Enable/disable detailed DNS event logging. |
| | **filter** string | | Null-device 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 null device logging.
fortios_log_null_device_filter:
vdom: "{{ vdom }}"
log_null_device_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_system_standalone_cluster – Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_standalone\_cluster – Configure FortiGate Session Life Support Protocol (FGSP) cluster 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_standalone_cluster`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 standalone\_cluster category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_standalone\_cluster** dictionary | | Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes. |
| | **encryption** string | **Choices:*** enable
* disable
| Enable/disable encryption when synchronizing sessions. |
| | **group\_member\_id** integer | | Cluster member ID (0 - 15). |
| | **layer2\_connection** string | **Choices:*** available
* unavailable
| Indicate whether layer 2 connections are present among FGSP members. |
| | **psksecret** string | | Pre-shared secret for session synchronization (ASCII string or hexadecimal encoded with a leading 0x). |
| | **session\_sync\_dev** string | | Offload session-sync process to kernel and sync sessions using connected interface(s) directly. Source system.interface.name. |
| | **standalone\_group\_id** integer | | Cluster group ID (0 - 255). Must be the same for all members. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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) cluster attributes.
fortios_system_standalone_cluster:
vdom: "{{ vdom }}"
system_standalone_cluster:
encryption: "enable"
group_member_id: "4"
layer2_connection: "available"
psksecret: "<your_own_value>"
session_sync_dev: "<your_own_value> (source system.interface.name)"
standalone_group_id: "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_email_server – Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_email\_server – Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features in Fortinet’s FortiOS and FortiGate.
================================================================================================================================================================================================================================================
Note
This plugin is part of the [fortinet.fortios collection](https://galaxy.ansible.com/fortinet/fortios) (version 2.1.2).
You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_email_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 email\_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. |
| **system\_email\_server** dictionary | | Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features. |
| | **authenticate** string | **Choices:*** enable
* disable
| Enable/disable 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. |
| | **password** string | | SMTP server user password for authentication. |
| | **port** integer | | SMTP server port. |
| | **reply\_to** string | | Reply-To email address. |
| | **security** string | **Choices:*** none
* starttls
* smtps
| Connection security used by the email server. |
| | **server** string | | SMTP server IP address or hostname. |
| | **source\_ip** string | | SMTP server IPv4 source IP. |
| | **source\_ip6** string | | SMTP server IPv6 source IP. |
| | **ssl\_min\_proto\_version** string | **Choices:*** default
* SSLv3
* TLSv1
* TLSv1-1
* TLSv1-2
| Minimum supported protocol version for SSL/TLS connections . |
| | **type** string | **Choices:*** custom
| Use FortiGuard Message service or custom email server. |
| | **username** string | | SMTP server user name for authentication. |
| | **validate\_server** string | **Choices:*** enable
* disable
| Enable/disable validation of server certificate. |
| **vdom** string | **Default:**"root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that 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 email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication
features.
fortios_system_email_server:
vdom: "{{ vdom }}"
system_email_server:
authenticate: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
password: "<your_own_value>"
port: "7"
reply_to: "<your_own_value>"
security: "none"
server: "192.168.100.40"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
ssl_min_proto_version: "default"
type: "custom"
username: "<your_own_value>"
validate_server: "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_sso_forticloud_admin – Configure FortiCloud SSO admin users in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_sso\_forticloud\_admin – Configure FortiCloud 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_forticloud_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\_forticloud\_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\_forticloud\_admin** dictionary | | Configure FortiCloud SSO admin users. |
| | **name** string / required | | FortiCloud 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 FortiCloud SSO admin users.
fortios_system_sso_forticloud_admin:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sso_forticloud_admin:
name: "default_name_3"
vdom:
-
name: "default_name_5 (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_system_replacemsg_http – Replacement messages in Fortinet’s FortiOS and FortiGate. fortinet.fortios.fortios\_system\_replacemsg\_http – 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_http`.
New in version 2.10: of fortinet.fortios
* [Synopsis](#synopsis)
* [Requirements](#requirements)
* [Parameters](#parameters)
* [Notes](#notes)
* [Examples](#examples)
* [Return 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 http category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
* ansible>=2.9.0
Parameters
----------
| Parameter | Choices/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\_http** 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_http:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_http:
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 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.