code
stringlengths 2.5k
150k
| kind
stringclasses 1
value |
|---|---|
ansible fortinet.fortimanager.fmgr_user_device – Configure devices. fortinet.fortimanager.fmgr\_user\_device – Configure 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_user_device`.
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\_device** dictionary | | the top level parameters set |
| | **alias** string | | Device alias. |
| | **avatar** string | | Image file for avatar (maximum 4K base64 encoded). |
| | **category** string | **Choices:*** none
* android-device
* blackberry-device
* fortinet-device
* ios-device
* windows-device
* amazon-device
| Device category. |
| | **comment** string | | Comment. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **avatar** string | | no description |
| | | **category** string | **Choices:*** none
* android-device
* blackberry-device
* fortinet-device
* ios-device
* windows-device
* amazon-device
| no description |
| | | **comment** string | | no description |
| | | **family** string | | no description |
| | | **hardware-vendor** string | | no description |
| | | **hardware-version** string | | no description |
| | | **mac** string | | no description |
| | | **master-device** string | | no description |
| | | **os** string | | no description |
| | | **software-version** string | | no description |
| | | **tags** string | | no description |
| | | **type** string | **Choices:*** ipad
* iphone
* gaming-console
* blackberry-phone
* blackberry-playbook
* linux-pc
* mac
* windows-pc
* android-phone
* android-tablet
* media-streaming
* windows-phone
* fortinet-device
* ip-phone
* router-nat-device
* other-network-device
* windows-tablet
* printer
* forticam
* fortifone
* unknown
| no description |
| | | **user** string | | no description |
| | **mac** string | | Device MAC address(es). |
| | **master-device** string | | Master device (optional). |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **type** string | **Choices:*** ipad
* iphone
* gaming-console
* blackberry-phone
* blackberry-playbook
* linux-pc
* mac
* windows-pc
* android-phone
* android-tablet
* media-streaming
* windows-phone
* fortinet-device
* ip-phone
* router-nat-device
* other-network-device
* windows-tablet
* printer
* forticam
* fortifone
* unknown
| Device type. |
| | **user** 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: Configure devices.
fmgr_user_device:
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_device:
alias: <value of string>
avatar: <value of string>
category: <value in [none, android-device, blackberry-device, ...]>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
avatar: <value of string>
category: <value in [none, android-device, blackberry-device, ...]>
comment: <value of string>
mac: <value of string>
master-device: <value of string>
tags: <value of string>
type: <value in [ipad, iphone, gaming-console, ...]>
user: <value of string>
family: <value of string>
hardware-vendor: <value of string>
hardware-version: <value of string>
os: <value of string>
software-version: <value of string>
mac: <value of string>
master-device: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
type: <value in [ipad, iphone, gaming-console, ...]>
user: <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_dvm_cmd_changehaseq – Modify HA sequence to promote a slave to become the master of the cluster. fortinet.fortimanager.fmgr\_dvm\_cmd\_changehaseq – Modify HA sequence to promote a slave to become the master of the cluster.
==============================================================================================================================
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_changehaseq`.
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\_changehaseq** dictionary | | the top level parameters set |
| | **adom** string | | Name or ID of the ADOM where the command is to be executed on. |
| | **device** string | | Name or ID of the target HA cluster (original master device). |
| | **flags** list / elements=string | **Choices:*** none
* create\_task
* nonblocking
* log\_dev
| no description |
| | **new\_master** string | | Name or ID of the new HA master. |
| **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: Modify HA sequence to promote a slave to become the master of the cluster.
fmgr_dvm_cmd_changehaseq:
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_changehaseq:
adom: <value of string>
device: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
new_master: <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_hotspot20_h2qposuprovider – Configure online sign up fortinet.fortimanager.fmgr\_hotspot20\_h2qposuprovider – Configure online sign up
=================================================================================
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_h2qposuprovider`.
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\_h2qposuprovider** dictionary | | the top level parameters set |
| | **friendly-name** list / elements=string | | no description |
| | | **friendly-name** string | | OSU provider friendly name. |
| | | **index** integer | | OSU provider friendly name index. |
| | | **lang** string | | Language code. |
| | **icon** string | | OSU provider icon. |
| | **name** string | | OSU provider ID. |
| | **osu-method** list / elements=string | **Choices:*** oma-dm
* soap-xml-spp
* reserved
| no description |
| | **osu-nai** string | | OSU NAI. |
| | **server-uri** string | | Server URI. |
| | **service-description** list / elements=string | | no description |
| | | **lang** string | | Language code. |
| | | **service-description** string | | Service description. |
| | | **service-id** integer | | OSU service 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 online sign up
fmgr_hotspot20_h2qposuprovider:
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_h2qposuprovider:
friendly-name:
-
friendly-name: <value of string>
index: <value of integer>
lang: <value of string>
icon: <value of string>
name: <value of string>
osu-method:
- oma-dm
- soap-xml-spp
- reserved
osu-nai: <value of string>
server-uri: <value of string>
service-description:
-
lang: <value of string>
service-description: <value of string>
service-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_devprof_system_snmp_community – SNMP community configuration. fortinet.fortimanager.fmgr\_devprof\_system\_snmp\_community – SNMP community 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_devprof_system_snmp_community`.
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\_snmp\_community** dictionary | | the top level parameters set |
| | **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
* temperature-high
* voltage-alert
* ha-member-up
* ha-member-down
* ent-conf-change
* av-conserve
* av-bypass
* av-oversize-passed
* av-oversize-blocked
* ips-pkg-update
* power-supply-failure
* amc-bypass
* faz-disconnect
* fan-failure
* bgp-established
* bgp-backward-transition
* wc-ap-up
* wc-ap-down
* fswctl-session-up
* fswctl-session-down
* ips-fail-open
* load-balance-real-server-down
* device-new
* enter-intf-bypass
* exit-intf-bypass
* per-cpu-high
* power-blade-down
* confsync\_failure
* dhcp
* pool-usage
* power-redundancy-degrade
* power-redundancy-failure
* ospf-nbr-state-change
* ospf-virtnbr-state-change
| no description |
| | **hosts** list / elements=string | | no description |
| | | **ha-direct** string | **Choices:*** disable
* enable
| 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 | | 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 | | no description |
| | | **ha-direct** string | **Choices:*** disable
* enable
| 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 | | Host6 entry ID. |
| | | **ipv6** string | | SNMP manager IPv6 address prefix. |
| | | **source-ipv6** string | | Source IPv6 address for SNMP traps. |
| | **id** integer | | Community ID. |
| | **name** string | | 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 v1 trap local port (default = 162). |
| | **trap-v1-rport** integer | | SNMP v1 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. |
| **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: SNMP community configuration.
fmgr_devprof_system_snmp_community:
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>
state: <value in [present, absent]>
devprof_system_snmp_community:
events:
- 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
- temperature-high
- voltage-alert
- ha-member-up
- ha-member-down
- ent-conf-change
- av-conserve
- av-bypass
- av-oversize-passed
- av-oversize-blocked
- ips-pkg-update
- power-supply-failure
- amc-bypass
- faz-disconnect
- fan-failure
- bgp-established
- bgp-backward-transition
- wc-ap-up
- wc-ap-down
- fswctl-session-up
- fswctl-session-down
- ips-fail-open
- load-balance-real-server-down
- device-new
- enter-intf-bypass
- exit-intf-bypass
- per-cpu-high
- power-blade-down
- confsync_failure
- dhcp
- pool-usage
- power-redundancy-degrade
- power-redundancy-failure
- ospf-nbr-state-change
- ospf-virtnbr-state-change
hosts:
-
ha-direct: <value in [disable, enable]>
host-type: <value in [any, query, trap]>
id: <value of integer>
ip: <value of string>
source-ip: <value of string>
hosts6:
-
ha-direct: <value in [disable, enable]>
host-type: <value in [any, query, trap]>
id: <value of integer>
ipv6: <value of string>
source-ipv6: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dynamic_vpntunnel_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_vpntunnel\_dynamicmapping – 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_dynamic_vpntunnel_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_vpntunnel\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **local-ipsec** string | | no description |
| **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 |
| **vpntunnel** string / required | | the parameter (vpntunnel) 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_dynamic_vpntunnel_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>
vpntunnel: <your own value>
state: <value in [present, absent]>
dynamic_vpntunnel_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
local-ipsec: <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_mainclass – Hidden table for datasource. fortinet.fortimanager.fmgr\_waf\_mainclass – Hidden table for datasource.
=========================================================================
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_mainclass`.
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 |
| **waf\_mainclass** dictionary | | the top level parameters set |
| | **id** integer | | Main signature class ID. |
| | **name** string | | Main signature class 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: Hidden table for datasource.
fmgr_waf_mainclass:
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]>
waf_mainclass:
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_devprof_device_profile_fortianalyzer – no description fortinet.fortimanager.fmgr\_devprof\_device\_profile\_fortianalyzer – 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_devprof_device_profile_fortianalyzer`.
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\_device\_profile\_fortianalyzer** dictionary | | the top level parameters set |
| | **managed-sn** string | | no description |
| | **target** string | **Choices:*** none
* this-fmg
* managed
* others
| no description |
| | **target-ip** string | | no description |
| | **target-sn** string | | no description |
| **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: no description
fmgr_devprof_device_profile_fortianalyzer:
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_device_profile_fortianalyzer:
managed-sn: <value of string>
target: <value in [none, this-fmg, managed, ...]>
target-ip: <value of string>
target-sn: <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_certificate_oftp – OFTP certificates and keys. fortinet.fortimanager.fmgr\_system\_certificate\_oftp – OFTP certificates and keys.
===================================================================================
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_certificate_oftp`.
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\_certificate\_oftp** dictionary | | the top level parameters set |
| | **certificate** string | | no description |
| | **comment** string | | OFTP certificate comment. |
| | **custom** string | **Choices:*** **disable** ←
* enable
| Enable/disable custom certificate. disable - Disable setting. enable - Enable setting. |
| | **local** string | | Choose from a local certificates. |
| | **mode** string | **Choices:*** **default** ←
* custom
* local
| Mode of certificates used by oftpd. default - Default mode. custom - Use custom certificate. local - Use a local certificate. |
| | **password** string | | no description |
| | **private-key** 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: OFTP certificates and keys.
fmgr_system_certificate_oftp:
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_certificate_oftp:
certificate: <value of string>
comment: <value of string>
custom: <value in [disable, enable]>
password: <value of string>
private-key: <value of string>
local: <value of string>
mode: <value in [default, custom, local]>
```
Return Values
-------------
Common return 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 – Configure AntiSpam profiles. fortinet.fortimanager.fmgr\_spamfilter\_profile – Configure AntiSpam 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_spamfilter_profile`.
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 |
| **spamfilter\_profile** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **external** string | **Choices:*** disable
* enable
| Enable/disable external Email inspection. |
| | **flow-based** string | **Choices:*** disable
* enable
| Enable/disable flow-based spam filtering. |
| | **name** string | | Profile name. |
| | **options** list / elements=string | **Choices:*** bannedword
* spamemailbwl
* spamfsip
* spamfssubmit
* spamfschksum
* spamfsurl
* spamhelodns
* spamipbwl
* spamraddrdns
* spamrbl
* spamhdrcheck
* spamfsphish
* spambwl
| no description |
| | **replacemsg-group** string | | Replacement message group. |
| | **spam-bwl-table** string | | Anti-spam black/white list table ID. |
| | **spam-bword-table** string | | Anti-spam banned word table ID. |
| | **spam-bword-threshold** integer | | Spam banned word threshold. |
| | **spam-filtering** string | **Choices:*** disable
* enable
| Enable/disable spam filtering. |
| | **spam-iptrust-table** string | | Anti-spam IP trust table 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** string | | Anti-spam MIME header table ID. |
| | **spam-rbl-table** string | | Anti-spam DNSBL table ID. |
| **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 profiles.
fmgr_spamfilter_profile:
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]>
spamfilter_profile:
comment: <value of string>
external: <value in [disable, enable]>
flow-based: <value in [disable, enable]>
name: <value of string>
options:
- bannedword
- spamemailbwl
- spamfsip
- spamfssubmit
- spamfschksum
- spamfsurl
- spamhelodns
- spamipbwl
- spamraddrdns
- spamrbl
- spamhdrcheck
- spamfsphish
- spambwl
replacemsg-group: <value of string>
spam-bwl-table: <value of string>
spam-bword-table: <value of string>
spam-bword-threshold: <value of integer>
spam-filtering: <value in [disable, enable]>
spam-iptrust-table: <value of string>
spam-log: <value in [disable, enable]>
spam-log-fortiguard-response: <value in [disable, enable]>
spam-mheader-table: <value of string>
spam-rbl-table: <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_webfilter_profile_youtubechannelfilter – YouTube channel filter. fortinet.fortimanager.fmgr\_webfilter\_profile\_youtubechannelfilter – YouTube channel filter.
==============================================================================================
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_youtubechannelfilter`.
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\_youtubechannelfilter** dictionary | | the top level parameters set |
| | **channel-id** string | | YouTube channel ID to be filtered. |
| | **comment** string | | Comment. |
| | **id** integer | | 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: YouTube channel filter.
fmgr_webfilter_profile_youtubechannelfilter:
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_youtubechannelfilter:
channel-id: <value of string>
comment: <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_devprof_system_replacemsg_http – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_http – 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_http`.
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\_http** 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_http:
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_http:
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_system_replacemsggroup_nntp – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_nntp – 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_nntp`.
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\_nntp** 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. |
| **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_nntp:
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_nntp:
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_firewall_profileprotocoloptions_http – Configure HTTP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_http – Configure HTTP 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_http`.
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\_http** dictionary | | the top level parameters set |
| | **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 - 10240 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, default = 10). |
| | **fortinet-bar** string | **Choices:*** disable
* enable
| Enable/disable Fortinet bar on HTML content. |
| | **fortinet-bar-port** integer | | Port for use by Fortinet Bar (1 - 65535, default = 8011). |
| | **http-policy** string | **Choices:*** disable
* enable
| Enable/disable HTTP policy check. |
| | **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 uncompression use... |
| | **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 occur if ... |
| | **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. |
| **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: Configure HTTP protocol options.
fmgr_firewall_profileprotocoloptions_http:
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>
firewall_profileprotocoloptions_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>
http-policy: <value in [disable, enable]>
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
range-block: <value in [disable, enable]>
retry-count: <value of integer>
scan-bzip2: <value in [disable, enable]>
status: <value in [disable, enable]>
streaming-content-bypass: <value in [disable, enable]>
strip-x-forwarded-for: <value in [disable, enable]>
switching-protocols: <value in [bypass, block]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-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]>
ssl-offloaded: <value in [no, yes]>
stream-based-uncompressed-limit: <value of integer>
proxy-after-tcp-handshake: <value in [disable, enable]>
tunnel-non-http: <value in [disable, enable]>
unknown-http-version: <value in [best-effort, reject, tunnel]>
```
Return Values
-------------
Common return 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_voip_profile_sccp – SCCP. fortinet.fortimanager.fmgr\_voip\_profile\_sccp – SCCP.
=======================================================
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_voip_profile_sccp`.
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 |
| **voip\_profile\_sccp** dictionary | | the top level parameters set |
| | **block-mcast** string | **Choices:*** disable
* enable
| Enable/disable block multicast RTP connections. |
| | **log-call-summary** string | **Choices:*** disable
* enable
| Enable/disable log summary of SCCP calls. |
| | **log-violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SCCP violations. |
| | **max-calls** integer | | Maximum calls per minute per SCCP client (max 65535). |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SCCP. |
| | **verify-header** string | **Choices:*** disable
* enable
| Enable/disable verify SCCP header content. |
| **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: SCCP.
fmgr_voip_profile_sccp:
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>
voip_profile_sccp:
block-mcast: <value in [disable, enable]>
log-call-summary: <value in [disable, enable]>
log-violations: <value in [disable, enable]>
max-calls: <value of integer>
status: <value in [disable, enable]>
verify-header: <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_securityconsole_assign_package – Assign or unassign global policy package to ADOM packages. fortinet.fortimanager.fmgr\_securityconsole\_assign\_package – Assign or unassign global policy package to ADOM packages.
=========================================================================================================================
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_securityconsole_assign_package`.
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 |
| **securityconsole\_assign\_package** dictionary | | the top level parameters set |
| | **flags** list / elements=string | **Choices:*** none
* cp\_all\_objs
* copy\_assigned\_pkg
* unassign
| no description |
| | **pkg** string | | Source package path and name. |
| | **target** list / elements=string | | no description |
| | | **adom** string | | Destination ADOM. |
| | | **excluded** string | **Choices:*** **disable** ←
* enable
| disable - Only include the packages listed in the <i>pkg</i> list. enable - Exclude the package listed in the <i>pkg</i> list, and assign to all other packages in the ADOM. |
| | | **pkg** string | | Destination ADOM policy package path and 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: Assign or unassign global policy package to ADOM packages.
fmgr_securityconsole_assign_package:
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, ...]
securityconsole_assign_package:
flags:
- none
- cp_all_objs
- copy_assigned_pkg
- unassign
pkg: <value of string>
target:
-
adom: <value of string>
excluded: <value in [disable, enable]>
pkg: <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_content – Configure Web filter banned word table. fortinet.fortimanager.fmgr\_webfilter\_content – Configure Web filter banned word table.
========================================================================================
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_content`.
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 |
| **webfilter\_content** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** exempt
* block
| 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 | | 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, default = 10). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable banned word. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **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 Web filter banned word table.
fmgr_webfilter_content:
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]>
webfilter_content:
comment: <value of string>
entries:
-
action: <value in [exempt, block]>
lang: <value in [western, simch, trach, ...]>
name: <value of string>
pattern-type: <value in [wildcard, regexp]>
score: <value of integer>
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)
ansible fortinet.fortimanager.fmgr_switchcontroller_lldpprofile_mednetworkpolicy – Configuration method to edit Media Endpoint Discovery fortinet.fortimanager.fmgr\_switchcontroller\_lldpprofile\_mednetworkpolicy – Configuration method to edit Media Endpoint Discovery
===================================================================================================================================
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_lldpprofile_mednetworkpolicy`.
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 |
| **lldp-profile** string / required | | the parameter (lldp-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 |
| **switchcontroller\_lldpprofile\_mednetworkpolicy** dictionary | | the top level parameters set |
| | **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 fo... |
| | **name** string | | 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. |
| **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 Media Endpoint Discovery
fmgr_switchcontroller_lldpprofile_mednetworkpolicy:
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>
lldp-profile: <your own value>
state: <value in [present, absent]>
switchcontroller_lldpprofile_mednetworkpolicy:
dscp: <value of integer>
name: <value of string>
priority: <value of integer>
status: <value in [disable, enable]>
vlan: <value of integer>
vlan-intf: <value of string>
assign-vlan: <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_socfabric – SOC Fabric. fortinet.fortimanager.fmgr\_system\_socfabric – SOC Fabric.
===========================================================
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_socfabric`.
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\_socfabric** dictionary | | the top level parameters set |
| | **name** string | | Fabric name. |
| | **port** integer | **Default:**6443 | communication port (1 - 65535). |
| | **psk** string | | no description |
| | **role** string | **Choices:*** **member** ←
* supervisor
| Enable or Disable SOC Fabric. member - SOC Fabric member. supervisor - SOC Fabric supervisor. |
| | **secure-connection** string | **Choices:*** disable
* **enable** ←
| Enable or Disable SSL/TLS. disable - Disable SSL/TLS. enable - Enable SSL/TLS. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable or Disable SOC Fabric. disable - Disable SOC Fabric. enable - Enable SOC Fabric. |
| | **supervisor** string | | IP/FQDN of supervisor. |
| **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: SOC Fabric.
fmgr_system_socfabric:
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_socfabric:
name: <value of string>
port: <value of integer>
psk: <value of string>
role: <value in [member, supervisor]>
secure-connection: <value in [disable, enable]>
status: <value in [disable, enable]>
supervisor: <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_custommessage – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_custommessage – 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_custommessage`.
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\_custommessage** 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. |
| **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_custommessage:
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_custommessage:
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_webfilter_profile_web – Web content filtering settings. fortinet.fortimanager.fmgr\_webfilter\_profile\_web – Web content filtering 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_web`.
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\_web** dictionary | | the top level parameters set |
| | **allowlist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| no description |
| | **blacklist** string | **Choices:*** disable
* enable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blacklist. |
| | **blocklist** string | **Choices:*** disable
* enable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blocklist. |
| | **bword-table** string | | Banned word table ID. |
| | **bword-threshold** integer | | Banned word score threshold. |
| | **content-header-list** string | | Content header list. |
| | **keyword-match** string | | no description |
| | **log-search** string | **Choices:*** disable
* enable
| Enable/disable logging all search phrases. |
| | **safe-search** list / elements=string | **Choices:*** google
* yahoo
* bing
* url
* header
| no description |
| | **urlfilter-table** string | | URL filter table ID. |
| | **whitelist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| no description |
| | **youtube-restrict** string | **Choices:*** strict
* none
* moderate
| YouTube EDU filter level. |
| **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 content filtering settings.
fmgr_webfilter_profile_web:
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_web:
blacklist: <value in [disable, enable]>
bword-table: <value of string>
bword-threshold: <value of integer>
content-header-list: <value of string>
keyword-match: <value of string>
log-search: <value in [disable, enable]>
safe-search:
- google
- yahoo
- bing
- url
- header
urlfilter-table: <value of string>
whitelist:
- exempt-av
- exempt-webcontent
- exempt-activex-java-cookie
- exempt-dlp
- exempt-rangeblock
- extended-log-others
youtube-restrict: <value in [strict, none, moderate]>
allowlist:
- exempt-av
- exempt-webcontent
- exempt-activex-java-cookie
- exempt-dlp
- exempt-rangeblock
- extended-log-others
blocklist: <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_autodelete – Automatic deletion policy for logs, reports, archived, and quarantined files. fortinet.fortimanager.fmgr\_system\_autodelete – Automatic deletion policy for logs, reports, archived, and quarantined files.
==============================================================================================================================
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_autodelete`.
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\_autodelete** dictionary | | the top level parameters set |
| | **dlp-files-auto-deletion** dictionary | | no description |
| | | **retention** string | **Choices:*** **days** ←
* weeks
* months
| Automatic deletion in days, weeks, or months. days - Auto-delete data older than <value> days. weeks - Auto-delete data older than <value> weeks. months - Auto-delete data older than <value> months. |
| | | **runat** integer | **Default:**0 | Automatic deletion run at (0 - 23) oclock. |
| | | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable automatic deletion. disable - Disable automatic deletion. enable - Enable automatic deletion. |
| | | **value** integer | **Default:**0 | Automatic deletion in x days, weeks, or months. |
| | **log-auto-deletion** dictionary | | no description |
| | | **retention** string | **Choices:*** **days** ←
* weeks
* months
| Automatic deletion in days, weeks, or months. days - Auto-delete data older than <value> days. weeks - Auto-delete data older than <value> weeks. months - Auto-delete data older than <value> months. |
| | | **runat** integer | **Default:**0 | Automatic deletion run at (0 - 23) oclock. |
| | | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable automatic deletion. disable - Disable automatic deletion. enable - Enable automatic deletion. |
| | | **value** integer | **Default:**0 | Automatic deletion in x days, weeks, or months. |
| | **quarantine-files-auto-deletion** dictionary | | no description |
| | | **retention** string | **Choices:*** **days** ←
* weeks
* months
| Automatic deletion in days, weeks, or months. days - Auto-delete data older than <value> days. weeks - Auto-delete data older than <value> weeks. months - Auto-delete data older than <value> months. |
| | | **runat** integer | **Default:**0 | Automatic deletion run at (0 - 23) oclock. |
| | | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable automatic deletion. disable - Disable automatic deletion. enable - Enable automatic deletion. |
| | | **value** integer | **Default:**0 | Automatic deletion in x days, weeks, or months. |
| | **report-auto-deletion** dictionary | | no description |
| | | **retention** string | **Choices:*** **days** ←
* weeks
* months
| Automatic deletion in days, weeks, or months. days - Auto-delete data older than <value> days. weeks - Auto-delete data older than <value> weeks. months - Auto-delete data older than <value> months. |
| | | **runat** integer | **Default:**0 | Automatic deletion run at (0 - 23) oclock. |
| | | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable automatic deletion. disable - Disable automatic deletion. enable - Enable automatic deletion. |
| | | **value** integer | **Default:**0 | Automatic deletion in x days, weeks, or months. |
| | **status-fake** integer | | Fake value for the menu to work. |
| **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: Automatic deletion policy for logs, reports, archived, and quarantined files.
fmgr_system_autodelete:
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_autodelete:
dlp-files-auto-deletion:
retention: <value in [days, weeks, months]>
runat: <value of integer>
status: <value in [disable, enable]>
value: <value of integer>
log-auto-deletion:
retention: <value in [days, weeks, months]>
runat: <value of integer>
status: <value in [disable, enable]>
value: <value of integer>
quarantine-files-auto-deletion:
retention: <value in [days, weeks, months]>
runat: <value of integer>
status: <value in [disable, enable]>
value: <value of integer>
report-auto-deletion:
retention: <value in [days, weeks, months]>
runat: <value of integer>
status: <value in [disable, enable]>
value: <value of integer>
status-fake: <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_fsp_vlan_interface_ipv6_ip6delegatedprefixlist – Advertised IPv6 delegated prefix list. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface\_ipv6\_ip6delegatedprefixlist – Advertised IPv6 delegated prefix 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_fsp_vlan_interface_ipv6_ip6delegatedprefixlist`.
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 |
| **fsp\_vlan\_interface\_ipv6\_ip6delegatedprefixlist** dictionary | | the top level parameters set |
| | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | **prefix-id** integer | | no description |
| | **rdnss** string | | no description |
| | **rdnss-service** string | **Choices:*** delegated
* default
* specify
| no description |
| | **subnet** string | | no description |
| | **upstream-interface** 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 |
| **vlan** string / required | | the parameter (vlan) 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: Advertised IPv6 delegated prefix list.
fmgr_fsp_vlan_interface_ipv6_ip6delegatedprefixlist:
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>
vlan: <your own value>
state: <value in [present, absent]>
fsp_vlan_interface_ipv6_ip6delegatedprefixlist:
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <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_duplication – Create SD-WAN duplication rule. fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_duplication – Create SD-WAN duplication 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_wanprof_system_sdwan_duplication`.
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\_duplication** dictionary | | the top level parameters set |
| | **dstaddr** string | | Destination address or address group names. |
| | **dstaddr6** string | | Destination address6 or address6 group names. |
| | **dstintf** string | | Outgoing (egress) interfaces or zones. |
| | **id** integer | | Duplication rule ID (1 - 255). |
| | **packet-de-duplication** string | **Choices:*** disable
* enable
| Enable/disable discarding of packets that have been duplicated. |
| | **packet-duplication** string | **Choices:*** disable
* force
* on-demand
| Configure packet duplication method. |
| | **service** string | | Service and service group name. |
| | **service-id** string | | SD-WAN service rule ID list. |
| | **srcaddr** string | | Source address or address group names. |
| | **srcaddr6** string | | Source address6 or address6 group names. |
| | **srcintf** string | | Incoming (ingress) interfaces or zones. |
| **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 duplication rule.
fmgr_wanprof_system_sdwan_duplication:
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_duplication:
dstaddr: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
id: <value of integer>
packet-de-duplication: <value in [disable, enable]>
packet-duplication: <value in [disable, force, on-demand]>
service: <value of string>
srcaddr: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
service-id: <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_fsp_vlan_dynamicmapping_interface_secondaryip – Second IP address of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_interface\_secondaryip – Second IP address of interface.
===============================================================================================================
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_fsp_vlan_dynamicmapping_interface_secondaryip`.
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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fsp\_vlan\_dynamicmapping\_interface\_secondaryip** dictionary | | the top level parameters set |
| | **allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
* dnp
* ftm
* fabric
| no description |
| | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| no description |
| | **detectserver** string | | no description |
| | **gwdetect** string | **Choices:*** disable
* enable
| no description |
| | **ha-priority** integer | | no description |
| | **id** integer | | no description |
| | **ip** string | | no description |
| | **ping-serv-status** integer | | no description |
| | **seq** integer | | 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 |
| **vlan** string / required | | the parameter (vlan) 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: Second IP address of interface.
fmgr_fsp_vlan_dynamicmapping_interface_secondaryip:
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>
vlan: <your own value>
dynamic_mapping: <your own value>
state: <value in [present, absent]>
fsp_vlan_dynamicmapping_interface_secondaryip:
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <value of string>
gwdetect: <value in [disable, enable]>
ha-priority: <value of integer>
id: <value of integer>
ip: <value of string>
ping-serv-status: <value of integer>
seq: <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_pkg_firewall_policy64 – Configure IPv6 to IPv4 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy64 – Configure IPv6 to IPv4 policies.
======================================================================================
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_policy64`.
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\_policy64** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
| Policy action. |
| | **comments** string | | Comment. |
| | **dstaddr** string | | Destination address name. |
| | **dstintf** string | | Destination interface name. |
| | **fixedport** string | **Choices:*** disable
* enable
| Enable/disable policy fixed port. |
| | **ippool** string | **Choices:*** disable
* enable
| Enable/disable policy64 IP pool. |
| | **logtraffic** string | **Choices:*** disable
* enable
| Enable/disable policy log traffic. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts and ends. |
| | **name** string | | Policy name. |
| | **per-ip-shaper** string | | Per-IP traffic shaper. |
| | **permit-any-host** string | **Choices:*** disable
* enable
| Enable/disable permit any host in. |
| | **policyid** integer | | Policy ID. |
| | **poolname** string | | Policy IP pool names. |
| | **schedule** string | | Schedule name. |
| | **service** string | | Service name. |
| | **srcaddr** string | | Source address name. |
| | **srcintf** string | | Source interface name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable policy status. |
| | **tags** string | | Applied object tags. |
| | **tcp-mss-receiver** integer | | TCP MSS value of receiver. |
| | **tcp-mss-sender** integer | | TCP MSS value of sender. |
| | **traffic-shaper** string | | Traffic shaper. |
| | **traffic-shaper-reverse** string | | Reverse traffic shaper. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 IPv6 to IPv4 policies.
fmgr_pkg_firewall_policy64:
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>
state: <value in [present, absent]>
pkg_firewall_policy64:
action: <value in [deny, accept]>
comments: <value of string>
dstaddr: <value of string>
dstintf: <value of string>
fixedport: <value in [disable, enable]>
ippool: <value in [disable, enable]>
logtraffic: <value in [disable, enable]>
per-ip-shaper: <value of string>
permit-any-host: <value in [disable, enable]>
policyid: <value of integer>
poolname: <value of string>
schedule: <value of string>
service: <value of string>
srcaddr: <value of string>
srcintf: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
uuid: <value of string>
logtraffic-start: <value in [disable, enable]>
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_wtpprofile_denymaclist – List of MAC addresses that are denied access to this WTP, FortiAP, or AP. fortinet.fortimanager.fmgr\_wtpprofile\_denymaclist – List of MAC addresses that are denied access to this WTP, FortiAP, or AP.
===============================================================================================================================
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_wtpprofile_denymaclist`.
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 |
| **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 |
| **wtp-profile** string / required | | the parameter (wtp-profile) in requested url |
| **wtpprofile\_denymaclist** dictionary | | the top level parameters set |
| | **id** integer | | ID. |
| | **mac** string | | A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. |
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: List of MAC addresses that are denied access to this WTP, FortiAP, or AP.
fmgr_wtpprofile_denymaclist:
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>
wtp-profile: <your own value>
state: <value in [present, absent]>
wtpprofile_denymaclist:
id: <value of integer>
mac: <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_group_member – Group members. fortinet.fortimanager.fmgr\_system\_admin\_group\_member – Group members.
=========================================================================
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_group_member`.
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\_admin\_group\_member** dictionary | | the top level parameters set |
| | **name** string | | Group member 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: Group members.
fmgr_system_admin_group_member:
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_admin_group_member:
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_exec_fgfm_reclaimdevtunnel – Reclaim management tunnel to device. fortinet.fortimanager.fmgr\_exec\_fgfm\_reclaimdevtunnel – Reclaim management tunnel to device.
===============================================================================================
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_exec_fgfm_reclaimdevtunnel`.
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 |
| **device\_name** string / required | | the parameter (device\_name) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **exec\_fgfm\_reclaimdevtunnel** dictionary | | the top level parameters set |
| | **flags** list / elements=string | **Choices:*** force
| no description |
| **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: Reclaim management tunnel to device.
fmgr_exec_fgfm_reclaimdevtunnel:
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, ...]
device_name: <your own value>
exec_fgfm_reclaimdevtunnel:
flags:
- force
```
Return Values
-------------
Common return 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_update_devlist – Refresh FGFM connection and system information for a list of devices. fortinet.fortimanager.fmgr\_dvm\_cmd\_update\_devlist – Refresh FGFM connection and system information for a list of 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_update_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\_update\_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 |
| | **update-dev-member-list** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **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: Refresh FGFM connection and system information for a list of devices.
fmgr_dvm_cmd_update_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_update_devlist:
adom: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
update-dev-member-list:
-
name: <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)
ansible fortinet.fortimanager.fmgr_metafields_system_admin_user – no description fortinet.fortimanager.fmgr\_metafields\_system\_admin\_user – 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_metafields_system_admin_user`.
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 |
| **metafields\_system\_admin\_user** dictionary | | the top level parameters set |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **length** integer | | no description |
| | **name** string | | no description |
| | **status** 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: no description
fmgr_metafields_system_admin_user:
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, ...]
metafields_system_admin_user:
importance: <value in [optional, required]>
length: <value of integer>
name: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_spamfilter_iptrust_entries – Spam filter trusted IP addresses. fortinet.fortimanager.fmgr\_spamfilter\_iptrust\_entries – Spam filter trusted IP 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_spamfilter_iptrust_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 |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **iptrust** string / required | | the parameter (iptrust) 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\_iptrust\_entries** dictionary | | the top level parameters set |
| | **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. |
| **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 trusted IP addresses.
fmgr_spamfilter_iptrust_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>
iptrust: <your own value>
state: <value in [present, absent]>
spamfilter_iptrust_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]>
```
Return Values
-------------
Common return 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_dynamic_vip – no description fortinet.fortimanager.fmgr\_dynamic\_vip – 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_dynamic_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 |
| **dynamic\_vip** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **name** string | | no description |
| **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: no description
fmgr_dynamic_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]>
dynamic_vip:
description: <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_emailfilter_profile_smtp – SMTP. fortinet.fortimanager.fmgr\_emailfilter\_profile\_smtp – SMTP.
==============================================================
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_profile_smtp`.
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\_profile\_smtp** dictionary | | the top level parameters set |
| | **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:*** disable
* enable
| 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
| no description |
| **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: SMTP.
fmgr_emailfilter_profile_smtp:
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>
emailfilter_profile_smtp:
action: <value in [pass, tag, discard]>
hdrip: <value in [disable, enable]>
local-override: <value in [disable, enable]>
log: <value in [disable, enable]>
tag-msg: <value of string>
tag-type:
- subject
- header
- spaminfo
log-all: <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_hotspot20_anqpnairealm – Configure network access identifier fortinet.fortimanager.fmgr\_hotspot20\_anqpnairealm – Configure network access identifier
=========================================================================================
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_anqpnairealm`.
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\_anqpnairealm** dictionary | | the top level parameters set |
| | **nai-list** list / elements=string | | no description |
| | | **eap-method** list / elements=string | | no description |
| | | | **auth-param** list / elements=string | | no description |
| | | | | **id** string | **Choices:*** non-eap-inner-auth
* inner-auth-eap
* credential
* tunneled-credential
| ID of authentication parameter. |
| | | | | **index** integer | | 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 | | 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 | | NAI realm name. |
| | **name** string | | NAI realm list 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 network access identifier
fmgr_hotspot20_anqpnairealm:
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_anqpnairealm:
nai-list:
-
eap-method:
-
auth-param:
-
id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
index: <value of integer>
val: <value in [eap-identity, eap-md5, eap-tls, ...]>
index: <value of integer>
method: <value in [eap-identity, eap-md5, eap-tls, ...]>
encoding: <value in [disable, enable]>
nai-realm: <value of string>
name: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_ipv6 – IPv6 of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6 – IPv6 of interface.
===========================================================================================
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_fsp_vlan_dynamicmapping_interface_ipv6`.
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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fsp\_vlan\_dynamicmapping\_interface\_ipv6** dictionary | | the top level parameters set |
| | **autoconf** string | **Choices:*** disable
* enable
| no description |
| | **cli-conn6-status** integer | | no description |
| | **dhcp6-client-options** list / elements=string | **Choices:*** rapid
* iapd
* iana
* dns
* dnsname
| no description |
| | **dhcp6-information-request** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-prefix-delegation** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-prefix-hint** string | | no description |
| | **dhcp6-prefix-hint-plt** integer | | no description |
| | **dhcp6-prefix-hint-vlt** integer | | no description |
| | **dhcp6-relay-ip** string | | no description |
| | **dhcp6-relay-service** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-relay-type** string | **Choices:*** regular
| no description |
| | **icmp6-send-redirect** string | **Choices:*** disable
* enable
| Enable/disable sending of ICMPv6 redirects. |
| | **interface-identifier** string | | no description |
| | **ip6-address** string | | no description |
| | **ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* capwap
* fabric
| no description |
| | **ip6-default-life** integer | | no description |
| | **ip6-delegated-prefix-list** list / elements=string | | no description |
| | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | **prefix-id** integer | | no description |
| | | **rdnss** string | | no description |
| | | **rdnss-service** string | **Choices:*** delegated
* default
* specify
| no description |
| | | **subnet** string | | no description |
| | | **upstream-interface** string | | no description |
| | **ip6-dns-server-override** string | **Choices:*** disable
* enable
| no description |
| | **ip6-extra-addr** list / elements=string | | no description |
| | | **prefix** string | | no description |
| | **ip6-hop-limit** integer | | no description |
| | **ip6-link-mtu** integer | | no description |
| | **ip6-manage-flag** string | **Choices:*** disable
* enable
| no description |
| | **ip6-max-interval** integer | | no description |
| | **ip6-min-interval** integer | | no description |
| | **ip6-mode** string | **Choices:*** static
* dhcp
* pppoe
* delegated
| no description |
| | **ip6-other-flag** string | **Choices:*** disable
* enable
| no description |
| | **ip6-prefix-list** list / elements=string | | no description |
| | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | **dnssl** string | | no description |
| | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | **preferred-life-time** integer | | no description |
| | | **prefix** string | | no description |
| | | **rdnss** string | | no description |
| | | **valid-life-time** integer | | no description |
| | **ip6-prefix-mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from DHCP or RA. |
| | **ip6-reachable-time** integer | | no description |
| | **ip6-retrans-time** integer | | no description |
| | **ip6-send-adv** string | **Choices:*** disable
* enable
| no description |
| | **ip6-subnet** string | | no description |
| | **ip6-upstream-interface** string | | no description |
| | **nd-cert** string | | no description |
| | **nd-cga-modifier** string | | no description |
| | **nd-mode** string | **Choices:*** basic
* SEND-compatible
| no description |
| | **nd-security-level** integer | | no description |
| | **nd-timestamp-delta** integer | | no description |
| | **nd-timestamp-fuzz** integer | | no description |
| | **ra-send-mtu** string | **Choices:*** disable
* enable
| Enable/disable sending link MTU in RA packet. |
| | **unique-autoconf-addr** string | **Choices:*** disable
* enable
| no description |
| | **vrip6\_link\_local** string | | no description |
| | **vrrp-virtual-mac6** string | **Choices:*** disable
* enable
| no description |
| | **vrrp6** list / elements=string | | no description |
| | | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | | **adv-interval** integer | | no description |
| | | **preempt** string | **Choices:*** disable
* enable
| no description |
| | | **priority** integer | | no description |
| | | **start-time** integer | | no description |
| | | **status** string | **Choices:*** disable
* enable
| no description |
| | | **vrdst6** string | | no description |
| | | **vrgrp** integer | | no description |
| | | **vrid** integer | | no description |
| | | **vrip6** 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 |
| **vlan** string / required | | the parameter (vlan) 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: IPv6 of interface.
fmgr_fsp_vlan_dynamicmapping_interface_ipv6:
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>
vlan: <your own value>
dynamic_mapping: <your own value>
fsp_vlan_dynamicmapping_interface_ipv6:
autoconf: <value in [disable, enable]>
dhcp6-client-options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6-information-request: <value in [disable, enable]>
dhcp6-prefix-delegation: <value in [disable, enable]>
dhcp6-prefix-hint: <value of string>
dhcp6-prefix-hint-plt: <value of integer>
dhcp6-prefix-hint-vlt: <value of integer>
dhcp6-relay-ip: <value of string>
dhcp6-relay-service: <value in [disable, enable]>
dhcp6-relay-type: <value in [regular]>
ip6-address: <value of string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <value of integer>
ip6-delegated-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <value of string>
ip6-dns-server-override: <value in [disable, enable]>
ip6-extra-addr:
-
prefix: <value of string>
ip6-hop-limit: <value of integer>
ip6-link-mtu: <value of integer>
ip6-manage-flag: <value in [disable, enable]>
ip6-max-interval: <value of integer>
ip6-min-interval: <value of integer>
ip6-mode: <value in [static, dhcp, pppoe, ...]>
ip6-other-flag: <value in [disable, enable]>
ip6-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
dnssl: <value of string>
onlink-flag: <value in [disable, enable]>
preferred-life-time: <value of integer>
prefix: <value of string>
rdnss: <value of string>
valid-life-time: <value of integer>
ip6-reachable-time: <value of integer>
ip6-retrans-time: <value of integer>
ip6-send-adv: <value in [disable, enable]>
ip6-subnet: <value of string>
ip6-upstream-interface: <value of string>
nd-cert: <value of string>
nd-cga-modifier: <value of string>
nd-mode: <value in [basic, SEND-compatible]>
nd-security-level: <value of integer>
nd-timestamp-delta: <value of integer>
nd-timestamp-fuzz: <value of integer>
vrip6_link_local: <value of string>
vrrp-virtual-mac6: <value in [disable, enable]>
vrrp6:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <value of string>
interface-identifier: <value of string>
unique-autoconf-addr: <value in [disable, enable]>
icmp6-send-redirect: <value in [disable, enable]>
cli-conn6-status: <value of integer>
ip6-prefix-mode: <value in [dhcp6, ra]>
ra-send-mtu: <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_fmupdate_webspam_fgdsetting_serveroverride – Server override configure. fortinet.fortimanager.fmgr\_fmupdate\_webspam\_fgdsetting\_serveroverride – Server override configure.
======================================================================================================
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_webspam_fgdsetting_serveroverride`.
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\_webspam\_fgdsetting\_serveroverride** dictionary | | the top level parameters set |
| | **servlist** list / elements=string | | no description |
| | | **id** integer | **Default:**0 | Override server ID (1 - 10). |
| | | **ip** string | **Default:**"0.0.0.0" | IPv4 address of the override server. |
| | | **ip6** string | **Default:**"::" | IPv6 address of the override server. |
| | | **port** integer | **Default:**443 | Port number to use when contacting FortiGuard (1 - 65535, default = 443). |
| | | **service-type** list / elements=string | **Choices:*** fgd
* fgc
* fsa
| no description |
| | **status** string | **Choices:*** **disable** ←
* enable
| Override status. 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: Server override configure.
fmgr_fmupdate_webspam_fgdsetting_serveroverride:
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_webspam_fgdsetting_serveroverride:
servlist:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
port: <value of integer>
service-type:
- fgd
- fgc
- fsa
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_switchcontroller_managedswitch_customcommand – Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller… fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_customcommand – Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller…
======================================================================================================================================================================================================================
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_customcommand`.
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\_customcommand** dictionary | | the top level parameters set |
| | **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. |
| **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 FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller...
fmgr_switchcontroller_managedswitch_customcommand:
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_customcommand:
command-entry: <value of string>
command-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_switchcontroller_managedswitch_igmpsnooping – Configure FortiSwitch IGMP snooping global settings. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_igmpsnooping – Configure FortiSwitch IGMP snooping global 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_switchcontroller_managedswitch_igmpsnooping`.
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 |
| **device** string / required | | the parameter (device) in requested url |
| **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 |
| **vdom** string / required | | the parameter (vdom) 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: Configure FortiSwitch IGMP snooping global settings.
fmgr_switchcontroller_managedswitch_igmpsnooping:
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, ...]
device: <your own value>
vdom: <your own value>
managed-switch: <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_switchcontroller_managedswitch_switchlog – Configuration method to edit FortiSwitch logging settings fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_switchlog – Configuration method to edit FortiSwitch logging 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_switchcontroller_managedswitch_switchlog`.
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 |
| **device** string / required | | the parameter (device) in requested url |
| **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 |
| **vdom** string / required | | the parameter (vdom) 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: Configuration method to edit FortiSwitch logging settings
fmgr_switchcontroller_managedswitch_switchlog:
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, ...]
device: <your own value>
vdom: <your own value>
managed-switch: <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_wanopt_profile – Configure WAN optimization profiles. fortinet.fortimanager.fmgr\_wanopt\_profile – Configure WAN optimization 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_wanopt_profile`.
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 |
| **wanopt\_profile** dictionary | | the top level parameters set |
| | **auth-group** string | | Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. |
| | **cifs** dictionary | | no description |
| | | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i... |
| | | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **prefer-chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for WAN Optimization. |
| | | **protocol-opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable WAN Optimization. |
| | | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **comments** string | | Comment. |
| | **ftp** dictionary | | no description |
| | | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i... |
| | | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **prefer-chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for WAN Optimization. |
| | | **protocol-opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** disable
* enable
| Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable WAN Optimization. |
| | | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **http** dictionary | | no description |
| | | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i... |
| | | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **prefer-chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for WAN Optimization. |
| | | **protocol-opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** disable
* enable
| Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable WAN Optimization. |
| | | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **mapi** dictionary | | no description |
| | | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i... |
| | | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable WAN Optimization. |
| | | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **name** string | | Profile name. |
| | **tcp** dictionary | | no description |
| | | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i... |
| | | **byte-caching-opt** string | **Choices:*** mem-only
* mem-disk
| Select whether TCP byte-caching uses system memory only or both memory and disk space. |
| | | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **port** string | | Port numbers or port number ranges for TCP. Only packets with a destination port number that matches this port number ... |
| | | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | | **ssl** string | **Choices:*** disable
* enable
| Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. |
| | | **ssl-port** integer | | no description |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable WAN Optimization. |
| | | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **transparent** string | **Choices:*** disable
* enable
| Enable/disable transparent mode. |
| **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 WAN optimization profiles.
fmgr_wanopt_profile:
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]>
wanopt_profile:
auth-group: <value of string>
comments: <value of string>
name: <value of string>
transparent: <value in [disable, enable]>
cifs:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
ftp:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
http:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
mapi:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
secure-tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
tcp:
byte-caching: <value in [disable, enable]>
byte-caching-opt: <value in [mem-only, mem-disk]>
log-traffic: <value in [disable, enable]>
port: <value of string>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
ssl-port: <value of integer>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
```
Return Values
-------------
Common return 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_dynamic_virtualwanlink_neighbor_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_virtualwanlink\_neighbor\_dynamicmapping – 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_dynamic_virtualwanlink_neighbor_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_virtualwanlink\_neighbor\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **description** string | | no description |
| | **ip** string | | no description |
| | **role** string | **Choices:*** primary
* secondary
* standalone
| no description |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **neighbor** string / required | | the parameter (neighbor) 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_dynamic_virtualwanlink_neighbor_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>
neighbor: <your own value>
state: <value in [present, absent]>
dynamic_virtualwanlink_neighbor_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
description: <value of string>
ip: <value of string>
role: <value in [primary, secondary, standalone]>
```
Return Values
-------------
Common return 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_vpndstnode – no description fortinet.fortimanager.fmgr\_pkg\_firewall\_policy\_vpndstnode – 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_vpndstnode`.
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\_vpndstnode** 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_vpndstnode:
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_vpndstnode:
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)
ansible fortinet.fortimanager.fmgr_dynamic_input_interface_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_input\_interface\_dynamicmapping – 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_dynamic_input_interface_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_input\_interface\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **local-intf** string | | no description |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **interface** string / required | | the parameter (interface) 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_dynamic_input_interface_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>
interface: <your own value>
state: <value in [present, absent]>
dynamic_input_interface_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
local-intf: <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_antivirus_profile_mapi – Configure MAPI AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_mapi – Configure MAPI 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_mapi`.
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\_mapi** 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. |
| | **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
* 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 MAPI AntiVirus options.
fmgr_antivirus_profile_mapi:
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_mapi:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
executables: <value in [default, virus]>
options:
- scan
- 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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dvmdb_workspace_commit_dev – Commit change fortinet.fortimanager.fmgr\_dvmdb\_workspace\_commit\_dev – Commit change
=========================================================================
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_commit_dev`.
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 |
| **device\_name** string / required | | the parameter (device\_name) in requested url |
| **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: Commit change
fmgr_dvmdb_workspace_commit_dev:
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>
device_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_waf_profile_constraint_maxurlparam – Maximum number of parameters in URL. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_maxurlparam – Maximum number of parameters in URL.
========================================================================================================
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_maxurlparam`.
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\_maxurlparam** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **max-url-param** integer | | Maximum number of parameters in URL (0 to 2147483647). |
| | **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: Maximum number of parameters in URL.
fmgr_waf_profile_constraint_maxurlparam:
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_maxurlparam:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-url-param: <value of integer>
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_region – Configure FortiAP regions fortinet.fortimanager.fmgr\_region – Configure FortiAP regions
==============================================================
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_region`.
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 |
| **region** dictionary | | the top level parameters set |
| | **comments** string | | Comments. |
| | **grayscale** string | **Choices:*** disable
* enable
| Region image grayscale. |
| | **image-type** string | **Choices:*** gif
* jpeg
* png
| FortiAP region image type (png|jpeg|gif). |
| | **name** string | | FortiAP region name. |
| | **opacity** integer | | Region image opacity (0 - 100). |
| **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 FortiAP regions
fmgr_region:
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]>
region:
comments: <value of string>
grayscale: <value in [disable, enable]>
image-type: <value in [gif, jpeg, png]>
name: <value of string>
opacity: <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_firewall_multicastaddress_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_multicastaddress\_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_multicastaddress_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 |
| --- | --- | --- |
| **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\_multicastaddress\_tagging** dictionary | | the top level parameters set |
| | **category** string | | Tag category. |
| | **name** string | | Tagging entry name. |
| | **tags** string | | no description |
| **multicast-address** string / required | | the parameter (multicast-address) 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: Config object tagging.
fmgr_firewall_multicastaddress_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>
multicast-address: <your own value>
state: <value in [present, absent]>
firewall_multicastaddress_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_emailfilter_mheader_entries – Spam filter mime header content. fortinet.fortimanager.fmgr\_emailfilter\_mheader\_entries – Spam filter mime header content.
============================================================================================
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_mheader_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 |
| **emailfilter\_mheader\_entries** dictionary | | the top level parameters set |
| | **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 | | Mime header entry ID. |
| | **pattern-type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable status. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **mheader** string / required | | the parameter (mheader) 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: Spam filter mime header content.
fmgr_emailfilter_mheader_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>
mheader: <your own value>
state: <value in [present, absent]>
emailfilter_mheader_entries:
action: <value in [spam, clear]>
fieldbody: <value of string>
fieldname: <value of string>
id: <value of integer>
pattern-type: <value in [wildcard, regexp]>
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_sslsshprofile_ftps – Configure FTPS options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_ftps – Configure FTPS 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_sslsshprofile_ftps`.
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\_sslsshprofile\_ftps** dictionary | | the top level parameters set |
| | **allow-invalid-server-cert** string | **Choices:*** disable
* enable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | **cert-validation-failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | **cert-validation-timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | **client-cert-request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | **client-certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | **expired-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | **invalid-server-cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | **ports** integer | | no description |
| | **revoked-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | **sni-server-cert-check** string | **Choices:*** disable
* enable
* strict
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | **unsupported-ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | **unsupported-ssl-cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | **unsupported-ssl-negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | **untrusted-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **untrusted-server-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| **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 |
| **ssl-ssh-profile** string / required | | the parameter (ssl-ssh-profile) in requested url |
| **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 FTPS options.
fmgr_firewall_sslsshprofile_ftps:
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>
ssl-ssh-profile: <your own value>
firewall_sslsshprofile_ftps:
allow-invalid-server-cert: <value in [disable, enable]>
client-cert-request: <value in [bypass, inspect, block]>
ports: <value of integer>
status: <value in [disable, deep-inspection]>
unsupported-ssl: <value in [bypass, inspect, block]>
untrusted-cert: <value in [allow, block, ignore]>
invalid-server-cert: <value in [allow, block]>
sni-server-cert-check: <value in [disable, enable, strict]>
untrusted-server-cert: <value in [allow, block, ignore]>
cert-validation-failure: <value in [allow, block, ignore]>
cert-validation-timeout: <value in [allow, block, ignore]>
client-certificate: <value in [bypass, inspect, block]>
expired-server-cert: <value in [allow, block, ignore]>
revoked-server-cert: <value in [allow, block, ignore]>
unsupported-ssl-cipher: <value in [allow, block]>
unsupported-ssl-negotiation: <value in [allow, block]>
```
Return Values
-------------
Common return 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_wanopt_authgroup – Configure WAN optimization authentication groups. fortinet.fortimanager.fmgr\_wanopt\_authgroup – Configure WAN optimization authentication 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_wanopt_authgroup`.
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 |
| **wanopt\_authgroup** dictionary | | the top level parameters set |
| | **auth-method** string | **Choices:*** cert
* psk
| Select certificate or pre-shared key authentication for this authentication group. |
| | **cert** string | | Name of certificate to identify this peer. |
| | **name** string | | Auth-group name. |
| | **peer** string | | If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with t... |
| | **peer-accept** string | **Choices:*** any
* defined
* one
| Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. |
| | **psk** string | | 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: Configure WAN optimization authentication groups.
fmgr_wanopt_authgroup:
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]>
wanopt_authgroup:
auth-method: <value in [cert, psk]>
cert: <value of string>
name: <value of string>
peer: <value of string>
peer-accept: <value in [any, defined, one]>
psk: <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_trafficquota – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_trafficquota – 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_trafficquota`.
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\_trafficquota** 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_trafficquota:
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_trafficquota:
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_firewall_sslsshprofile_pop3s – Configure POP3S options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_pop3s – Configure POP3S 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_sslsshprofile_pop3s`.
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\_sslsshprofile\_pop3s** dictionary | | the top level parameters set |
| | **allow-invalid-server-cert** string | **Choices:*** disable
* enable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | **cert-validation-failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | **cert-validation-timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | **client-cert-request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | **client-certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | **expired-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | **invalid-server-cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | **ports** integer | | no description |
| | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | **revoked-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | **sni-server-cert-check** string | **Choices:*** disable
* enable
* strict
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | **status** string | **Choices:*** disable
* deep-inspection
| Configure protocol inspection status. |
| | **unsupported-ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | **unsupported-ssl-cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | **unsupported-ssl-negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | **untrusted-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **untrusted-server-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| **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 |
| **ssl-ssh-profile** string / required | | the parameter (ssl-ssh-profile) in requested url |
| **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 POP3S options.
fmgr_firewall_sslsshprofile_pop3s:
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>
ssl-ssh-profile: <your own value>
firewall_sslsshprofile_pop3s:
allow-invalid-server-cert: <value in [disable, enable]>
client-cert-request: <value in [bypass, inspect, block]>
ports: <value of integer>
status: <value in [disable, deep-inspection]>
unsupported-ssl: <value in [bypass, inspect, block]>
untrusted-cert: <value in [allow, block, ignore]>
invalid-server-cert: <value in [allow, block]>
sni-server-cert-check: <value in [disable, enable, strict]>
untrusted-server-cert: <value in [allow, block, ignore]>
cert-validation-failure: <value in [allow, block, ignore]>
cert-validation-timeout: <value in [allow, block, ignore]>
client-certificate: <value in [bypass, inspect, block]>
expired-server-cert: <value in [allow, block, ignore]>
proxy-after-tcp-handshake: <value in [disable, enable]>
revoked-server-cert: <value in [allow, block, ignore]>
unsupported-ssl-cipher: <value in [allow, block]>
unsupported-ssl-negotiation: <value in [allow, block]>
```
Return Values
-------------
Common return 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_cifs – Configure CIFS AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_cifs – Configure CIFS 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_cifs`.
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\_cifs** 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. |
| | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | **external-blocklist** string | **Choices:*** disable
* monitor
* block
| Enable external-blocklist. |
| | **options** list / elements=string | **Choices:*** scan
* quarantine
* avmonitor
| no description |
| | **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. |
| **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 CIFS AntiVirus options.
fmgr_antivirus_profile_cifs:
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_cifs:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
options:
- scan
- quarantine
- 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_user_pxgrid – no description fortinet.fortimanager.fmgr\_user\_pxgrid – 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_user_pxgrid`.
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\_pxgrid** dictionary | | the top level parameters set |
| | **ca-cert** string | | no description |
| | **client-cert** string | | no description |
| | **name** string | | no description |
| | **server** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| 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_user_pxgrid:
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_pxgrid:
ca-cert: <value of string>
client-cert: <value of string>
name: <value of string>
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_dynamic_input_interface – no description fortinet.fortimanager.fmgr\_dynamic\_input\_interface – 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_dynamic_input_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_input\_interface** dictionary | | the top level parameters set |
| | **default-mapping** string | **Choices:*** disable
* enable
| no description |
| | **defmap-intf** string | | no description |
| | **description** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **local-intf** string | | no description |
| | **name** string | | no description |
| | **skip-unmapped** string | **Choices:*** disable
* enable
| no description |
| **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: no description
fmgr_dynamic_input_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, ...]
adom: <your own value>
state: <value in [present, absent]>
dynamic_input_interface:
default-mapping: <value in [disable, enable]>
defmap-intf: <value of string>
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
local-intf: <value of string>
name: <value of string>
skip-unmapped: <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_mpskprofile_mpskgroup – List of multiple PSK groups. fortinet.fortimanager.fmgr\_mpskprofile\_mpskgroup – List of multiple PSK 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_mpskprofile_mpskgroup`.
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 |
| **mpsk-profile** string / required | | the parameter (mpsk-profile) in requested url |
| **mpskprofile\_mpskgroup** dictionary | | the top level parameters set |
| | **mpsk-key** list / elements=string | | no description |
| | | **comment** string | | Comment. |
| | | **concurrent-client-limit-type** string | **Choices:*** default
* unlimited
* specified
| MPSK client limit type options. |
| | | **concurrent-clients** integer | | Number of clients that can connect using this pre-shared key (1 - 65535, default is 256). |
| | | **mac** string | | MAC address. |
| | | **mpsk-schedules** string | | Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. |
| | | **name** string | | Pre-shared key name. |
| | | **passphrase** string | | no description |
| | | **pmk** string | | no description |
| | **name** string | | MPSK group name. |
| | **vlan-id** integer | | Optional VLAN ID. |
| | **vlan-type** string | **Choices:*** no-vlan
* fixed-vlan
| MPSK group VLAN options. |
| **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: List of multiple PSK groups.
fmgr_mpskprofile_mpskgroup:
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>
mpsk-profile: <your own value>
state: <value in [present, absent]>
mpskprofile_mpskgroup:
mpsk-key:
-
comment: <value of string>
concurrent-client-limit-type: <value in [default, unlimited, specified]>
concurrent-clients: <value of integer>
mac: <value of string>
mpsk-schedules: <value of string>
name: <value of string>
passphrase: <value of string>
pmk: <value of string>
name: <value of string>
vlan-id: <value of integer>
vlan-type: <value in [no-vlan, fixed-vlan]>
```
Return Values
-------------
Common return 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_vap – Configure Virtual Access Points fortinet.fortimanager.fmgr\_vap – Configure Virtual Access Points
=================================================================
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_vap`.
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 |
| **vap** dictionary | | the top level parameters set |
| | **\_centmgmt** string | **Choices:*** **disable** ←
* enable
| no description |
| | **\_dhcp\_svr\_id** string | | no description |
| | **\_intf\_allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
| no description |
| | **\_intf\_device-access-list** string | | no description |
| | **\_intf\_device-identification** string | **Choices:*** **disable** ←
* enable
| no description |
| | **\_intf\_device-netscan** string | **Choices:*** **disable** ←
* enable
| no description |
| | **\_intf\_dhcp-relay-ip** string | | no description |
| | **\_intf\_dhcp-relay-service** string | **Choices:*** **disable** ←
* enable
| no description |
| | **\_intf\_dhcp-relay-type** string | **Choices:*** **regular** ←
* ipsec
| no description |
| | **\_intf\_dhcp6-relay-ip** string | | no description |
| | **\_intf\_dhcp6-relay-service** string | **Choices:*** **disable** ←
* enable
| no description |
| | **\_intf\_dhcp6-relay-type** string | **Choices:*** **regular** ←
| no description |
| | **\_intf\_ip** string | | no description |
| | **\_intf\_ip6-address** string | | no description |
| | **\_intf\_ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* any
* fgfm
* capwap
| no description |
| | **\_intf\_listen-forticlient-connection** string | **Choices:*** **disable** ←
* enable
| no description |
| | **access-control-list** string | | access-control-list profile name. |
| | **acct-interim-interval** integer | | WiFi RADIUS accounting interim interval (60 - 86400 sec, default = 0). |
| | **additional-akms** list / elements=string | **Choices:*** akm6
| no description |
| | **address-group** string | | Address group ID. |
| | **alias** string | | Alias. |
| | **atf-weight** integer | | Airtime weight in percentage (default = 20). |
| | **auth** string | **Choices:*** PSK
* psk
* RADIUS
* radius
* usergroup
| Authentication protocol. |
| | **broadcast-ssid** string | **Choices:*** disable
* enable
| Enable/disable broadcasting the SSID (default = enable). |
| | **broadcast-suppression** list / elements=string | **Choices:*** dhcp
* arp
* dhcp2
* arp2
* netbios-ns
* netbios-ds
* arp3
* dhcp-up
* dhcp-down
* arp-known
* arp-unknown
* arp-reply
* ipv6
* dhcp-starvation
* arp-poison
* all-other-mc
* all-other-bc
* arp-proxy
* dhcp-ucast
| no description |
| | **bss-color-partial** string | **Choices:*** disable
* enable
| Enable/disable 802.11ax partial BSS color (default = enable). |
| | **bstm-disassociation-imminent** string | **Choices:*** disable
* enable
| Enable/disable forcing of disassociation after the BSTM request timer has been reached (default = enable). |
| | **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, default = ... |
| | **bstm-rssi-disassoc-timer** integer | | Time interval for client to voluntarily leave AP before forcing a disassociation due to low RSSI (0 to 2000, default = 200). |
| | **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, default = 0). |
| | **captive-portal-macauth-radius-secret** string | | no description |
| | **captive-portal-macauth-radius-server** string | | Captive portal external RADIUS server domain name or IP address. |
| | **captive-portal-radius-secret** string | | no description |
| | **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, default = 0). |
| | **dhcp-address-enforcement** string | **Choices:*** disable
* enable
| Enable/disable DHCP address enforcement (default = disable). |
| | **dhcp-lease-time** integer | | DHCP lease time in seconds for NAT IP address. |
| | **dhcp-option43-insertion** string | **Choices:*** disable
* enable
| Enable/disable insertion of DHCP option 43 (default = enable). |
| | **dhcp-option82-circuit-id-insertion** string | **Choices:*** disable
* style-1
* style-2
* style-3
| Enable/disable DHCP option 82 circuit-id insert (default = disable). |
| | **dhcp-option82-insertion** string | **Choices:*** disable
* enable
| Enable/disable DHCP option 82 insert (default = disable). |
| | **dhcp-option82-remote-id-insertion** string | **Choices:*** disable
* style-1
| Enable/disable DHCP option 82 remote-id insert (default = disable). |
| | **dynamic-vlan** string | **Choices:*** disable
* enable
| Enable/disable dynamic VLAN assignment. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_centmgmt** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_dhcp\_svr\_id** string | | no description |
| | | **\_intf\_allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
| no description |
| | | **\_intf\_device-access-list** string | | no description |
| | | **\_intf\_device-identification** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_intf\_device-netscan** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_intf\_dhcp-relay-ip** string | | no description |
| | | **\_intf\_dhcp-relay-service** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_intf\_dhcp-relay-type** string | **Choices:*** **regular** ←
* ipsec
| no description |
| | | **\_intf\_dhcp6-relay-ip** string | | no description |
| | | **\_intf\_dhcp6-relay-service** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_intf\_dhcp6-relay-type** string | **Choices:*** **regular** ←
| no description |
| | | **\_intf\_ip** string | | no description |
| | | **\_intf\_ip6-address** string | | no description |
| | | **\_intf\_ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* any
* fgfm
* capwap
| no description |
| | | **\_intf\_listen-forticlient-connection** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **access-control-list** string | | no description |
| | | **acct-interim-interval** integer | | no description |
| | | **additional-akms** list / elements=string | **Choices:*** akm6
| no description |
| | | **address-group** string | | no description |
| | | **alias** string | | no description |
| | | **atf-weight** integer | | no description |
| | | **auth** string | **Choices:*** PSK
* psk
* RADIUS
* radius
* usergroup
| no description |
| | | **broadcast-ssid** string | **Choices:*** disable
* enable
| no description |
| | | **broadcast-suppression** list / elements=string | **Choices:*** dhcp
* arp
* dhcp2
* arp2
* netbios-ns
* netbios-ds
* arp3
* dhcp-up
* dhcp-down
* arp-known
* arp-unknown
* arp-reply
* ipv6
* dhcp-starvation
* arp-poison
* all-other-mc
* all-other-bc
* arp-proxy
* dhcp-ucast
| no description |
| | | **bss-color-partial** string | **Choices:*** disable
* enable
| no description |
| | | **bstm-disassociation-imminent** string | **Choices:*** disable
* enable
| Enable/disable forcing of disassociation after the BSTM request timer has been reached (default = enable). |
| | | **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, de... |
| | | **bstm-rssi-disassoc-timer** integer | | Time interval for client to voluntarily leave AP before forcing a disassociation due to low RSSI (0 to 2000, default =... |
| | | **captive-portal-ac-name** string | | no description |
| | | **captive-portal-auth-timeout** integer | | no description |
| | | **captive-portal-macauth-radius-secret** string | | no description |
| | | **captive-portal-macauth-radius-server** string | | no description |
| | | **captive-portal-radius-secret** string | | no description |
| | | **captive-portal-radius-server** string | | no description |
| | | **captive-portal-session-timeout-interval** integer | | no description |
| | | **client-count** integer | | no description |
| | | **dhcp-address-enforcement** string | **Choices:*** disable
* enable
| Enable/disable DHCP address enforcement (default = disable). |
| | | **dhcp-lease-time** integer | | no description |
| | | **dhcp-option43-insertion** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp-option82-circuit-id-insertion** string | **Choices:*** disable
* style-1
* style-2
* style-3
| no description |
| | | **dhcp-option82-insertion** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp-option82-remote-id-insertion** string | **Choices:*** disable
* style-1
| no description |
| | | **dynamic-vlan** string | **Choices:*** disable
* enable
| no description |
| | | **eap-reauth** string | **Choices:*** disable
* enable
| no description |
| | | **eap-reauth-intv** integer | | no description |
| | | **eapol-key-retries** string | **Choices:*** disable
* enable
| no description |
| | | **encrypt** string | **Choices:*** TKIP
* AES
* TKIP-AES
| no description |
| | | **external-fast-roaming** string | **Choices:*** disable
* enable
| no description |
| | | **external-logout** string | | no description |
| | | **external-web** string | | no description |
| | | **external-web-format** string | **Choices:*** auto-detect
* no-query-string
* partial-query-string
| no description |
| | | **fast-bss-transition** string | **Choices:*** disable
* enable
| no description |
| | | **fast-roaming** string | **Choices:*** disable
* enable
| no description |
| | | **ft-mobility-domain** integer | | no description |
| | | **ft-over-ds** string | **Choices:*** disable
* enable
| no description |
| | | **ft-r0-key-lifetime** integer | | no description |
| | | **gas-comeback-delay** integer | | GAS comeback delay (0 or 100 - 10000 milliseconds, default = 500). |
| | | **gas-fragmentation-limit** integer | | GAS fragmentation limit (512 - 4096, default = 1024). |
| | | **gtk-rekey** string | **Choices:*** disable
* enable
| no description |
| | | **gtk-rekey-intv** integer | | no description |
| | | **high-efficiency** string | **Choices:*** disable
* enable
| no description |
| | | **hotspot20-profile** string | | no description |
| | | **igmp-snooping** string | **Choices:*** disable
* enable
| Enable/disable IGMP snooping. |
| | | **intra-vap-privacy** string | **Choices:*** disable
* enable
| no description |
| | | **ip** string | | no description |
| | | **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
| no description |
| | | **key** string | | no description |
| | | **keyindex** integer | | no description |
| | | **ldpc** string | **Choices:*** disable
* tx
* rx
* rxtx
| no description |
| | | **local-authentication** string | **Choices:*** disable
* enable
| no description |
| | | **local-bridging** string | **Choices:*** disable
* enable
| no description |
| | | **local-lan** string | **Choices:*** deny
* allow
| no description |
| | | **local-standalone** string | **Choices:*** disable
* enable
| no description |
| | | **local-standalone-nat** string | **Choices:*** disable
* enable
| no description |
| | | **local-switching** string | **Choices:*** disable
* enable
| no description |
| | | **mac-auth-bypass** string | **Choices:*** disable
* enable
| no description |
| | | **mac-called-station-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC called station delimiter (default = hyphen). |
| | | **mac-calling-station-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC calling station delimiter (default = hyphen). |
| | | **mac-case** string | **Choices:*** uppercase
* lowercase
| MAC case (default = uppercase). |
| | | **mac-filter** string | **Choices:*** disable
* enable
| no description |
| | | **mac-filter-policy-other** string | **Choices:*** deny
* allow
| no description |
| | | **mac-password-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC authentication password delimiter (default = hyphen). |
| | | **mac-username-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC authentication username delimiter (default = hyphen). |
| | | **max-clients** integer | | no description |
| | | **max-clients-ap** integer | | no description |
| | | **mbo** string | **Choices:*** disable
* enable
| Enable/disable Multiband Operation (default = disable). |
| | | **mbo-cell-data-conn-pref** string | **Choices:*** excluded
* prefer-not
* prefer-use
| MBO cell data connection preference (0, 1, or 255, default = 1). |
| | | **me-disable-thresh** integer | | no description |
| | | **mesh-backhaul** string | **Choices:*** disable
* enable
| no description |
| | | **mpsk** string | **Choices:*** disable
* enable
| no description |
| | | **mpsk-concurrent-clients** integer | | no description |
| | | **mpsk-profile** string | | no description |
| | | **mu-mimo** string | **Choices:*** disable
* enable
| no description |
| | | **multicast-enhance** string | **Choices:*** disable
* enable
| no description |
| | | **multicast-rate** string | **Choices:*** 0
* 6000
* 12000
* 24000
| no description |
| | | **nac** string | **Choices:*** disable
* enable
| Enable/disable network access control. |
| | | **nac-profile** string | | NAC profile name. |
| | | **neighbor-report-dual-band** string | **Choices:*** disable
* enable
| Enable/disable dual-band neighbor report (default = disable). |
| | | **okc** string | **Choices:*** disable
* enable
| no description |
| | | **owe-groups** list / elements=string | **Choices:*** 19
* 20
* 21
| no description |
| | | **owe-transition** string | **Choices:*** disable
* enable
| no description |
| | | **owe-transition-ssid** string | | no description |
| | | **passphrase** string | | no description |
| | | **pmf** string | **Choices:*** disable
* enable
* optional
| no description |
| | | **pmf-assoc-comeback-timeout** integer | | no description |
| | | **pmf-sa-query-retry-timeout** integer | | no description |
| | | **port-macauth** string | **Choices:*** disable
* radius
* address-group
| Enable/disable LAN port MAC authentication (default = disable). |
| | | **port-macauth-reauth-timeout** integer | | LAN port MAC authentication re-authentication timeout value (default = 7200 sec). |
| | | **port-macauth-timeout** integer | | LAN port MAC authentication idle timeout value (default = 600 sec). |
| | | **portal-message-override-group** string | | no description |
| | | **portal-type** string | **Choices:*** auth
* auth+disclaimer
* disclaimer
* email-collect
* cmcc
* cmcc-macauth
* auth-mac
* external-auth
* external-macauth
| no description |
| | | **primary-wag-profile** string | | no description |
| | | **probe-resp-suppression** string | **Choices:*** disable
* enable
| no description |
| | | **probe-resp-threshold** string | | no description |
| | | **ptk-rekey** string | **Choices:*** disable
* enable
| no description |
| | | **ptk-rekey-intv** integer | | no description |
| | | **qos-profile** string | | no description |
| | | **quarantine** string | **Choices:*** disable
* enable
| no description |
| | | **radio-2g-threshold** string | | no description |
| | | **radio-5g-threshold** string | | no description |
| | | **radio-sensitivity** string | **Choices:*** disable
* enable
| no description |
| | | **radius-mac-auth** string | **Choices:*** disable
* enable
| no description |
| | | **radius-mac-auth-server** string | | no description |
| | | **radius-mac-auth-usergroups** string | | no description |
| | | **radius-server** string | | no description |
| | | **rates-11a** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-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
* 11
* 11-basic
| no description |
| | | **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
* mcs0/2
* mcs1/2
* mcs2/2
* mcs3/2
* mcs4/2
* mcs5/2
* mcs6/2
* mcs7/2
* mcs8/2
* mcs9/2
* mcs10/1
* mcs11/1
* mcs10/2
* mcs11/2
| no description |
| | | **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
* mcs0/4
* mcs1/4
* mcs2/4
* mcs3/4
* mcs4/4
* mcs5/4
* mcs6/4
* mcs7/4
* mcs8/4
* mcs9/4
* mcs10/3
* mcs11/3
* mcs10/4
* mcs11/4
| no description |
| | | **rates-11bg** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-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
* 11
* 11-basic
| no description |
| | | **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
| no description |
| | | **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
| no description |
| | | **sae-groups** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
| no description |
| | | **sae-password** string | | no description |
| | | **schedule** string | | no description |
| | | **secondary-wag-profile** string | | no description |
| | | **security** string | **Choices:*** None
* WEP64
* wep64
* WEP128
* wep128
* WPA\_PSK
* WPA\_RADIUS
* WPA
* WPA2
* WPA2\_AUTO
* open
* wpa-personal
* wpa-enterprise
* captive-portal
* wpa-only-personal
* wpa-only-enterprise
* wpa2-only-personal
* wpa2-only-enterprise
* wpa-personal+captive-portal
* wpa-only-personal+captive-portal
* wpa2-only-personal+captive-portal
* osen
* wpa3-enterprise
* sae
* sae-transition
* owe
* wpa3-sae
* wpa3-sae-transition
* wpa3-only-enterprise
* wpa3-enterprise-transition
| no description |
| | | **security-exempt-list** string | | no description |
| | | **security-obsolete-option** string | **Choices:*** disable
* enable
| no description |
| | | **security-redirect-url** string | | no description |
| | | **selected-usergroups** string | | no description |
| | | **split-tunneling** string | **Choices:*** disable
* enable
| no description |
| | | **ssid** string | | no description |
| | | **sticky-client-remove** string | **Choices:*** disable
* enable
| no description |
| | | **sticky-client-threshold-2g** string | | no description |
| | | **sticky-client-threshold-5g** string | | no description |
| | | **target-wake-time** string | **Choices:*** disable
* enable
| no description |
| | | **tkip-counter-measure** string | **Choices:*** disable
* enable
| no description |
| | | **tunnel-echo-interval** integer | | no description |
| | | **tunnel-fallback-interval** integer | | no description |
| | | **usergroup** string | | no description |
| | | **utm-profile** string | | no description |
| | | **vdom** string | | no description |
| | | **vlan-auto** string | **Choices:*** disable
* enable
| no description |
| | | **vlan-pooling** string | **Choices:*** wtp-group
* round-robin
* hash
* disable
| no description |
| | | **vlanid** integer | | no description |
| | | **voice-enterprise** string | **Choices:*** disable
* enable
| no description |
| | **eap-reauth** string | **Choices:*** disable
* enable
| Enable/disable EAP re-authentication for WPA-Enterprise security. |
| | **eap-reauth-intv** integer | | EAP re-authentication interval (1800 - 864000 sec, default = 86400). |
| | **eapol-key-retries** string | **Choices:*** disable
* enable
| Enable/disable retransmission of EAPOL-Key frames (message 3/4 and group message 1/2) (default = enable). |
| | **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:*** disable
* enable
| Enable/disable fast roaming or pre-authentication with external APs not managed by the FortiGate (default = disable). |
| | **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 (default = auto-detect). |
| | **fast-bss-transition** string | **Choices:*** disable
* enable
| Enable/disable 802.11r Fast BSS Transition (FT) (default = disable). |
| | **fast-roaming** string | **Choices:*** disable
* enable
| Enable/disable fast-roaming, or pre-authentication, where supported by clients (default = disable). |
| | **ft-mobility-domain** integer | | Mobility domain identifier in FT (1 - 65535, default = 1000). |
| | **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, default = 500). |
| | **gas-fragmentation-limit** integer | | GAS fragmentation limit (512 - 4096, default = 1024). |
| | **gtk-rekey** string | **Choices:*** disable
* enable
| Enable/disable GTK rekey for WPA security. |
| | **gtk-rekey-intv** integer | | GTK rekey interval (1800 - 864000 sec, default = 86400). |
| | **high-efficiency** string | **Choices:*** disable
* enable
| Enable/disable 802.11ax high efficiency (default = enable). |
| | **hotspot20-profile** string | | Hotspot 2.0 profile name. |
| | **igmp-snooping** string | **Choices:*** disable
* enable
| Enable/disable IGMP snooping. |
| | **intra-vap-privacy** string | **Choices:*** disable
* enable
| Enable/disable blocking communication between clients on the same SSID (called intra-SSID privacy) (default = disable). |
| | **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
| no description |
| | **key** string | | no description |
| | **keyindex** integer | | WEP key index (1 - 4). |
| | **ldpc** string | **Choices:*** disable
* tx
* rx
* rxtx
| VAP low-density parity-check (LDPC) coding configuration. |
| | **local-authentication** string | **Choices:*** disable
* enable
| Enable/disable AP local authentication. |
| | **local-bridging** string | **Choices:*** disable
* enable
| Enable/disable bridging of wireless and Ethernet interfaces on the FortiAP (default = disable). |
| | **local-lan** string | **Choices:*** deny
* allow
| Allow/deny traffic destined for a Class A, B, or C private IP address (default = allow). |
| | **local-standalone** string | **Choices:*** disable
* enable
| Enable/disable AP local standalone (default = disable). |
| | **local-standalone-nat** string | **Choices:*** disable
* enable
| Enable/disable AP local standalone NAT mode. |
| | **mac-auth-bypass** string | **Choices:*** disable
* enable
| Enable/disable MAC authentication bypass. |
| | **mac-called-station-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC called station delimiter (default = hyphen). |
| | **mac-calling-station-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC calling station delimiter (default = hyphen). |
| | **mac-case** string | **Choices:*** uppercase
* lowercase
| MAC case (default = uppercase). |
| | **mac-filter** string | **Choices:*** disable
* enable
| Enable/disable MAC filtering to block wireless clients by mac address. |
| | **mac-filter-list** list / elements=string | | no description |
| | | **id** integer | | ID. |
| | | **mac** string | | MAC address. |
| | | **mac-filter-policy** string | **Choices:*** deny
* allow
| Deny or allow the client with this MAC address. |
| | **mac-filter-policy-other** string | **Choices:*** deny
* allow
| 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 (default = hyphen). |
| | **mac-username-delimiter** string | **Choices:*** hyphen
* single-hyphen
* colon
* none
| MAC authentication username delimiter (default = hyphen). |
| | **max-clients** integer | | Maximum number of clients that can connect simultaneously to the VAP (default = 0, meaning no limitation). |
| | **max-clients-ap** integer | | Maximum number of clients that can connect simultaneously to each radio (default = 0, meaning no limitation). |
| | **mbo** string | **Choices:*** disable
* enable
| Enable/disable Multiband Operation (default = disable). |
| | **mbo-cell-data-conn-pref** string | **Choices:*** excluded
* prefer-not
* prefer-use
| MBO cell data connection preference (0, 1, or 255, default = 1). |
| | **me-disable-thresh** integer | | Disable multicast enhancement when this many clients are receiving multicast traffic. |
| | **mesh-backhaul** string | **Choices:*** disable
* enable
| Enable/disable using this VAP as a WiFi mesh backhaul (default = disable). This entry is only available when security is set t... |
| | **mpsk** string | **Choices:*** disable
* enable
| 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 | | no description |
| | | **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** string | | Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. |
| | | **passphrase** string | | no description |
| | **mpsk-profile** string | | MPSK profile name. |
| | **mu-mimo** string | **Choices:*** disable
* enable
| Enable/disable Multi-user MIMO (default = enable). |
| | **multicast-enhance** string | **Choices:*** disable
* enable
| Enable/disable converting multicast to unicast to improve performance (default = disable). |
| | **multicast-rate** string | **Choices:*** 0
* 6000
* 12000
* 24000
| Multicast rate (0, 6000, 12000, or 24000 kbps, default = 0). |
| | **nac** string | **Choices:*** disable
* enable
| Enable/disable network access control. |
| | **nac-profile** string | | NAC profile name. |
| | **name** string | | Virtual AP name. |
| | **neighbor-report-dual-band** string | **Choices:*** disable
* enable
| Enable/disable dual-band neighbor report (default = disable). |
| | **okc** string | **Choices:*** disable
* enable
| Enable/disable Opportunistic Key Caching (OKC) (default = enable). |
| | **owe-groups** list / elements=string | **Choices:*** 19
* 20
* 21
| no description |
| | **owe-transition** string | **Choices:*** disable
* enable
| Enable/disable OWE transition mode support. |
| | **owe-transition-ssid** string | | OWE transition mode peer SSID. |
| | **passphrase** string | | no description |
| | **pmf** string | **Choices:*** disable
* enable
* optional
| Protected Management Frames (PMF) support (default = disable). |
| | **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 (default = disable). |
| | **port-macauth-reauth-timeout** integer | | LAN port MAC authentication re-authentication timeout value (default = 7200 sec). |
| | **port-macauth-timeout** integer | | LAN port MAC authentication idle timeout value (default = 600 sec). |
| | **portal-message-override-group** string | | Replacement message group for this VAP (only available when security is set to a captive portal type). |
| | **portal-message-overrides** dictionary | | no description |
| | | **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. |
| | **probe-resp-suppression** string | **Choices:*** disable
* enable
| Enable/disable probe response suppression (to ignore weak signals) (default = disable). |
| | **probe-resp-threshold** string | | Minimum signal level/threshold in dBm required for the AP response to probe requests (-95 to -20, default = -80). |
| | **ptk-rekey** string | **Choices:*** disable
* enable
| Enable/disable PTK rekey for WPA-Enterprise security. |
| | **ptk-rekey-intv** integer | | PTK rekey interval (1800 - 864000 sec, default = 86400). |
| | **qos-profile** string | | Quality of service profile name. |
| | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable station quarantine (default = enable). |
| | **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, default = -79). |
| | **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, default = -76). |
| | **radio-sensitivity** string | **Choices:*** disable
* enable
| Enable/disable software radio sensitivity (to ignore weak signals) (default = disable). |
| | **radius-mac-auth** string | **Choices:*** disable
* enable
| Enable/disable RADIUS-based MAC authentication of clients (default = disable). |
| | **radius-mac-auth-server** string | | RADIUS-based MAC authentication server. |
| | **radius-mac-auth-usergroups** string | | no description |
| | **radius-server** string | | RADIUS server to be used to authenticate WiFi users. |
| | **rates-11a** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-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
* 11
* 11-basic
| no description |
| | **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
* mcs0/2
* mcs1/2
* mcs2/2
* mcs3/2
* mcs4/2
* mcs5/2
* mcs6/2
* mcs7/2
* mcs8/2
* mcs9/2
* mcs10/1
* mcs11/1
* mcs10/2
* mcs11/2
| no description |
| | **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
* mcs0/4
* mcs1/4
* mcs2/4
* mcs3/4
* mcs4/4
* mcs5/4
* mcs6/4
* mcs7/4
* mcs8/4
* mcs9/4
* mcs10/3
* mcs11/3
* mcs10/4
* mcs11/4
| no description |
| | **rates-11bg** list / elements=string | **Choices:*** 1
* 1-basic
* 2
* 2-basic
* 5.5
* 5.5-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
* 11
* 11-basic
| no description |
| | **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
| no description |
| | **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
| no description |
| | **sae-groups** list / elements=string | **Choices:*** 1
* 2
* 5
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 27
* 28
* 29
* 30
* 31
| no description |
| | **sae-password** string | | no description |
| | **schedule** string | | VAP schedule name. |
| | **secondary-wag-profile** string | | Secondary wireless access gateway profile name. |
| | **security** string | **Choices:*** None
* WEP64
* wep64
* WEP128
* wep128
* WPA\_PSK
* WPA\_RADIUS
* WPA
* WPA2
* WPA2\_AUTO
* open
* wpa-personal
* wpa-enterprise
* captive-portal
* wpa-only-personal
* wpa-only-enterprise
* wpa2-only-personal
* wpa2-only-enterprise
* wpa-personal+captive-portal
* wpa-only-personal+captive-portal
* wpa2-only-personal+captive-portal
* osen
* wpa3-enterprise
* sae
* sae-transition
* owe
* wpa3-sae
* wpa3-sae-transition
* wpa3-only-enterprise
* wpa3-enterprise-transition
| Security mode for the wireless interface (default = wpa2-only-personal). |
| | **security-exempt-list** string | | Optional security exempt list for captive portal authentication. |
| | **security-obsolete-option** string | **Choices:*** disable
* enable
| Enable/disable obsolete security options. |
| | **security-redirect-url** string | | Optional URL for redirecting users after they pass captive portal authentication. |
| | **selected-usergroups** string | | Selective user groups that are permitted to authenticate. |
| | **split-tunneling** string | **Choices:*** disable
* enable
| Enable/disable split tunneling (default = disable). |
| | **ssid** string | | IEEE 802.11 service set identifier (SSID) for the wireless interface. Users who wish to use the wireless network must configur... |
| | **sticky-client-remove** string | **Choices:*** disable
* enable
| Enable/disable sticky client remove to maintain good signal level clients in SSID. (default = disable). |
| | **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, default = -79). |
| | **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, default = -76). |
| | **target-wake-time** string | **Choices:*** disable
* enable
| Enable/disable 802.11ax target wake time (default = enable). |
| | **tkip-counter-measure** string | **Choices:*** disable
* enable
| 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, default = 300). |
| | **tunnel-fallback-interval** integer | | The time interval for secondary tunnel to fall back to primary tunnel (0 - 65535 sec, default = 7200). |
| | **usergroup** string | | Firewall user group to be used to authenticate WiFi users. |
| | **utm-profile** string | | UTM profile name. |
| | **vdom** string | | Name of the VDOM that the Virtual AP has been added to. |
| | **vlan-auto** string | **Choices:*** disable
* enable
| Enable/disable automatic management of SSID VLAN interface. |
| | **vlan-pool** list / elements=string | | no description |
| | | **\_wtp-group** string | | no description |
| | | **id** integer | | ID. |
| | | **wtp-group** string | | 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 (default = disable). When... |
| | **vlanid** integer | | Optional VLAN ID. |
| | **voice-enterprise** string | **Choices:*** disable
* enable
| Enable/disable 802.11k and 802.11v assisted Voice-Enterprise roaming (default = disable). |
| **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 Access Points
fmgr_vap:
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]>
vap:
_centmgmt: <value in [disable, enable]>
_dhcp_svr_id: <value of string>
_intf_allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
_intf_device-identification: <value in [disable, enable]>
_intf_device-netscan: <value in [disable, enable]>
_intf_dhcp-relay-ip: <value of string>
_intf_dhcp-relay-service: <value in [disable, enable]>
_intf_dhcp-relay-type: <value in [regular, ipsec]>
_intf_dhcp6-relay-ip: <value of string>
_intf_dhcp6-relay-service: <value in [disable, enable]>
_intf_dhcp6-relay-type: <value in [regular]>
_intf_ip: <value of string>
_intf_ip6-address: <value of string>
_intf_ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- any
- fgfm
- capwap
_intf_listen-forticlient-connection: <value in [disable, enable]>
acct-interim-interval: <value of integer>
alias: <value of string>
auth: <value in [PSK, psk, RADIUS, ...]>
broadcast-ssid: <value in [disable, enable]>
broadcast-suppression:
- dhcp
- arp
- dhcp2
- arp2
- netbios-ns
- netbios-ds
- arp3
- dhcp-up
- dhcp-down
- arp-known
- arp-unknown
- arp-reply
- ipv6
- dhcp-starvation
- arp-poison
- all-other-mc
- all-other-bc
- arp-proxy
- dhcp-ucast
captive-portal-ac-name: <value of string>
captive-portal-macauth-radius-secret: <value of string>
captive-portal-macauth-radius-server: <value of string>
captive-portal-radius-secret: <value of string>
captive-portal-radius-server: <value of string>
captive-portal-session-timeout-interval: <value of integer>
dhcp-lease-time: <value of integer>
dhcp-option82-circuit-id-insertion: <value in [disable, style-1, style-2, ...]>
dhcp-option82-insertion: <value in [disable, enable]>
dhcp-option82-remote-id-insertion: <value in [disable, style-1]>
dynamic-vlan: <value in [disable, enable]>
dynamic_mapping:
-
_centmgmt: <value in [disable, enable]>
_dhcp_svr_id: <value of string>
_intf_allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
_intf_device-identification: <value in [disable, enable]>
_intf_device-netscan: <value in [disable, enable]>
_intf_dhcp-relay-ip: <value of string>
_intf_dhcp-relay-service: <value in [disable, enable]>
_intf_dhcp-relay-type: <value in [regular, ipsec]>
_intf_dhcp6-relay-ip: <value of string>
_intf_dhcp6-relay-service: <value in [disable, enable]>
_intf_dhcp6-relay-type: <value in [regular]>
_intf_ip: <value of string>
_intf_ip6-address: <value of string>
_intf_ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- any
- fgfm
- capwap
_intf_listen-forticlient-connection: <value in [disable, enable]>
_scope:
-
name: <value of string>
vdom: <value of string>
acct-interim-interval: <value of integer>
address-group: <value of string>
alias: <value of string>
atf-weight: <value of integer>
auth: <value in [PSK, psk, RADIUS, ...]>
broadcast-ssid: <value in [disable, enable]>
broadcast-suppression:
- dhcp
- arp
- dhcp2
- arp2
- netbios-ns
- netbios-ds
- arp3
- dhcp-up
- dhcp-down
- arp-known
- arp-unknown
- arp-reply
- ipv6
- dhcp-starvation
- arp-poison
- all-other-mc
- all-other-bc
- arp-proxy
- dhcp-ucast
captive-portal-ac-name: <value of string>
captive-portal-macauth-radius-secret: <value of string>
captive-portal-macauth-radius-server: <value of string>
captive-portal-radius-secret: <value of string>
captive-portal-radius-server: <value of string>
captive-portal-session-timeout-interval: <value of integer>
client-count: <value of integer>
dhcp-lease-time: <value of integer>
dhcp-option82-circuit-id-insertion: <value in [disable, style-1, style-2, ...]>
dhcp-option82-insertion: <value in [disable, enable]>
dhcp-option82-remote-id-insertion: <value in [disable, style-1]>
dynamic-vlan: <value in [disable, enable]>
eap-reauth: <value in [disable, enable]>
eap-reauth-intv: <value of integer>
eapol-key-retries: <value in [disable, enable]>
encrypt: <value in [TKIP, AES, TKIP-AES]>
external-fast-roaming: <value in [disable, enable]>
external-logout: <value of string>
external-web: <value of string>
fast-bss-transition: <value in [disable, enable]>
fast-roaming: <value in [disable, enable]>
ft-mobility-domain: <value of integer>
ft-over-ds: <value in [disable, enable]>
ft-r0-key-lifetime: <value of integer>
gtk-rekey: <value in [disable, enable]>
gtk-rekey-intv: <value of integer>
hotspot20-profile: <value of string>
intra-vap-privacy: <value in [disable, enable]>
ip: <value of string>
key: <value of string>
keyindex: <value of integer>
ldpc: <value in [disable, tx, rx, ...]>
local-authentication: <value in [disable, enable]>
local-bridging: <value in [disable, enable]>
local-lan: <value in [deny, allow]>
local-standalone: <value in [disable, enable]>
local-standalone-nat: <value in [disable, enable]>
local-switching: <value in [disable, enable]>
mac-auth-bypass: <value in [disable, enable]>
mac-filter: <value in [disable, enable]>
mac-filter-policy-other: <value in [deny, allow]>
max-clients: <value of integer>
max-clients-ap: <value of integer>
me-disable-thresh: <value of integer>
mesh-backhaul: <value in [disable, enable]>
mpsk: <value in [disable, enable]>
mpsk-concurrent-clients: <value of integer>
multicast-enhance: <value in [disable, enable]>
multicast-rate: <value in [0, 6000, 12000, ...]>
okc: <value in [disable, enable]>
owe-groups:
- 19
- 20
- 21
owe-transition: <value in [disable, enable]>
owe-transition-ssid: <value of string>
passphrase: <value of string>
pmf: <value in [disable, enable, optional]>
pmf-assoc-comeback-timeout: <value of integer>
pmf-sa-query-retry-timeout: <value of integer>
portal-message-override-group: <value of string>
portal-type: <value in [auth, auth+disclaimer, disclaimer, ...]>
probe-resp-suppression: <value in [disable, enable]>
probe-resp-threshold: <value of string>
ptk-rekey: <value in [disable, enable]>
ptk-rekey-intv: <value of integer>
qos-profile: <value of string>
quarantine: <value in [disable, enable]>
radio-2g-threshold: <value of string>
radio-5g-threshold: <value of string>
radio-sensitivity: <value in [disable, enable]>
radius-mac-auth: <value in [disable, enable]>
radius-mac-auth-server: <value of string>
radius-mac-auth-usergroups: <value of string>
radius-server: <value of string>
rates-11a:
- 1
- 1-basic
- 2
- 2-basic
- 5.5
- 5.5-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
- 11
- 11-basic
rates-11ac-ss12:
- mcs0/1
- mcs1/1
- mcs2/1
- mcs3/1
- mcs4/1
- mcs5/1
- mcs6/1
- mcs7/1
- mcs8/1
- mcs9/1
- mcs0/2
- mcs1/2
- mcs2/2
- mcs3/2
- mcs4/2
- mcs5/2
- mcs6/2
- mcs7/2
- mcs8/2
- mcs9/2
- mcs10/1
- mcs11/1
- mcs10/2
- mcs11/2
rates-11ac-ss34:
- mcs0/3
- mcs1/3
- mcs2/3
- mcs3/3
- mcs4/3
- mcs5/3
- mcs6/3
- mcs7/3
- mcs8/3
- mcs9/3
- mcs0/4
- mcs1/4
- mcs2/4
- mcs3/4
- mcs4/4
- mcs5/4
- mcs6/4
- mcs7/4
- mcs8/4
- mcs9/4
- mcs10/3
- mcs11/3
- mcs10/4
- mcs11/4
rates-11bg:
- 1
- 1-basic
- 2
- 2-basic
- 5.5
- 5.5-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
- 11
- 11-basic
rates-11n-ss12:
- 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
rates-11n-ss34:
- 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
sae-groups:
- 1
- 2
- 5
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 27
- 28
- 29
- 30
- 31
sae-password: <value of string>
schedule: <value of string>
security: <value in [None, WEP64, wep64, ...]>
security-exempt-list: <value of string>
security-obsolete-option: <value in [disable, enable]>
security-redirect-url: <value of string>
selected-usergroups: <value of string>
split-tunneling: <value in [disable, enable]>
ssid: <value of string>
tkip-counter-measure: <value in [disable, enable]>
usergroup: <value of string>
utm-profile: <value of string>
vdom: <value of string>
vlan-auto: <value in [disable, enable]>
vlan-pooling: <value in [wtp-group, round-robin, hash, ...]>
vlanid: <value of integer>
voice-enterprise: <value in [disable, enable]>
mu-mimo: <value in [disable, enable]>
_intf_device-access-list: <value of string>
external-web-format: <value in [auto-detect, no-query-string, partial-query-string]>
high-efficiency: <value in [disable, enable]>
primary-wag-profile: <value of string>
secondary-wag-profile: <value of string>
target-wake-time: <value in [disable, enable]>
tunnel-echo-interval: <value of integer>
tunnel-fallback-interval: <value of integer>
access-control-list: <value of string>
captive-portal-auth-timeout: <value of integer>
ipv6-rules:
- drop-icmp6ra
- drop-icmp6rs
- drop-llmnr6
- drop-icmp6mld2
- drop-dhcp6s
- drop-dhcp6c
- ndp-proxy
- drop-ns-dad
- drop-ns-nondad
sticky-client-remove: <value in [disable, enable]>
sticky-client-threshold-2g: <value of string>
sticky-client-threshold-5g: <value of string>
bss-color-partial: <value in [disable, enable]>
dhcp-option43-insertion: <value in [disable, enable]>
mpsk-profile: <value of string>
igmp-snooping: <value in [disable, enable]>
port-macauth: <value in [disable, radius, address-group]>
port-macauth-reauth-timeout: <value of integer>
port-macauth-timeout: <value of integer>
additional-akms:
- akm6
bstm-disassociation-imminent: <value in [disable, enable]>
bstm-load-balancing-disassoc-timer: <value of integer>
bstm-rssi-disassoc-timer: <value of integer>
dhcp-address-enforcement: <value in [disable, enable]>
gas-comeback-delay: <value of integer>
gas-fragmentation-limit: <value of integer>
mac-called-station-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-calling-station-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-case: <value in [uppercase, lowercase]>
mac-password-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-username-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mbo: <value in [disable, enable]>
mbo-cell-data-conn-pref: <value in [excluded, prefer-not, prefer-use]>
nac: <value in [disable, enable]>
nac-profile: <value of string>
neighbor-report-dual-band: <value in [disable, enable]>
eap-reauth: <value in [disable, enable]>
eap-reauth-intv: <value of integer>
eapol-key-retries: <value in [disable, enable]>
encrypt: <value in [TKIP, AES, TKIP-AES]>
external-fast-roaming: <value in [disable, enable]>
external-logout: <value of string>
external-web: <value of string>
fast-bss-transition: <value in [disable, enable]>
fast-roaming: <value in [disable, enable]>
ft-mobility-domain: <value of integer>
ft-over-ds: <value in [disable, enable]>
ft-r0-key-lifetime: <value of integer>
gtk-rekey: <value in [disable, enable]>
gtk-rekey-intv: <value of integer>
hotspot20-profile: <value of string>
intra-vap-privacy: <value in [disable, enable]>
ip: <value of string>
key: <value of string>
keyindex: <value of integer>
ldpc: <value in [disable, tx, rx, ...]>
local-authentication: <value in [disable, enable]>
local-bridging: <value in [disable, enable]>
local-lan: <value in [deny, allow]>
local-standalone: <value in [disable, enable]>
local-standalone-nat: <value in [disable, enable]>
mac-auth-bypass: <value in [disable, enable]>
mac-filter: <value in [disable, enable]>
mac-filter-list:
-
id: <value of integer>
mac: <value of string>
mac-filter-policy: <value in [deny, allow]>
mac-filter-policy-other: <value in [deny, allow]>
max-clients: <value of integer>
max-clients-ap: <value of integer>
me-disable-thresh: <value of integer>
mesh-backhaul: <value in [disable, enable]>
mpsk: <value in [disable, enable]>
mpsk-concurrent-clients: <value of integer>
mpsk-key:
-
comment: <value of string>
concurrent-clients: <value of string>
key-name: <value of string>
passphrase: <value of string>
mpsk-schedules: <value of string>
multicast-enhance: <value in [disable, enable]>
multicast-rate: <value in [0, 6000, 12000, ...]>
name: <value of string>
okc: <value in [disable, enable]>
passphrase: <value of string>
pmf: <value in [disable, enable, optional]>
pmf-assoc-comeback-timeout: <value of integer>
pmf-sa-query-retry-timeout: <value of integer>
portal-message-override-group: <value of string>
portal-type: <value in [auth, auth+disclaimer, disclaimer, ...]>
probe-resp-suppression: <value in [disable, enable]>
probe-resp-threshold: <value of string>
ptk-rekey: <value in [disable, enable]>
ptk-rekey-intv: <value of integer>
qos-profile: <value of string>
quarantine: <value in [disable, enable]>
radio-2g-threshold: <value of string>
radio-5g-threshold: <value of string>
radio-sensitivity: <value in [disable, enable]>
radius-mac-auth: <value in [disable, enable]>
radius-mac-auth-server: <value of string>
radius-mac-auth-usergroups: <value of string>
radius-server: <value of string>
rates-11a:
- 1
- 1-basic
- 2
- 2-basic
- 5.5
- 5.5-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
- 11
- 11-basic
rates-11ac-ss12:
- mcs0/1
- mcs1/1
- mcs2/1
- mcs3/1
- mcs4/1
- mcs5/1
- mcs6/1
- mcs7/1
- mcs8/1
- mcs9/1
- mcs0/2
- mcs1/2
- mcs2/2
- mcs3/2
- mcs4/2
- mcs5/2
- mcs6/2
- mcs7/2
- mcs8/2
- mcs9/2
- mcs10/1
- mcs11/1
- mcs10/2
- mcs11/2
rates-11ac-ss34:
- mcs0/3
- mcs1/3
- mcs2/3
- mcs3/3
- mcs4/3
- mcs5/3
- mcs6/3
- mcs7/3
- mcs8/3
- mcs9/3
- mcs0/4
- mcs1/4
- mcs2/4
- mcs3/4
- mcs4/4
- mcs5/4
- mcs6/4
- mcs7/4
- mcs8/4
- mcs9/4
- mcs10/3
- mcs11/3
- mcs10/4
- mcs11/4
rates-11bg:
- 1
- 1-basic
- 2
- 2-basic
- 5.5
- 5.5-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
- 11
- 11-basic
rates-11n-ss12:
- 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
rates-11n-ss34:
- 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
schedule: <value of string>
security: <value in [None, WEP64, wep64, ...]>
security-exempt-list: <value of string>
security-obsolete-option: <value in [disable, enable]>
security-redirect-url: <value of string>
selected-usergroups: <value of string>
split-tunneling: <value in [disable, enable]>
ssid: <value of string>
tkip-counter-measure: <value in [disable, enable]>
usergroup: <value of string>
utm-profile: <value of string>
vdom: <value of string>
vlan-auto: <value in [disable, enable]>
vlan-pool:
-
_wtp-group: <value of string>
id: <value of integer>
wtp-group: <value of string>
vlan-pooling: <value in [wtp-group, round-robin, hash, ...]>
vlanid: <value of integer>
voice-enterprise: <value in [disable, enable]>
address-group: <value of string>
atf-weight: <value of integer>
mu-mimo: <value in [disable, enable]>
owe-groups:
- 19
- 20
- 21
owe-transition: <value in [disable, enable]>
owe-transition-ssid: <value of string>
sae-groups:
- 1
- 2
- 5
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 27
- 28
- 29
- 30
- 31
sae-password: <value of string>
_intf_device-access-list: <value of string>
external-web-format: <value in [auto-detect, no-query-string, partial-query-string]>
high-efficiency: <value in [disable, enable]>
primary-wag-profile: <value of string>
secondary-wag-profile: <value of string>
target-wake-time: <value in [disable, enable]>
tunnel-echo-interval: <value of integer>
tunnel-fallback-interval: <value of integer>
access-control-list: <value of string>
captive-portal-auth-timeout: <value of integer>
ipv6-rules:
- drop-icmp6ra
- drop-icmp6rs
- drop-llmnr6
- drop-icmp6mld2
- drop-dhcp6s
- drop-dhcp6c
- ndp-proxy
- drop-ns-dad
- drop-ns-nondad
sticky-client-remove: <value in [disable, enable]>
sticky-client-threshold-2g: <value of string>
sticky-client-threshold-5g: <value of string>
bss-color-partial: <value in [disable, enable]>
dhcp-option43-insertion: <value in [disable, enable]>
mpsk-profile: <value of string>
igmp-snooping: <value in [disable, enable]>
port-macauth: <value in [disable, radius, address-group]>
port-macauth-reauth-timeout: <value of integer>
port-macauth-timeout: <value of integer>
portal-message-overrides:
auth-disclaimer-page: <value of string>
auth-login-failed-page: <value of string>
auth-login-page: <value of string>
auth-reject-page: <value of string>
additional-akms:
- akm6
bstm-disassociation-imminent: <value in [disable, enable]>
bstm-load-balancing-disassoc-timer: <value of integer>
bstm-rssi-disassoc-timer: <value of integer>
dhcp-address-enforcement: <value in [disable, enable]>
gas-comeback-delay: <value of integer>
gas-fragmentation-limit: <value of integer>
mac-called-station-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-calling-station-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-case: <value in [uppercase, lowercase]>
mac-password-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mac-username-delimiter: <value in [hyphen, single-hyphen, colon, ...]>
mbo: <value in [disable, enable]>
mbo-cell-data-conn-pref: <value in [excluded, prefer-not, prefer-use]>
nac: <value in [disable, enable]>
nac-profile: <value of string>
neighbor-report-dual-band: <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.fortimanager – HttpApi Plugin for Fortinet FortiManager Appliance or VM. fortinet.fortimanager.fortimanager – HttpApi Plugin for Fortinet FortiManager Appliance or VM.
==============================================================================================
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.fortimanager`.
New in version 2.8: of fortinet.fortimanager
Synopsis
--------
* This HttpApi plugin provides methods to connect to Fortinet FortiManager Appliance or VM via JSON RPC API.
### Authors
* Link Zheng (@chillancezen)
* Luke Weighall (@lweighall)
* Andrew Welsh (@Ghilli3)
* Jim Huber (@p4r4n0y1ng)
ansible fortinet.fortimanager.fmgr_spamfilter_profile_pop3 – POP3. fortinet.fortimanager.fmgr\_spamfilter\_profile\_pop3 – POP3.
=============================================================
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_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 |
| **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\_pop3** 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: POP3.
fmgr_spamfilter_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>
spamfilter_profile_pop3:
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_wtpprofile_splittunnelingacl – Split tunneling ACL filter list. fortinet.fortimanager.fmgr\_wtpprofile\_splittunnelingacl – Split tunneling ACL filter 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_wtpprofile_splittunnelingacl`.
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 |
| **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 |
| **wtp-profile** string / required | | the parameter (wtp-profile) in requested url |
| **wtpprofile\_splittunnelingacl** dictionary | | the top level parameters set |
| | **dest-ip** string | | Destination IP and mask for the split-tunneling subnet. |
| | **id** integer | | ID. |
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: Split tunneling ACL filter list.
fmgr_wtpprofile_splittunnelingacl:
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>
wtp-profile: <your own value>
state: <value in [present, absent]>
wtpprofile_splittunnelingacl:
dest-ip: <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_waf_profile_urlaccess_accesspattern – URL access pattern. fortinet.fortimanager.fmgr\_waf\_profile\_urlaccess\_accesspattern – URL access pattern.
========================================================================================
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_accesspattern`.
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 |
| **url-access** string / required | | the parameter (url-access) in requested url |
| **waf\_profile\_urlaccess\_accesspattern** dictionary | | the top level parameters set |
| | **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. |
| **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 pattern.
fmgr_waf_profile_urlaccess_accesspattern:
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>
url-access: <your own value>
state: <value in [present, absent]>
waf_profile_urlaccess_accesspattern:
id: <value of integer>
negate: <value in [disable, enable]>
pattern: <value of string>
regex: <value in [disable, enable]>
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_sshfilter_profile_shellcommands – SSH command filter. fortinet.fortimanager.fmgr\_sshfilter\_profile\_shellcommands – SSH command filter.
===================================================================================
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_sshfilter_profile_shellcommands`.
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 |
| **sshfilter\_profile\_shellcommands** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** block
* allow
| Action to take for URL filter matches. |
| | **alert** string | **Choices:*** disable
* enable
| Enable/disable alert. |
| | **id** integer | | Id. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **pattern** string | | SSH shell command pattern. |
| | **severity** string | **Choices:*** low
* medium
* high
* critical
| Log severity. |
| | **type** string | **Choices:*** regex
* simple
| Matching type. |
| **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: SSH command filter.
fmgr_sshfilter_profile_shellcommands:
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]>
sshfilter_profile_shellcommands:
action: <value in [block, allow]>
alert: <value in [disable, enable]>
id: <value of integer>
log: <value in [disable, enable]>
pattern: <value of string>
severity: <value in [low, medium, high, ...]>
type: <value in [regex, 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 |
| --- | --- | --- |
| **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_pkg_footer_shapingpolicy – Configure shaping policies. fortinet.fortimanager.fmgr\_pkg\_footer\_shapingpolicy – Configure shaping policies.
====================================================================================
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_footer_shapingpolicy`.
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 |
| **pkg** string / required | | the parameter (pkg) in requested url |
| **pkg\_footer\_shapingpolicy** dictionary | | the top level parameters set |
| | **app-category** string | | no description |
| | **app-group** string | | no description |
| | **application** integer | | no description |
| | **class-id** integer | | no description |
| | **comment** string | | no description |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| no description |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| no description |
| | **diffservcode-forward** string | | no description |
| | **diffservcode-rev** string | | no description |
| | **dstaddr** string | | no description |
| | **dstaddr6** string | | no description |
| | **dstintf** string | | no description |
| | **groups** string | | no description |
| | **id** integer | | no description |
| | **internet-service** string | **Choices:*** disable
* enable
| no description |
| | **internet-service-custom** string | | no description |
| | **internet-service-custom-group** string | | no description |
| | **internet-service-group** string | | no description |
| | **internet-service-id** string | | no description |
| | **internet-service-name** string | | no description |
| | **internet-service-src** string | **Choices:*** disable
* enable
| no description |
| | **internet-service-src-custom** string | | no description |
| | **internet-service-src-custom-group** string | | no description |
| | **internet-service-src-group** string | | no description |
| | **internet-service-src-id** string | | no description |
| | **internet-service-src-name** string | | no description |
| | **ip-version** string | **Choices:*** 4
* 6
| no description |
| | **per-ip-shaper** string | | no description |
| | **schedule** string | | no description |
| | **service** string | | no description |
| | **srcaddr** string | | no description |
| | **srcaddr6** string | | no description |
| | **srcintf** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **tos** string | | no description |
| | **tos-mask** string | | no description |
| | **tos-negate** string | **Choices:*** disable
* enable
| no description |
| | **traffic-shaper** string | | no description |
| | **traffic-shaper-reverse** string | | no description |
| | **url-category** string | | no description |
| | **users** string | | no description |
| | **uuid** 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: Configure shaping policies.
fmgr_pkg_footer_shapingpolicy:
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, ...]
pkg: <your own value>
state: <value in [present, absent]>
pkg_footer_shapingpolicy:
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
class-id: <value of integer>
comment: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
dstaddr: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
groups: <value of string>
id: <value of integer>
internet-service: <value in [disable, enable]>
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>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
ip-version: <value in [4, 6]>
per-ip-shaper: <value of string>
schedule: <value of string>
service: <value of string>
srcaddr: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
status: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
uuid: <value of string>
internet-service-name: <value of string>
internet-service-src-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_switchcontroller_qos_queuepolicy_cosqueue – COS queue configuration. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_queuepolicy\_cosqueue – COS queue 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_switchcontroller_qos_queuepolicy_cosqueue`.
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 |
| **queue-policy** string / required | | the parameter (queue-policy) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **switchcontroller\_qos\_queuepolicy\_cosqueue** dictionary | | the top level parameters set |
| | **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 (0f link speed). |
| | **min-rate** integer | | Minimum rate (0 - 4294967295 kbps, 0 to disable). |
| | **min-rate-percent** integer | | Minimum rate (0f link speed). |
| | **name** string | | Cos queue ID. |
| | **weight** integer | | Weight of weighted round robin scheduling. |
| **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: COS queue configuration.
fmgr_switchcontroller_qos_queuepolicy_cosqueue:
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>
queue-policy: <your own value>
state: <value in [present, absent]>
switchcontroller_qos_queuepolicy_cosqueue:
description: <value of string>
drop-policy: <value in [taildrop, weighted-random-early-detection]>
max-rate: <value of integer>
min-rate: <value of integer>
name: <value of string>
weight: <value of integer>
max-rate-percent: <value of integer>
min-rate-percent: <value of integer>
ecn: <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_hotspot20_anqpvenuename – Configure venue name duple. fortinet.fortimanager.fmgr\_hotspot20\_anqpvenuename – Configure venue name duple.
==================================================================================
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_anqpvenuename`.
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\_anqpvenuename** dictionary | | the top level parameters set |
| | **name** string | | Name of venue name duple. |
| | **value-list** list / elements=string | | no description |
| | | **index** integer | | Value index. |
| | | **lang** string | | Language code. |
| | | **value** string | | Venue name value. |
| **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 venue name duple.
fmgr_hotspot20_anqpvenuename:
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_anqpvenuename:
name: <value of string>
value-list:
-
index: <value of integer>
lang: <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)
ansible fortinet.fortimanager.fmgr_firewall_profilegroup – Configure profile groups. fortinet.fortimanager.fmgr\_firewall\_profilegroup – Configure profile 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_profilegroup`.
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\_profilegroup** dictionary | | the top level parameters set |
| | **application-list** string | | Name of an existing Application list. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **file-filter-profile** string | | Name of an existing file-filter profile. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Profile group name. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **spamfilter-profile** string | | Name of an existing Spam filter profile. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **waf-profile** string | | Name of an existing Web application firewall profile. |
| | **webfilter-profile** string | | Name of an existing Web filter profile. |
| **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 profile groups.
fmgr_firewall_profilegroup:
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_profilegroup:
application-list: <value of string>
av-profile: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
icap-profile: <value of string>
ips-sensor: <value of string>
mms-profile: <value of string>
name: <value of string>
profile-protocol-options: <value of string>
spamfilter-profile: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
voip-profile: <value of string>
waf-profile: <value of string>
webfilter-profile: <value of string>
cifs-profile: <value of string>
emailfilter-profile: <value of string>
file-filter-profile: <value of string>
videofilter-profile: <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_objecttagging – Configure object tagging. fortinet.fortimanager.fmgr\_system\_objecttagging – Configure 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_system_objecttagging`.
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\_objecttagging** dictionary | | the top level parameters set |
| | **address** string | **Choices:*** optional
* mandatory
* disable
| Address. |
| | **category** string | | Tag Category. |
| | **color** integer | | Color of icon on the GUI. |
| | **device** string | **Choices:*** optional
* mandatory
* disable
| Device. |
| | **interface** string | **Choices:*** optional
* mandatory
* disable
| Interface. |
| | **multiple** string | **Choices:*** disable
* enable
| Allow multiple tag selection. |
| | **tags** 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: Configure object tagging.
fmgr_system_objecttagging:
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_objecttagging:
address: <value in [optional, mandatory, disable]>
category: <value of string>
color: <value of integer>
device: <value in [optional, mandatory, disable]>
interface: <value in [optional, mandatory, disable]>
multiple: <value in [disable, enable]>
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_firewall_address6 – Configure IPv6 firewall addresses. fortinet.fortimanager.fmgr\_firewall\_address6 – Configure IPv6 firewall 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_firewall_address6`.
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\_address6** dictionary | | the top level parameters set |
| | **\_image-base64** string | | no description |
| | **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, default = 0, which sets the value to 1). |
| | **comment** string | | Comment. |
| | **country** string | | IPv6 addresses associated to a specific country. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_image-base64** string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **cache-ttl** integer | | no description |
| | | **color** integer | | no description |
| | | **comment** string | | no description |
| | | **country** string | | no description |
| | | **end-ip** string | | no description |
| | | **end-mac** string | | no description |
| | | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | | **fqdn** string | | no description |
| | | **global-object** integer | | no description |
| | | **host** string | | no description |
| | | **host-type** string | **Choices:*** any
* specific
| no description |
| | | **ip6** string | | no description |
| | | **macaddr** string | | no description |
| | | **obj-id** string | | no description |
| | | **sdn** string | **Choices:*** nsx
| no description |
| | | **start-ip** string | | no description |
| | | **start-mac** string | | no description |
| | | **subnet-segment** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **type** string | **Choices:*** any
* specific
| no description |
| | | | **value** string | | no description |
| | | **tags** string | | no description |
| | | **template** string | | no description |
| | | **type** string | **Choices:*** ipprefix
* iprange
* dynamic
* fqdn
* template
| no description |
| | | **uuid** string | | no description |
| | | **visibility** string | **Choices:*** disable
* enable
| no description |
| | **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:*** disable
* enable
| Security Fabric global object setting. |
| | **fqdn** string | | Fully qualified domain name. |
| | **global-object** integer | | Global Object. |
| | **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 | | no description |
| | | **ip** string | | IP. |
| | | **net-id** string | | Network ID. |
| | | **obj-id** string | | Object ID. |
| | **macaddr** string | | no description |
| | **name** string | | Address name. |
| | **obj-id** string | | Object ID for NSX. |
| | **sdn** string | **Choices:*** nsx
| SDN. |
| | **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 | | no description |
| | | **name** string | | Name. |
| | | **type** string | **Choices:*** any
* specific
| Subnet segment type. |
| | | **value** string | | Subnet segment value. |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **template** string | | IPv6 address template. |
| | **type** string | **Choices:*** ipprefix
* iprange
* dynamic
* fqdn
* template
| Type of IPv6 address object (default = ipprefix). |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable the 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: Configure IPv6 firewall addresses.
fmgr_firewall_address6:
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_address6:
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
end-ip: <value of string>
fqdn: <value of string>
host: <value of string>
host-type: <value in [any, specific]>
ip6: <value of string>
obj-id: <value of string>
sdn: <value in [nsx]>
start-ip: <value of string>
tags: <value of string>
template: <value of string>
type: <value in [ipprefix, iprange, dynamic, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
subnet-segment:
-
name: <value of string>
type: <value in [any, specific]>
value: <value of string>
_image-base64: <value of string>
end-mac: <value of string>
start-mac: <value of string>
country: <value of string>
global-object: <value of integer>
fabric-object: <value in [disable, enable]>
macaddr: <value of string>
end-ip: <value of string>
fqdn: <value of string>
host: <value of string>
host-type: <value in [any, specific]>
ip6: <value of string>
list:
-
ip: <value of string>
net-id: <value of string>
obj-id: <value of string>
name: <value of string>
obj-id: <value of string>
sdn: <value in [nsx]>
start-ip: <value of string>
subnet-segment:
-
name: <value of string>
type: <value in [any, specific]>
value: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
template: <value of string>
type: <value in [ipprefix, iprange, dynamic, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
_image-base64: <value of string>
end-mac: <value of string>
start-mac: <value of string>
country: <value of string>
global-object: <value of integer>
fabric-object: <value in [disable, enable]>
macaddr: <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_hostchecksoftware_checkitemlist – Check item list. fortinet.fortimanager.fmgr\_vpnsslweb\_hostchecksoftware\_checkitemlist – Check item 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_vpnsslweb_hostchecksoftware_checkitemlist`.
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 |
| **host-check-software** string / required | | the parameter (host-check-software) 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\_hostchecksoftware\_checkitemlist** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* require
| Action. |
| | **id** integer | | ID (0 - 4294967295). |
| | **md5s** string | | no description |
| | **target** string | | Target. |
| | **type** string | **Choices:*** file
* registry
* process
| Type. |
| | **version** string | | Version. |
| **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: Check item list.
fmgr_vpnsslweb_hostchecksoftware_checkitemlist:
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>
host-check-software: <your own value>
state: <value in [present, absent]>
vpnsslweb_hostchecksoftware_checkitemlist:
action: <value in [deny, require]>
id: <value of integer>
md5s: <value of string>
target: <value of string>
type: <value in [file, registry, process]>
version: <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_pm_pkg_global – no description fortinet.fortimanager.fmgr\_pm\_pkg\_global – 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_pm_pkg_global`.
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 |
| **pm\_pkg\_global** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **obj ver** integer | | no description |
| | **oid** integer | | no description |
| | **package setting** dictionary | | no description |
| | | **central-nat** string | **Choices:*** disable
* enable
| no description |
| | | **consolidated-firewall-mode** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy6-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | | **ngfw-mode** string | **Choices:*** profile-based
* policy-based
| no description |
| | | **ssl-ssh-profile** string | | no description |
| | **scope member** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **type** string | **Choices:*** pkg
* folder
| 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_pm_pkg_global:
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, ...]
pm_pkg_global:
name: <value of string>
obj ver: <value of integer>
oid: <value of integer>
package setting:
central-nat: <value in [disable, enable]>
consolidated-firewall-mode: <value in [disable, enable]>
fwpolicy-implicit-log: <value in [disable, enable]>
fwpolicy6-implicit-log: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
ngfw-mode: <value in [profile-based, policy-based]>
ssl-ssh-profile: <value of string>
scope member:
-
name: <value of string>
vdom: <value of string>
type: <value in [pkg, folder]>
```
Return Values
-------------
Common return 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_h2qposuprovider_friendlyname – OSU provider friendly name. fortinet.fortimanager.fmgr\_hotspot20\_h2qposuprovider\_friendlyname – OSU provider friendly name.
==================================================================================================
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_h2qposuprovider_friendlyname`.
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 |
| **h2qp-osu-provider** string / required | | the parameter (h2qp-osu-provider) in requested url |
| **hotspot20\_h2qposuprovider\_friendlyname** dictionary | | the top level parameters set |
| | **friendly-name** string | | OSU provider friendly name. |
| | **index** integer | | OSU provider friendly name index. |
| | **lang** string | | Language code. |
| **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: OSU provider friendly name.
fmgr_hotspot20_h2qposuprovider_friendlyname:
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>
h2qp-osu-provider: <your own value>
state: <value in [present, absent]>
hotspot20_h2qposuprovider_friendlyname:
friendly-name: <value of string>
index: <value of integer>
lang: <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_voip_profile – Configure VoIP profiles. fortinet.fortimanager.fmgr\_voip\_profile – Configure VoIP 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_voip_profile`.
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 |
| **voip\_profile** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **feature-set** string | **Choices:*** flow
* proxy
| Flow or proxy inspection feature set. |
| | **name** string | | Profile name. |
| | **sccp** dictionary | | no description |
| | | **block-mcast** string | **Choices:*** disable
* enable
| Enable/disable block multicast RTP connections. |
| | | **log-call-summary** string | **Choices:*** disable
* enable
| Enable/disable log summary of SCCP calls. |
| | | **log-violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SCCP violations. |
| | | **max-calls** integer | | Maximum calls per minute per SCCP client (max 65535). |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable SCCP. |
| | | **verify-header** string | **Choices:*** disable
* enable
| Enable/disable verify SCCP header content. |
| | **sip** dictionary | | no description |
| | | **ack-rate** integer | | ACK request rate limit (per second, per policy). |
| | | **ack-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **block-ack** string | **Choices:*** disable
* enable
| Enable/disable block ACK requests. |
| | | **block-bye** string | **Choices:*** disable
* enable
| Enable/disable block BYE requests. |
| | | **block-cancel** string | **Choices:*** disable
* enable
| Enable/disable block CANCEL requests. |
| | | **block-geo-red-options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests, but OPTIONS requests still notify for redundancy. |
| | | **block-info** string | **Choices:*** disable
* enable
| Enable/disable block INFO requests. |
| | | **block-invite** string | **Choices:*** disable
* enable
| Enable/disable block INVITE requests. |
| | | **block-long-lines** string | **Choices:*** disable
* enable
| Enable/disable block requests with headers exceeding max-line-length. |
| | | **block-message** string | **Choices:*** disable
* enable
| Enable/disable block MESSAGE requests. |
| | | **block-notify** string | **Choices:*** disable
* enable
| Enable/disable block NOTIFY requests. |
| | | **block-options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests and no OPTIONS as notifying message for redundancy either. |
| | | **block-prack** string | **Choices:*** disable
* enable
| Enable/disable block prack requests. |
| | | **block-publish** string | **Choices:*** disable
* enable
| Enable/disable block PUBLISH requests. |
| | | **block-refer** string | **Choices:*** disable
* enable
| Enable/disable block REFER requests. |
| | | **block-register** string | **Choices:*** disable
* enable
| Enable/disable block REGISTER requests. |
| | | **block-subscribe** string | **Choices:*** disable
* enable
| Enable/disable block SUBSCRIBE requests. |
| | | **block-unknown** string | **Choices:*** disable
* enable
| Block unrecognized SIP requests (enabled by default). |
| | | **block-update** string | **Choices:*** disable
* enable
| Enable/disable block UPDATE requests. |
| | | **bye-rate** integer | | BYE request rate limit (per second, per policy). |
| | | **bye-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **call-keepalive** integer | | Continue tracking calls with no RTP for this many minutes. |
| | | **cancel-rate** integer | | CANCEL request rate limit (per second, per policy). |
| | | **cancel-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **contact-fixup** string | **Choices:*** disable
* enable
| Fixup contact anyway even if contacts IP:port doesnt match sessions IP:port. |
| | | **hnt-restrict-source-ip** string | **Choices:*** disable
* enable
| Enable/disable restrict RTP source IP to be the same as SIP source IP when HNT is enabled. |
| | | **hosted-nat-traversal** string | **Choices:*** disable
* enable
| Hosted NAT Traversal (HNT). |
| | | **info-rate** integer | | INFO request rate limit (per second, per policy). |
| | | **info-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **invite-rate** integer | | INVITE request rate limit (per second, per policy). |
| | | **invite-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **ips-rtp** string | **Choices:*** disable
* enable
| Enable/disable allow IPS on RTP. |
| | | **log-call-summary** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP call summary. |
| | | **log-violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP violations. |
| | | **malformed-header-allow** string | **Choices:*** pass
* discard
* respond
| Action for malformed Allow header. |
| | | **malformed-header-call-id** string | **Choices:*** pass
* discard
* respond
| Action for malformed Call-ID header. |
| | | **malformed-header-contact** string | **Choices:*** pass
* discard
* respond
| Action for malformed Contact header. |
| | | **malformed-header-content-length** string | **Choices:*** pass
* discard
* respond
| Action for malformed Content-Length header. |
| | | **malformed-header-content-type** string | **Choices:*** pass
* discard
* respond
| Action for malformed Content-Type header. |
| | | **malformed-header-cseq** string | **Choices:*** pass
* discard
* respond
| Action for malformed CSeq header. |
| | | **malformed-header-expires** string | **Choices:*** pass
* discard
* respond
| Action for malformed Expires header. |
| | | **malformed-header-from** string | **Choices:*** pass
* discard
* respond
| Action for malformed From header. |
| | | **malformed-header-max-forwards** string | **Choices:*** pass
* discard
* respond
| Action for malformed Max-Forwards header. |
| | | **malformed-header-no-proxy-require** string | **Choices:*** pass
* discard
* respond
| Action for malformed SIP messages without Proxy-Require header. |
| | | **malformed-header-no-require** string | **Choices:*** pass
* discard
* respond
| Action for malformed SIP messages without Require header. |
| | | **malformed-header-p-asserted-identity** string | **Choices:*** pass
* discard
* respond
| Action for malformed P-Asserted-Identity header. |
| | | **malformed-header-rack** string | **Choices:*** pass
* discard
* respond
| Action for malformed RAck header. |
| | | **malformed-header-record-route** string | **Choices:*** pass
* discard
* respond
| Action for malformed Record-Route header. |
| | | **malformed-header-route** string | **Choices:*** pass
* discard
* respond
| Action for malformed Route header. |
| | | **malformed-header-rseq** string | **Choices:*** pass
* discard
* respond
| Action for malformed RSeq header. |
| | | **malformed-header-sdp-a** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP a line. |
| | | **malformed-header-sdp-b** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP b line. |
| | | **malformed-header-sdp-c** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP c line. |
| | | **malformed-header-sdp-i** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP i line. |
| | | **malformed-header-sdp-k** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP k line. |
| | | **malformed-header-sdp-m** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP m line. |
| | | **malformed-header-sdp-o** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP o line. |
| | | **malformed-header-sdp-r** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP r line. |
| | | **malformed-header-sdp-s** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP s line. |
| | | **malformed-header-sdp-t** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP t line. |
| | | **malformed-header-sdp-v** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP v line. |
| | | **malformed-header-sdp-z** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP z line. |
| | | **malformed-header-to** string | **Choices:*** pass
* discard
* respond
| Action for malformed To header. |
| | | **malformed-header-via** string | **Choices:*** pass
* discard
* respond
| Action for malformed VIA header. |
| | | **malformed-request-line** string | **Choices:*** pass
* discard
* respond
| Action for malformed request line. |
| | | **max-body-length** integer | | Maximum SIP message body length (0 meaning no limit). |
| | | **max-dialogs** integer | | Maximum number of concurrent calls/dialogs (per policy). |
| | | **max-idle-dialogs** integer | | Maximum number established but idle dialogs to retain (per policy). |
| | | **max-line-length** integer | | Maximum SIP header line length (78-4096). |
| | | **message-rate** integer | | MESSAGE request rate limit (per second, per policy). |
| | | **message-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **nat-port-range** string | | RTP NAT port range. |
| | | **nat-trace** string | **Choices:*** disable
* enable
| Enable/disable preservation of original IP in SDP i line. |
| | | **no-sdp-fixup** string | **Choices:*** disable
* enable
| Enable/disable no SDP fix-up. |
| | | **notify-rate** integer | | NOTIFY request rate limit (per second, per policy). |
| | | **notify-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **open-contact-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for non-REGISTER Contact port. |
| | | **open-record-route-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Record-Route port. |
| | | **open-register-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for REGISTER Contact port. |
| | | **open-via-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Via port. |
| | | **options-rate** integer | | OPTIONS request rate limit (per second, per policy). |
| | | **options-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **prack-rate** integer | | PRACK request rate limit (per second, per policy). |
| | | **prack-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **preserve-override** string | **Choices:*** disable
* enable
| Override i line to preserve original IPS (default: append). |
| | | **provisional-invite-expiry-time** integer | | Expiry time for provisional INVITE (10 - 3600 sec). |
| | | **publish-rate** integer | | PUBLISH request rate limit (per second, per policy). |
| | | **publish-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **refer-rate** integer | | REFER request rate limit (per second, per policy). |
| | | **refer-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **register-contact-trace** string | **Choices:*** disable
* enable
| Enable/disable trace original IP/port within the contact header of REGISTER requests. |
| | | **register-rate** integer | | REGISTER request rate limit (per second, per policy). |
| | | **register-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **rfc2543-branch** string | **Choices:*** disable
* enable
| Enable/disable support via branch compliant with RFC 2543. |
| | | **rtp** string | **Choices:*** disable
* enable
| Enable/disable create pinholes for RTP traffic to traverse firewall. |
| | | **ssl-algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted in negotiation. |
| | | **ssl-auth-client** string | | Require a client certificate and authenticate it with the peer/peergrp. |
| | | **ssl-auth-server** string | | Authenticate the servers certificate with the peer/peergrp. |
| | | **ssl-client-certificate** string | | Name of Certificate to offer to server if requested. |
| | | **ssl-client-renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow/block client renegotiation by server. |
| | | **ssl-max-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version to negotiate. |
| | | **ssl-min-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version to negotiate. |
| | | **ssl-mode** string | **Choices:*** off
* full
| SSL/TLS mode for encryption & decryption of traffic. |
| | | **ssl-pfs** string | **Choices:*** require
* deny
* allow
| SSL Perfect Forward Secrecy. |
| | | **ssl-send-empty-frags** string | **Choices:*** disable
* enable
| Send empty fragments to avoid attack on CBC IV (SSL 3.0 & TLS 1.0 only). |
| | | **ssl-server-certificate** string | | Name of Certificate return to the client in every SSL connection. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable SIP. |
| | | **strict-register** string | **Choices:*** disable
* enable
| Enable/disable only allow the registrar to connect. |
| | | **subscribe-rate** integer | | SUBSCRIBE request rate limit (per second, per policy). |
| | | **subscribe-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | | **unknown-header** string | **Choices:*** pass
* discard
* respond
| Action for unknown SIP header. |
| | | **update-rate** integer | | UPDATE request rate limit (per second, per policy). |
| | | **update-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| **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 VoIP profiles.
fmgr_voip_profile:
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]>
voip_profile:
comment: <value of string>
name: <value of string>
sccp:
block-mcast: <value in [disable, enable]>
log-call-summary: <value in [disable, enable]>
log-violations: <value in [disable, enable]>
max-calls: <value of integer>
status: <value in [disable, enable]>
verify-header: <value in [disable, enable]>
sip:
ack-rate: <value of integer>
block-ack: <value in [disable, enable]>
block-bye: <value in [disable, enable]>
block-cancel: <value in [disable, enable]>
block-geo-red-options: <value in [disable, enable]>
block-info: <value in [disable, enable]>
block-invite: <value in [disable, enable]>
block-long-lines: <value in [disable, enable]>
block-message: <value in [disable, enable]>
block-notify: <value in [disable, enable]>
block-options: <value in [disable, enable]>
block-prack: <value in [disable, enable]>
block-publish: <value in [disable, enable]>
block-refer: <value in [disable, enable]>
block-register: <value in [disable, enable]>
block-subscribe: <value in [disable, enable]>
block-unknown: <value in [disable, enable]>
block-update: <value in [disable, enable]>
bye-rate: <value of integer>
call-keepalive: <value of integer>
cancel-rate: <value of integer>
contact-fixup: <value in [disable, enable]>
hnt-restrict-source-ip: <value in [disable, enable]>
hosted-nat-traversal: <value in [disable, enable]>
info-rate: <value of integer>
invite-rate: <value of integer>
ips-rtp: <value in [disable, enable]>
log-call-summary: <value in [disable, enable]>
log-violations: <value in [disable, enable]>
malformed-header-allow: <value in [pass, discard, respond]>
malformed-header-call-id: <value in [pass, discard, respond]>
malformed-header-contact: <value in [pass, discard, respond]>
malformed-header-content-length: <value in [pass, discard, respond]>
malformed-header-content-type: <value in [pass, discard, respond]>
malformed-header-cseq: <value in [pass, discard, respond]>
malformed-header-expires: <value in [pass, discard, respond]>
malformed-header-from: <value in [pass, discard, respond]>
malformed-header-max-forwards: <value in [pass, discard, respond]>
malformed-header-p-asserted-identity: <value in [pass, discard, respond]>
malformed-header-rack: <value in [pass, discard, respond]>
malformed-header-record-route: <value in [pass, discard, respond]>
malformed-header-route: <value in [pass, discard, respond]>
malformed-header-rseq: <value in [pass, discard, respond]>
malformed-header-sdp-a: <value in [pass, discard, respond]>
malformed-header-sdp-b: <value in [pass, discard, respond]>
malformed-header-sdp-c: <value in [pass, discard, respond]>
malformed-header-sdp-i: <value in [pass, discard, respond]>
malformed-header-sdp-k: <value in [pass, discard, respond]>
malformed-header-sdp-m: <value in [pass, discard, respond]>
malformed-header-sdp-o: <value in [pass, discard, respond]>
malformed-header-sdp-r: <value in [pass, discard, respond]>
malformed-header-sdp-s: <value in [pass, discard, respond]>
malformed-header-sdp-t: <value in [pass, discard, respond]>
malformed-header-sdp-v: <value in [pass, discard, respond]>
malformed-header-sdp-z: <value in [pass, discard, respond]>
malformed-header-to: <value in [pass, discard, respond]>
malformed-header-via: <value in [pass, discard, respond]>
malformed-request-line: <value in [pass, discard, respond]>
max-body-length: <value of integer>
max-dialogs: <value of integer>
max-idle-dialogs: <value of integer>
max-line-length: <value of integer>
message-rate: <value of integer>
nat-port-range: <value of string>
nat-trace: <value in [disable, enable]>
no-sdp-fixup: <value in [disable, enable]>
notify-rate: <value of integer>
open-contact-pinhole: <value in [disable, enable]>
open-record-route-pinhole: <value in [disable, enable]>
open-register-pinhole: <value in [disable, enable]>
open-via-pinhole: <value in [disable, enable]>
options-rate: <value of integer>
prack-rate: <value of integer>
preserve-override: <value in [disable, enable]>
provisional-invite-expiry-time: <value of integer>
publish-rate: <value of integer>
refer-rate: <value of integer>
register-contact-trace: <value in [disable, enable]>
register-rate: <value of integer>
rfc2543-branch: <value in [disable, enable]>
rtp: <value in [disable, enable]>
ssl-algorithm: <value in [high, medium, low]>
ssl-auth-client: <value of string>
ssl-auth-server: <value of string>
ssl-client-certificate: <value of string>
ssl-client-renegotiation: <value in [allow, deny, secure]>
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 [off, full]>
ssl-pfs: <value in [require, deny, allow]>
ssl-send-empty-frags: <value in [disable, enable]>
ssl-server-certificate: <value of string>
status: <value in [disable, enable]>
strict-register: <value in [disable, enable]>
subscribe-rate: <value of integer>
unknown-header: <value in [pass, discard, respond]>
update-rate: <value of integer>
ack-rate-track: <value in [none, src-ip, dest-ip]>
bye-rate-track: <value in [none, src-ip, dest-ip]>
cancel-rate-track: <value in [none, src-ip, dest-ip]>
info-rate-track: <value in [none, src-ip, dest-ip]>
invite-rate-track: <value in [none, src-ip, dest-ip]>
malformed-header-no-proxy-require: <value in [pass, discard, respond]>
malformed-header-no-require: <value in [pass, discard, respond]>
message-rate-track: <value in [none, src-ip, dest-ip]>
notify-rate-track: <value in [none, src-ip, dest-ip]>
options-rate-track: <value in [none, src-ip, dest-ip]>
prack-rate-track: <value in [none, src-ip, dest-ip]>
publish-rate-track: <value in [none, src-ip, dest-ip]>
refer-rate-track: <value in [none, src-ip, dest-ip]>
register-rate-track: <value in [none, src-ip, dest-ip]>
subscribe-rate-track: <value in [none, src-ip, dest-ip]>
update-rate-track: <value in [none, src-ip, dest-ip]>
feature-set: <value in [flow, proxy]>
```
Return Values
-------------
Common return 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_log_maildomain – FortiMail domain setting. fortinet.fortimanager.fmgr\_system\_log\_maildomain – FortiMail domain setting.
===============================================================================
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_maildomain`.
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\_maildomain** dictionary | | the top level parameters set |
| | **devices** string | **Default:**"All\_FortiMail" | Devices for domain to vdom mapping |
| | **domain** string | | FortiMail domain |
| | **id** integer | **Default:**0 | ID of FortiMail domain. |
| | **vdom** string | | Virtual Domain name mapping to FortiMail domain |
| **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: FortiMail domain setting.
fmgr_system_log_maildomain:
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_log_maildomain:
devices: <value of string>
domain: <value of string>
id: <value of integer>
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)
ansible fortinet.fortimanager.fmgr_fmupdate_webspam_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates. fortinet.fortimanager.fmgr\_fmupdate\_webspam\_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_webspam_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\_webspam\_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_webspam_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_webspam_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_firewall_sslsshprofile_https – Configure HTTPS options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_https – Configure HTTPS 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_sslsshprofile_https`.
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\_sslsshprofile\_https** dictionary | | the top level parameters set |
| | **allow-invalid-server-cert** string | **Choices:*** disable
* enable
| When enabled, allows SSL sessions whose server certificate validation failed. |
| | **cert-probe-failure** string | **Choices:*** block
* allow
| Action based on certificate probe failure. |
| | **cert-validation-failure** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation failure. |
| | **cert-validation-timeout** string | **Choices:*** allow
* block
* ignore
| Action based on certificate validation timeout. |
| | **client-cert-request** string | **Choices:*** bypass
* inspect
* block
| Action based on client certificate request. |
| | **client-certificate** string | **Choices:*** bypass
* inspect
* block
| Action based on received client certificate. |
| | **expired-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is expired. |
| | **invalid-server-cert** string | **Choices:*** allow
* block
| Allow or block the invalid SSL session server certificate. |
| | **ports** integer | | no description |
| | **proxy-after-tcp-handshake** string | **Choices:*** disable
* enable
| Proxy traffic after the TCP 3-way handshake has been established (not before). |
| | **revoked-server-cert** string | **Choices:*** allow
* block
* ignore
| Action based on server certificate is revoked. |
| | **sni-server-cert-check** string | **Choices:*** disable
* enable
* strict
| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. |
| | **status** string | **Choices:*** disable
* certificate-inspection
* deep-inspection
| Configure protocol inspection status. |
| | **unsupported-ssl** string | **Choices:*** bypass
* inspect
* block
| Action based on the SSL encryption used being unsupported. |
| | **unsupported-ssl-cipher** string | **Choices:*** allow
* block
| Action based on the SSL cipher used being unsupported. |
| | **unsupported-ssl-negotiation** string | **Choices:*** allow
* block
| Action based on the SSL negotiation used being unsupported. |
| | **untrusted-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| | **untrusted-server-cert** string | **Choices:*** allow
* block
* ignore
| Allow, ignore, or block the untrusted SSL session server certificate. |
| **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 |
| **ssl-ssh-profile** string / required | | the parameter (ssl-ssh-profile) in requested url |
| **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 HTTPS options.
fmgr_firewall_sslsshprofile_https:
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>
ssl-ssh-profile: <your own value>
firewall_sslsshprofile_https:
allow-invalid-server-cert: <value in [disable, enable]>
client-cert-request: <value in [bypass, inspect, block]>
ports: <value of integer>
status: <value in [disable, certificate-inspection, deep-inspection]>
unsupported-ssl: <value in [bypass, inspect, block]>
untrusted-cert: <value in [allow, block, ignore]>
invalid-server-cert: <value in [allow, block]>
sni-server-cert-check: <value in [disable, enable, strict]>
untrusted-server-cert: <value in [allow, block, ignore]>
cert-validation-failure: <value in [allow, block, ignore]>
cert-validation-timeout: <value in [allow, block, ignore]>
client-certificate: <value in [bypass, inspect, block]>
expired-server-cert: <value in [allow, block, ignore]>
proxy-after-tcp-handshake: <value in [disable, enable]>
revoked-server-cert: <value in [allow, block, ignore]>
unsupported-ssl-cipher: <value in [allow, block]>
unsupported-ssl-negotiation: <value in [allow, block]>
cert-probe-failure: <value in [block, 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 |
| --- | --- | --- |
| **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_filefilter_profile_rules – File filter rules. fortinet.fortimanager.fmgr\_filefilter\_profile\_rules – File filter 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_filefilter_profile_rules`.
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 |
| **filefilter\_profile\_rules** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** log-only
* block
| Action taken for matched file. |
| | **comment** string | | Comment. |
| | **direction** string | **Choices:*** any
* incoming
* outgoing
| Traffic direction. (HTTP, FTP, SSH, CIFS only) |
| | **file-type** string | | no description |
| | **name** string | | File-filter rule name. |
| | **password-protected** string | **Choices:*** any
* yes
| Match password-protected files. |
| | **protocol** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* mapi
* cifs
* ssh
| no description |
| **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: File filter rules.
fmgr_filefilter_profile_rules:
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]>
filefilter_profile_rules:
action: <value in [log-only, block]>
comment: <value of string>
direction: <value in [any, incoming, outgoing]>
file-type: <value of string>
name: <value of string>
password-protected: <value in [any, yes]>
protocol:
- imap
- smtp
- pop3
- http
- ftp
- mapi
- cifs
- ssh
```
Return Values
-------------
Common return 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_dynamic_virtualwanlink_server – no description fortinet.fortimanager.fmgr\_dynamic\_virtualwanlink\_server – 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_dynamic_virtualwanlink_server`.
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 |
| **dynamic\_virtualwanlink\_server** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **server** string | | no description |
| | **name** string | | no description |
| | **server** string | | no description |
| **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: no description
fmgr_dynamic_virtualwanlink_server:
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]>
dynamic_virtualwanlink_server:
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
server: <value of string>
name: <value of string>
server: <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_securityconsole_install_device – no description fortinet.fortimanager.fmgr\_securityconsole\_install\_device – 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_securityconsole_install_device`.
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 |
| **securityconsole\_install\_device** dictionary | | the top level parameters set |
| | **adom** string | | Source ADOM name. |
| | **dev\_rev\_comments** string | | no description |
| | **flags** list / elements=string | **Choices:*** none
* preview
* auto\_lock\_ws
| no description |
| | **scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** 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_securityconsole_install_device:
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, ...]
securityconsole_install_device:
adom: <value of string>
dev_rev_comments: <value of string>
flags:
- none
- preview
- auto_lock_ws
scope:
-
name: <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)
ansible fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip – Configure IP configuration. fortinet.fortimanager.fmgr\_system\_sdnconnector\_nic\_ip – Configure IP 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_sdnconnector_nic_ip`.
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 |
| **nic** string / required | | the parameter (nic) 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 |
| **sdn-connector** string / required | | the parameter (sdn-connector) in requested url |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_sdnconnector\_nic\_ip** dictionary | | the top level parameters set |
| | **name** string | | IP configuration name. |
| | **public-ip** string | | Public IP name. |
| | **resource-group** string | | Resource group of Azure public 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: Configure IP configuration.
fmgr_system_sdnconnector_nic_ip:
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>
sdn-connector: <your own value>
nic: <your own value>
state: <value in [present, absent]>
system_sdnconnector_nic_ip:
name: <value of string>
public-ip: <value of string>
resource-group: <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_hotspot20_qosmap – Configure QoS map set. fortinet.fortimanager.fmgr\_hotspot20\_qosmap – Configure QoS map set.
======================================================================
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_qosmap`.
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\_qosmap** dictionary | | the top level parameters set |
| | **dscp-except** list / elements=string | | no description |
| | | **dscp** integer | | DSCP value. |
| | | **index** integer | | DSCP exception index. |
| | | **up** integer | | User priority. |
| | **dscp-range** list / elements=string | | no description |
| | | **high** integer | | DSCP high value. |
| | | **index** integer | | DSCP range index. |
| | | **low** integer | | DSCP low value. |
| | | **up** integer | | User priority. |
| | **name** string | | QOS-MAP 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 QoS map set.
fmgr_hotspot20_qosmap:
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_qosmap:
dscp-except:
-
dscp: <value of integer>
index: <value of integer>
up: <value of integer>
dscp-range:
-
high: <value of integer>
index: <value of integer>
low: <value of integer>
up: <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_fmupdate_fwmsetting – Configure firmware management settings. fortinet.fortimanager.fmgr\_fmupdate\_fwmsetting – Configure firmware management 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_fmupdate_fwmsetting`.
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\_fwmsetting** dictionary | | the top level parameters set |
| | **auto-scan-fgt-disk** string | **Choices:*** disable
* **enable** ←
| auto scan fgt disk if needed. disable - Disable setting. enable - Enable setting. |
| | **check-fgt-disk** string | **Choices:*** disable
* **enable** ←
| check fgt disk before upgrade image. disable - Disable setting. enable - Enable setting. |
| | **fds-failover-fmg** string | **Choices:*** disable
* **enable** ←
| using fmg local image file is download from fds fails. disable - Disable setting. enable - Enable setting. |
| | **fds-image-timeout** integer | **Default:**1800 | timer for fgt download image from fortiguard (300-3600s default=1800) |
| | **immx-source** string | **Choices:*** **fmg** ←
* fgt
* cloud
| Configure which of IMMX file to be used for choosing upgrade pach. Default is file for FortiManager fmg - Use IMMX file for FortiManager fgt - Use IMMX file for FortiGate cloud - Use IMMX file for FortiCloud |
| | **max-fds-retry** integer | **Default:**5 | The retries when fgt download from fds fail (5-20, default=10) |
| | **multiple-steps-interval** integer | **Default:**60 | waiting time between multiple steps upgrade (30-180s, default=60) |
| | **skip-disk-check** string | **Choices:*** **disable** ←
* enable
| skip disk check when upgrade image. 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: Configure firmware management settings.
fmgr_fmupdate_fwmsetting:
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_fwmsetting:
fds-image-timeout: <value of integer>
max-fds-retry: <value of integer>
multiple-steps-interval: <value of integer>
skip-disk-check: <value in [disable, enable]>
auto-scan-fgt-disk: <value in [disable, enable]>
check-fgt-disk: <value in [disable, enable]>
fds-failover-fmg: <value in [disable, enable]>
immx-source: <value in [fmg, fgt, cloud]>
```
Return Values
-------------
Common return 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_videofilter_youtubechannelfilter_entries – YouTube filter entries. fortinet.fortimanager.fmgr\_videofilter\_youtubechannelfilter\_entries – YouTube filter 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_videofilter_youtubechannelfilter_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 |
| **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 |
| **videofilter\_youtubechannelfilter\_entries** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** block
* bypass
* monitor
| YouTube channel filter action. |
| | **channel-id** string | | Channel ID. |
| | **comment** string | | Comment. |
| | **id** integer | | 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 |
| **youtube-channel-filter** string / required | | the parameter (youtube-channel-filter) in requested url |
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: YouTube filter entries.
fmgr_videofilter_youtubechannelfilter_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>
youtube-channel-filter: <your own value>
state: <value in [present, absent]>
videofilter_youtubechannelfilter_entries:
action: <value in [block, bypass, monitor]>
channel-id: <value of string>
comment: <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_gtp_messagefilterv0v1 – Message filter for GTPv0/v1 messages. fortinet.fortimanager.fmgr\_gtp\_messagefilterv0v1 – Message filter for GTPv0/v1 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_gtp_messagefilterv0v1`.
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 |
| **gtp\_messagefilterv0v1** dictionary | | the top level parameters set |
| | **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 | | 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** integer | | no description |
| | **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:*** deny
* allow
| 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). |
| **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: Message filter for GTPv0/v1 messages.
fmgr_gtp_messagefilterv0v1:
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]>
gtp_messagefilterv0v1:
create-mbms: <value in [allow, deny]>
create-pdp: <value in [allow, deny]>
data-record: <value in [allow, deny]>
delete-aa-pdp: <value in [allow, deny]>
delete-mbms: <value in [allow, deny]>
delete-pdp: <value in [allow, deny]>
echo: <value in [allow, deny]>
end-marker: <value in [allow, deny]>
error-indication: <value in [allow, deny]>
failure-report: <value in [allow, deny]>
fwd-relocation: <value in [allow, deny]>
fwd-srns-context: <value in [allow, deny]>
gtp-pdu: <value in [allow, deny]>
identification: <value in [allow, deny]>
mbms-de-registration: <value in [allow, deny]>
mbms-notification: <value in [allow, deny]>
mbms-registration: <value in [allow, deny]>
mbms-session-start: <value in [allow, deny]>
mbms-session-stop: <value in [allow, deny]>
mbms-session-update: <value in [allow, deny]>
ms-info-change-notif: <value in [allow, deny]>
name: <value of string>
node-alive: <value in [allow, deny]>
note-ms-present: <value in [allow, deny]>
pdu-notification: <value in [allow, deny]>
ran-info: <value in [allow, deny]>
redirection: <value in [allow, deny]>
relocation-cancel: <value in [allow, deny]>
send-route: <value in [allow, deny]>
sgsn-context: <value in [allow, deny]>
support-extension: <value in [allow, deny]>
unknown-message: <value in [allow, deny]>
unknown-message-white-list: <value of integer>
update-mbms: <value in [allow, deny]>
update-pdp: <value in [allow, deny]>
v0-create-aa-pdp--v1-init-pdp-ctx: <value in [deny, allow]>
version-not-support: <value in [allow, deny]>
```
Return Values
-------------
Common return 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_logfetch_clientprofile_devicefilter – List of device filter. fortinet.fortimanager.fmgr\_system\_logfetch\_clientprofile\_devicefilter – List of device filter.
==================================================================================================
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_logfetch_clientprofile_devicefilter`.
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 |
| **client-profile** string / required | | the parameter (client-profile) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_logfetch\_clientprofile\_devicefilter** dictionary | | the top level parameters set |
| | **adom** string | **Default:**"\*" | Adom name. |
| | **device** string | **Default:**"\*" | Device name or Serial number. |
| | **id** integer | **Default:**0 | Add or edit a device filter. |
| | **vdom** string | **Default:**"\*" | Vdom filters. |
| **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: List of device filter.
fmgr_system_logfetch_clientprofile_devicefilter:
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, ...]
client-profile: <your own value>
state: <value in [present, absent]>
system_logfetch_clientprofile_devicefilter:
adom: <value of string>
device: <value of string>
id: <value of integer>
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)
ansible fortinet.fortimanager.fmgr_pkg_header_policy – Configure IPv4/IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_header\_policy – Configure IPv4/IPv6 policies.
===============================================================================
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_header_policy`.
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 |
| **pkg** string / required | | the parameter (pkg) in requested url |
| **pkg\_header\_policy** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
* ipsec
* ssl-vpn
| no description |
| | **active-auth-method** string | **Choices:*** ntlm
* basic
* digest
* form
| no description |
| | **anti-replay** string | **Choices:*** disable
* enable
| no description |
| | **app-category** string | | no description |
| | **app-group** string | | no description |
| | **application** integer | | no description |
| | **application-charts** list / elements=string | **Choices:*** top10-app
* top10-p2p-user
* top10-media-user
| no description |
| | **application-list** string | | no description |
| | **auth-cert** string | | no description |
| | **auth-method** string | **Choices:*** basic
* digest
* ntlm
* fsae
* form
* fsso
* rsso
| no description |
| | **auth-path** string | **Choices:*** disable
* enable
| no description |
| | **auth-portal** string | **Choices:*** disable
* enable
| no description |
| | **auth-redirect-addr** string | | no description |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| no description |
| | **av-profile** string | | no description |
| | **bandwidth** string | **Choices:*** disable
* enable
| no description |
| | **best-route** string | **Choices:*** disable
* enable
| no description |
| | **block-notification** string | **Choices:*** disable
* enable
| no description |
| | **captive-portal-exempt** string | **Choices:*** disable
* enable
| no description |
| | **capture-packet** string | **Choices:*** disable
* enable
| no description |
| | **casi-profile** string | | no description |
| | **central-nat** string | **Choices:*** disable
* enable
| no description |
| | **cgn-eif** string | **Choices:*** disable
* enable
| no description |
| | **cgn-eim** string | **Choices:*** disable
* enable
| no description |
| | **cgn-log-server-grp** string | | no description |
| | **cgn-resource-quota** integer | | no description |
| | **cgn-session-quota** integer | | no description |
| | **cifs-profile** string | | no description |
| | **client-reputation** string | **Choices:*** disable
* enable
| no description |
| | **client-reputation-mode** string | **Choices:*** learning
* monitoring
| no description |
| | **comments** string | | no description |
| | **custom-log-fields** string | | no description |
| | **decrypted-traffic-mirror** string | | no description |
| | **deep-inspection-options** string | | no description |
| | **delay-tcp-npu-session** string | **Choices:*** disable
* enable
| no description |
| | **delay-tcp-npu-sessoin** string | **Choices:*** disable
* enable
| no description |
| | **device-detection-portal** string | **Choices:*** disable
* enable
| no description |
| | **devices** string | | no description |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| no description |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| no description |
| | **diffservcode-forward** string | | no description |
| | **diffservcode-rev** string | | no description |
| | **disclaimer** string | **Choices:*** disable
* enable
| no description |
| | **dlp-sensor** string | | no description |
| | **dnsfilter-profile** string | | no description |
| | **dponly** string | **Choices:*** disable
* enable
| no description |
| | **dscp-match** string | **Choices:*** disable
* enable
| no description |
| | **dscp-negate** string | **Choices:*** disable
* enable
| no description |
| | **dscp-value** string | | no description |
| | **dsri** string | **Choices:*** disable
* enable
| no description |
| | **dstaddr** string | | no description |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| no description |
| | **dstaddr6** string | | no description |
| | **dstintf** string | | no description |
| | **dynamic-profile** string | **Choices:*** disable
* enable
| no description |
| | **dynamic-profile-access** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* im
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
* ssh
| no description |
| | **dynamic-profile-fallthrough** string | **Choices:*** disable
* enable
| no description |
| | **dynamic-profile-group** string | | no description |
| | **dynamic-shaping** string | **Choices:*** disable
* enable
| Enable/disable dynamic RADIUS defined traffic shaping. |
| | **email-collect** string | **Choices:*** disable
* enable
| no description |
| | **email-collection-portal** string | **Choices:*** disable
* enable
| no description |
| | **emailfilter-profile** string | | no description |
| | **endpoint-check** string | **Choices:*** disable
* enable
| no description |
| | **endpoint-compliance** string | **Choices:*** disable
* enable
| no description |
| | **endpoint-keepalive-interface** string | | no description |
| | **endpoint-profile** string | | no description |
| | **failed-connection** string | **Choices:*** disable
* enable
| no description |
| | **fall-through-unauthenticated** string | **Choices:*** disable
* enable
| no description |
| | **file-filter-profile** string | | no description |
| | **firewall-session-dirty** string | **Choices:*** check-all
* check-new
| no description |
| | **fixedport** string | **Choices:*** disable
* enable
| no description |
| | **forticlient-compliance-devices** list / elements=string | **Choices:*** windows-pc
* mac
* iphone-ipad
* android
| no description |
| | **forticlient-compliance-enforcement-portal** string | **Choices:*** disable
* enable
| no description |
| | **fsae** string | **Choices:*** disable
* enable
| no description |
| | **fsae-server-for-ntlm** string | | no description |
| | **fsso** string | **Choices:*** disable
* enable
| no description |
| | **fsso-agent-for-ntlm** string | | no description |
| | **fsso-groups** string | | no description |
| | **geo-location** string | **Choices:*** disable
* enable
| no description |
| | **geoip-anycast** string | **Choices:*** disable
* enable
| no description |
| | **geoip-match** string | **Choices:*** physical-location
* registered-location
| no description |
| | **global-label** string | | no description |
| | **groups** string | | no description |
| | **gtp-profile** string | | no description |
| | **http-policy-redirect** string | **Choices:*** disable
* enable
| no description |
| | **icap-profile** string | | no description |
| | **identity-based** string | **Choices:*** disable
* enable
| no description |
| | **identity-based-policy** list / elements=string | | no description |
| | | **action** string | **Choices:*** deny
* accept
| no description |
| | | **application-charts** list / elements=string | **Choices:*** top10-app
* top10-p2p-user
* top10-media-user
| no description |
| | | **application-list** string | | no description |
| | | **av-profile** string | | no description |
| | | **capture-packet** string | **Choices:*** disable
* enable
| no description |
| | | **deep-inspection-options** string | | no description |
| | | **devices** string | | no description |
| | | **dlp-sensor** string | | no description |
| | | **dstaddr** string | | no description |
| | | **dstaddr-negate** string | **Choices:*** disable
* enable
| no description |
| | | **endpoint-compliance** string | **Choices:*** disable
* enable
| no description |
| | | **groups** string | | no description |
| | | **icap-profile** string | | no description |
| | | **id** integer | | no description |
| | | **ips-sensor** string | | no description |
| | | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| no description |
| | | **logtraffic-app** string | **Choices:*** disable
* enable
| no description |
| | | **logtraffic-start** string | **Choices:*** disable
* enable
| no description |
| | | **mms-profile** string | | no description |
| | | **per-ip-shaper** string | | no description |
| | | **profile-group** string | | no description |
| | | **profile-protocol-options** string | | no description |
| | | **profile-type** string | **Choices:*** single
* group
| no description |
| | | **replacemsg-group** string | | no description |
| | | **schedule** string | | no description |
| | | **send-deny-packet** string | **Choices:*** disable
* enable
| no description |
| | | **service** string | | no description |
| | | **service-negate** string | **Choices:*** disable
* enable
| no description |
| | | **spamfilter-profile** string | | no description |
| | | **sslvpn-portal** string | | no description |
| | | **sslvpn-realm** string | | no description |
| | | **traffic-shaper** string | | no description |
| | | **traffic-shaper-reverse** string | | no description |
| | | **users** string | | no description |
| | | **utm-status** string | **Choices:*** disable
* enable
| no description |
| | | **voip-profile** string | | no description |
| | | **webfilter-profile** string | | no description |
| | **identity-based-route** string | | no description |
| | **identity-from** string | **Choices:*** auth
* device
| no description |
| | **inbound** string | **Choices:*** disable
* enable
| no description |
| | **inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | **internet-service** string | **Choices:*** disable
* enable
| no description |
| | **internet-service-custom** string | | no description |
| | **internet-service-custom-group** string | | no description |
| | **internet-service-group** string | | no description |
| | **internet-service-id** string | | no description |
| | **internet-service-name** string | | no description |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| no description |
| | **internet-service-src** string | **Choices:*** disable
* enable
| no description |
| | **internet-service-src-custom** string | | no description |
| | **internet-service-src-custom-group** string | | no description |
| | **internet-service-src-group** string | | no description |
| | **internet-service-src-id** string | | no description |
| | **internet-service-src-name** string | | no description |
| | **internet-service-src-negate** string | **Choices:*** disable
* enable
| no description |
| | **ip-based** string | **Choices:*** disable
* enable
| no description |
| | **ippool** string | **Choices:*** disable
* enable
| no description |
| | **ips-sensor** string | | no description |
| | **label** string | | no description |
| | **learning-mode** string | **Choices:*** disable
* enable
| no description |
| | **log-unmatched-traffic** string | **Choices:*** disable
* enable
| no description |
| | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| no description |
| | **logtraffic-app** string | **Choices:*** disable
* enable
| no description |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| no description |
| | **match-vip** string | **Choices:*** disable
* enable
| no description |
| | **match-vip-only** string | **Choices:*** disable
* enable
| no description |
| | **mms-profile** string | | no description |
| | **name** string | | no description |
| | **nat** string | **Choices:*** disable
* enable
| no description |
| | **natinbound** string | **Choices:*** disable
* enable
| no description |
| | **natip** string | | no description |
| | **natoutbound** string | **Choices:*** disable
* enable
| no description |
| | **np-acceleration** string | **Choices:*** disable
* enable
| no description |
| | **ntlm** string | **Choices:*** disable
* enable
| no description |
| | **ntlm-enabled-browsers** string | | no description |
| | **ntlm-guest** string | **Choices:*** disable
* enable
| no description |
| | **outbound** string | **Choices:*** disable
* enable
| no description |
| | **passive-wan-health-measurement** string | **Choices:*** disable
* enable
| Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. |
| | **per-ip-shaper** string | | no description |
| | **permit-any-host** string | **Choices:*** disable
* enable
| no description |
| | **permit-stun-host** string | **Choices:*** disable
* enable
| no description |
| | **policy-offload** string | **Choices:*** disable
* enable
| no description |
| | **policyid** integer | | no description |
| | **poolname** string | | no description |
| | **poolname6** string | | no description |
| | **profile-group** string | | no description |
| | **profile-protocol-options** string | | no description |
| | **profile-type** string | **Choices:*** single
* group
| no description |
| | **radius-mac-auth-bypass** string | **Choices:*** disable
* enable
| no description |
| | **redirect-url** string | | no description |
| | **replacemsg-group** string | | no description |
| | **replacemsg-override-group** string | | no description |
| | **reputation-direction** string | **Choices:*** source
* destination
| no description |
| | **reputation-minimum** integer | | no description |
| | **require-tfa** string | **Choices:*** disable
* enable
| no description |
| | **rsso** string | **Choices:*** disable
* enable
| no description |
| | **rtp-addr** string | | no description |
| | **rtp-nat** string | **Choices:*** disable
* enable
| no description |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| no description |
| | **schedule** string | | no description |
| | **schedule-timeout** string | **Choices:*** disable
* enable
| no description |
| | **send-deny-packet** string | **Choices:*** disable
* enable
| no description |
| | **service** string | | no description |
| | **service-negate** string | **Choices:*** disable
* enable
| no description |
| | **session-ttl** integer | | no description |
| | **sessions** string | **Choices:*** disable
* enable
| no description |
| | **spamfilter-profile** string | | no description |
| | **src-vendor-mac** string | | no description |
| | **srcaddr** string | | no description |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| no description |
| | **srcaddr6** string | | no description |
| | **srcintf** string | | no description |
| | **ssh-filter-profile** string | | no description |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| no description |
| | **ssl-mirror** string | **Choices:*** disable
* enable
| no description |
| | **ssl-mirror-intf** string | | no description |
| | **ssl-ssh-profile** string | | no description |
| | **sslvpn-auth** string | **Choices:*** any
* local
* radius
* ldap
* tacacs+
| no description |
| | **sslvpn-ccert** string | **Choices:*** disable
* enable
| no description |
| | **sslvpn-cipher** string | **Choices:*** any
* high
* medium
| no description |
| | **sso-auth-method** string | **Choices:*** fsso
* rsso
| no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **tags** string | | no description |
| | **tcp-mss-receiver** integer | | no description |
| | **tcp-mss-sender** integer | | no description |
| | **tcp-reset** string | **Choices:*** disable
* enable
| no description |
| | **tcp-session-without-syn** string | **Choices:*** all
* data-only
* disable
| no description |
| | **timeout-send-rst** string | **Choices:*** disable
* enable
| no description |
| | **tos** string | | no description |
| | **tos-mask** string | | no description |
| | **tos-negate** string | **Choices:*** disable
* enable
| no description |
| | **traffic-shaper** string | | no description |
| | **traffic-shaper-reverse** string | | no description |
| | **transaction-based** string | **Choices:*** disable
* enable
| no description |
| | **url-category** string | | no description |
| | **users** string | | no description |
| | **utm-inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | **utm-status** string | **Choices:*** disable
* enable
| no description |
| | **uuid** string | | no description |
| | **vendor-mac** string | | no description |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **vlan-cos-fwd** integer | | no description |
| | **vlan-cos-rev** integer | | no description |
| | **vlan-filter** string | | no description |
| | **voip-profile** string | | no description |
| | **vpntunnel** string | | no description |
| | **waf-profile** string | | no description |
| | **wanopt** string | **Choices:*** disable
* enable
| no description |
| | **wanopt-detection** string | **Choices:*** active
* passive
* off
| no description |
| | **wanopt-passive-opt** string | **Choices:*** default
* transparent
* non-transparent
| no description |
| | **wanopt-peer** string | | no description |
| | **wanopt-profile** string | | no description |
| | **wccp** string | **Choices:*** disable
* enable
| no description |
| | **web-auth-cookie** string | **Choices:*** disable
* enable
| no description |
| | **webcache** string | **Choices:*** disable
* enable
| no description |
| | **webcache-https** string | **Choices:*** disable
* ssl-server
* any
* enable
| no description |
| | **webfilter-profile** string | | no description |
| | **webproxy-forward-server** string | | no description |
| | **webproxy-profile** string | | no description |
| | **wsso** string | **Choices:*** disable
* enable
| no description |
| | **ztna-ems-tag** string | | Source ztna-ems-tag names. |
| | **ztna-geo-tag** string | | Source ztna-geo-tag names. |
| | **ztna-status** string | **Choices:*** disable
* enable
| Enable/disable zero trust access. |
| **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/IPv6 policies.
fmgr_pkg_header_policy:
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, ...]
pkg: <your own value>
state: <value in [present, absent]>
pkg_header_policy:
action: <value in [deny, accept, ipsec, ...]>
active-auth-method: <value in [ntlm, basic, digest, ...]>
anti-replay: <value in [disable, enable]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-charts:
- top10-app
- top10-p2p-user
- top10-media-user
application-list: <value of string>
auth-cert: <value of string>
auth-method: <value in [basic, digest, ntlm, ...]>
auth-path: <value in [disable, enable]>
auth-portal: <value in [disable, enable]>
auth-redirect-addr: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
bandwidth: <value in [disable, enable]>
block-notification: <value in [disable, enable]>
captive-portal-exempt: <value in [disable, enable]>
capture-packet: <value in [disable, enable]>
casi-profile: <value of string>
central-nat: <value in [disable, enable]>
cifs-profile: <value of string>
client-reputation: <value in [disable, enable]>
client-reputation-mode: <value in [learning, monitoring]>
comments: <value of string>
custom-log-fields: <value of string>
deep-inspection-options: <value of string>
delay-tcp-npu-session: <value in [disable, enable]>
delay-tcp-npu-sessoin: <value in [disable, enable]>
device-detection-portal: <value in [disable, enable]>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
disclaimer: <value in [disable, enable]>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dponly: <value in [disable, enable]>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstaddr6: <value of string>
dstintf: <value of string>
dynamic-profile: <value in [disable, enable]>
dynamic-profile-access:
- imap
- smtp
- pop3
- http
- ftp
- im
- nntp
- imaps
- smtps
- pop3s
- https
- ftps
- ssh
dynamic-profile-fallthrough: <value in [disable, enable]>
dynamic-profile-group: <value of string>
email-collect: <value in [disable, enable]>
email-collection-portal: <value in [disable, enable]>
emailfilter-profile: <value of string>
endpoint-check: <value in [disable, enable]>
endpoint-compliance: <value in [disable, enable]>
endpoint-keepalive-interface: <value of string>
endpoint-profile: <value of string>
failed-connection: <value in [disable, enable]>
fall-through-unauthenticated: <value in [disable, enable]>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
forticlient-compliance-devices:
- windows-pc
- mac
- iphone-ipad
- android
forticlient-compliance-enforcement-portal: <value in [disable, enable]>
fsae: <value in [disable, enable]>
fsae-server-for-ntlm: <value of string>
fsso: <value in [disable, enable]>
fsso-agent-for-ntlm: <value of string>
geo-location: <value in [disable, enable]>
geoip-anycast: <value in [disable, enable]>
global-label: <value of string>
groups: <value of string>
gtp-profile: <value of string>
http-policy-redirect: <value in [disable, enable]>
icap-profile: <value of string>
identity-based: <value in [disable, enable]>
identity-based-policy:
-
action: <value in [deny, accept]>
application-charts:
- top10-app
- top10-p2p-user
- top10-media-user
application-list: <value of string>
av-profile: <value of string>
capture-packet: <value in [disable, enable]>
deep-inspection-options: <value of string>
devices: <value of string>
dlp-sensor: <value of string>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
endpoint-compliance: <value in [disable, enable]>
groups: <value of string>
icap-profile: <value of string>
id: <value of integer>
ips-sensor: <value of string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-app: <value in [disable, enable]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
per-ip-shaper: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
replacemsg-group: <value of string>
schedule: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
spamfilter-profile: <value of string>
sslvpn-portal: <value of string>
sslvpn-realm: <value of string>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
voip-profile: <value of string>
webfilter-profile: <value of string>
identity-based-route: <value of string>
identity-from: <value in [auth, device]>
inbound: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
internet-service: <value in [disable, enable]>
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>
internet-service-negate: <value in [disable, enable]>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
internet-service-src-negate: <value in [disable, enable]>
ip-based: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
learning-mode: <value in [disable, enable]>
log-unmatched-traffic: <value in [disable, enable]>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-app: <value in [disable, enable]>
logtraffic-start: <value in [disable, enable]>
match-vip: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natip: <value of string>
natoutbound: <value in [disable, enable]>
np-acceleration: <value in [disable, enable]>
ntlm: <value in [disable, enable]>
ntlm-enabled-browsers: <value of string>
ntlm-guest: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
permit-any-host: <value in [disable, enable]>
permit-stun-host: <value in [disable, enable]>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
radius-mac-auth-bypass: <value in [disable, enable]>
redirect-url: <value of string>
replacemsg-group: <value of string>
replacemsg-override-group: <value of string>
reputation-direction: <value in [source, destination]>
reputation-minimum: <value of integer>
require-tfa: <value in [disable, enable]>
rsso: <value in [disable, enable]>
rtp-addr: <value of string>
rtp-nat: <value in [disable, enable]>
scan-botnet-connections: <value in [disable, block, monitor]>
schedule: <value of string>
schedule-timeout: <value in [disable, enable]>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
sessions: <value in [disable, enable]>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
sslvpn-auth: <value in [any, local, radius, ...]>
sslvpn-ccert: <value in [disable, enable]>
sslvpn-cipher: <value in [any, high, medium]>
sso-auth-method: <value in [fsso, rsso]>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-reset: <value in [disable, enable]>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
transaction-based: <value in [disable, enable]>
url-category: <value of string>
users: <value of string>
utm-inspection-mode: <value in [proxy, flow]>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
vlan-filter: <value of string>
voip-profile: <value of string>
vpntunnel: <value of string>
waf-profile: <value of string>
wanopt: <value in [disable, enable]>
wanopt-detection: <value in [active, passive, off]>
wanopt-passive-opt: <value in [default, transparent, non-transparent]>
wanopt-peer: <value of string>
wanopt-profile: <value of string>
wccp: <value in [disable, enable]>
web-auth-cookie: <value in [disable, enable]>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, ssl-server, any, ...]>
webfilter-profile: <value of string>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
wsso: <value in [disable, enable]>
fsso-groups: <value of string>
match-vip-only: <value in [disable, enable]>
best-route: <value in [disable, enable]>
decrypted-traffic-mirror: <value of string>
geoip-match: <value in [physical-location, registered-location]>
internet-service-name: <value of string>
internet-service-src-name: <value of string>
poolname6: <value of string>
src-vendor-mac: <value of string>
vendor-mac: <value of string>
file-filter-profile: <value of string>
cgn-eif: <value in [disable, enable]>
cgn-eim: <value in [disable, enable]>
cgn-log-server-grp: <value of string>
cgn-resource-quota: <value of integer>
cgn-session-quota: <value of integer>
policy-offload: <value in [disable, enable]>
dynamic-shaping: <value in [disable, enable]>
passive-wan-health-measurement: <value in [disable, enable]>
videofilter-profile: <value of string>
ztna-ems-tag: <value of string>
ztna-geo-tag: <value of string>
ztna-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_system_sdnconnector_routetable – Configure Azure route table. fortinet.fortimanager.fmgr\_system\_sdnconnector\_routetable – Configure Azure route table.
===========================================================================================
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_routetable`.
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 |
| **sdn-connector** string / required | | the parameter (sdn-connector) in requested url |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_sdnconnector\_routetable** dictionary | | the top level parameters set |
| | **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. |
| **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 Azure route table.
fmgr_system_sdnconnector_routetable:
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>
sdn-connector: <your own value>
state: <value in [present, absent]>
system_sdnconnector_routetable:
name: <value of string>
route:
-
name: <value of string>
next-hop: <value of string>
resource-group: <value of string>
subscription-id: <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_videofilter_profile_fortiguardcategory_filters – Configure VideoFilter FortiGuard category. fortinet.fortimanager.fmgr\_videofilter\_profile\_fortiguardcategory\_filters – Configure VideoFilter FortiGuard category.
==========================================================================================================================
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_videofilter_profile_fortiguardcategory_filters`.
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 |
| **videofilter\_profile\_fortiguardcategory\_filters** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** block
* bypass
* monitor
| VideoFilter action. |
| | **category-id** integer | | Category ID. |
| | **id** integer | | ID. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| **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 VideoFilter FortiGuard category.
fmgr_videofilter_profile_fortiguardcategory_filters:
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]>
videofilter_profile_fortiguardcategory_filters:
action: <value in [block, bypass, monitor]>
category-id: <value of integer>
id: <value of integer>
log: <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_replacemsgimage – Configure replacement message images. fortinet.fortimanager.fmgr\_system\_replacemsgimage – Configure replacement message images.
===========================================================================================
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_replacemsgimage`.
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\_replacemsgimage** dictionary | | the top level parameters set |
| | **image-base64** string | | Image data. |
| | **image-type** string | **Choices:*** gif
* jpg
* tiff
* png
| Image type. |
| | **name** string | | Image 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 replacement message images.
fmgr_system_replacemsgimage:
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_replacemsgimage:
image-base64: <value of string>
image-type: <value in [gif, jpg, tiff, ...]>
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_carrierendpointbwl – Carrier end point black/white list tables. fortinet.fortimanager.fmgr\_firewall\_carrierendpointbwl – Carrier end point black/white list tables.
=====================================================================================================
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`.
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\_carrierendpointbwl** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **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. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **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 tables.
fmgr_firewall_carrierendpointbwl:
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_carrierendpointbwl:
comment: <value of string>
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]>
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_system_route6 – Routing table configuration. fortinet.fortimanager.fmgr\_system\_route6 – Routing table 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_route6`.
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\_route6** dictionary | | the top level parameters set |
| | **device** string | | Gateway out interface. |
| | **dst** string | **Default:**"::/0" | Destination IP and mask for this route. |
| | **gateway** string | **Default:**"::" | Gateway IP for this route. |
| | **prio** integer | **Default:**0 | Entry number. |
| **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: Routing table configuration.
fmgr_system_route6:
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_route6:
device: <value of string>
dst: <value of string>
gateway: <value of string>
prio: <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_system_docker – Docker host. fortinet.fortimanager.fmgr\_system\_docker – Docker host.
=========================================================
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_docker`.
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\_docker** dictionary | | the top level parameters set |
| | **cpu** integer | **Default:**50 | no description |
| | **default-address-pool\_base** string | **Default:**"172.17.0.0 255.255.0.0" | Set default-address-pool CIDR. |
| | **default-address-pool\_size** integer | **Default:**24 | Set default-address-pool size. |
| | **docker-user-login-max** integer | **Default:**32 | Max login session for docker users. |
| | **fortiauthenticator** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **fortiportal** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **fortisigconverter** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **fortisoar** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **fortiwlm** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **mem** integer | **Default:**50 | Max % RAM usage. |
| | **sdwancontroller** string | **Choices:*** **disable** ←
* enable
| Enable/disable container. disable - Disable setting. enable - Enable setting. |
| | **status** string | **Choices:*** **disable** ←
* enable
* qa
* dev
| Enable and set registry. disable - Disable docker host service. enable - Enable production registry. qa - Enable QA test registry. dev - Enable QA test registry (without signature). |
| **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: Docker host.
fmgr_system_docker:
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_docker:
fortiportal: <value in [disable, enable]>
fortiwlm: <value in [disable, enable]>
sdwancontroller: <value in [disable, enable]>
status: <value in [disable, enable, qa, ...]>
cpu: <value of integer>
default-address-pool_base: <value of string>
default-address-pool_size: <value of integer>
fortiauthenticator: <value in [disable, enable]>
fortisigconverter: <value in [disable, enable]>
mem: <value of integer>
docker-user-login-max: <value of integer>
fortisoar: <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_user_fsso_dynamicmapping – Configure Fortinet Single Sign On fortinet.fortimanager.fmgr\_user\_fsso\_dynamicmapping – Configure Fortinet Single Sign On
==========================================================================================
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_fsso_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 |
| --- | --- | --- |
| **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 |
| **fsso** string / required | | the parameter (fsso) 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\_fsso\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_gui\_meta** string | | no description |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **group-poll-interval** integer | | no description |
| | **interface** string | | no description |
| | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | **ldap-poll** string | **Choices:*** disable
* enable
| no description |
| | **ldap-poll-filter** string | | no description |
| | **ldap-poll-interval** integer | | no description |
| | **ldap-server** string | | no description |
| | **password** string | | no description |
| | **password2** string | | no description |
| | **password3** string | | no description |
| | **password4** string | | no description |
| | **password5** string | | no description |
| | **port** integer | | no description |
| | **port2** integer | | no description |
| | **port3** integer | | no description |
| | **port4** integer | | no description |
| | **port5** integer | | no description |
| | **server** string | | no description |
| | **server2** string | | no description |
| | **server3** string | | no description |
| | **server4** string | | no description |
| | **server5** string | | no description |
| | **source-ip** string | | no description |
| | **source-ip6** string | | no description |
| | **ssl** string | **Choices:*** disable
* enable
| no description |
| | **ssl-trusted-cert** string | | no description |
| | **type** string | **Choices:*** default
* fortiems
* fortinac
* fortiems-cloud
| no description |
| | **user-info-server** 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: Configure Fortinet Single Sign On
fmgr_user_fsso_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>
fsso: <your own value>
state: <value in [present, absent]>
user_fsso_dynamicmapping:
_gui_meta: <value of string>
_scope:
-
name: <value of string>
vdom: <value of string>
ldap-server: <value of string>
password: <value of string>
password2: <value of string>
password3: <value of string>
password4: <value of string>
password5: <value of string>
port: <value of integer>
port2: <value of integer>
port3: <value of integer>
port4: <value of integer>
port5: <value of integer>
server: <value of string>
server2: <value of string>
server3: <value of string>
server4: <value of string>
server5: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
ssl: <value in [disable, enable]>
ssl-trusted-cert: <value of string>
type: <value in [default, fortiems, fortinac, ...]>
user-info-server: <value of string>
ldap-poll: <value in [disable, enable]>
ldap-poll-filter: <value of string>
ldap-poll-interval: <value of integer>
group-poll-interval: <value of integer>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
```
Return Values
-------------
Common return 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_antivirus_profile – Configure AntiVirus profiles. fortinet.fortimanager.fmgr\_antivirus\_profile – Configure AntiVirus 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_antivirus_profile`.
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** dictionary | | the top level parameters set |
| | **analytics-accept-filetype** string | | Only submit files matching this DLP file-pattern to FortiSandbox. |
| | **analytics-bl-filetype** string | | Only submit files matching this DLP file-pattern to FortiSandbox. |
| | **analytics-db** string | **Choices:*** disable
* enable
| Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. |
| | **analytics-ignore-filetype** string | | Do not submit files matching this DLP file-pattern to FortiSandbox. |
| | **analytics-max-upload** integer | | Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes, default = 10). |
| | **analytics-wl-filetype** string | | Do not submit files matching this DLP file-pattern to FortiSandbox. |
| | **av-block-log** string | **Choices:*** disable
* enable
| Enable/disable logging for AntiVirus file blocking. |
| | **av-virus-log** string | **Choices:*** disable
* enable
| Enable/disable AntiVirus logging. |
| | **cifs** dictionary | | no description |
| | | **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. |
| | | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | | **external-blocklist** string | **Choices:*** disable
* monitor
* block
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* quarantine
* avmonitor
| no description |
| | | **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 | | no description |
| | | **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 PDF document actions that submit data to other targets. |
| | | **pdf-act-gotor** string | **Choices:*** disable
* enable
| Enable/disable stripping of PDF document actions that access other PDF documents. |
| | | **pdf-act-java** string | **Choices:*** disable
* enable
| Enable/disable stripping of PDF document actions that execute JavaScript code. |
| | | **pdf-act-launch** string | **Choices:*** disable
* enable
| Enable/disable stripping of PDF document actions that launch other applications. |
| | | **pdf-act-movie** string | **Choices:*** disable
* enable
| Enable/disable stripping of PDF document actions that play a movie. |
| | | **pdf-act-sound** string | **Choices:*** disable
* enable
| Enable/disable stripping of PDF document actions that play a sound. |
| | | **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:*** disable
* enable
| Enable/disable extended logging for antivirus. |
| | **external-blocklist** string | | One or more external malware block lists. |
| | **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:*** proxy
* flow
| Flow/proxy feature set. |
| | **ftgd-analytics** string | **Choices:*** disable
* suspicious
* everything
| Settings to control which files are uploaded to FortiSandbox. |
| | **ftp** dictionary | | no description |
| | | **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. |
| | | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | | **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 Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **http** dictionary | | no description |
| | | **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. |
| | | **external-blocklist** string | **Choices:*** disable
* monitor
* block
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** scan
* file-filter
* quarantine
* avquery
* avmonitor
* strict-file
| no description |
| | | **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. |
| | **imap** dictionary | | no description |
| | | **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 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 | | no description |
| | | **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. |
| | | **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
* quarantine
* avquery
* avmonitor
| no description |
| | | **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. |
| | **mobile-malware-db** string | **Choices:*** disable
* enable
| Enable/disable using the mobile malware signature database. |
| | **nac-quar** dictionary | | no description |
| | | **expiry** string | | Duration of quarantine. |
| | | **infected** string | **Choices:*** none
* quar-src-ip
* quar-interface
| Enable/Disable quarantining infected hosts to the banned user list. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable AntiVirus quarantine logging. |
| | **name** string | | Profile name. |
| | **nntp** dictionary | | no description |
| | | **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. |
| | | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | | **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 Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **outbreak-prevention** dictionary | | no description |
| | | **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 | | no description |
| | | **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 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. |
| | **scan-mode** string | **Choices:*** quick
* full
* legacy
* default
| Choose between full scan mode and quick scan mode. |
| | **smtp** dictionary | | no description |
| | | **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 Virus Outbreak Prevention service. |
| | | **quarantine** string | **Choices:*** disable
* enable
| Enable/disable quarantine for infected files. |
| | **ssh** dictionary | | no description |
| | | **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. |
| | | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | | **external-blocklist** string | **Choices:*** disable
* monitor
* block
| Enable external-blocklist. |
| | | **options** list / elements=string | **Choices:*** avmonitor
* quarantine
* scan
| no description |
| | | **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. |
| **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 |
| **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 AntiVirus profiles.
fmgr_antivirus_profile:
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]>
antivirus_profile:
analytics-bl-filetype: <value of string>
analytics-db: <value in [disable, enable]>
analytics-max-upload: <value of integer>
analytics-wl-filetype: <value of string>
av-block-log: <value in [disable, enable]>
av-virus-log: <value in [disable, enable]>
comment: <value of string>
extended-log: <value in [disable, enable]>
ftgd-analytics: <value in [disable, suspicious, everything]>
inspection-mode: <value in [proxy, flow-based]>
mobile-malware-db: <value in [disable, enable]>
name: <value of string>
replacemsg-group: <value of string>
scan-mode: <value in [quick, full, legacy, ...]>
feature-set: <value in [proxy, flow]>
cifs:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
options:
- scan
- quarantine
- 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]>
content-disarm:
cover-page: <value in [disable, enable]>
detect-only: <value in [disable, enable]>
error-action: <value in [block, log-only, ignore]>
office-action: <value in [disable, enable]>
office-dde: <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]>
ftp:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
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]>
http:
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]>
options:
- scan
- file-filter
- quarantine
- avquery
- avmonitor
- strict-file
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]>
imap:
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]>
mapi:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
executables: <value in [default, virus]>
options:
- scan
- 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]>
nac-quar:
expiry: <value of string>
infected: <value in [none, quar-src-ip, quar-interface]>
log: <value in [disable, enable]>
nntp:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
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]>
outbreak-prevention:
external-blocklist: <value in [disable, enable]>
ftgd-service: <value in [disable, enable]>
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]>
smtp:
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]>
ssh:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
options:
- avmonitor
- quarantine
- scan
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]>
analytics-accept-filetype: <value of string>
analytics-ignore-filetype: <value of string>
ems-threat-feed: <value in [disable, enable]>
external-blocklist: <value of string>
external-blocklist-archive-scan: <value in [disable, enable]>
external-blocklist-enable-all: <value in [disable, enable]>
outbreak-prevention-archive-scan: <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_profileprotocoloptions_cifs_filefilter_entries – File filter entries. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_cifs\_filefilter\_entries – File filter 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_firewall_profileprotocoloptions_cifs_filefilter_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 |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_profileprotocoloptions\_cifs\_filefilter\_entries** dictionary | | the top level parameters set |
| | **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 |
| **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: File filter entries.
fmgr_firewall_profileprotocoloptions_cifs_filefilter_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>
profile-protocol-options: <your own value>
state: <value in [present, absent]>
firewall_profileprotocoloptions_cifs_filefilter_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
```
Return Values
-------------
Common return 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_sniffer – Interface sniffer. fortinet.fortimanager.fmgr\_system\_sniffer – Interface sniffer.
================================================================
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_sniffer`.
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\_sniffer** dictionary | | the top level parameters set |
| | **host** string | | Hosts to filter for in sniffer traffic |
| | **id** integer | **Default:**0 | Sniffer ID. |
| | **interface** string | | Interface. |
| | **ipv6** string | **Choices:*** **disable** ←
* enable
| Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. |
| | **max-packet-count** integer | **Default:**4000 | Maximum packet count (1000000, default = 4000). |
| | **non-ip** string | **Choices:*** **disable** ←
* enable
| Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. |
| | **port** string | | Ports to sniff (Format examples: 10, 100-200). |
| | **protocol** string | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **vlan** string | | List of VLANs to sniff. |
| **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 sniffer.
fmgr_system_sniffer:
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_sniffer:
host: <value of string>
id: <value of integer>
interface: <value of string>
ipv6: <value in [disable, enable]>
max-packet-count: <value of integer>
non-ip: <value in [disable, enable]>
port: <value of string>
protocol: <value of string>
vlan: <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_hotspot20_h2qpwanmetric – Configure WAN metrics. fortinet.fortimanager.fmgr\_hotspot20\_h2qpwanmetric – Configure WAN metrics.
=============================================================================
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_h2qpwanmetric`.
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\_h2qpwanmetric** dictionary | | the top level parameters set |
| | **downlink-load** integer | | Downlink load. |
| | **downlink-speed** integer | | Downlink speed (in kilobits/s). |
| | **link-at-capacity** string | **Choices:*** disable
* enable
| Link at capacity. |
| | **link-status** string | **Choices:*** down
* up
* in-test
| Link status. |
| | **load-measurement-duration** integer | | Load measurement duration (in tenths of a second). |
| | **name** string | | WAN metric name. |
| | **symmetric-wan-link** string | **Choices:*** asymmetric
* symmetric
| WAN link symmetry. |
| | **uplink-load** integer | | Uplink load. |
| | **uplink-speed** integer | | Uplink speed (in kilobits/s). |
| **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 WAN metrics.
fmgr_hotspot20_h2qpwanmetric:
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_h2qpwanmetric:
downlink-load: <value of integer>
downlink-speed: <value of integer>
link-at-capacity: <value in [disable, enable]>
link-status: <value in [down, up, in-test]>
load-measurement-duration: <value of integer>
name: <value of string>
symmetric-wan-link: <value in [asymmetric, symmetric]>
uplink-load: <value of integer>
uplink-speed: <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_firewall_gtp_messageratelimitv2 – Message rate limiting for GTP version 2. fortinet.fortimanager.fmgr\_firewall\_gtp\_messageratelimitv2 – Message rate limiting for GTP version 2.
========================================================================================================
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_messageratelimitv2`.
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\_messageratelimitv2** dictionary | | the top level parameters set |
| | **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. |
| **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: Message rate limiting for GTP version 2.
fmgr_firewall_gtp_messageratelimitv2:
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>
firewall_gtp_messageratelimitv2:
create-session-request: <value of integer>
delete-session-request: <value of integer>
echo-request: <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_firewall_internetservicegroup – Configure group of Internet Service. fortinet.fortimanager.fmgr\_firewall\_internetservicegroup – Configure group of Internet Service.
=================================================================================================
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_internetservicegroup`.
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\_internetservicegroup** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **direction** string | **Choices:*** both
* source
* destination
| How this service may be used (source, destination or both). |
| | **member** string | | Internet Service group member. |
| | **name** string | | Internet Service group 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 group of Internet Service.
fmgr_firewall_internetservicegroup:
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_internetservicegroup:
comment: <value of string>
member: <value of string>
name: <value of string>
direction: <value in [both, source, destination]>
```
Return Values
-------------
Common return 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_locallog_fortianalyzer2_filter – Filter for FortiAnalyzer2 logging. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer2\_filter – Filter for FortiAnalyzer2 logging.
=========================================================================================================
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_locallog_fortianalyzer2_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 |
| --- | --- | --- |
| **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\_locallog\_fortianalyzer2\_filter** dictionary | | the top level parameters set |
| | **aid** string | **Choices:*** disable
* **enable** ←
| Log aid messages. disable - Disable setting. enable - Enable setting. |
| | **devcfg** string | **Choices:*** disable
* **enable** ←
| Log device configuration message. disable - Disable setting. enable - Enable setting. |
| | **devops** string | **Choices:*** disable
* **enable** ←
| Managered devices operations messages. disable - Disable setting. enable - Enable setting. |
| | **diskquota** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer disk quota messages. disable - Disable setting. enable - Enable setting. |
| | **dm** string | **Choices:*** disable
* **enable** ←
| Log deployment manager message. disable - Disable setting. enable - Enable setting. |
| | **docker** string | **Choices:*** disable
* **enable** ←
| Docker application generic messages. disable - Disable setting. enable - Enable setting. |
| | **dvm** string | **Choices:*** disable
* **enable** ←
| Log device manager messages. disable - Disable setting. enable - Enable setting. |
| | **ediscovery** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer ediscovery messages. disable - Disable setting. enable - Enable setting. |
| | **epmgr** string | **Choices:*** disable
* **enable** ←
| Log endpoint manager message. disable - Disable setting. enable - Enable setting. |
| | **event** string | **Choices:*** disable
* **enable** ←
| Log event messages. disable - Disable setting. enable - Enable setting. |
| | **eventmgmt** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer event handler messages. disable - Disable setting. enable - Enable setting. |
| | **faz** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer messages. disable - Disable setting. enable - Enable setting. |
| | **fazha** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer HA messages. disable - Disable setting. enable - Enable setting. |
| | **fazsys** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer system messages. disable - Disable setting. enable - Enable setting. |
| | **fgd** string | **Choices:*** disable
* **enable** ←
| Log FortiGuard service message. disable - Disable setting. enable - Enable setting. |
| | **fgfm** string | **Choices:*** disable
* **enable** ←
| Log FGFM protocol message. disable - Disable setting. enable - Enable setting. |
| | **fips** string | **Choices:*** disable
* **enable** ←
| Whether to log fips messages. disable - Disable setting. enable - Enable setting. |
| | **fmgws** string | **Choices:*** disable
* **enable** ←
| Log web service messages. disable - Disable setting. enable - Enable setting. |
| | **fmlmgr** string | **Choices:*** disable
* **enable** ←
| Log FortiMail manager message. disable - Disable setting. enable - Enable setting. |
| | **fmwmgr** string | **Choices:*** disable
* **enable** ←
| Log firmware manager message. disable - Disable setting. enable - Enable setting. |
| | **fortiview** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer FortiView messages. disable - Disable setting. enable - Enable setting. |
| | **glbcfg** string | **Choices:*** disable
* **enable** ←
| Log global database message. disable - Disable setting. enable - Enable setting. |
| | **ha** string | **Choices:*** disable
* **enable** ←
| Log HA message. disable - Disable setting. enable - Enable setting. |
| | **hcache** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer hcache messages. disable - Disable setting. enable - Enable setting. |
| | **incident** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer incident messages. disable - Disable setting. enable - Enable setting. |
| | **iolog** string | **Choices:*** disable
* **enable** ←
| Log debug IO log message. disable - Disable setting. enable - Enable setting. |
| | **logd** string | **Choices:*** disable
* **enable** ←
| Log the status of log daemon. disable - Disable setting. enable - Enable setting. |
| | **logdb** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log DB messages. disable - Disable setting. enable - Enable setting. |
| | **logdev** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log device messages. disable - Disable setting. enable - Enable setting. |
| | **logfile** string | **Choices:*** enable
* disable
| Log Fortianalyzer log file messages. enable - Enable setting. disable - Disable setting. |
| | **logging** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer logging messages. disable - Disable setting. enable - Enable setting. |
| | **lrmgr** string | **Choices:*** disable
* **enable** ←
| Log log and report manager message. disable - Disable setting. enable - Enable setting. |
| | **objcfg** string | **Choices:*** disable
* **enable** ←
| Log object configuration change message. disable - Disable setting. enable - Enable setting. |
| | **report** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer report messages. disable - Disable setting. enable - Enable setting. |
| | **rev** string | **Choices:*** disable
* **enable** ←
| Log revision history message. disable - Disable setting. enable - Enable setting. |
| | **rtmon** string | **Choices:*** disable
* **enable** ←
| Log real-time monitor message. disable - Disable setting. enable - Enable setting. |
| | **scfw** string | **Choices:*** disable
* **enable** ←
| Log firewall objects message. disable - Disable setting. enable - Enable setting. |
| | **scply** string | **Choices:*** disable
* **enable** ←
| Log policy console message. disable - Disable setting. enable - Enable setting. |
| | **scrmgr** string | **Choices:*** disable
* **enable** ←
| Log script manager message. disable - Disable setting. enable - Enable setting. |
| | **scvpn** string | **Choices:*** disable
* **enable** ←
| Log VPN console message. disable - Disable setting. enable - Enable setting. |
| | **system** string | **Choices:*** disable
* **enable** ←
| Log system manager message. disable - Disable setting. enable - Enable setting. |
| | **webport** string | **Choices:*** disable
* **enable** ←
| Log web portal message. disable - Disable setting. enable - Enable 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: Filter for FortiAnalyzer2 logging.
fmgr_system_locallog_fortianalyzer2_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, ...]
system_locallog_fortianalyzer2_filter:
devcfg: <value in [disable, enable]>
devops: <value in [disable, enable]>
diskquota: <value in [disable, enable]>
dm: <value in [disable, enable]>
dvm: <value in [disable, enable]>
ediscovery: <value in [disable, enable]>
epmgr: <value in [disable, enable]>
event: <value in [disable, enable]>
eventmgmt: <value in [disable, enable]>
faz: <value in [disable, enable]>
fazha: <value in [disable, enable]>
fazsys: <value in [disable, enable]>
fgd: <value in [disable, enable]>
fgfm: <value in [disable, enable]>
fips: <value in [disable, enable]>
fmgws: <value in [disable, enable]>
fmlmgr: <value in [disable, enable]>
fmwmgr: <value in [disable, enable]>
fortiview: <value in [disable, enable]>
glbcfg: <value in [disable, enable]>
ha: <value in [disable, enable]>
hcache: <value in [disable, enable]>
iolog: <value in [disable, enable]>
logd: <value in [disable, enable]>
logdb: <value in [disable, enable]>
logdev: <value in [disable, enable]>
logfile: <value in [enable, disable]>
logging: <value in [disable, enable]>
lrmgr: <value in [disable, enable]>
objcfg: <value in [disable, enable]>
report: <value in [disable, enable]>
rev: <value in [disable, enable]>
rtmon: <value in [disable, enable]>
scfw: <value in [disable, enable]>
scply: <value in [disable, enable]>
scrmgr: <value in [disable, enable]>
scvpn: <value in [disable, enable]>
system: <value in [disable, enable]>
webport: <value in [disable, enable]>
incident: <value in [disable, enable]>
aid: <value in [disable, enable]>
docker: <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_antivirus_profile_imap – Configure IMAP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_imap – Configure IMAP 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_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 |
| **antivirus\_profile\_imap** 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 IMAP AntiVirus options.
fmgr_antivirus_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>
antivirus_profile_imap:
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_firewall_addrgrp6_dynamicmapping – Configure IPv6 address groups. fortinet.fortimanager.fmgr\_firewall\_addrgrp6\_dynamicmapping – Configure IPv6 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_addrgrp6_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 |
| --- | --- | --- |
| **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\_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 |
| | **color** integer | | no description |
| | **comment** 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 |
| | **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 IPv6 address groups.
fmgr_firewall_addrgrp6_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>
addrgrp6: <your own value>
state: <value in [present, absent]>
firewall_addrgrp6_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
color: <value of integer>
comment: <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>
fabric-object: <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_pkg_firewall_proxypolicy_sectionvalue – Configure proxy policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_proxypolicy\_sectionvalue – Configure proxy policies.
================================================================================================
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_proxypolicy_sectionvalue`.
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\_proxypolicy\_sectionvalue** dictionary | | the top level parameters set |
| | **attr** string | **Choices:*** label
* global-label
| no description |
| | **name** string | | no description |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **proxy-policy** string / required | | the parameter (proxy-policy) 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 |
| **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 proxy policies.
fmgr_pkg_firewall_proxypolicy_sectionvalue:
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>
proxy-policy: <your own value>
state: <value in [present, absent]>
pkg_firewall_proxypolicy_sectionvalue:
attr: <value in [label, global-label]>
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_wanprof_system_virtualwanlink_service_sla – Service level agreement fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_service\_sla – Service level agreement
===================================================================================================
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_sla`.
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 |
| **service** string / required | | the parameter (service) in requested url |
| **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\_sla** dictionary | | the top level parameters set |
| | **health-check** string | | Virtual WAN Link health-check. |
| | **id** integer | | SLA 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: Service level agreement
fmgr_wanprof_system_virtualwanlink_service_sla:
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>
service: <your own value>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_service_sla:
health-check: <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_firewall_address6_list – IP address list. fortinet.fortimanager.fmgr\_firewall\_address6\_list – IP address 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_address6_list`.
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 |
| --- | --- | --- |
| **address6** string / required | | the parameter (address6) 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\_address6\_list** dictionary | | the top level parameters set |
| | **ip** string | | IP. |
| | **net-id** string | | Network ID. |
| | **obj-id** string | | Object 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: IP address list.
fmgr_firewall_address6_list:
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>
address6: <your own value>
state: <value in [present, absent]>
firewall_address6_list:
ip: <value of string>
net-id: <value of string>
obj-id: <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_user_dashboardtabs – Custom dashboard. fortinet.fortimanager.fmgr\_system\_admin\_user\_dashboardtabs – Custom dashboard.
==================================================================================
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_dashboardtabs`.
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\_dashboardtabs** dictionary | | the top level parameters set |
| | **name** string | | Tab name. |
| | **tabid** integer | **Default:**0 | Tab ID. |
| **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: Custom dashboard.
fmgr_system_admin_user_dashboardtabs:
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_dashboardtabs:
name: <value of string>
tabid: <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_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress – Options for the DHCP server to assign IP settings to specific MAC addresses. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_reservedaddress – Options for the DHCP server to assign IP settings to specific MAC 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_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress`.
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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fsp\_vlan\_dynamicmapping\_dhcpserver\_reservedaddress** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** assign
* block
* reserved
| no description |
| | **circuit-id** string | | no description |
| | **circuit-id-type** string | **Choices:*** hex
* string
| no description |
| | **description** string | | no description |
| | **id** integer | | no description |
| | **ip** string | | no description |
| | **mac** string | | no description |
| | **remote-id** string | | no description |
| | **remote-id-type** string | **Choices:*** hex
* string
| no description |
| | **type** string | **Choices:*** mac
* option82
| 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 |
| **vlan** string / required | | the parameter (vlan) 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: Options for the DHCP server to assign IP settings to specific MAC addresses.
fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
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>
vlan: <your own value>
dynamic_mapping: <your own value>
state: <value in [present, absent]>
fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
action: <value in [assign, block, reserved]>
circuit-id: <value of string>
circuit-id-type: <value in [hex, string]>
description: <value of string>
id: <value of integer>
ip: <value of string>
mac: <value of string>
remote-id: <value of string>
remote-id-type: <value in [hex, string]>
type: <value in [mac, option82]>
```
Return Values
-------------
Common return 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_passwordpolicy – Password policy. fortinet.fortimanager.fmgr\_system\_passwordpolicy – Password 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_system_passwordpolicy`.
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\_passwordpolicy** dictionary | | the top level parameters set |
| | **change-4-characters** string | **Choices:*** **disable** ←
* enable
| Enable/disable changing at least 4 characters for new password. disable - Disable changing at least 4 characters for new password. enable - Enable changing at least 4 characters for new password. |
| | **expire** integer | **Default:**0 | Number of days after which admin users password will expire (0 - 3650, 0 = never expire). |
| | **minimum-length** integer | **Default:**8 | Minimum password length. |
| | **must-contain** list / elements=string | **Choices:*** upper-case-letter
* lower-case-letter
* number
* non-alphanumeric
| no description |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable password policy. disable - Disable password policy. enable - Enable password policy. |
| **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: Password policy.
fmgr_system_passwordpolicy:
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_passwordpolicy:
change-4-characters: <value in [disable, enable]>
expire: <value of integer>
minimum-length: <value of integer>
must-contain:
- upper-case-letter
- lower-case-letter
- number
- non-alphanumeric
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_system_snmp_sysinfo – SNMP configuration. fortinet.fortimanager.fmgr\_system\_snmp\_sysinfo – SNMP 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_snmp_sysinfo`.
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\_snmp\_sysinfo** dictionary | | the top level parameters set |
| | **contact\_info** string | | Contact information. |
| | **description** string | | System description. |
| | **engine-id** string | | Local SNMP engineID string (maximum 24 characters). |
| | **location** string | | System location. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable SNMP. disable - Disable setting. enable - Enable setting. |
| | **trap-cpu-high-exclude-nice-threshold** integer | **Default:**80 | SNMP trap for CPU usage threshold (exclude NICE processes). |
| | **trap-high-cpu-threshold** integer | **Default:**80 | SNMP trap for CPU usage threshold. |
| | **trap-low-memory-threshold** integer | **Default:**80 | SNMP trap for memory usage threshold. |
| **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: SNMP configuration.
fmgr_system_snmp_sysinfo:
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_snmp_sysinfo:
contact_info: <value of string>
description: <value of string>
engine-id: <value of string>
location: <value of string>
status: <value in [disable, enable]>
trap-cpu-high-exclude-nice-threshold: <value of integer>
trap-high-cpu-threshold: <value of integer>
trap-low-memory-threshold: <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_simprofile – no description fortinet.fortimanager.fmgr\_extendercontroller\_simprofile – 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_simprofile`.
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\_simprofile** dictionary | | the top level parameters set |
| | **auto-switch\_profile** dictionary | | no description |
| | | **dataplan** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **disconnect** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **disconnect-period** integer | **Default:**600 | no description |
| | | **disconnect-threshold** integer | **Default:**3 | no description |
| | | **signal** string | **Choices:*** **disable** ←
* enable
| no description |
| | | **status** string | **Choices:*** disable
* **enable** ←
| no description |
| | | **switch-back** list / elements=string | **Choices:*** time
* timer
| no description |
| | | **switch-back-time** string | **Default:**"00:01" | no description |
| | | **switch-back-timer** integer | **Default:**86400 | no description |
| | **conn-status** integer | **Default:**0 | no description |
| | **default-sim** string | **Choices:*** **sim1** ←
* sim2
* carrier
* cost
| no description |
| | **description** string | | no description |
| | **gps** string | **Choices:*** disable
* **enable** ←
| no description |
| | **modem-id** integer | **Default:**0 | no description |
| | **name** string | | no description |
| | **preferred-carrier** string | | no description |
| | **redundant-intf** string | | no description |
| | **redundant-mode** string | **Choices:*** **disable** ←
* enable
| no description |
| | **sim1-pin** string | **Choices:*** **disable** ←
* enable
| no description |
| | **sim1-pin-code** string | | no description |
| | **sim2-pin** string | **Choices:*** **disable** ←
* enable
| no description |
| | **sim2-pin-code** string | | no description |
| | **status** 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: no description
fmgr_extendercontroller_simprofile:
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_simprofile:
auto-switch_profile:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect-period: <value of integer>
disconnect-threshold: <value of integer>
signal: <value in [disable, enable]>
status: <value in [disable, enable]>
switch-back:
- time
- timer
switch-back-time: <value of string>
switch-back-timer: <value of integer>
conn-status: <value of integer>
default-sim: <value in [sim1, sim2, carrier, ...]>
description: <value of string>
gps: <value in [disable, enable]>
modem-id: <value of integer>
name: <value of string>
preferred-carrier: <value of string>
redundant-intf: <value of string>
redundant-mode: <value in [disable, enable]>
sim1-pin: <value in [disable, enable]>
sim1-pin-code: <value of string>
sim2-pin: <value in [disable, enable]>
sim2-pin-code: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dynamic_virtualwanlink_neighbor – no description fortinet.fortimanager.fmgr\_dynamic\_virtualwanlink\_neighbor – 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_dynamic_virtualwanlink_neighbor`.
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 |
| **dynamic\_virtualwanlink\_neighbor** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **description** string | | no description |
| | | **ip** string | | no description |
| | | **role** string | **Choices:*** primary
* secondary
* standalone
| no description |
| | **ip** string | | no description |
| | **name** string | | no description |
| | **role** string | **Choices:*** primary
* secondary
* standalone
| no description |
| **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: no description
fmgr_dynamic_virtualwanlink_neighbor:
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]>
dynamic_virtualwanlink_neighbor:
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
description: <value of string>
ip: <value of string>
role: <value in [primary, secondary, standalone]>
ip: <value of string>
name: <value of string>
role: <value in [primary, secondary, standalone]>
```
Return Values
-------------
Common return 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_nsx – no description fortinet.fortimanager.fmgr\_user\_nsx – 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_user_nsx`.
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\_nsx** dictionary | | the top level parameters set |
| | **fmgip** string | | no description |
| | **fmgpasswd** string | | no description |
| | **fmguser** string | | no description |
| | **name** string | | no description |
| | **password** string | | no description |
| | **server** string | | no description |
| | **service-id** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **user** 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_user_nsx:
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_nsx:
fmgip: <value of string>
fmguser: <value of string>
name: <value of string>
password: <value of string>
server: <value of string>
status: <value in [disable, enable]>
user: <value of string>
fmgpasswd: <value of string>
service-id: <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_locallog_syslogd3_filter – Filter for syslog logging. fortinet.fortimanager.fmgr\_system\_locallog\_syslogd3\_filter – Filter for syslog logging.
===========================================================================================
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_locallog_syslogd3_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 |
| --- | --- | --- |
| **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\_locallog\_syslogd3\_filter** dictionary | | the top level parameters set |
| | **aid** string | **Choices:*** disable
* **enable** ←
| Log aid messages. disable - Disable setting. enable - Enable setting. |
| | **devcfg** string | **Choices:*** disable
* **enable** ←
| Log device configuration message. disable - Disable setting. enable - Enable setting. |
| | **devops** string | **Choices:*** disable
* **enable** ←
| Managered devices operations messages. disable - Disable setting. enable - Enable setting. |
| | **diskquota** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer disk quota messages. disable - Disable setting. enable - Enable setting. |
| | **dm** string | **Choices:*** disable
* **enable** ←
| Log deployment manager message. disable - Disable setting. enable - Enable setting. |
| | **docker** string | **Choices:*** disable
* **enable** ←
| Docker application generic messages. disable - Disable setting. enable - Enable setting. |
| | **dvm** string | **Choices:*** disable
* **enable** ←
| Log device manager messages. disable - Disable setting. enable - Enable setting. |
| | **ediscovery** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer ediscovery messages. disable - Disable setting. enable - Enable setting. |
| | **epmgr** string | **Choices:*** disable
* **enable** ←
| Log endpoint manager message. disable - Disable setting. enable - Enable setting. |
| | **event** string | **Choices:*** disable
* **enable** ←
| Log event messages. disable - Disable setting. enable - Enable setting. |
| | **eventmgmt** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer event handler messages. disable - Disable setting. enable - Enable setting. |
| | **faz** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer messages. disable - Disable setting. enable - Enable setting. |
| | **fazha** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer HA messages. disable - Disable setting. enable - Enable setting. |
| | **fazsys** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer system messages. disable - Disable setting. enable - Enable setting. |
| | **fgd** string | **Choices:*** disable
* **enable** ←
| Log FortiGuard service message. disable - Disable setting. enable - Enable setting. |
| | **fgfm** string | **Choices:*** disable
* **enable** ←
| Log FGFM protocol message. disable - Disable setting. enable - Enable setting. |
| | **fips** string | **Choices:*** disable
* **enable** ←
| Whether to log fips messages. disable - Disable setting. enable - Enable setting. |
| | **fmgws** string | **Choices:*** disable
* **enable** ←
| Log web service messages. disable - Disable setting. enable - Enable setting. |
| | **fmlmgr** string | **Choices:*** disable
* **enable** ←
| Log FortiMail manager message. disable - Disable setting. enable - Enable setting. |
| | **fmwmgr** string | **Choices:*** disable
* **enable** ←
| Log firmware manager message. disable - Disable setting. enable - Enable setting. |
| | **fortiview** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer FortiView messages. disable - Disable setting. enable - Enable setting. |
| | **glbcfg** string | **Choices:*** disable
* **enable** ←
| Log global database message. disable - Disable setting. enable - Enable setting. |
| | **ha** string | **Choices:*** disable
* **enable** ←
| Log HA message. disable - Disable setting. enable - Enable setting. |
| | **hcache** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer hcache messages. disable - Disable setting. enable - Enable setting. |
| | **incident** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer incident messages. disable - Disable setting. enable - Enable setting. |
| | **iolog** string | **Choices:*** disable
* **enable** ←
| Log debug IO log message. disable - Disable setting. enable - Enable setting. |
| | **logd** string | **Choices:*** disable
* **enable** ←
| Log the status of log daemon. disable - Disable setting. enable - Enable setting. |
| | **logdb** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log DB messages. disable - Disable setting. enable - Enable setting. |
| | **logdev** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log device messages. disable - Disable setting. enable - Enable setting. |
| | **logfile** string | **Choices:*** enable
* disable
| Log Fortianalyzer log file messages. enable - Enable setting. disable - Disable setting. |
| | **logging** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer logging messages. disable - Disable setting. enable - Enable setting. |
| | **lrmgr** string | **Choices:*** disable
* **enable** ←
| Log log and report manager message. disable - Disable setting. enable - Enable setting. |
| | **objcfg** string | **Choices:*** disable
* **enable** ←
| Log object configuration change message. disable - Disable setting. enable - Enable setting. |
| | **report** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer report messages. disable - Disable setting. enable - Enable setting. |
| | **rev** string | **Choices:*** disable
* **enable** ←
| Log revision history message. disable - Disable setting. enable - Enable setting. |
| | **rtmon** string | **Choices:*** disable
* **enable** ←
| Log real-time monitor message. disable - Disable setting. enable - Enable setting. |
| | **scfw** string | **Choices:*** disable
* **enable** ←
| Log firewall objects message. disable - Disable setting. enable - Enable setting. |
| | **scply** string | **Choices:*** disable
* **enable** ←
| Log policy console message. disable - Disable setting. enable - Enable setting. |
| | **scrmgr** string | **Choices:*** disable
* **enable** ←
| Log script manager message. disable - Disable setting. enable - Enable setting. |
| | **scvpn** string | **Choices:*** disable
* **enable** ←
| Log VPN console message. disable - Disable setting. enable - Enable setting. |
| | **system** string | **Choices:*** disable
* **enable** ←
| Log system manager message. disable - Disable setting. enable - Enable setting. |
| | **webport** string | **Choices:*** disable
* **enable** ←
| Log web portal message. disable - Disable setting. enable - Enable 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: Filter for syslog logging.
fmgr_system_locallog_syslogd3_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, ...]
system_locallog_syslogd3_filter:
devcfg: <value in [disable, enable]>
devops: <value in [disable, enable]>
diskquota: <value in [disable, enable]>
dm: <value in [disable, enable]>
dvm: <value in [disable, enable]>
ediscovery: <value in [disable, enable]>
epmgr: <value in [disable, enable]>
event: <value in [disable, enable]>
eventmgmt: <value in [disable, enable]>
faz: <value in [disable, enable]>
fazha: <value in [disable, enable]>
fazsys: <value in [disable, enable]>
fgd: <value in [disable, enable]>
fgfm: <value in [disable, enable]>
fips: <value in [disable, enable]>
fmgws: <value in [disable, enable]>
fmlmgr: <value in [disable, enable]>
fmwmgr: <value in [disable, enable]>
fortiview: <value in [disable, enable]>
glbcfg: <value in [disable, enable]>
ha: <value in [disable, enable]>
hcache: <value in [disable, enable]>
iolog: <value in [disable, enable]>
logd: <value in [disable, enable]>
logdb: <value in [disable, enable]>
logdev: <value in [disable, enable]>
logfile: <value in [enable, disable]>
logging: <value in [disable, enable]>
lrmgr: <value in [disable, enable]>
objcfg: <value in [disable, enable]>
report: <value in [disable, enable]>
rev: <value in [disable, enable]>
rtmon: <value in [disable, enable]>
scfw: <value in [disable, enable]>
scply: <value in [disable, enable]>
scrmgr: <value in [disable, enable]>
scvpn: <value in [disable, enable]>
system: <value in [disable, enable]>
webport: <value in [disable, enable]>
incident: <value in [disable, enable]>
aid: <value in [disable, enable]>
docker: <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_dynamic_certificate_local – no description fortinet.fortimanager.fmgr\_dynamic\_certificate\_local – 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_dynamic_certificate_local`.
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 |
| **dynamic\_certificate\_local** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **local-cert** string | | no description |
| | **name** string | | no description |
| **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: no description
fmgr_dynamic_certificate_local:
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]>
dynamic_certificate_local:
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
local-cert: <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_spamfilter_profile_gmail – Gmail. fortinet.fortimanager.fmgr\_spamfilter\_profile\_gmail – Gmail.
===============================================================
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_gmail`.
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\_gmail** dictionary | | the top level parameters set |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| **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: Gmail.
fmgr_spamfilter_profile_gmail:
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_gmail:
log: <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_pkg_central_dnat – no description fortinet.fortimanager.fmgr\_pkg\_central\_dnat – 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_central_dnat`.
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\_central\_dnat** dictionary | | the top level parameters set |
| | **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_pkg_central_dnat:
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>
state: <value in [present, absent]>
pkg_central_dnat:
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_dvmdb_workspace_commit – Commit change fortinet.fortimanager.fmgr\_dvmdb\_workspace\_commit – Commit change
====================================================================
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_commit`.
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 |
| **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: Commit change
fmgr_dvmdb_workspace_commit:
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>
```
Return Values
-------------
Common return 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_report_autocache – Report auto-cache settings. fortinet.fortimanager.fmgr\_system\_report\_autocache – Report auto-cache 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_report_autocache`.
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\_report\_autocache** dictionary | | the top level parameters set |
| | **aggressive-schedule** string | **Choices:*** **disable** ←
* enable
| Enable/disable auto-cache on schedule reports aggressively. disable - Disable the aggressive schedule auto-cache. enable - Enable the aggressive schedule auto-cache. |
| | **order** string | **Choices:*** **oldest-first** ←
| The order of which SQL log table is processed first. oldest-first - The oldest SQL log table is processed first. |
| | **status** string | **Choices:*** disable
* **enable** ←
| Enable/disable sql report auto cache. disable - Disable the sql report auto-cache. enable - Enable the sql report auto-cache. |
| **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: Report auto-cache settings.
fmgr_system_report_autocache:
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_report_autocache:
aggressive-schedule: <value in [disable, enable]>
order: <value in [oldest-first]>
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_user_radius_dynamicmapping_accountingserver – Additional accounting servers. fortinet.fortimanager.fmgr\_user\_radius\_dynamicmapping\_accountingserver – Additional accounting servers.
===========================================================================================================
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_radius_dynamicmapping_accountingserver`.
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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) 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 |
| **radius** string / required | | the parameter (radius) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **user\_radius\_dynamicmapping\_accountingserver** dictionary | | the top level parameters set |
| | **id** integer | | no description |
| | **interface** string | | no description |
| | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | **port** integer | | no description |
| | **secret** string | | no description |
| | **server** string | | no description |
| | **source-ip** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| 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: Additional accounting servers.
fmgr_user_radius_dynamicmapping_accountingserver:
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>
radius: <your own value>
dynamic_mapping: <your own value>
state: <value in [present, absent]>
user_radius_dynamicmapping_accountingserver:
id: <value of integer>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
port: <value of integer>
secret: <value of string>
server: <value of string>
source-ip: <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_pm_pkg – no description fortinet.fortimanager.fmgr\_pm\_pkg – 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_pm_pkg`.
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\_path** string / required | | the parameter (pkg\_path) in requested url |
| **pm\_pkg** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **obj ver** integer | | no description |
| | **oid** integer | | no description |
| | **package setting** dictionary | | no description |
| | | **central-nat** string | **Choices:*** disable
* enable
| no description |
| | | **consolidated-firewall-mode** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy6-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | | **ngfw-mode** string | **Choices:*** profile-based
* policy-based
| no description |
| | | **ssl-ssh-profile** string | | no description |
| | **scope member** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **type** string | **Choices:*** pkg
* folder
| 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_pm_pkg:
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_path: <your own value>
state: <value in [present, absent]>
pm_pkg:
name: <value of string>
obj ver: <value of integer>
oid: <value of integer>
package setting:
central-nat: <value in [disable, enable]>
consolidated-firewall-mode: <value in [disable, enable]>
fwpolicy-implicit-log: <value in [disable, enable]>
fwpolicy6-implicit-log: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
ngfw-mode: <value in [profile-based, policy-based]>
ssl-ssh-profile: <value of string>
scope member:
-
name: <value of string>
vdom: <value of string>
type: <value in [pkg, folder]>
```
Return Values
-------------
Common return 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 – Configure redundant internet connections using SD-WAN fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan – Configure redundant internet connections using 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`.
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** dictionary | | the top level parameters set |
| | **duplication** list / elements=string | | no description |
| | | **dstaddr** string | | Destination address or address group names. |
| | | **dstaddr6** string | | Destination address6 or address6 group names. |
| | | **dstintf** string | | Outgoing (egress) interfaces or zones. |
| | | **id** integer | | Duplication rule ID (1 - 255). |
| | | **packet-de-duplication** string | **Choices:*** disable
* enable
| Enable/disable discarding of packets that have been duplicated. |
| | | **packet-duplication** string | **Choices:*** disable
* force
* on-demand
| Configure packet duplication method. |
| | | **service** string | | Service and service group name. |
| | | **service-id** string | | SD-WAN service rule ID list. |
| | | **srcaddr** string | | Source address or address group names. |
| | | **srcaddr6** string | | Source address6 or address6 group names. |
| | | **srcintf** string | | Incoming (ingress) interfaces or zones. |
| | **duplication-max-num** integer | | Maximum number of interface members a packet is duplicated in the SD-WAN zone (2 - 4, default = 2; if set to 3, the original p... |
| | **fail-detect** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN Internet connection status checking (failure detection). |
| | **health-check** list / elements=string | | no description |
| | | **\_dynamic-server** string | | no description |
| | | **addr-mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | | **detect-mode** string | **Choices:*** active
* passive
* prefer-passive
| The mode determining how to detect the server. |
| | | **diffservcode** string | | Differentiated services code point (DSCP) in the IP header of the probe packet. |
| | | **dns-match-ip** string | | Response IP expected from DNS server if the protocol is DNS. |
| | | **dns-request-domain** string | | Fully qualified domain name to resolve for the DNS probe. |
| | | **failtime** integer | | Number of failures before server is considered lost (1 - 3600, default = 5). |
| | | **ftp-file** string | | Full path and file name on the FTP server to download for FTP health-check to probe. |
| | | **ftp-mode** string | **Choices:*** passive
* port
| FTP mode. |
| | | **ha-priority** integer | | HA election priority (1 - 50). |
| | | **http-agent** string | | String in the http-agent field in the HTTP header. |
| | | **http-get** string | | URL used to communicate with the server if the protocol if the protocol is HTTP. |
| | | **http-match** string | | Response string expected from the server if the protocol is HTTP. |
| | | **interval** integer | | Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600\*1000 msec, ... |
| | | **members** string | | Member sequence number list. |
| | | **name** string | | Status check or health check name. |
| | | **packet-size** integer | | Packet size of a twamp test session, |
| | | **password** string | | no description |
| | | **port** integer | | Port number used to communicate with the server over the selected protocol (0-65535, default = 0, auto select. http, t... |
| | | **probe-count** integer | | Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). |
| | | **probe-packets** string | **Choices:*** disable
* enable
| Enable/disable transmission of probe packets. |
| | | **probe-timeout** integer | | Time to wait before a probe packet is considered lost (500 - 3600\*1000 msec, default = 500). |
| | | **protocol** string | **Choices:*** ping
* tcp-echo
* udp-echo
* http
* twamp
* ping6
* dns
* tcp-connect
* ftp
| Protocol used to determine if the FortiGate can communicate with the server. |
| | | **quality-measured-method** string | **Choices:*** half-close
* half-open
| Method to measure the quality of tcp-connect. |
| | | **recoverytime** integer | | Number of successful responses received before server is considered recovered (1 - 3600, default = 5). |
| | | **security-mode** string | **Choices:*** none
* authentication
| Twamp controller security mode. |
| | | **server** string | | no description |
| | | **sla** list / elements=string | | no description |
| | | | **id** integer | | SLA ID. |
| | | | **jitter-threshold** integer | | Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | | | **latency-threshold** integer | | Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | | | **link-cost-factor** list / elements=string | **Choices:*** latency
* jitter
* packet-loss
| no description |
| | | | **packetloss-threshold** integer | | Packet loss for SLA to make decision in percentage. (0 - 100, default = 0). |
| | | **sla-fail-log-period** integer | | Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0). |
| | | **sla-pass-log-period** integer | | Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0). |
| | | **system-dns** string | **Choices:*** disable
* enable
| Enable/disable system DNS as the probe server. |
| | | **threshold-alert-jitter** integer | | Alert threshold for jitter (ms, default = 0). |
| | | **threshold-alert-latency** integer | | Alert threshold for latency (ms, default = 0). |
| | | **threshold-alert-packetloss** integer | | Alert threshold for packet loss (percentage, default = 0). |
| | | **threshold-warning-jitter** integer | | Warning threshold for jitter (ms, default = 0). |
| | | **threshold-warning-latency** integer | | Warning threshold for latency (ms, default = 0). |
| | | **threshold-warning-packetloss** integer | | Warning threshold for packet loss (percentage, default = 0). |
| | | **update-cascade-interface** string | **Choices:*** disable
* enable
| Enable/disable update cascade interface. |
| | | **update-static-route** string | **Choices:*** disable
* enable
| Enable/disable updating the static route. |
| | | **user** string | | The user name to access probe server. |
| | **load-balance-mode** string | **Choices:*** source-ip-based
* weight-based
* usage-based
* source-dest-ip-based
* measured-volume-based
| Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. |
| | **members** list / elements=string | | no description |
| | | **\_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 interfa... |
| | | **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, n... |
| | | **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, ne... |
| | | **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 wei... |
| | | **zone** string | | Zone name. |
| | **neighbor** list / elements=string | | no description |
| | | **health-check** string | | SD-WAN health-check name. |
| | | **ip** string | | IP/IPv6 address of neighbor. |
| | | **member** string | | Member sequence number. |
| | | **role** string | **Choices:*** primary
* secondary
* standalone
| Role of neighbor. |
| | | **sla-id** integer | | SLA ID. |
| | **neighbor-hold-boot-time** integer | | Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. (0 - 100... |
| | **neighbor-hold-down** string | **Choices:*** disable
* enable
| Enable/disable hold switching from the secondary neighbor to the primary neighbor. |
| | **neighbor-hold-down-time** integer | | Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. (0 - ... |
| | **service** list / elements=string | | no description |
| | | **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 =... |
| | | **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. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SD-WAN. |
| | **zone** list / elements=string | | no description |
| | | **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 redundant internet connections using SD-WAN
fmgr_wanprof_system_sdwan:
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>
wanprof_system_sdwan:
duplication:
-
dstaddr: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
id: <value of integer>
packet-de-duplication: <value in [disable, enable]>
packet-duplication: <value in [disable, force, on-demand]>
service: <value of string>
srcaddr: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
service-id: <value of string>
duplication-max-num: <value of integer>
fail-detect: <value in [disable, enable]>
health-check:
-
_dynamic-server: <value of string>
addr-mode: <value in [ipv4, ipv6]>
diffservcode: <value of string>
dns-match-ip: <value of string>
dns-request-domain: <value of string>
failtime: <value of integer>
ftp-file: <value of string>
ftp-mode: <value in [passive, port]>
ha-priority: <value of integer>
http-agent: <value of string>
http-get: <value of string>
http-match: <value of string>
interval: <value of integer>
members: <value of string>
name: <value of string>
packet-size: <value of integer>
password: <value of string>
port: <value of integer>
probe-count: <value of integer>
probe-packets: <value in [disable, enable]>
probe-timeout: <value of integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
quality-measured-method: <value in [half-close, half-open]>
recoverytime: <value of integer>
security-mode: <value in [none, authentication]>
server: <value of string>
sla:
-
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
packetloss-threshold: <value of integer>
sla-fail-log-period: <value of integer>
sla-pass-log-period: <value of integer>
system-dns: <value in [disable, enable]>
threshold-alert-jitter: <value of integer>
threshold-alert-latency: <value of integer>
threshold-alert-packetloss: <value of integer>
threshold-warning-jitter: <value of integer>
threshold-warning-latency: <value of integer>
threshold-warning-packetloss: <value of integer>
update-cascade-interface: <value in [disable, enable]>
update-static-route: <value in [disable, enable]>
user: <value of string>
detect-mode: <value in [active, passive, prefer-passive]>
load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]>
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>
neighbor:
-
health-check: <value of string>
ip: <value of string>
member: <value of string>
role: <value in [primary, secondary, standalone]>
sla-id: <value of integer>
neighbor-hold-boot-time: <value of integer>
neighbor-hold-down: <value in [disable, enable]>
neighbor-hold-down-time: <value of integer>
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]>
status: <value in [disable, enable]>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_system_fortiview_autocache – FortiView auto-cache settings. fortinet.fortimanager.fmgr\_system\_fortiview\_autocache – FortiView auto-cache 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_fortiview_autocache`.
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\_fortiview\_autocache** dictionary | | the top level parameters set |
| | **aggressive-fortiview** string | **Choices:*** **disable** ←
* enable
| Enable/disable auto-cache on fortiview aggressively. disable - Disable the aggressive fortiview auto-cache. enable - Enable the aggressive fortiview auto-cache. |
| | **interval** integer | **Default:**168 | The time interval in hours for fortiview auto-cache. |
| | **status** string | **Choices:*** disable
* **enable** ←
| Enable/disable fortiview auto-cache. disable - Disable the fortiview auto-cache. enable - Enable the fortiview auto-cache. |
| **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: FortiView auto-cache settings.
fmgr_system_fortiview_autocache:
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_fortiview_autocache:
aggressive-fortiview: <value in [disable, enable]>
interval: <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_vip6_dynamicmapping – Configure virtual IP for IPv6. fortinet.fortimanager.fmgr\_firewall\_vip6\_dynamicmapping – Configure virtual IP for IPv6.
===========================================================================================
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_vip6_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 |
| --- | --- | --- |
| **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\_vip6\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_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 |
| | **extip** string | | no description |
| | **extport** string | | 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 |
| | **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 |
| | **protocol** string | **Choices:*** tcp
* udp
* sctp
| no description |
| | **server-type** string | **Choices:*** http
* https
* ssl
* tcp
* udp
* ip
* imaps
* pop3s
* smtps
| no description |
| | **src-filter** string | | no description |
| | **ssl-algorithm** string | **Choices:*** high
* low
* medium
* custom
| no description |
| | **ssl-certificate** string | | 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 |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| no description |
| | **uuid** string | | no description |
| | **weblogic-server** string | **Choices:*** disable
* enable
| no description |
| | **websphere-server** 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 |
| **vip6** string / required | | the parameter (vip6) 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: Configure virtual IP for IPv6.
fmgr_firewall_vip6_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>
vip6: <your own value>
state: <value in [present, absent]>
firewall_vip6_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
extip: <value of string>
extport: <value of string>
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, ...]>
mappedip: <value of string>
mappedport: <value of string>
max-embryonic-connections: <value of integer>
monitor: <value of string>
outlook-web-access: <value in [disable, enable]>
persistence: <value in [none, http-cookie, ssl-session-id]>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp, sctp]>
server-type: <value in [http, https, ssl, ...]>
src-filter: <value of string>
ssl-algorithm: <value in [high, low, medium, ...]>
ssl-certificate: <value of string>
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, 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>
nat-source-vip: <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_vip64_realservers – Real servers. fortinet.fortimanager.fmgr\_firewall\_vip64\_realservers – Real servers.
========================================================================
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_vip64_realservers`.
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\_vip64\_realservers** dictionary | | the top level parameters set |
| | **client-ip** string | | Restrict server to a client IP in this range. |
| | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | **holddown-interval** integer | | Hold down interval. |
| | **id** integer | | Real server ID. |
| | **ip** string | | Mapped server IP. |
| | **max-connections** integer | | Maximum number of connections allowed to server. |
| | **monitor** string | | Health monitors. |
| | **port** integer | | Mapped server port. |
| | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | **weight** integer | | 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 |
| **vip64** string / required | | the parameter (vip64) 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: Real servers.
fmgr_firewall_vip64_realservers:
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>
vip64: <your own value>
state: <value in [present, absent]>
firewall_vip64_realservers:
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
id: <value of integer>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dlp_filepattern_entries – Configure file patterns used by DLP blocking. fortinet.fortimanager.fmgr\_dlp\_filepattern\_entries – Configure file patterns used by DLP blocking.
=====================================================================================================
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_dlp_filepattern_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 |
| **dlp\_filepattern\_entries** dictionary | | the top level parameters set |
| | **file-type** string | **Choices:*** unknown
* ignored
* exe
* elf
* bat
* javascript
* html
* hta
* msoffice
* gzip
* rar
* tar
* lzh
* upx
* zip
* cab
* bzip2
* bzip
* activemime
* mime
* hlp
* arj
* base64
* binhex
* uue
* fsg
* aspack
* msc
* petite
* jpeg
* gif
* tiff
* png
* bmp
* msi
* mpeg
* mov
* mp3
* wma
* wav
* pdf
* avi
* rm
* torrent
* hibun
* 7z
* xz
* msofficex
* mach-o
* dmg
* .net
* xar
* chm
* iso
* crx
* sis
* prc
* class
* jad
* cod
* flac
| Select a file type. |
| | **filter-type** string | **Choices:*** pattern
* type
| Filter by file name pattern or by file type. |
| | **pattern** string | | Add a file name pattern. |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **filepattern** string / required | | the parameter (filepattern) 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 file patterns used by DLP blocking.
fmgr_dlp_filepattern_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>
filepattern: <your own value>
state: <value in [present, absent]>
dlp_filepattern_entries:
file-type: <value in [unknown, ignored, exe, ...]>
filter-type: <value in [pattern, type]>
pattern: <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_shapingpolicy – Configure shaping policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_shapingpolicy – Configure shaping policies.
======================================================================================
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_shapingpolicy`.
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\_shapingpolicy** dictionary | | the top level parameters set |
| | **app-category** string | | IDs of one or more application categories that this shaper applies application control traffic shaping to. |
| | **app-group** string | | One or more application group names. |
| | **application** integer | | no description |
| | **class-id** integer | | Traffic class ID. |
| | **comment** string | | Comments. |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| Enable to change packets DiffServ values to the specified diffservcode-forward value. |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode-forward** string | | Change packets DiffServ to this value. |
| | **diffservcode-rev** string | | Change packets reverse (reply) DiffServ to this value. |
| | **dstaddr** string | | IPv4 destination address and address group names. |
| | **dstaddr6** string | | IPv6 destination address and address group names. |
| | **dstintf** string | | One or more outgoing (egress) interfaces. |
| | **groups** string | | Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. |
| | **id** integer | | Shaping policy ID. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-name** string | | Internet Service ID. |
| | **internet-service-src** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet-service-src-custom** string | | Custom Internet Service source name. |
| | **internet-service-src-custom-group** string | | Custom Internet Service source group name. |
| | **internet-service-src-group** string | | Internet Service source group name. |
| | **internet-service-src-id** string | | Internet Service source ID. |
| | **internet-service-src-name** string | | Internet Service source name. |
| | **ip-version** string | **Choices:*** 4
* 6
| Apply this traffic shaping policy to IPv4 or IPv6 traffic. |
| | **name** string | | Shaping policy name. |
| | **per-ip-shaper** string | | Per-IP traffic shaper to apply with this policy. |
| | **schedule** string | | Schedule name. |
| | **service** string | | Service and service group names. |
| | **srcaddr** string | | IPv4 source address and address group names. |
| | **srcaddr6** string | | IPv6 source address and address group names. |
| | **srcintf** string | | One or more incoming (ingress) interfaces. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this traffic shaping policy. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos-mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos-negate** string | **Choices:*** disable
* enable
| Enable negated TOS match. |
| | **traffic-shaper** string | | Traffic shaper to apply to traffic forwarded by the firewall policy. |
| | **traffic-shaper-reverse** string | | Traffic shaper to apply to response traffic received by the firewall policy. |
| | **url-category** string | | IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. |
| | **users** string | | Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. |
| **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 policies.
fmgr_pkg_firewall_shapingpolicy:
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>
state: <value in [present, absent]>
pkg_firewall_shapingpolicy:
app-category: <value of string>
application: <value of integer>
dstaddr: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
groups: <value of string>
id: <value of integer>
ip-version: <value in [4, 6]>
per-ip-shaper: <value of string>
schedule: <value of string>
service: <value of string>
srcaddr: <value of string>
srcaddr6: <value of string>
status: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
app-group: <value of string>
class-id: <value of integer>
comment: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
internet-service: <value in [disable, enable]>
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>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
name: <value of string>
srcintf: <value of string>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
internet-service-name: <value of string>
internet-service-src-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_trafficclass – Configure names for shaping classes. fortinet.fortimanager.fmgr\_firewall\_trafficclass – Configure names for shaping classes.
=========================================================================================
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_trafficclass`.
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\_trafficclass** dictionary | | the top level parameters set |
| | **class-id** integer | | Class ID to be named. |
| | **class-name** string | | Define the name for this class-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 names for shaping classes.
fmgr_firewall_trafficclass:
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_trafficclass:
class-id: <value of integer>
class-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_wanopt_profile_ftp – Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features. fortinet.fortimanager.fmgr\_wanopt\_profile\_ftp – Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features.
===================================================================================================================================
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_wanopt_profile_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 |
| **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 |
| **wanopt\_profile\_ftp** dictionary | | the top level parameters set |
| | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and ... |
| | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **port** integer | | no description |
| | **prefer-chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for HTTP WAN Optimization. |
| | **protocol-opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | **ssl** string | **Choices:*** disable
* enable
| Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable HTTP WAN Optimization. |
| | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| **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 FTP WAN Optimization and configure FTP WAN Optimization features.
fmgr_wanopt_profile_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>
profile: <your own value>
wanopt_profile_ftp:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
port: <value of integer>
prefer-chunking: <value in [dynamic, fix]>
secure-tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
protocol-opt: <value in [protocol, tcp]>
ssl: <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_pkg_firewall_policy_sectionvalue – Configure IPv4 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy\_sectionvalue – Configure IPv4 policies.
==========================================================================================
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_sectionvalue`.
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\_sectionvalue** dictionary | | the top level parameters set |
| | **attr** string | **Choices:*** label
* global-label
| no description |
| | **name** 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: Configure IPv4 policies.
fmgr_pkg_firewall_policy_sectionvalue:
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_sectionvalue:
attr: <value in [label, global-label]>
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_peer – Configure peer users. fortinet.fortimanager.fmgr\_user\_peer – Configure peer users.
==============================================================
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_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 |
| --- | --- | --- |
| **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\_peer** dictionary | | the top level parameters set |
| | **ca** string | | Name of the CA certificate as returned by the execute vpn certificate ca list command. |
| | **cn** string | | Peer certificate common name. |
| | **cn-type** string | **Choices:*** string
* email
* FQDN
* ipv4
* ipv6
| Peer certificate common name type. |
| | **ldap-mode** string | **Choices:*** password
* principal-name
| Mode for LDAP peer authentication. |
| | **ldap-password** string | | no description |
| | **ldap-server** string | | Name of an LDAP server defined under the user ldap command. Performs client access rights check. |
| | **ldap-username** string | | Username for LDAP server bind. |
| | **mandatory-ca-verify** string | **Choices:*** disable
* enable
| Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certific... |
| | **name** string | | Peer name. |
| | **ocsp-override-server** string | | Online Certificate Status Protocol (OCSP) server for certificate retrieval. |
| | **passwd** string | | no description |
| | **subject** string | | Peer certificate name constraints. |
| | **two-factor** string | **Choices:*** disable
* enable
| Enable/disable two-factor authentication, applying certificate and password-based authentication. |
| **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 peer users.
fmgr_user_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, ...]
adom: <your own value>
state: <value in [present, absent]>
user_peer:
ca: <value of string>
cn: <value of string>
cn-type: <value in [string, email, FQDN, ...]>
ldap-mode: <value in [password, principal-name]>
ldap-password: <value of string>
ldap-server: <value of string>
ldap-username: <value of string>
mandatory-ca-verify: <value in [disable, enable]>
name: <value of string>
ocsp-override-server: <value of string>
passwd: <value of string>
subject: <value of string>
two-factor: <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_dvm_cmd_update_device – Refresh the FGFM connection and system information of a device. fortinet.fortimanager.fmgr\_dvm\_cmd\_update\_device – Refresh the FGFM connection and system information of a device.
======================================================================================================================
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_update_device`.
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\_update\_device** dictionary | | the top level parameters set |
| | **adom** string | | Name or ID of the ADOM where the command is to be executed on. |
| | **device** string | | Name or ID of the target device. |
| | **flags** list / elements=string | **Choices:*** none
* create\_task
* nonblocking
* log\_dev
| 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: Refresh the FGFM connection and system information of a device.
fmgr_dvm_cmd_update_device:
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_update_device:
adom: <value of string>
device: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
```
Return Values
-------------
Common return 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_dns – DNS configuration. fortinet.fortimanager.fmgr\_system\_dns – DNS 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_dns`.
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\_dns** dictionary | | the top level parameters set |
| | **ip6-primary** string | **Default:**"::" | IPv6 primary DNS IP. |
| | **ip6-secondary** string | **Default:**"::" | IPv6 secondary DNS IP. |
| | **primary** string | **Default:**"0.0.0.0" | Primary DNS IP. |
| | **secondary** string | **Default:**"0.0.0.0" | Secondary DNS 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: DNS configuration.
fmgr_system_dns:
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_dns:
ip6-primary: <value of string>
ip6-secondary: <value of string>
primary: <value of string>
secondary: <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_profile_filefilter_entries – File filter entries. fortinet.fortimanager.fmgr\_emailfilter\_profile\_filefilter\_entries – File filter 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_emailfilter_profile_filefilter_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 |
| **emailfilter\_profile\_filefilter\_entries** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** log
* block
| Action taken for matched file. |
| | **comment** string | | Comment. |
| | **encryption** string | **Choices:*** any
* yes
| Match encrypted files or not. |
| | **file-type** string | | no description |
| | **filter** string | | Add a file filter. |
| | **password-protected** string | **Choices:*** any
* yes
| Match password-protected files. |
| | **protocol** list / elements=string | **Choices:*** smtp
* imap
* pop3
| no description |
| **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: File filter entries.
fmgr_emailfilter_profile_filefilter_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>
profile: <your own value>
state: <value in [present, absent]>
emailfilter_profile_filefilter_entries:
action: <value in [log, block]>
comment: <value of string>
encryption: <value in [any, yes]>
file-type: <value of string>
filter: <value of string>
password-protected: <value in [any, yes]>
protocol:
- smtp
- imap
- pop3
```
Return Values
-------------
Common return 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_locallog_syslogd2_setting – Settings for remote syslog server. fortinet.fortimanager.fmgr\_system\_locallog\_syslogd2\_setting – Settings for remote syslog 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_system_locallog_syslogd2_setting`.
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\_locallog\_syslogd2\_setting** dictionary | | the top level parameters set |
| | **csv** string | **Choices:*** **disable** ←
* enable
| CSV format. disable - Disable CSV format. enable - Enable CSV format. |
| | **facility** string | **Choices:*** kernel
* user
* ntp
* audit
* alert
* clock
* mail
* daemon
* auth
* syslog
* lpr
* news
* uucp
* cron
* authpriv
* ftp
* local0
* local1
* local2
* local3
* local4
* local5
* local6
* **local7** ←
| Remote syslog facility. kernel - Kernel messages. user - Random user-level messages. ntp - NTP daemon. audit - Log audit. alert - Log alert. clock - Clock daemon. mail - Mail system. daemon - System daemons. auth - Security/authorization messages. syslog - Messages generated internally by syslog daemon. lpr - Line printer subsystem. news - Network news subsystem. uucp - Network news subsystem. cron - Clock daemon. authpriv - Security/authorization messages (private). ftp - FTP daemon. local0 - Reserved for local use. local1 - Reserved for local use. local2 - Reserved for local use. local3 - Reserved for local use. local4 - Reserved for local use. local5 - Reserved for local use. local6 - Reserved for local use. local7 - Reserved for local use. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* **notification** ←
* information
* debug
| Least severity level to log. emergency - Emergency level. alert - Alert level. critical - Critical level. error - Error level. warning - Warning level. notification - Notification level. information - Information level. debug - Debug level. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Remote syslog log. disable - Do not log to remote syslog server. enable - Log to remote syslog server. |
| | **syslog-name** string | | Remote syslog server 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: Settings for remote syslog server.
fmgr_system_locallog_syslogd2_setting:
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_locallog_syslogd2_setting:
csv: <value in [disable, enable]>
facility: <value in [kernel, user, ntp, ...]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
syslog-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_shaper_peripshaper – Configure per-IP traffic shaper. fortinet.fortimanager.fmgr\_firewall\_shaper\_peripshaper – Configure per-IP traffic shaper.
============================================================================================
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_shaper_peripshaper`.
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\_shaper\_peripshaper** dictionary | | the top level parameters set |
| | **bandwidth-unit** string | **Choices:*** kbps
* mbps
* gbps
| Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps). |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper. |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper. |
| | **diffservcode-forward** string | | Forward (original) DiffServ setting to be applied to traffic accepted by this shaper. |
| | **diffservcode-rev** string | | Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper. |
| | **max-bandwidth** integer | | Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting. |
| | **max-concurrent-session** integer | | Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **max-concurrent-tcp-session** integer | | Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **max-concurrent-udp-session** integer | | Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit. |
| | **name** string | | Traffic shaper 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 per-IP traffic shaper.
fmgr_firewall_shaper_peripshaper:
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_shaper_peripshaper:
bandwidth-unit: <value in [kbps, mbps, gbps]>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
max-bandwidth: <value of integer>
max-concurrent-session: <value of integer>
name: <value of string>
max-concurrent-tcp-session: <value of integer>
max-concurrent-udp-session: <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_firewall_schedule_group – Schedule group configuration. fortinet.fortimanager.fmgr\_firewall\_schedule\_group – Schedule 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_schedule_group`.
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\_schedule\_group** dictionary | | the top level parameters set |
| | **color** integer | | Color of icon on the GUI. |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **global-object** integer | | Global Object. |
| | **member** string | | Schedules added to the schedule group. |
| | **name** string | | Schedule group 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: Schedule group configuration.
fmgr_firewall_schedule_group:
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_schedule_group:
color: <value of integer>
member: <value of string>
name: <value of string>
global-object: <value of integer>
fabric-object: <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_pm_pkg_adom – no description fortinet.fortimanager.fmgr\_pm\_pkg\_adom – 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_pm_pkg_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 |
| --- | --- | --- |
| **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 |
| **pm\_pkg\_adom** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **obj ver** integer | | no description |
| | **oid** integer | | no description |
| | **package setting** dictionary | | no description |
| | | **central-nat** string | **Choices:*** disable
* enable
| no description |
| | | **consolidated-firewall-mode** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **fwpolicy6-implicit-log** string | **Choices:*** disable
* enable
| no description |
| | | **inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | | **ngfw-mode** string | **Choices:*** profile-based
* policy-based
| no description |
| | | **ssl-ssh-profile** string | | no description |
| | **scope member** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **type** string | **Choices:*** pkg
* folder
| 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_pm_pkg_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, ...]
adom: <your own value>
pm_pkg_adom:
name: <value of string>
obj ver: <value of integer>
oid: <value of integer>
package setting:
central-nat: <value in [disable, enable]>
consolidated-firewall-mode: <value in [disable, enable]>
fwpolicy-implicit-log: <value in [disable, enable]>
fwpolicy6-implicit-log: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
ngfw-mode: <value in [profile-based, policy-based]>
ssl-ssh-profile: <value of string>
scope member:
-
name: <value of string>
vdom: <value of string>
type: <value in [pkg, folder]>
```
Return Values
-------------
Common return 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_device_dynamicmapping – no description fortinet.fortimanager.fmgr\_user\_device\_dynamicmapping – 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_user_device_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 |
| --- | --- | --- |
| **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 |
| **device** string / required | | the parameter (device) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **user\_device\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **avatar** string | | no description |
| | **category** string | **Choices:*** none
* android-device
* blackberry-device
* fortinet-device
* ios-device
* windows-device
* amazon-device
| no description |
| | **comment** string | | no description |
| | **family** string | | no description |
| | **hardware-vendor** string | | no description |
| | **hardware-version** string | | no description |
| | **mac** string | | no description |
| | **master-device** string | | no description |
| | **os** string | | no description |
| | **software-version** string | | no description |
| | **tags** string | | no description |
| | **type** string | **Choices:*** ipad
* iphone
* gaming-console
* blackberry-phone
* blackberry-playbook
* linux-pc
* mac
* windows-pc
* android-phone
* android-tablet
* media-streaming
* windows-phone
* fortinet-device
* ip-phone
* router-nat-device
* other-network-device
* windows-tablet
* printer
* forticam
* fortifone
* unknown
| no description |
| | **user** 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_user_device_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>
device: <your own value>
state: <value in [present, absent]>
user_device_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
avatar: <value of string>
category: <value in [none, android-device, blackberry-device, ...]>
comment: <value of string>
mac: <value of string>
master-device: <value of string>
tags: <value of string>
type: <value in [ipad, iphone, gaming-console, ...]>
user: <value of string>
family: <value of string>
hardware-vendor: <value of string>
hardware-version: <value of string>
os: <value of string>
software-version: <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_fsp_vlan_interface_ipv6_vrrp6 – IPv6 VRRP configuration. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface\_ipv6\_vrrp6 – IPv6 VRRP 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_fsp_vlan_interface_ipv6_vrrp6`.
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 |
| **fsp\_vlan\_interface\_ipv6\_vrrp6** dictionary | | the top level parameters set |
| | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | **adv-interval** integer | | no description |
| | **preempt** string | **Choices:*** disable
* enable
| no description |
| | **priority** integer | | no description |
| | **start-time** integer | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **vrdst6** string | | no description |
| | **vrgrp** integer | | no description |
| | **vrid** integer | | no description |
| | **vrip6** 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 |
| **vlan** string / required | | the parameter (vlan) 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: IPv6 VRRP configuration.
fmgr_fsp_vlan_interface_ipv6_vrrp6:
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>
vlan: <your own value>
state: <value in [present, absent]>
fsp_vlan_interface_ipv6_vrrp6:
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <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_waf_signature – Hidden table for datasource. fortinet.fortimanager.fmgr\_waf\_signature – Hidden table for datasource.
=========================================================================
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_signature`.
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 |
| **waf\_signature** dictionary | | the top level parameters set |
| | **desc** string | | Signature description. |
| | **id** integer | | Signature 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: Hidden table for datasource.
fmgr_waf_signature:
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]>
waf_signature:
desc: <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_webproxy_profile_headers – Configure HTTP forwarded requests headers. fortinet.fortimanager.fmgr\_webproxy\_profile\_headers – Configure HTTP forwarded requests 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_webproxy_profile_headers`.
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 |
| **webproxy\_profile\_headers** dictionary | | the top level parameters set |
| | **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 headers content. |
| | **dstaddr** string | | Destination address and address group names. |
| | **dstaddr6** string | | Destination address and address group names (IPv6). |
| | **id** integer | | HTTP forwarded header id. |
| | **name** string | | HTTP forwarded header name. |
| | **protocol** list / elements=string | **Choices:*** https
* http
| 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: Configure HTTP forwarded requests headers.
fmgr_webproxy_profile_headers:
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]>
webproxy_profile_headers:
action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
content: <value of string>
id: <value of integer>
name: <value of string>
add-option: <value in [append, new-on-not-found, new]>
base64-encoding: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr6: <value of string>
protocol:
- https
- http
```
Return Values
-------------
Common return 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_trafficquota – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_trafficquota – 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_trafficquota`.
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\_trafficquota** 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. |
| **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_trafficquota:
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_trafficquota:
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_system_certificate_remote – Remote certificate. fortinet.fortimanager.fmgr\_system\_certificate\_remote – Remote certificate.
=============================================================================
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_certificate_remote`.
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\_certificate\_remote** dictionary | | the top level parameters set |
| | **cert** string | | no description |
| | **comment** string | | Remote certificate comment. |
| | **name** 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: Remote certificate.
fmgr_system_certificate_remote:
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_certificate_remote:
cert: <value of string>
comment: <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_spamfilter_profile_msnhotmail – MSN Hotmail. fortinet.fortimanager.fmgr\_spamfilter\_profile\_msnhotmail – MSN Hotmail.
==========================================================================
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_msnhotmail`.
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\_msnhotmail** dictionary | | the top level parameters set |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| **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: MSN Hotmail.
fmgr_spamfilter_profile_msnhotmail:
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_msnhotmail:
log: <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_devprof_system_replacemsg_auth – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_auth – 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_auth`.
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\_auth** 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_auth:
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_auth:
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_user_fssopolling_adgrp – LDAP Group Info. fortinet.fortimanager.fmgr\_user\_fssopolling\_adgrp – LDAP Group Info.
=======================================================================
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_fssopolling_adgrp`.
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 |
| **fsso-polling** string / required | | the parameter (fsso-polling) 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\_fssopolling\_adgrp** dictionary | | the top level parameters set |
| | **name** string | | 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: LDAP Group Info.
fmgr_user_fssopolling_adgrp:
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>
fsso-polling: <your own value>
state: <value in [present, absent]>
user_fssopolling_adgrp:
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_profileprotocoloptions_ssh – Configure SFTP and SCP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_ssh – Configure SFTP and SCP 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_ssh`.
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\_ssh** dictionary | | the top level parameters set |
| | **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, default = 10). |
| | **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 uncompression use... |
| | **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). |
| **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: Configure SFTP and SCP protocol options.
fmgr_firewall_profileprotocoloptions_ssh:
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>
firewall_profileprotocoloptions_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)
ansible fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping – Configure IPv4 IP pools. fortinet.fortimanager.fmgr\_firewall\_ippool\_dynamicmapping – Configure IPv4 IP pools.
=======================================================================================
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_ippool_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 |
| --- | --- | --- |
| **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\_ippool\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **arp-intf** string | | no description |
| | **arp-reply** string | **Choices:*** disable
* enable
| no description |
| | **associated-interface** string | | no description |
| | **block-size** integer | | no description |
| | **cgn-block-size** integer | | no description |
| | **cgn-client-endip** string | | no description |
| | **cgn-client-startip** string | | no description |
| | **cgn-fixedalloc** string | **Choices:*** disable
* enable
| no description |
| | **cgn-overload** string | **Choices:*** disable
* enable
| no description |
| | **cgn-port-end** integer | | no description |
| | **cgn-port-start** integer | | no description |
| | **cgn-spa** string | **Choices:*** disable
* enable
| no description |
| | **comments** string | | no description |
| | **endip** string | | no description |
| | **endport** integer | | Final port number (inclusive) in the range for the address pool (Default: 65533). |
| | **num-blocks-per-user** integer | | no description |
| | **pba-timeout** integer | | no description |
| | **permit-any-host** string | **Choices:*** disable
* enable
| no description |
| | **port-per-user** integer | | Number of port for each user (32 to 60416, default = 0, auto). |
| | **source-endip** string | | no description |
| | **source-startip** string | | no description |
| | **startip** string | | no description |
| | **startport** integer | | First port number (inclusive) in the range for the address pool (Default: 5117). |
| | **type** string | **Choices:*** overload
* one-to-one
* fixed-port-range
* port-block-allocation
* cgn-resource-allocation
| no description |
| | **utilization-alarm-clear** integer | | no description |
| | **utilization-alarm-raise** integer | | no description |
| **ippool** string / required | | the parameter (ippool) 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 IPv4 IP pools.
fmgr_firewall_ippool_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>
ippool: <your own value>
state: <value in [present, absent]>
firewall_ippool_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
arp-intf: <value of string>
arp-reply: <value in [disable, enable]>
associated-interface: <value of string>
block-size: <value of integer>
comments: <value of string>
endip: <value of string>
num-blocks-per-user: <value of integer>
pba-timeout: <value of integer>
permit-any-host: <value in [disable, enable]>
source-endip: <value of string>
source-startip: <value of string>
startip: <value of string>
type: <value in [overload, one-to-one, fixed-port-range, ...]>
cgn-block-size: <value of integer>
cgn-client-endip: <value of string>
cgn-client-startip: <value of string>
cgn-fixedalloc: <value in [disable, enable]>
cgn-overload: <value in [disable, enable]>
cgn-port-end: <value of integer>
cgn-port-start: <value of integer>
cgn-spa: <value in [disable, enable]>
utilization-alarm-clear: <value of integer>
utilization-alarm-raise: <value of integer>
endport: <value of integer>
port-per-user: <value of integer>
startport: <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_vap_mpskkey – Pre-shared keys that can be used to connect to this virtual access point. fortinet.fortimanager.fmgr\_vap\_mpskkey – Pre-shared keys that can be used to connect to this virtual access point.
====================================================================================================================
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_vap_mpskkey`.
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 |
| **vap** string / required | | the parameter (vap) in requested url |
| **vap\_mpskkey** dictionary | | the top level parameters set |
| | **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** string | | Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. |
| | **passphrase** 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: Pre-shared keys that can be used to connect to this virtual access point.
fmgr_vap_mpskkey:
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>
vap: <your own value>
state: <value in [present, absent]>
vap_mpskkey:
comment: <value of string>
concurrent-clients: <value of string>
key-name: <value of string>
passphrase: <value of string>
mpsk-schedules: <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_route – Routing table configuration. fortinet.fortimanager.fmgr\_system\_route – Routing table 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_route`.
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\_route** dictionary | | the top level parameters set |
| | **device** string | | Gateway out interface. |
| | **dst** string | **Default:**"0.0.0.0 0.0.0.0" | Destination IP and mask for this route. |
| | **gateway** string | **Default:**"0.0.0.0" | Gateway IP for this route. |
| | **seq\_num** integer | **Default:**0 | Entry number. |
| **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: Routing table configuration.
fmgr_system_route:
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_route:
device: <value of string>
dst: <value of string>
gateway: <value of string>
seq_num: <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_vpnmgr_node_protectedsubnet – no description fortinet.fortimanager.fmgr\_vpnmgr\_node\_protectedsubnet – 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_node_protectedsubnet`.
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 |
| **node** string / required | | the parameter (node) 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 |
| **vpnmgr\_node\_protectedsubnet** dictionary | | the top level parameters set |
| | **addr** string | | no description |
| | **seq** integer | | 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_node_protectedsubnet:
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>
node: <your own value>
state: <value in [present, absent]>
vpnmgr_node_protectedsubnet:
addr: <value of string>
seq: <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_pkg_firewall_policy46 – Configure IPv4 to IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy46 – Configure IPv4 to IPv6 policies.
======================================================================================
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_policy46`.
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\_policy46** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
| Accept or deny traffic matching the policy. |
| | **comments** string | | Comment. |
| | **dstaddr** string | | Destination address objects. |
| | **dstintf** string | | Destination interface name. |
| | **fixedport** string | **Choices:*** disable
* enable
| Enable/disable fixed port for this policy. |
| | **ippool** string | **Choices:*** disable
* enable
| Enable/disable use of IP Pools for source NAT. |
| | **logtraffic** string | **Choices:*** disable
* enable
| Enable/disable traffic logging for this policy. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts and ends. |
| | **name** string | | Policy name. |
| | **per-ip-shaper** string | | Per IP traffic shaper. |
| | **permit-any-host** string | **Choices:*** disable
* enable
| Enable/disable allowing any host. |
| | **policyid** integer | | Policy ID. |
| | **poolname** string | | IP Pool names. |
| | **schedule** string | | Schedule name. |
| | **service** string | | Service name. |
| | **srcaddr** string | | Source address objects. |
| | **srcintf** string | | Source interface name. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this policy. |
| | **tags** string | | Applied object tags. |
| | **tcp-mss-receiver** integer | | TCP Maximum Segment Size value of receiver (0 - 65535, default = 0) |
| | **tcp-mss-sender** integer | | TCP Maximum Segment Size value of sender (0 - 65535, default = 0). |
| | **traffic-shaper** string | | Traffic shaper. |
| | **traffic-shaper-reverse** string | | Reverse traffic shaper. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 to IPv6 policies.
fmgr_pkg_firewall_policy46:
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>
state: <value in [present, absent]>
pkg_firewall_policy46:
action: <value in [deny, accept]>
comments: <value of string>
dstaddr: <value of string>
dstintf: <value of string>
fixedport: <value in [disable, enable]>
logtraffic: <value in [disable, enable]>
per-ip-shaper: <value of string>
permit-any-host: <value in [disable, enable]>
policyid: <value of integer>
schedule: <value of string>
service: <value of string>
srcaddr: <value of string>
srcintf: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
uuid: <value of string>
ippool: <value in [disable, enable]>
logtraffic-start: <value in [disable, enable]>
poolname: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dvmdb_device_vdom – Device VDOM table. fortinet.fortimanager.fmgr\_dvmdb\_device\_vdom – Device VDOM table.
====================================================================
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_device_vdom`.
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 |
| **device** string / required | | the parameter (device) in requested url |
| **dvmdb\_device\_vdom** dictionary | | the top level parameters set |
| | **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 |
| **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: Device VDOM table.
fmgr_dvmdb_device_vdom:
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>
device: <your own value>
state: <value in [present, absent]>
dvmdb_device_vdom:
comments: <value of string>
name: <value of string>
opmode: <value in [nat, transparent]>
rtm_prof_id: <value of integer>
status: <value of string>
vpn_id: <value of integer>
meta fields: <value of dict>
```
Return Values
-------------
Common return 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_geoipoverride_ip6range – Table of IPv6 ranges assigned to country. fortinet.fortimanager.fmgr\_system\_geoipoverride\_ip6range – Table of IPv6 ranges assigned to country.
=======================================================================================================
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_geoipoverride_ip6range`.
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 |
| **geoip-override** string / required | | the parameter (geoip-override) 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\_geoipoverride\_ip6range** dictionary | | the top level parameters set |
| | **end-ip** string | | Ending IP address, inclusive, of the address range (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| | **id** integer | | ID of individual entry in the IPv6 range table. |
| | **start-ip** string | | Starting IP address, inclusive, of the address range (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). |
| **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: Table of IPv6 ranges assigned to country.
fmgr_system_geoipoverride_ip6range:
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>
geoip-override: <your own value>
state: <value in [present, absent]>
system_geoipoverride_ip6range:
end-ip: <value of string>
id: <value of integer>
start-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_system_alertevent_alertdestination – Alert destination. fortinet.fortimanager.fmgr\_system\_alertevent\_alertdestination – Alert destination.
=====================================================================================
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_alertevent_alertdestination`.
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 |
| --- | --- | --- |
| **alert-event** string / required | | the parameter (alert-event) 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\_alertevent\_alertdestination** dictionary | | the top level parameters set |
| | **from** string | | Sender email address to use in alert emails. |
| | **smtp-name** string | | SMTP server name. |
| | **snmp-name** string | | SNMP trap name. |
| | **syslog-name** string | | Syslog server name. |
| | **to** string | | Recipient email address to use in alert emails. |
| | **type** string | **Choices:*** **mail** ←
* snmp
* syslog
| Destination type. mail - Send email alert. snmp - Send SNMP trap. syslog - Send syslog message. |
| **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: Alert destination.
fmgr_system_alertevent_alertdestination:
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, ...]
alert-event: <your own value>
state: <value in [present, absent]>
system_alertevent_alertdestination:
from: <value of string>
smtp-name: <value of string>
snmp-name: <value of string>
syslog-name: <value of string>
to: <value of string>
type: <value in [mail, snmp, syslog]>
```
Return Values
-------------
Common return 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_radius – Configure radius. fortinet.fortimanager.fmgr\_system\_admin\_radius – Configure radius.
=====================================================================
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_radius`.
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\_radius** dictionary | | the top level parameters set |
| | **auth-type** string | **Choices:*** **any** ←
* pap
* chap
* mschap2
| Authentication protocol. any - Use any supported authentication protocol. pap - PAP. chap - CHAP. mschap2 - MSCHAPv2. |
| | **name** string | | Name. |
| | **nas-ip** string | **Default:**"0.0.0.0" | NAS IP address and called station ID. |
| | **port** integer | **Default:**1812 | Server port. |
| | **secondary-secret** string | | no description |
| | **secondary-server** string | | Secondary server name/IP. |
| | **secret** string | | no description |
| | **server** string | | Server name/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: Configure radius.
fmgr_system_admin_radius:
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_admin_radius:
auth-type: <value in [any, pap, chap, ...]>
name: <value of string>
nas-ip: <value of string>
port: <value of integer>
secondary-secret: <value of string>
secondary-server: <value of string>
secret: <value of string>
server: <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_pkg_firewall_securitypolicy_sectionvalue – Configure NGFW IPv4/IPv6 application policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_securitypolicy\_sectionvalue – Configure NGFW IPv4/IPv6 application policies.
========================================================================================================================
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_securitypolicy_sectionvalue`.
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\_securitypolicy\_sectionvalue** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
| Policy action (accept/deny). |
| | **app-category** string | | Application category ID list. |
| | **app-group** string | | Application group names. |
| | **application** integer | | no description |
| | **application-list** string | | Name of an existing Application list. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | Comment. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **dstaddr** string | | Destination IPv4 address name and address group names. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. |
| | **dstaddr4** string | | Destination IPv4 address name and address group names. |
| | **dstaddr6** string | | Destination IPv6 address name and address group names. |
| | **dstintf** string | | Outgoing (egress) interface. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **enforce-default-app-port** string | **Choices:*** disable
* enable
| Enable/disable default application port enforcement for allowed applications. |
| | **file-filter-profile** string | | Name of an existing file-filter profile. |
| | **fsso-groups** string | | Names of FSSO groups. |
| | **global-label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** string | | Names of user groups that can authenticate with this policy. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-name** string | | Internet Service name. |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| When enabled internet-service specifies what the service must NOT be. |
| | **internet-service-src** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet-service-src-custom** string | | Custom Internet Service source name. |
| | **internet-service-src-custom-group** string | | Custom Internet Service source group name. |
| | **internet-service-src-group** string | | Internet Service source group name. |
| | **internet-service-src-id** string | | Internet Service source ID. |
| | **internet-service-src-name** string | | Internet Service source name. |
| | **internet-service-src-negate** string | **Choices:*** disable
* enable
| When enabled internet-service-src specifies what the service must NOT be. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **learning-mode** string | **Choices:*** disable
* enable
| Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be g... |
| | **logtraffic** string | **Choices:*** disable
* all
* utm
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **policyid** integer | | Policy ID. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **schedule** string | | Schedule 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** string | | Service and service group names. |
| | **service-negate** string | **Choices:*** disable
* enable
| When enabled service specifies what the service must NOT be. |
| | **srcaddr** string | | Source IPv4 address name and address group names. |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. |
| | **srcaddr4** string | | Source IPv4 address name and address group names. |
| | **srcaddr6** string | | Source IPv6 address name and address group names. |
| | **srcintf** string | | Incoming (ingress) interface. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| Enable or disable this policy. |
| | **url-category** string | | URL category ID list. |
| | **users** string | | Names of individual users that can authenticate with this policy. |
| | **utm-status** string | **Choices:*** disable
* enable
| Enable security profiles. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **webfilter-profile** string | | Name of an existing Web filter profile. |
| **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 |
| **security-policy** string / required | | the parameter (security-policy) in requested url |
| **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 NGFW IPv4/IPv6 application policies.
fmgr_pkg_firewall_securitypolicy_sectionvalue:
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>
security-policy: <your own value>
state: <value in [present, absent]>
pkg_firewall_securitypolicy_sectionvalue:
action: <value in [deny, accept]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-list: <value of string>
av-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dstaddr4: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
emailfilter-profile: <value of string>
enforce-default-app-port: <value in [disable, enable]>
groups: <value of string>
icap-profile: <value of string>
internet-service: <value in [disable, enable]>
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>
internet-service-negate: <value in [disable, enable]>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
internet-service-src-negate: <value in [disable, enable]>
ips-sensor: <value of string>
logtraffic: <value in [disable, all, utm]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
policyid: <value of integer>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
schedule: <value of string>
service: <value of string>
service-negate: <value in [disable, enable]>
srcaddr4: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
voip-profile: <value of string>
webfilter-profile: <value of string>
fsso-groups: <value of string>
global-label: <value of string>
send-deny-packet: <value in [disable, enable]>
dstaddr: <value of string>
internet-service-name: <value of string>
internet-service-src-name: <value of string>
srcaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
file-filter-profile: <value of string>
srcaddr-negate: <value in [disable, enable]>
learning-mode: <value in [disable, enable]>
videofilter-profile: <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_virtualwanlink_healthcheck – SD-WAN status checking or health checking. fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_healthcheck – SD-WAN status checking or health checking.
=====================================================================================================================
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_healthcheck`.
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\_healthcheck** dictionary | | the top level parameters set |
| | **\_dynamic-server** string | | no description |
| | **addr-mode** string | **Choices:*** ipv4
* ipv6
| Address mode (IPv4 or IPv6). |
| | **diffservcode** string | | Differentiated services code point (DSCP) in the IP header of the probe packet. |
| | **dns-request-domain** string | | Fully qualified domain name to resolve for the DNS probe. |
| | **failtime** integer | | Number of failures before server is considered lost (1 - 3600, default = 5). |
| | **ha-priority** integer | | HA election priority (1 - 50). |
| | **http-agent** string | | String in the http-agent field in the HTTP header. |
| | **http-get** string | | URL used to communicate with the server if the protocol if the protocol is HTTP. |
| | **http-match** string | | Response string expected from the server if the protocol is HTTP. |
| | **internet-service-id** string | | Internet service ID. |
| | **interval** integer | | Status check interval, or the time between attempting to connect to the server (1 - 3600 sec, default = 5). |
| | **members** string | | Member sequence number list. |
| | **name** string | | Status check or health check name. |
| | **packet-size** integer | | Packet size of a twamp test session, |
| | **password** string | | no description |
| | **port** integer | | Port number used to communicate with the server over the selected protocol. |
| | **probe-count** integer | | Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). |
| | **probe-packets** string | **Choices:*** disable
* enable
| Enable/disable transmission of probe packets. |
| | **probe-timeout** integer | | Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500). |
| | **protocol** string | **Choices:*** ping
* tcp-echo
* udp-echo
* http
* twamp
* ping6
* dns
| Protocol used to determine if the FortiGate can communicate with the server. |
| | **recoverytime** integer | | Number of successful responses received before server is considered recovered (1 - 3600, default = 5). |
| | **security-mode** string | **Choices:*** none
* authentication
| Twamp controller security mode. |
| | **server** string | | no description |
| | **sla** list / elements=string | | no description |
| | | **id** integer | | SLA ID. |
| | | **jitter-threshold** integer | | Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | | **latency-threshold** integer | | Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | | **link-cost-factor** list / elements=string | **Choices:*** latency
* jitter
* packet-loss
| no description |
| | | **packetloss-threshold** integer | | Packet loss for SLA to make decision in percentage. (0 - 100, default = 0). |
| | **sla-fail-log-period** integer | | Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0). |
| | **sla-pass-log-period** integer | | Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0). |
| | **system-dns** string | **Choices:*** disable
* enable
| Enable/disable system DNS as the probe server. |
| | **threshold-alert-jitter** integer | | Alert threshold for jitter (ms, default = 0). |
| | **threshold-alert-latency** integer | | Alert threshold for latency (ms, default = 0). |
| | **threshold-alert-packetloss** integer | | Alert threshold for packet loss (percentage, default = 0). |
| | **threshold-warning-jitter** integer | | Warning threshold for jitter (ms, default = 0). |
| | **threshold-warning-latency** integer | | Warning threshold for latency (ms, default = 0). |
| | **threshold-warning-packetloss** integer | | Warning threshold for packet loss (percentage, default = 0). |
| | **update-cascade-interface** string | **Choices:*** disable
* enable
| Enable/disable update cascade interface. |
| | **update-static-route** string | **Choices:*** disable
* enable
| Enable/disable updating the static route. |
| **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: SD-WAN status checking or health checking.
fmgr_wanprof_system_virtualwanlink_healthcheck:
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_healthcheck:
_dynamic-server: <value of string>
addr-mode: <value in [ipv4, ipv6]>
failtime: <value of integer>
http-agent: <value of string>
http-get: <value of string>
http-match: <value of string>
interval: <value of integer>
members: <value of string>
name: <value of string>
packet-size: <value of integer>
password: <value of string>
port: <value of integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
recoverytime: <value of integer>
security-mode: <value in [none, authentication]>
server: <value of string>
sla:
-
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
packetloss-threshold: <value of integer>
threshold-alert-jitter: <value of integer>
threshold-alert-latency: <value of integer>
threshold-alert-packetloss: <value of integer>
threshold-warning-jitter: <value of integer>
threshold-warning-latency: <value of integer>
threshold-warning-packetloss: <value of integer>
update-cascade-interface: <value in [disable, enable]>
update-static-route: <value in [disable, enable]>
internet-service-id: <value of string>
probe-packets: <value in [disable, enable]>
sla-fail-log-period: <value of integer>
sla-pass-log-period: <value of integer>
ha-priority: <value of integer>
diffservcode: <value of string>
probe-timeout: <value of integer>
dns-request-domain: <value of string>
probe-count: <value of integer>
system-dns: <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_fsp_vlan_dynamicmapping – no description fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping – 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_fsp_vlan_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 |
| --- | --- | --- |
| **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 |
| **fsp\_vlan\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_dhcp-status** string | **Choices:*** disable
* enable
| no description |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **dhcp-server** dictionary | | no description |
| | | **auto-configuration** string | **Choices:*** disable
* enable
| Enable/disable auto configuration. |
| | | **auto-managed-status** string | **Choices:*** disable
* enable
| Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. |
| | | **conflicted-ip-timeout** integer | | Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. |
| | | **ddns-auth** string | **Choices:*** disable
* tsig
| DDNS authentication mode. |
| | | **ddns-key** string | | DDNS update key (base 64 encoding). |
| | | **ddns-keyname** string | | DDNS update key name. |
| | | **ddns-server-ip** string | | DDNS server IP. |
| | | **ddns-ttl** integer | | TTL. |
| | | **ddns-update** string | **Choices:*** disable
* enable
| Enable/disable DDNS update for DHCP. |
| | | **ddns-update-override** string | **Choices:*** disable
* enable
| Enable/disable DDNS update override for DHCP. |
| | | **ddns-zone** string | | Zone of your domain name (ex. DDNS.com). |
| | | **default-gateway** string | | Default gateway IP address assigned by the DHCP server. |
| | | **dhcp-settings-from-fortiipam** string | **Choices:*** disable
* enable
| Enable/disable populating of DHCP server settings from FortiIPAM. |
| | | **dns-server1** string | | DNS server 1. |
| | | **dns-server2** string | | DNS server 2. |
| | | **dns-server3** string | | DNS server 3. |
| | | **dns-server4** string | | DNS server 4. |
| | | **dns-service** string | **Choices:*** default
* specify
* local
| Options for assigning DNS servers to DHCP clients. |
| | | **domain** string | | Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
| | | **enable** string | **Choices:*** disable
* enable
| no description |
| | | **exclude-range** list / elements=string | | no description |
| | | | **end-ip** string | | End of IP range. |
| | | | **id** integer | | ID. |
| | | | **start-ip** string | | Start of IP range. |
| | | **filename** string | | Name of the boot file on the TFTP server. |
| | | **forticlient-on-net-status** string | **Choices:*** disable
* enable
| Enable/disable FortiClient-On-Net service for this DHCP server. |
| | | **id** integer | | ID. |
| | | **ip-mode** string | **Choices:*** range
* usrgrp
| Method used to assign client IP. |
| | | **ip-range** list / elements=string | | no description |
| | | | **end-ip** string | | End of IP range. |
| | | | **id** integer | | ID. |
| | | | **start-ip** string | | Start of IP range. |
| | | **ipsec-lease-hold** integer | | DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). |
| | | **lease-time** integer | | Lease time in seconds, 0 means unlimited. |
| | | **mac-acl-default-action** string | **Choices:*** assign
* block
| MAC access control default action (allow or block assigning IP settings). |
| | | **netmask** string | | Netmask assigned by the DHCP server. |
| | | **next-server** string | | IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. |
| | | **ntp-server1** string | | NTP server 1. |
| | | **ntp-server2** string | | NTP server 2. |
| | | **ntp-server3** string | | NTP server 3. |
| | | **ntp-service** string | **Choices:*** default
* specify
* local
| Options for assigning Network Time Protocol (NTP) servers to DHCP clients. |
| | | **option1** string | | no description |
| | | **option2** string | | no description |
| | | **option3** string | | no description |
| | | **option4** string | | no description |
| | | **option5** string | | no description |
| | | **option6** string | | no description |
| | | **options** list / elements=string | | no description |
| | | | **code** integer | | DHCP option code. |
| | | | **id** integer | | ID. |
| | | | **ip** string | | no description |
| | | | **type** string | **Choices:*** hex
* string
* ip
* fqdn
| DHCP option type. |
| | | | **value** string | | DHCP option value. |
| | | **reserved-address** list / elements=string | | no description |
| | | | **action** string | **Choices:*** assign
* block
* reserved
| Options for the DHCP server to configure the client with the reserved MAC address. |
| | | | **circuit-id** string | | Option 82 circuit-ID of the client that will get the reserved IP address. |
| | | | **circuit-id-type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | | **description** string | | Description. |
| | | | **id** integer | | ID. |
| | | | **ip** string | | IP address to be reserved for the MAC address. |
| | | | **mac** string | | MAC address of the client that will get the reserved IP address. |
| | | | **remote-id** string | | Option 82 remote-ID of the client that will get the reserved IP address. |
| | | | **remote-id-type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | | **type** string | **Choices:*** mac
* option82
| DHCP reserved-address type. |
| | | **server-type** string | **Choices:*** regular
* ipsec
| DHCP server can be a normal DHCP server or an IPsec DHCP server. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this DHCP configuration. |
| | | **tftp-server** string | | no description |
| | | **timezone** string | **Choices:*** 00
* 01
* 02
* 03
* 04
* 05
* 06
* 07
* 08
* 09
* 10
* 11
* 12
* 13
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 22
* 23
* 24
* 25
* 26
* 27
* 28
* 29
* 30
* 31
* 32
* 33
* 34
* 35
* 36
* 37
* 38
* 39
* 40
* 41
* 42
* 43
* 44
* 45
* 46
* 47
* 48
* 49
* 50
* 51
* 52
* 53
* 54
* 55
* 56
* 57
* 58
* 59
* 60
* 61
* 62
* 63
* 64
* 65
* 66
* 67
* 68
* 69
* 70
* 71
* 72
* 73
* 74
* 75
* 76
* 77
* 78
* 79
* 80
* 81
* 82
* 83
* 84
* 85
* 86
* 87
| Select the time zone to be assigned to DHCP clients. |
| | | **timezone-option** string | **Choices:*** disable
* default
* specify
| Options for the DHCP server to set the clients time zone. |
| | | **vci-match** string | **Choices:*** disable
* enable
| Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. |
| | | **vci-string** string | | no description |
| | | **wifi-ac-service** string | **Choices:*** specify
* local
| Options for assigning WiFi Access Controllers to DHCP clients |
| | | **wifi-ac1** string | | WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). |
| | | **wifi-ac2** string | | WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). |
| | | **wifi-ac3** string | | WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). |
| | | **wins-server1** string | | WINS server 1. |
| | | **wins-server2** string | | WINS server 2. |
| | **interface** dictionary | | no description |
| | | **dhcp-relay-agent-option** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp-relay-ip** string | | no description |
| | | **dhcp-relay-service** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp-relay-type** string | **Choices:*** regular
* ipsec
| no description |
| | | **ip** string | | no description |
| | | **ipv6** dictionary | | no description |
| | | | **autoconf** string | **Choices:*** disable
* enable
| Enable/disable address auto config. |
| | | | **cli-conn6-status** integer | | no description |
| | | | **dhcp6-client-options** list / elements=string | **Choices:*** rapid
* iapd
* iana
* dns
* dnsname
| no description |
| | | | **dhcp6-information-request** string | **Choices:*** disable
* enable
| Enable/disable DHCPv6 information request. |
| | | | **dhcp6-prefix-delegation** string | **Choices:*** disable
* enable
| Enable/disable DHCPv6 prefix delegation. |
| | | | **dhcp6-prefix-hint** string | | DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. |
| | | | **dhcp6-prefix-hint-plt** integer | | DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. |
| | | | **dhcp6-prefix-hint-vlt** integer | | DHCPv6 prefix hint valid life time (sec). |
| | | | **dhcp6-relay-ip** string | | DHCPv6 relay IP address. |
| | | | **dhcp6-relay-service** string | **Choices:*** disable
* enable
| Enable/disable DHCPv6 relay. |
| | | | **dhcp6-relay-type** string | **Choices:*** regular
| DHCPv6 relay type. |
| | | | **icmp6-send-redirect** string | **Choices:*** disable
* enable
| Enable/disable sending of ICMPv6 redirects. |
| | | | **interface-identifier** string | | IPv6 interface identifier. |
| | | | **ip6-address** string | | Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx |
| | | | **ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* capwap
* fabric
| no description |
| | | | **ip6-default-life** integer | | Default life (sec). |
| | | | **ip6-delegated-prefix-list** list / elements=string | | no description |
| | | | | **autonomous-flag** string | **Choices:*** disable
* enable
| Enable/disable the autonomous flag. |
| | | | | **onlink-flag** string | **Choices:*** disable
* enable
| Enable/disable the onlink flag. |
| | | | | **prefix-id** integer | | Prefix ID. |
| | | | | **rdnss** string | | no description |
| | | | | **rdnss-service** string | **Choices:*** delegated
* default
* specify
| Recursive DNS service option. |
| | | | | **subnet** string | | Add subnet ID to routing prefix. |
| | | | | **upstream-interface** string | | Name of the interface that provides delegated information. |
| | | | **ip6-dns-server-override** string | **Choices:*** disable
* enable
| Enable/disable using the DNS server acquired by DHCP. |
| | | | **ip6-extra-addr** list / elements=string | | no description |
| | | | | **prefix** string | | IPv6 address prefix. |
| | | | **ip6-hop-limit** integer | | Hop limit (0 means unspecified). |
| | | | **ip6-link-mtu** integer | | IPv6 link MTU. |
| | | | **ip6-manage-flag** string | **Choices:*** disable
* enable
| Enable/disable the managed flag. |
| | | | **ip6-max-interval** integer | | IPv6 maximum interval (4 to 1800 sec). |
| | | | **ip6-min-interval** integer | | IPv6 minimum interval (3 to 1350 sec). |
| | | | **ip6-mode** string | **Choices:*** static
* dhcp
* pppoe
* delegated
| Addressing mode (static, DHCP, delegated). |
| | | | **ip6-other-flag** string | **Choices:*** disable
* enable
| Enable/disable the other IPv6 flag. |
| | | | **ip6-prefix-list** list / elements=string | | no description |
| | | | | **autonomous-flag** string | **Choices:*** disable
* enable
| Enable/disable the autonomous flag. |
| | | | | **dnssl** string | | no description |
| | | | | **onlink-flag** string | **Choices:*** disable
* enable
| Enable/disable the onlink flag. |
| | | | | **preferred-life-time** integer | | Preferred life time (sec). |
| | | | | **prefix** string | | IPv6 prefix. |
| | | | | **rdnss** string | | no description |
| | | | | **valid-life-time** integer | | Valid life time (sec). |
| | | | **ip6-prefix-mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from DHCP or RA. |
| | | | **ip6-reachable-time** integer | | IPv6 reachable time (milliseconds; 0 means unspecified). |
| | | | **ip6-retrans-time** integer | | IPv6 retransmit time (milliseconds; 0 means unspecified). |
| | | | **ip6-send-adv** string | **Choices:*** disable
* enable
| Enable/disable sending advertisements about the interface. |
| | | | **ip6-subnet** string | | Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx |
| | | | **ip6-upstream-interface** string | | Interface name providing delegated information. |
| | | | **nd-cert** string | | Neighbor discovery certificate. |
| | | | **nd-cga-modifier** string | | Neighbor discovery CGA modifier. |
| | | | **nd-mode** string | **Choices:*** basic
* SEND-compatible
| Neighbor discovery mode. |
| | | | **nd-security-level** integer | | Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). |
| | | | **nd-timestamp-delta** integer | | Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). |
| | | | **nd-timestamp-fuzz** integer | | Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). |
| | | | **ra-send-mtu** string | **Choices:*** disable
* enable
| Enable/disable sending link MTU in RA packet. |
| | | | **unique-autoconf-addr** string | **Choices:*** disable
* enable
| Enable/disable unique auto config address. |
| | | | **vrip6\_link\_local** string | | Link-local IPv6 address of virtual router. |
| | | | **vrrp-virtual-mac6** string | **Choices:*** disable
* enable
| Enable/disable virtual MAC for VRRP. |
| | | | **vrrp6** list / elements=string | | no description |
| | | | | **accept-mode** string | **Choices:*** disable
* enable
| Enable/disable accept mode. |
| | | | | **adv-interval** integer | | Advertisement interval (1 - 255 seconds). |
| | | | | **preempt** string | **Choices:*** disable
* enable
| Enable/disable preempt mode. |
| | | | | **priority** integer | | Priority of the virtual router (1 - 255). |
| | | | | **start-time** integer | | Startup time (1 - 255 seconds). |
| | | | | **status** string | **Choices:*** disable
* enable
| Enable/disable VRRP. |
| | | | | **vrdst6** string | | Monitor the route to this destination. |
| | | | | **vrgrp** integer | | VRRP group ID (1 - 65535). |
| | | | | **vrid** integer | | Virtual router identifier (1 - 255). |
| | | | | **vrip6** string | | IPv6 address of the virtual router. |
| | | **secondary-IP** string | **Choices:*** disable
* enable
| no description |
| | | **secondaryip** list / elements=string | | no description |
| | | | **allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
* dnp
* ftm
* fabric
| no description |
| | | | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| no description |
| | | | **detectserver** string | | Gateways ping server for this IP. |
| | | | **gwdetect** string | **Choices:*** disable
* enable
| Enable/disable detect gateway alive for first. |
| | | | **ha-priority** integer | | HA election priority for the PING server. |
| | | | **id** integer | | ID. |
| | | | **ip** string | | Secondary IP address of the interface. |
| | | | **ping-serv-status** integer | | no description |
| | | | **seq** integer | | no description |
| | | **vlanid** integer | | 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 |
| **vlan** string / required | | the parameter (vlan) 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_fsp_vlan_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>
vlan: <your own value>
state: <value in [present, absent]>
fsp_vlan_dynamicmapping:
_dhcp-status: <value in [disable, enable]>
_scope:
-
name: <value of string>
vdom: <value of string>
dhcp-server:
auto-configuration: <value in [disable, enable]>
auto-managed-status: <value in [disable, enable]>
conflicted-ip-timeout: <value of integer>
ddns-auth: <value in [disable, tsig]>
ddns-key: <value of string>
ddns-keyname: <value of string>
ddns-server-ip: <value of string>
ddns-ttl: <value of integer>
ddns-update: <value in [disable, enable]>
ddns-update-override: <value in [disable, enable]>
ddns-zone: <value of string>
default-gateway: <value of string>
dhcp-settings-from-fortiipam: <value in [disable, enable]>
dns-server1: <value of string>
dns-server2: <value of string>
dns-server3: <value of string>
dns-server4: <value of string>
dns-service: <value in [default, specify, local]>
domain: <value of string>
enable: <value in [disable, enable]>
exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
filename: <value of string>
forticlient-on-net-status: <value in [disable, enable]>
id: <value of integer>
ip-mode: <value in [range, usrgrp]>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipsec-lease-hold: <value of integer>
lease-time: <value of integer>
mac-acl-default-action: <value in [assign, block]>
netmask: <value of string>
next-server: <value of string>
ntp-server1: <value of string>
ntp-server2: <value of string>
ntp-server3: <value of string>
ntp-service: <value in [default, specify, local]>
option1: <value of string>
option2: <value of string>
option3: <value of string>
option4: <value of string>
option5: <value of string>
option6: <value of string>
options:
-
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <value of string>
reserved-address:
-
action: <value in [assign, block, reserved]>
circuit-id: <value of string>
circuit-id-type: <value in [hex, string]>
description: <value of string>
id: <value of integer>
ip: <value of string>
mac: <value of string>
remote-id: <value of string>
remote-id-type: <value in [hex, string]>
type: <value in [mac, option82]>
server-type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp-server: <value of string>
timezone: <value in [00, 01, 02, ...]>
timezone-option: <value in [disable, default, specify]>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
wifi-ac-service: <value in [specify, local]>
wifi-ac1: <value of string>
wifi-ac2: <value of string>
wifi-ac3: <value of string>
wins-server1: <value of string>
wins-server2: <value of string>
interface:
dhcp-relay-agent-option: <value in [disable, enable]>
dhcp-relay-ip: <value of string>
dhcp-relay-service: <value in [disable, enable]>
dhcp-relay-type: <value in [regular, ipsec]>
ip: <value of string>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6-client-options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6-information-request: <value in [disable, enable]>
dhcp6-prefix-delegation: <value in [disable, enable]>
dhcp6-prefix-hint: <value of string>
dhcp6-prefix-hint-plt: <value of integer>
dhcp6-prefix-hint-vlt: <value of integer>
dhcp6-relay-ip: <value of string>
dhcp6-relay-service: <value in [disable, enable]>
dhcp6-relay-type: <value in [regular]>
icmp6-send-redirect: <value in [disable, enable]>
interface-identifier: <value of string>
ip6-address: <value of string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <value of integer>
ip6-delegated-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <value of string>
ip6-dns-server-override: <value in [disable, enable]>
ip6-extra-addr:
-
prefix: <value of string>
ip6-hop-limit: <value of integer>
ip6-link-mtu: <value of integer>
ip6-manage-flag: <value in [disable, enable]>
ip6-max-interval: <value of integer>
ip6-min-interval: <value of integer>
ip6-mode: <value in [static, dhcp, pppoe, ...]>
ip6-other-flag: <value in [disable, enable]>
ip6-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
dnssl: <value of string>
onlink-flag: <value in [disable, enable]>
preferred-life-time: <value of integer>
prefix: <value of string>
rdnss: <value of string>
valid-life-time: <value of integer>
ip6-reachable-time: <value of integer>
ip6-retrans-time: <value of integer>
ip6-send-adv: <value in [disable, enable]>
ip6-subnet: <value of string>
ip6-upstream-interface: <value of string>
nd-cert: <value of string>
nd-cga-modifier: <value of string>
nd-mode: <value in [basic, SEND-compatible]>
nd-security-level: <value of integer>
nd-timestamp-delta: <value of integer>
nd-timestamp-fuzz: <value of integer>
unique-autoconf-addr: <value in [disable, enable]>
vrip6_link_local: <value of string>
vrrp-virtual-mac6: <value in [disable, enable]>
vrrp6:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <value of string>
cli-conn6-status: <value of integer>
ip6-prefix-mode: <value in [dhcp6, ra]>
ra-send-mtu: <value in [disable, enable]>
secondary-IP: <value in [disable, enable]>
secondaryip:
-
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <value of string>
gwdetect: <value in [disable, enable]>
ha-priority: <value of integer>
id: <value of integer>
ip: <value of string>
ping-serv-status: <value of integer>
seq: <value of integer>
vlanid: <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_webproxy_forwardservergroup – Configure a forward server group consisting or multiple forward servers. fortinet.fortimanager.fmgr\_webproxy\_forwardservergroup – Configure a forward server group consisting or multiple forward servers.
===================================================================================================================================
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`.
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\_forwardservergroup** dictionary | | the top level parameters set |
| | **affinity** string | **Choices:*** disable
* enable
| Enable/disable affinity, attaching a source-ips traffic to the assigned forwarding server until the forward-server-affinity-ti... |
| | **group-down-option** string | **Choices:*** block
* pass
| Action to take when all of the servers in the forward server group are down: block sessions until at least one server is back ... |
| | **ldb-method** string | **Choices:*** weighted
* least-session
* active-passive
| Load balance method: weighted or least-session. |
| | **name** string | | Configure a forward server group consisting one or multiple forward servers. Supports failover and load balancing. |
| | **server-list** list / elements=string | | no description |
| | | **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: Configure a forward server group consisting or multiple forward servers.
fmgr_webproxy_forwardservergroup:
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_forwardservergroup:
affinity: <value in [disable, enable]>
group-down-option: <value in [block, pass]>
ldb-method: <value in [weighted, least-session, active-passive]>
name: <value of string>
server-list:
-
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_devprof_system_replacemsg_nacquar – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_nacquar – 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_nacquar`.
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\_nacquar** 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_nacquar:
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_nacquar:
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_system_replacemsggroup_alertmail – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_alertmail – 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_alertmail`.
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\_alertmail** 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. |
| **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_alertmail:
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_alertmail:
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_securityconsole_package_commit – Install policies to device from preview cache. fortinet.fortimanager.fmgr\_securityconsole\_package\_commit – Install policies to device from preview cache.
=============================================================================================================
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_securityconsole_package_commit`.
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 |
| **securityconsole\_package\_commit** dictionary | | the top level parameters set |
| | **adom** string | | Source ADOM name. |
| | **scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** 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: Install policies to device from preview cache.
fmgr_securityconsole_package_commit:
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, ...]
securityconsole_package_commit:
adom: <value of string>
scope:
-
name: <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)
ansible fortinet.fortimanager.fmgr_wanopt_profile_http – Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features. fortinet.fortimanager.fmgr\_wanopt\_profile\_http – Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
======================================================================================================================================
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_wanopt_profile_http`.
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 |
| **wanopt\_profile\_http** dictionary | | the top level parameters set |
| | **byte-caching** string | **Choices:*** disable
* enable
| Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and ... |
| | **log-traffic** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **port** integer | | no description |
| | **prefer-chunking** string | **Choices:*** dynamic
* fix
| Select dynamic or fixed-size data chunking for HTTP WAN Optimization. |
| | **protocol-opt** string | **Choices:*** protocol
* tcp
| Select Protocol specific optimitation or generic TCP optimization. |
| | **secure-tunnel** string | **Choices:*** disable
* enable
| Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). |
| | **ssl** string | **Choices:*** disable
* enable
| Enable/disable SSL/TLS offloading (hardware acceleration) for HTTPS traffic in this tunnel. |
| | **ssl-port** integer | | no description |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable HTTP WAN Optimization. |
| | **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 occur if ... |
| | **tunnel-sharing** string | **Choices:*** private
* shared
* express-shared
| Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. |
| | **unknown-http-version** string | **Choices:*** best-effort
* reject
* tunnel
| How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. |
| **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 HTTP WAN Optimization and configure HTTP WAN Optimization features.
fmgr_wanopt_profile_http:
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>
wanopt_profile_http:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
port: <value of integer>
prefer-chunking: <value in [dynamic, fix]>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
ssl-port: <value of integer>
status: <value in [disable, enable]>
tunnel-non-http: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
unknown-http-version: <value in [best-effort, reject, tunnel]>
protocol-opt: <value in [protocol, tcp]>
```
Return Values
-------------
Common return 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_dvmdb_workspace_lock_dev – Lock a device. fortinet.fortimanager.fmgr\_dvmdb\_workspace\_lock\_dev – Lock a device.
========================================================================
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_lock_dev`.
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 |
| **device\_name** string / required | | the parameter (device\_name) in requested url |
| **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: Lock a device.
fmgr_dvmdb_workspace_lock_dev:
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>
device_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_system_locallog_syslogd3_setting – Settings for remote syslog server. fortinet.fortimanager.fmgr\_system\_locallog\_syslogd3\_setting – Settings for remote syslog 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_system_locallog_syslogd3_setting`.
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\_locallog\_syslogd3\_setting** dictionary | | the top level parameters set |
| | **csv** string | **Choices:*** **disable** ←
* enable
| CSV format. disable - Disable CSV format. enable - Enable CSV format. |
| | **facility** string | **Choices:*** kernel
* user
* ntp
* audit
* alert
* clock
* mail
* daemon
* auth
* syslog
* lpr
* news
* uucp
* cron
* authpriv
* ftp
* local0
* local1
* local2
* local3
* local4
* local5
* local6
* **local7** ←
| Remote syslog facility. kernel - Kernel messages. user - Random user-level messages. ntp - NTP daemon. audit - Log audit. alert - Log alert. clock - Clock daemon. mail - Mail system. daemon - System daemons. auth - Security/authorization messages. syslog - Messages generated internally by syslog daemon. lpr - Line printer subsystem. news - Network news subsystem. uucp - Network news subsystem. cron - Clock daemon. authpriv - Security/authorization messages (private). ftp - FTP daemon. local0 - Reserved for local use. local1 - Reserved for local use. local2 - Reserved for local use. local3 - Reserved for local use. local4 - Reserved for local use. local5 - Reserved for local use. local6 - Reserved for local use. local7 - Reserved for local use. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* **notification** ←
* information
* debug
| Least severity level to log. emergency - Emergency level. alert - Alert level. critical - Critical level. error - Error level. warning - Warning level. notification - Notification level. information - Information level. debug - Debug level. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Remote syslog log. disable - Do not log to remote syslog server. enable - Log to remote syslog server. |
| | **syslog-name** string | | Remote syslog server 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: Settings for remote syslog server.
fmgr_system_locallog_syslogd3_setting:
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_locallog_syslogd3_setting:
csv: <value in [disable, enable]>
facility: <value in [kernel, user, ntp, ...]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
syslog-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_wanopt_peer – Configure WAN optimization peers. fortinet.fortimanager.fmgr\_wanopt\_peer – Configure WAN optimization peers.
============================================================================
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_wanopt_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 |
| --- | --- | --- |
| **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 |
| **wanopt\_peer** dictionary | | the top level parameters set |
| | **ip** string | | Peer IP address. |
| | **peer-host-id** string | | Peer host 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 WAN optimization peers.
fmgr_wanopt_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, ...]
adom: <your own value>
state: <value in [present, absent]>
wanopt_peer:
ip: <value of string>
peer-host-id: <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_sshfilter_profile – SSH filter profile. fortinet.fortimanager.fmgr\_sshfilter\_profile – SSH filter profile.
====================================================================
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_sshfilter_profile`.
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 |
| **sshfilter\_profile** dictionary | | the top level parameters set |
| | **block** list / elements=string | **Choices:*** x11
* shell
* exec
* port-forward
* tun-forward
* sftp
* unknown
* scp
| no description |
| | **default-command-log** string | **Choices:*** disable
* enable
| Enable/disable logging unmatched shell commands. |
| | **log** list / elements=string | **Choices:*** x11
* shell
* exec
* port-forward
* tun-forward
* sftp
* unknown
* scp
| no description |
| | **name** string | | SSH filter profile name. |
| | **shell-commands** list / elements=string | | no description |
| | | **action** string | **Choices:*** block
* allow
| Action to take for URL filter matches. |
| | | **alert** string | **Choices:*** disable
* enable
| Enable/disable alert. |
| | | **id** integer | | Id. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **pattern** string | | SSH shell command pattern. |
| | | **severity** string | **Choices:*** low
* medium
* high
* critical
| Log severity. |
| | | **type** string | **Choices:*** regex
* simple
| Matching type. |
| **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: SSH filter profile.
fmgr_sshfilter_profile:
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]>
sshfilter_profile:
block:
- x11
- shell
- exec
- port-forward
- tun-forward
- sftp
- unknown
- scp
default-command-log: <value in [disable, enable]>
log:
- x11
- shell
- exec
- port-forward
- tun-forward
- sftp
- unknown
- scp
name: <value of string>
shell-commands:
-
action: <value in [block, allow]>
alert: <value in [disable, enable]>
id: <value of integer>
log: <value in [disable, enable]>
pattern: <value of string>
severity: <value in [low, medium, high, ...]>
type: <value in [regex, 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 |
| --- | --- | --- |
| **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_icap_profile – Configure ICAP profiles. fortinet.fortimanager.fmgr\_icap\_profile – Configure ICAP 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_icap_profile`.
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** dictionary | | the top level parameters set |
| | **icap-headers** list / elements=string | | no description |
| | | **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. |
| | **methods** list / elements=string | **Choices:*** delete
* get
* head
* options
* post
* put
* trace
* other
| no description |
| | **name** string | | ICAP profile name. |
| | **preview** string | **Choices:*** disable
* enable
| Enable/disable preview of data to ICAP server. |
| | **preview-data-length** integer | | Preview data length to be sent to ICAP server. |
| | **replacemsg-group** string | | Replacement message group. |
| | **request** string | **Choices:*** disable
* enable
| Enable/disable whether an HTTP request is passed to an ICAP server. |
| | **request-failure** string | **Choices:*** error
* bypass
| Action to take if the ICAP server cannot be contacted when processing an HTTP request. |
| | **request-path** string | | Path component of the ICAP URI that identifies the HTTP request processing service. |
| | **request-server** string | | ICAP server to use for an HTTP request. |
| | **respmod-default-action** string | **Choices:*** bypass
* forward
| Default action to ICAP response modification (respmod) processing. |
| | **respmod-forward-rules** list / elements=string | | no description |
| | | **action** string | **Choices:*** bypass
* forward
| Action to be taken for ICAP server. |
| | | **header-group** list / elements=string | | no description |
| | | | **case-sensitivity** string | **Choices:*** disable
* enable
| Enable/disable case sensitivity when matching header. |
| | | | **header** string | | HTTP header regular expression. |
| | | | **header-name** string | | HTTP header. |
| | | | **id** integer | | ID. |
| | | **host** string | | Address object for the host. |
| | | **http-resp-status-code** integer | | no description |
| | | **name** string | | Address name. |
| | **response** string | **Choices:*** disable
* enable
| Enable/disable whether an HTTP response is passed to an ICAP server. |
| | **response-failure** string | **Choices:*** error
* bypass
| Action to take if the ICAP server cannot be contacted when processing an HTTP response. |
| | **response-path** string | | Path component of the ICAP URI that identifies the HTTP response processing service. |
| | **response-req-hdr** string | **Choices:*** disable
* enable
| Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. |
| | **response-server** string | | ICAP server to use for an HTTP response. |
| | **streaming-content-bypass** string | **Choices:*** disable
* enable
| Enable/disable bypassing of ICAP server for streaming content. |
| **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 profiles.
fmgr_icap_profile:
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]>
icap_profile:
methods:
- delete
- get
- head
- options
- post
- put
- trace
- other
name: <value of string>
replacemsg-group: <value of string>
request: <value in [disable, enable]>
request-failure: <value in [error, bypass]>
request-path: <value of string>
request-server: <value of string>
response: <value in [disable, enable]>
response-failure: <value in [error, bypass]>
response-path: <value of string>
response-server: <value of string>
streaming-content-bypass: <value in [disable, enable]>
icap-headers:
-
base64-encoding: <value in [disable, enable]>
content: <value of string>
id: <value of integer>
name: <value of string>
preview: <value in [disable, enable]>
preview-data-length: <value of integer>
response-req-hdr: <value in [disable, enable]>
respmod-default-action: <value in [bypass, forward]>
respmod-forward-rules:
-
action: <value in [bypass, forward]>
header-group:
-
case-sensitivity: <value in [disable, enable]>
header: <value of string>
header-name: <value of string>
id: <value of integer>
host: <value of string>
http-resp-status-code: <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_vip6_sslserverciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_vip6\_sslserverciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority.
====================================================================================================================================
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_vip6_sslserverciphersuites`.
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\_vip6\_sslserverciphersuites** dictionary | | the top level parameters set |
| | **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 |
| **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 |
| **vip6** string / required | | the parameter (vip6) 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: SSL/TLS cipher suites to offer to a server, ordered by priority.
fmgr_firewall_vip6_sslserverciphersuites:
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>
vip6: <your own value>
state: <value in [present, absent]>
firewall_vip6_sslserverciphersuites:
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
```
Return Values
-------------
Common return 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_dlp_sensor_filter – Set up DLP filters for this sensor. fortinet.fortimanager.fmgr\_dlp\_sensor\_filter – Set up DLP filters for this sensor.
=====================================================================================
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_dlp_sensor_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 |
| **dlp\_sensor\_filter** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** log-only
* block
* exempt
* ban
* ban-sender
* quarantine-ip
* quarantine-port
* none
* allow
| Action to take with content that this DLP sensor matches. |
| | **archive** string | **Choices:*** disable
* enable
* summary-only
| Enable/disable DLP archiving. |
| | **company-identifier** string | | Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched. |
| | **expiry** string | | Quarantine duration in days, hours, minutes format (dddhhmm). |
| | **file-size** integer | | Match files this size or larger (0 - 4294967295 kbytes). |
| | **file-type** string | | Select the number of a DLP file pattern table to match. |
| | **filter-by** string | **Choices:*** credit-card
* ssn
* regexp
* file-type
* file-size
* fingerprint
* watermark
* encrypted
| Select the type of content to match. |
| | **fp-sensitivity** string | | Select a DLP file pattern sensitivity to match. |
| | **id** integer | | ID. |
| | **match-percentage** integer | | Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match. |
| | **name** string | | Filter name. |
| | **proto** list / elements=string | **Choices:*** imap
* smtp
* pop3
* ftp
* nntp
* mm1
* mm3
* mm4
* mm7
* mapi
* aim
* icq
* msn
* yahoo
* http-get
* http-post
* ssh
* cifs
| no description |
| | **regexp** string | | Enter a regular expression to match (max. 255 characters). |
| | **sensitivity** string | | Select a DLP file pattern sensitivity to match. |
| | **severity** string | **Choices:*** info
* low
* medium
* high
* critical
| Select the severity or threat level that matches this filter. |
| | **type** string | **Choices:*** file
* message
| Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). |
| **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 |
| **sensor** string / required | | the parameter (sensor) in requested url |
| **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 up DLP filters for this sensor.
fmgr_dlp_sensor_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>
sensor: <your own value>
state: <value in [present, absent]>
dlp_sensor_filter:
action: <value in [log-only, block, exempt, ...]>
archive: <value in [disable, enable, summary-only]>
company-identifier: <value of string>
expiry: <value of string>
file-size: <value of integer>
file-type: <value of string>
filter-by: <value in [credit-card, ssn, regexp, ...]>
fp-sensitivity: <value of string>
id: <value of integer>
match-percentage: <value of integer>
name: <value of string>
proto:
- imap
- smtp
- pop3
- ftp
- nntp
- mm1
- mm3
- mm4
- mm7
- mapi
- aim
- icq
- msn
- yahoo
- http-get
- http-post
- ssh
- cifs
regexp: <value of string>
severity: <value in [info, low, medium, ...]>
type: <value in [file, message]>
sensitivity: <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_proxyaddrgrp_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_proxyaddrgrp\_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_proxyaddrgrp_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 |
| --- | --- | --- |
| **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\_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 |
| **proxy-addrgrp** string / required | | the parameter (proxy-addrgrp) 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 |
| **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_proxyaddrgrp_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>
proxy-addrgrp: <your own value>
state: <value in [present, absent]>
firewall_proxyaddrgrp_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_pkg_firewall_proxypolicy – Configure proxy policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_proxypolicy – Configure proxy policies.
==================================================================================
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_proxypolicy`.
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\_proxypolicy** dictionary | | the top level parameters set |
| | **access-proxy** string | | Access Proxy. |
| | **action** string | **Choices:*** accept
* deny
* redirect
| Accept or deny traffic matching the policy parameters. |
| | **application-list** string | | Name of an existing Application list. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | Optional comments. |
| | **decrypted-traffic-mirror** string | | Decrypted traffic mirror. |
| | **device-ownership** string | **Choices:*** disable
* enable
| When enabled, the ownership enforcement will be done at policy level. |
| | **disclaimer** string | **Choices:*** disable
* domain
* policy
* user
| Web proxy disclaimer setting: by domain, policy, or user. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dstaddr** string | | Destination address objects. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled, destination addresses match against any address EXCEPT the specified destination addresses. |
| | **dstaddr6** string | | IPv6 destination address objects. |
| | **dstintf** string | | Destination interface names. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **file-filter-profile** string | | Name of an existing file-filter profile. |
| | **global-label** string | | Global web-based manager visible label. |
| | **groups** string | | Names of group objects. |
| | **http-tunnel-auth** string | **Choices:*** disable
* enable
| Enable/disable HTTP tunnel authentication. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-name** string | | Internet Service name. |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **label** string | | VDOM-specific GUI visible label. |
| | **logtraffic** string | **Choices:*** disable
* all
* utm
| Enable/disable logging traffic through the policy. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Enable/disable policy log traffic start. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **policyid** integer | | Policy ID. |
| | **poolname** string | | Name of IP pool object. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **proxy** string | **Choices:*** explicit-web
* transparent-web
* ftp
* wanopt
* ssh
* ssh-tunnel
* access-proxy
| Type of explicit proxy. |
| | **redirect-url** string | | Redirect URL for further explicit web proxy processing. |
| | **replacemsg-override-group** string | | Authentication replacement message override group. |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| Enable/disable scanning of connections to Botnet servers. |
| | **schedule** string | | Name of schedule object. |
| | **service** string | | Name of service objects. |
| | **service-negate** string | **Choices:*** disable
* enable
| When enabled, services match against any service EXCEPT the specified destination services. |
| | **session-ttl** integer | | TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL). |
| | **spamfilter-profile** string | | Name of an existing Spam filter profile. |
| | **srcaddr** string | | Source address objects (must be set when using Web proxy). |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled, source addresses match against any address EXCEPT the specified source addresses. |
| | **srcaddr6** string | | IPv6 source address objects. |
| | **srcintf** string | | Source interface names. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable the active status of the policy. |
| | **tags** string | | Names of object-tags applied to address. Tags need to be preconfigured in config system object-tag. Separate multiple tags wit... |
| | **transparent** string | **Choices:*** disable
* enable
| Enable to use the IP address of the client to connect to the server. |
| | **users** string | | Names of user objects. |
| | **utm-status** string | **Choices:*** disable
* enable
| Enable the use of UTM profiles/sensors/lists. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **waf-profile** string | | Name of an existing Web application firewall profile. |
| | **webcache** string | **Choices:*** disable
* enable
| Enable/disable web caching. |
| | **webcache-https** string | **Choices:*** disable
* enable
| Enable/disable web caching for HTTPS (Requires deep-inspection enabled in ssl-ssh-profile). |
| | **webfilter-profile** string | | Name of an existing Web filter profile. |
| | **webproxy-forward-server** string | | Name of web proxy forward server. |
| | **webproxy-profile** string | | Name of web proxy profile. |
| | **ztna-ems-tag** string | | ZTNA EMS Tag names. |
| **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 proxy policies.
fmgr_pkg_firewall_proxypolicy:
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>
state: <value in [present, absent]>
pkg_firewall_proxypolicy:
action: <value in [accept, deny, redirect]>
application-list: <value of string>
av-profile: <value of string>
comments: <value of string>
disclaimer: <value in [disable, domain, policy, ...]>
dlp-sensor: <value of string>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstaddr6: <value of string>
dstintf: <value of string>
global-label: <value of string>
groups: <value of string>
http-tunnel-auth: <value in [disable, enable]>
icap-profile: <value of string>
internet-service: <value in [disable, enable]>
internet-service-custom: <value of string>
internet-service-id: <value of string>
internet-service-negate: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
logtraffic: <value in [disable, all, utm]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
proxy: <value in [explicit-web, transparent-web, ftp, ...]>
redirect-url: <value of string>
replacemsg-override-group: <value of string>
scan-botnet-connections: <value in [disable, block, monitor]>
schedule: <value of string>
service: <value of string>
service-negate: <value in [disable, enable]>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcaddr6: <value of string>
srcintf: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
transparent: <value in [disable, enable]>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
waf-profile: <value of string>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, enable]>
webfilter-profile: <value of string>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
cifs-profile: <value of string>
emailfilter-profile: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
session-ttl: <value of integer>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
decrypted-traffic-mirror: <value of string>
internet-service-name: <value of string>
file-filter-profile: <value of string>
name: <value of string>
access-proxy: <value of string>
device-ownership: <value in [disable, enable]>
videofilter-profile: <value of string>
voip-profile: <value of string>
ztna-ems-tag: <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_log_fortianalyzercloud_setting – Global FortiAnalyzer Cloud settings. fortinet.fortimanager.fmgr\_devprof\_log\_fortianalyzercloud\_setting – Global FortiAnalyzer Cloud 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_devprof_log_fortianalyzercloud_setting`.
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\_fortianalyzercloud\_setting** dictionary | | the top level parameters set |
| | **\_\_change\_ip** integer | | Hidden attribute. |
| | **access-config** string | **Choices:*** disable
* enable
| Enable/disable FortiAnalyzer access to configuration and data. |
| | **certificate** string | | Certificate used to communicate with FortiAnalyzer. |
| | **conn-timeout** integer | | FortiAnalyzer connection time-out in seconds (for status and log buffer). |
| | **enc-algorithm** string | **Choices:*** high
* low
* high-medium
| Configure the level of SSL protection for secure communication with FortiAnalyzer. |
| | **hmac-algorithm** string | **Choices:*** sha256
* sha1
| FortiAnalyzer IPsec tunnel HMAC algorithm. |
| | **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. |
| | **ips-archive** string | **Choices:*** disable
* enable
| Enable/disable IPS packet archive logging. |
| | **max-log-rate** integer | | FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
| | **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:*** low
* default
| Set log transmission priority. |
| | **source-ip** string | | Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
| | **ssl-min-proto-version** string | **Choices:*** default
* TLSv1-1
* TLSv1-2
* SSLv3
* TLSv1
| Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). |
| | **status** string | **Choices:*** disable
* enable
| 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). |
| **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: Global FortiAnalyzer Cloud settings.
fmgr_devprof_log_fortianalyzercloud_setting:
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_fortianalyzercloud_setting:
__change_ip: <value of integer>
access-config: <value in [disable, enable]>
certificate: <value of string>
conn-timeout: <value of integer>
enc-algorithm: <value in [high, low, high-medium]>
hmac-algorithm: <value in [sha256, sha1]>
ips-archive: <value in [disable, enable]>
monitor-failure-retry-period: <value of integer>
monitor-keepalive-period: <value of integer>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
status: <value in [disable, enable]>
upload-day: <value of string>
upload-interval: <value in [daily, weekly, monthly]>
upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
upload-time: <value of string>
max-log-rate: <value of integer>
priority: <value in [low, default]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
preshared-key: <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_ippool6_dynamicmapping – Configure IPv6 IP pools. fortinet.fortimanager.fmgr\_firewall\_ippool6\_dynamicmapping – Configure IPv6 IP pools.
========================================================================================
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_ippool6_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 |
| --- | --- | --- |
| **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\_ippool6\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **comments** string | | no description |
| | **endip** string | | no description |
| | **startip** string | | no description |
| **ippool6** string / required | | the parameter (ippool6) 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 IPv6 IP pools.
fmgr_firewall_ippool6_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>
ippool6: <your own value>
state: <value in [present, absent]>
firewall_ippool6_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
comments: <value of string>
endip: <value of string>
startip: <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_switchcontroller_qos_qospolicy – Configure FortiSwitch QoS policy. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_qospolicy – Configure FortiSwitch QoS 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_switchcontroller_qos_qospolicy`.
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 |
| **switchcontroller\_qos\_qospolicy** dictionary | | the top level parameters set |
| | **default-cos** integer | | Default cos queue for untagged packets. |
| | **name** string | | QoS policy name. |
| | **queue-policy** string | | QoS egress queue policy. |
| | **trust-dot1p-map** string | | QoS trust 802.1p map. |
| | **trust-ip-dscp-map** string | | QoS trust ip dscp map. |
| **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 FortiSwitch QoS policy.
fmgr_switchcontroller_qos_qospolicy:
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]>
switchcontroller_qos_qospolicy:
default-cos: <value of integer>
name: <value of string>
queue-policy: <value of string>
trust-dot1p-map: <value of string>
trust-ip-dscp-map: <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_voip_profile_sip – SIP. fortinet.fortimanager.fmgr\_voip\_profile\_sip – SIP.
=====================================================
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_voip_profile_sip`.
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 |
| **voip\_profile\_sip** dictionary | | the top level parameters set |
| | **ack-rate** integer | | ACK request rate limit (per second, per policy). |
| | **ack-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **block-ack** string | **Choices:*** disable
* enable
| Enable/disable block ACK requests. |
| | **block-bye** string | **Choices:*** disable
* enable
| Enable/disable block BYE requests. |
| | **block-cancel** string | **Choices:*** disable
* enable
| Enable/disable block CANCEL requests. |
| | **block-geo-red-options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests, but OPTIONS requests still notify for redundancy. |
| | **block-info** string | **Choices:*** disable
* enable
| Enable/disable block INFO requests. |
| | **block-invite** string | **Choices:*** disable
* enable
| Enable/disable block INVITE requests. |
| | **block-long-lines** string | **Choices:*** disable
* enable
| Enable/disable block requests with headers exceeding max-line-length. |
| | **block-message** string | **Choices:*** disable
* enable
| Enable/disable block MESSAGE requests. |
| | **block-notify** string | **Choices:*** disable
* enable
| Enable/disable block NOTIFY requests. |
| | **block-options** string | **Choices:*** disable
* enable
| Enable/disable block OPTIONS requests and no OPTIONS as notifying message for redundancy either. |
| | **block-prack** string | **Choices:*** disable
* enable
| Enable/disable block prack requests. |
| | **block-publish** string | **Choices:*** disable
* enable
| Enable/disable block PUBLISH requests. |
| | **block-refer** string | **Choices:*** disable
* enable
| Enable/disable block REFER requests. |
| | **block-register** string | **Choices:*** disable
* enable
| Enable/disable block REGISTER requests. |
| | **block-subscribe** string | **Choices:*** disable
* enable
| Enable/disable block SUBSCRIBE requests. |
| | **block-unknown** string | **Choices:*** disable
* enable
| Block unrecognized SIP requests (enabled by default). |
| | **block-update** string | **Choices:*** disable
* enable
| Enable/disable block UPDATE requests. |
| | **bye-rate** integer | | BYE request rate limit (per second, per policy). |
| | **bye-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **call-keepalive** integer | | Continue tracking calls with no RTP for this many minutes. |
| | **cancel-rate** integer | | CANCEL request rate limit (per second, per policy). |
| | **cancel-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **contact-fixup** string | **Choices:*** disable
* enable
| Fixup contact anyway even if contacts IP:port doesnt match sessions IP:port. |
| | **hnt-restrict-source-ip** string | **Choices:*** disable
* enable
| Enable/disable restrict RTP source IP to be the same as SIP source IP when HNT is enabled. |
| | **hosted-nat-traversal** string | **Choices:*** disable
* enable
| Hosted NAT Traversal (HNT). |
| | **info-rate** integer | | INFO request rate limit (per second, per policy). |
| | **info-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **invite-rate** integer | | INVITE request rate limit (per second, per policy). |
| | **invite-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **ips-rtp** string | **Choices:*** disable
* enable
| Enable/disable allow IPS on RTP. |
| | **log-call-summary** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP call summary. |
| | **log-violations** string | **Choices:*** disable
* enable
| Enable/disable logging of SIP violations. |
| | **malformed-header-allow** string | **Choices:*** pass
* discard
* respond
| Action for malformed Allow header. |
| | **malformed-header-call-id** string | **Choices:*** pass
* discard
* respond
| Action for malformed Call-ID header. |
| | **malformed-header-contact** string | **Choices:*** pass
* discard
* respond
| Action for malformed Contact header. |
| | **malformed-header-content-length** string | **Choices:*** pass
* discard
* respond
| Action for malformed Content-Length header. |
| | **malformed-header-content-type** string | **Choices:*** pass
* discard
* respond
| Action for malformed Content-Type header. |
| | **malformed-header-cseq** string | **Choices:*** pass
* discard
* respond
| Action for malformed CSeq header. |
| | **malformed-header-expires** string | **Choices:*** pass
* discard
* respond
| Action for malformed Expires header. |
| | **malformed-header-from** string | **Choices:*** pass
* discard
* respond
| Action for malformed From header. |
| | **malformed-header-max-forwards** string | **Choices:*** pass
* discard
* respond
| Action for malformed Max-Forwards header. |
| | **malformed-header-no-proxy-require** string | **Choices:*** pass
* discard
* respond
| Action for malformed SIP messages without Proxy-Require header. |
| | **malformed-header-no-require** string | **Choices:*** pass
* discard
* respond
| Action for malformed SIP messages without Require header. |
| | **malformed-header-p-asserted-identity** string | **Choices:*** pass
* discard
* respond
| Action for malformed P-Asserted-Identity header. |
| | **malformed-header-rack** string | **Choices:*** pass
* discard
* respond
| Action for malformed RAck header. |
| | **malformed-header-record-route** string | **Choices:*** pass
* discard
* respond
| Action for malformed Record-Route header. |
| | **malformed-header-route** string | **Choices:*** pass
* discard
* respond
| Action for malformed Route header. |
| | **malformed-header-rseq** string | **Choices:*** pass
* discard
* respond
| Action for malformed RSeq header. |
| | **malformed-header-sdp-a** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP a line. |
| | **malformed-header-sdp-b** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP b line. |
| | **malformed-header-sdp-c** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP c line. |
| | **malformed-header-sdp-i** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP i line. |
| | **malformed-header-sdp-k** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP k line. |
| | **malformed-header-sdp-m** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP m line. |
| | **malformed-header-sdp-o** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP o line. |
| | **malformed-header-sdp-r** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP r line. |
| | **malformed-header-sdp-s** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP s line. |
| | **malformed-header-sdp-t** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP t line. |
| | **malformed-header-sdp-v** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP v line. |
| | **malformed-header-sdp-z** string | **Choices:*** pass
* discard
* respond
| Action for malformed SDP z line. |
| | **malformed-header-to** string | **Choices:*** pass
* discard
* respond
| Action for malformed To header. |
| | **malformed-header-via** string | **Choices:*** pass
* discard
* respond
| Action for malformed VIA header. |
| | **malformed-request-line** string | **Choices:*** pass
* discard
* respond
| Action for malformed request line. |
| | **max-body-length** integer | | Maximum SIP message body length (0 meaning no limit). |
| | **max-dialogs** integer | | Maximum number of concurrent calls/dialogs (per policy). |
| | **max-idle-dialogs** integer | | Maximum number established but idle dialogs to retain (per policy). |
| | **max-line-length** integer | | Maximum SIP header line length (78-4096). |
| | **message-rate** integer | | MESSAGE request rate limit (per second, per policy). |
| | **message-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **nat-port-range** string | | RTP NAT port range. |
| | **nat-trace** string | **Choices:*** disable
* enable
| Enable/disable preservation of original IP in SDP i line. |
| | **no-sdp-fixup** string | **Choices:*** disable
* enable
| Enable/disable no SDP fix-up. |
| | **notify-rate** integer | | NOTIFY request rate limit (per second, per policy). |
| | **notify-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **open-contact-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for non-REGISTER Contact port. |
| | **open-record-route-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Record-Route port. |
| | **open-register-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for REGISTER Contact port. |
| | **open-via-pinhole** string | **Choices:*** disable
* enable
| Enable/disable open pinhole for Via port. |
| | **options-rate** integer | | OPTIONS request rate limit (per second, per policy). |
| | **options-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **prack-rate** integer | | PRACK request rate limit (per second, per policy). |
| | **prack-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **preserve-override** string | **Choices:*** disable
* enable
| Override i line to preserve original IPS (default: append). |
| | **provisional-invite-expiry-time** integer | | Expiry time for provisional INVITE (10 - 3600 sec). |
| | **publish-rate** integer | | PUBLISH request rate limit (per second, per policy). |
| | **publish-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **refer-rate** integer | | REFER request rate limit (per second, per policy). |
| | **refer-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **register-contact-trace** string | **Choices:*** disable
* enable
| Enable/disable trace original IP/port within the contact header of REGISTER requests. |
| | **register-rate** integer | | REGISTER request rate limit (per second, per policy). |
| | **register-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **rfc2543-branch** string | **Choices:*** disable
* enable
| Enable/disable support via branch compliant with RFC 2543. |
| | **rtp** string | **Choices:*** disable
* enable
| Enable/disable create pinholes for RTP traffic to traverse firewall. |
| | **ssl-algorithm** string | **Choices:*** high
* medium
* low
| Relative strength of encryption algorithms accepted in negotiation. |
| | **ssl-auth-client** string | | Require a client certificate and authenticate it with the peer/peergrp. |
| | **ssl-auth-server** string | | Authenticate the servers certificate with the peer/peergrp. |
| | **ssl-client-certificate** string | | Name of Certificate to offer to server if requested. |
| | **ssl-client-renegotiation** string | **Choices:*** allow
* deny
* secure
| Allow/block client renegotiation by server. |
| | **ssl-max-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Highest SSL/TLS version to negotiate. |
| | **ssl-min-version** string | **Choices:*** ssl-3.0
* tls-1.0
* tls-1.1
* tls-1.2
* tls-1.3
| Lowest SSL/TLS version to negotiate. |
| | **ssl-mode** string | **Choices:*** off
* full
| SSL/TLS mode for encryption & decryption of traffic. |
| | **ssl-pfs** string | **Choices:*** require
* deny
* allow
| SSL Perfect Forward Secrecy. |
| | **ssl-send-empty-frags** string | **Choices:*** disable
* enable
| Send empty fragments to avoid attack on CBC IV (SSL 3.0 & TLS 1.0 only). |
| | **ssl-server-certificate** string | | Name of Certificate return to the client in every SSL connection. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SIP. |
| | **strict-register** string | **Choices:*** disable
* enable
| Enable/disable only allow the registrar to connect. |
| | **subscribe-rate** integer | | SUBSCRIBE request rate limit (per second, per policy). |
| | **subscribe-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| | **unknown-header** string | **Choices:*** pass
* discard
* respond
| Action for unknown SIP header. |
| | **update-rate** integer | | UPDATE request rate limit (per second, per policy). |
| | **update-rate-track** string | **Choices:*** none
* src-ip
* dest-ip
| Track the packet protocol field. |
| **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: SIP.
fmgr_voip_profile_sip:
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>
voip_profile_sip:
ack-rate: <value of integer>
block-ack: <value in [disable, enable]>
block-bye: <value in [disable, enable]>
block-cancel: <value in [disable, enable]>
block-geo-red-options: <value in [disable, enable]>
block-info: <value in [disable, enable]>
block-invite: <value in [disable, enable]>
block-long-lines: <value in [disable, enable]>
block-message: <value in [disable, enable]>
block-notify: <value in [disable, enable]>
block-options: <value in [disable, enable]>
block-prack: <value in [disable, enable]>
block-publish: <value in [disable, enable]>
block-refer: <value in [disable, enable]>
block-register: <value in [disable, enable]>
block-subscribe: <value in [disable, enable]>
block-unknown: <value in [disable, enable]>
block-update: <value in [disable, enable]>
bye-rate: <value of integer>
call-keepalive: <value of integer>
cancel-rate: <value of integer>
contact-fixup: <value in [disable, enable]>
hnt-restrict-source-ip: <value in [disable, enable]>
hosted-nat-traversal: <value in [disable, enable]>
info-rate: <value of integer>
invite-rate: <value of integer>
ips-rtp: <value in [disable, enable]>
log-call-summary: <value in [disable, enable]>
log-violations: <value in [disable, enable]>
malformed-header-allow: <value in [pass, discard, respond]>
malformed-header-call-id: <value in [pass, discard, respond]>
malformed-header-contact: <value in [pass, discard, respond]>
malformed-header-content-length: <value in [pass, discard, respond]>
malformed-header-content-type: <value in [pass, discard, respond]>
malformed-header-cseq: <value in [pass, discard, respond]>
malformed-header-expires: <value in [pass, discard, respond]>
malformed-header-from: <value in [pass, discard, respond]>
malformed-header-max-forwards: <value in [pass, discard, respond]>
malformed-header-p-asserted-identity: <value in [pass, discard, respond]>
malformed-header-rack: <value in [pass, discard, respond]>
malformed-header-record-route: <value in [pass, discard, respond]>
malformed-header-route: <value in [pass, discard, respond]>
malformed-header-rseq: <value in [pass, discard, respond]>
malformed-header-sdp-a: <value in [pass, discard, respond]>
malformed-header-sdp-b: <value in [pass, discard, respond]>
malformed-header-sdp-c: <value in [pass, discard, respond]>
malformed-header-sdp-i: <value in [pass, discard, respond]>
malformed-header-sdp-k: <value in [pass, discard, respond]>
malformed-header-sdp-m: <value in [pass, discard, respond]>
malformed-header-sdp-o: <value in [pass, discard, respond]>
malformed-header-sdp-r: <value in [pass, discard, respond]>
malformed-header-sdp-s: <value in [pass, discard, respond]>
malformed-header-sdp-t: <value in [pass, discard, respond]>
malformed-header-sdp-v: <value in [pass, discard, respond]>
malformed-header-sdp-z: <value in [pass, discard, respond]>
malformed-header-to: <value in [pass, discard, respond]>
malformed-header-via: <value in [pass, discard, respond]>
malformed-request-line: <value in [pass, discard, respond]>
max-body-length: <value of integer>
max-dialogs: <value of integer>
max-idle-dialogs: <value of integer>
max-line-length: <value of integer>
message-rate: <value of integer>
nat-trace: <value in [disable, enable]>
no-sdp-fixup: <value in [disable, enable]>
notify-rate: <value of integer>
open-contact-pinhole: <value in [disable, enable]>
open-record-route-pinhole: <value in [disable, enable]>
open-register-pinhole: <value in [disable, enable]>
open-via-pinhole: <value in [disable, enable]>
options-rate: <value of integer>
prack-rate: <value of integer>
preserve-override: <value in [disable, enable]>
provisional-invite-expiry-time: <value of integer>
publish-rate: <value of integer>
refer-rate: <value of integer>
register-contact-trace: <value in [disable, enable]>
register-rate: <value of integer>
rfc2543-branch: <value in [disable, enable]>
rtp: <value in [disable, enable]>
ssl-algorithm: <value in [high, medium, low]>
ssl-auth-client: <value of string>
ssl-auth-server: <value of string>
ssl-client-certificate: <value of string>
ssl-client-renegotiation: <value in [allow, deny, secure]>
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 [off, full]>
ssl-pfs: <value in [require, deny, allow]>
ssl-send-empty-frags: <value in [disable, enable]>
ssl-server-certificate: <value of string>
status: <value in [disable, enable]>
strict-register: <value in [disable, enable]>
subscribe-rate: <value of integer>
unknown-header: <value in [pass, discard, respond]>
update-rate: <value of integer>
nat-port-range: <value of string>
ack-rate-track: <value in [none, src-ip, dest-ip]>
bye-rate-track: <value in [none, src-ip, dest-ip]>
cancel-rate-track: <value in [none, src-ip, dest-ip]>
info-rate-track: <value in [none, src-ip, dest-ip]>
invite-rate-track: <value in [none, src-ip, dest-ip]>
malformed-header-no-proxy-require: <value in [pass, discard, respond]>
malformed-header-no-require: <value in [pass, discard, respond]>
message-rate-track: <value in [none, src-ip, dest-ip]>
notify-rate-track: <value in [none, src-ip, dest-ip]>
options-rate-track: <value in [none, src-ip, dest-ip]>
prack-rate-track: <value in [none, src-ip, dest-ip]>
publish-rate-track: <value in [none, src-ip, dest-ip]>
refer-rate-track: <value in [none, src-ip, dest-ip]>
register-rate-track: <value in [none, src-ip, dest-ip]>
subscribe-rate-track: <value in [none, src-ip, dest-ip]>
update-rate-track: <value in [none, src-ip, dest-ip]>
```
Return Values
-------------
Common return 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_decryptedtrafficmirror – Configure decrypted traffic mirror. fortinet.fortimanager.fmgr\_firewall\_decryptedtrafficmirror – Configure decrypted traffic mirror.
==================================================================================================
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_decryptedtrafficmirror`.
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\_decryptedtrafficmirror** dictionary | | the top level parameters set |
| | **dstmac** string | | Set destination MAC address for mirrored traffic. |
| | **interface** string | | Decrypted traffic mirror interface |
| | **name** string | | Name. |
| | **traffic-source** string | **Choices:*** client
* server
* both
| Source of decrypted traffic to be mirrored. |
| | **traffic-type** list / elements=string | **Choices:*** ssl
* ssh
| 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 decrypted traffic mirror.
fmgr_firewall_decryptedtrafficmirror:
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_decryptedtrafficmirror:
dstmac: <value of string>
interface: <value of string>
name: <value of string>
traffic-source: <value in [client, server, both]>
traffic-type:
- ssl
- ssh
```
Return Values
-------------
Common return 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_service – Enable/disable services provided by the built-in FortiGuard. fortinet.fortimanager.fmgr\_fmupdate\_service – Enable/disable services provided by the built-in FortiGuard.
============================================================================================================
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_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 |
| --- | --- | --- |
| **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\_service** dictionary | | the top level parameters set |
| | **avips** string | **Choices:*** disable
* **enable** ←
| Enable/disable the built-in FortiGuard to provide FortiGuard antivirus and IPS updates (default = enable). disable - Disable setting. enable - Enable setting. |
| | **query-antispam** string | **Choices:*** **disable** ←
* enable
| Enable/disable antispam service (default = disable). disable - Disable setting. enable - Enable setting. |
| | **query-antivirus** string | **Choices:*** **disable** ←
* enable
| Enable/disable antivirus query service (default = disable). disable - Disable setting. enable - Enable setting. |
| | **query-filequery** string | **Choices:*** **disable** ←
* enable
| Enable/disable file query service (default = disable). disable - Disable setting. enable - Enable setting. |
| | **query-geoip** string | **Choices:*** disable
* **enable** ←
| Enable/disable geoip service (default = enable). disable - Disable setting. enable - Enable setting. |
| | **query-outbreak-prevention** string | **Choices:*** **disable** ←
* enable
| Enable/disable outbreak prevention query service (default = disable). disable - Disable setting. enable - Enable setting. |
| | **query-webfilter** string | **Choices:*** **disable** ←
* enable
| Enable/disable Web Filter service (default = disable). disable - Disable setting. enable - Enable setting. |
| | **webfilter-https-traversal** string | **Choices:*** **disable** ←
* enable
| Enable/disable Web Filter HTTPS traversal (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 services provided by the built-in FortiGuard.
fmgr_fmupdate_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, ...]
fmupdate_service:
avips: <value in [disable, enable]>
query-antispam: <value in [disable, enable]>
query-antivirus: <value in [disable, enable]>
query-filequery: <value in [disable, enable]>
query-geoip: <value in [disable, enable]>
query-outbreak-prevention: <value in [disable, enable]>
query-webfilter: <value in [disable, enable]>
webfilter-https-traversal: <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_switchcontroller_managedswitch_ipsourceguard – IP source guard. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_ipsourceguard – IP source guard.
=============================================================================================
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_ipsourceguard`.
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\_ipsourceguard** dictionary | | the top level parameters set |
| | **binding-entry** list / elements=string | | no description |
| | | **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 | | Ingress interface to which source guard is bound. |
| **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: IP source guard.
fmgr_switchcontroller_managedswitch_ipsourceguard:
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_ipsourceguard:
binding-entry:
-
entry-name: <value of string>
ip: <value of string>
mac: <value of string>
description: <value of string>
port: <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_gtp_messagefilterv2 – Message filter for GTPv2 messages. fortinet.fortimanager.fmgr\_gtp\_messagefilterv2 – Message filter for GTPv2 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_gtp_messagefilterv2`.
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 |
| **gtp\_messagefilterv2** dictionary | | the top level parameters set |
| | **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 | | 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** integer | | no description |
| | **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). |
| **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: Message filter for GTPv2 messages.
fmgr_gtp_messagefilterv2:
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]>
gtp_messagefilterv2:
bearer-resource-cmd-fail: <value in [allow, deny]>
change-notification: <value in [allow, deny]>
create-bearer: <value in [allow, deny]>
create-session: <value in [allow, deny]>
delete-bearer-cmd-fail: <value in [allow, deny]>
delete-bearer-req-resp: <value in [allow, deny]>
delete-pdn-connection-set: <value in [allow, deny]>
delete-session: <value in [allow, deny]>
echo: <value in [allow, deny]>
modify-bearer-cmd-fail: <value in [allow, deny]>
modify-bearer-req-resp: <value in [allow, deny]>
name: <value of string>
resume: <value in [allow, deny]>
suspend: <value in [allow, deny]>
trace-session: <value in [allow, deny]>
unknown-message: <value in [allow, deny]>
unknown-message-white-list: <value of integer>
update-bearer: <value in [allow, deny]>
update-pdn-connection-set: <value in [allow, deny]>
version-not-support: <value in [allow, deny]>
```
Return Values
-------------
Common return 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_vip46_realservers – Real servers. fortinet.fortimanager.fmgr\_firewall\_vip46\_realservers – Real servers.
========================================================================
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_vip46_realservers`.
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\_vip46\_realservers** dictionary | | the top level parameters set |
| | **client-ip** string | | Restrict server to a client IP in this range. |
| | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | **holddown-interval** integer | | Hold down interval. |
| | **id** integer | | Real server ID. |
| | **ip** string | | Mapped server IPv6. |
| | **max-connections** integer | | Maximum number of connections allowed to server. |
| | **monitor** string | | Health monitors. |
| | **port** integer | | Mapped server port. |
| | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | **weight** integer | | 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 |
| **vip46** string / required | | the parameter (vip46) 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: Real servers.
fmgr_firewall_vip46_realservers:
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>
vip46: <your own value>
state: <value in [present, absent]>
firewall_vip46_realservers:
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
id: <value of integer>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
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_firewall_address6_dynamicmapping_subnetsegment – IPv6 subnet segments. fortinet.fortimanager.fmgr\_firewall\_address6\_dynamicmapping\_subnetsegment – IPv6 subnet segments.
=====================================================================================================
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_address6_dynamicmapping_subnetsegment`.
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 |
| --- | --- | --- |
| **address6** string / required | | the parameter (address6) 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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_address6\_dynamicmapping\_subnetsegment** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **type** string | **Choices:*** any
* specific
| no description |
| | **value** 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: IPv6 subnet segments.
fmgr_firewall_address6_dynamicmapping_subnetsegment:
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>
address6: <your own value>
dynamic_mapping: <your own value>
state: <value in [present, absent]>
firewall_address6_dynamicmapping_subnetsegment:
name: <value of string>
type: <value in [any, specific]>
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)
ansible fortinet.fortimanager.fmgr_pm_config_metafields_firewall_centralsnatmap – no description fortinet.fortimanager.fmgr\_pm\_config\_metafields\_firewall\_centralsnatmap – 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_pm_config_metafields_firewall_centralsnatmap`.
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 |
| **pm\_config\_metafields\_firewall\_centralsnatmap** dictionary | | the top level parameters set |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **length** integer | | 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_pm_config_metafields_firewall_centralsnatmap:
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, ...]
pm_config_metafields_firewall_centralsnatmap:
importance: <value in [optional, required]>
length: <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_antivirus_profile_nacquar – Configure AntiVirus quarantine settings. fortinet.fortimanager.fmgr\_antivirus\_profile\_nacquar – Configure AntiVirus quarantine 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_nacquar`.
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\_nacquar** dictionary | | the top level parameters set |
| | **expiry** string | | Duration of quarantine. |
| | **infected** string | **Choices:*** none
* quar-src-ip
* quar-interface
| Enable/Disable quarantining infected hosts to the banned user list. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable AntiVirus quarantine logging. |
| **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 AntiVirus quarantine settings.
fmgr_antivirus_profile_nacquar:
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_nacquar:
expiry: <value of string>
infected: <value in [none, quar-src-ip, quar-interface]>
log: <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_dm – Configure dm. fortinet.fortimanager.fmgr\_system\_dm – Configure dm.
======================================================
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_dm`.
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\_dm** dictionary | | the top level parameters set |
| | **concurrent-install-image-limit** integer | **Default:**500 | Maximum number of concurrent install image (1 - 1000). |
| | **concurrent-install-limit** integer | **Default:**480 | Maximum number of concurrent installs (5 - 2000). |
| | **concurrent-install-script-limit** integer | **Default:**480 | Maximum number of concurrent install scripts (5 - 2000). |
| | **conf-merge-after-script** string | **Choices:*** **disable** ←
* enable
| Merge config after run script on remote device, instead of full retrieve. disable - Disable. enable - Enable. |
| | **discover-timeout** integer | **Default:**6 | Check connection timeout when discover device (3 - 15). |
| | **dpm-logsize** integer | **Default:**10000 | Maximum dpm log size per device (1 - 10000K). |
| | **fgfm-install-refresh-count** integer | **Default:**10 | Maximum FGFM install refresh attempt. |
| | **fgfm-sock-timeout** integer | **Default:**360 | Maximum FGFM socket idle time (90 - 1800 sec). |
| | **fgfm\_keepalive\_itvl** integer | **Default:**120 | FGFM protocol keep alive interval (30 - 600 sec). |
| | **force-remote-diff** string | **Choices:*** **disable** ←
* enable
| Always use remote diff when installing. disable - Disable. enable - Enable. |
| | **fortiap-refresh-cnt** integer | **Default:**500 | Max auto refresh FortiAP number each time (1 - 10000). |
| | **fortiap-refresh-itvl** integer | **Default:**10 | Auto refresh FortiAP status interval (0 - 1440) minutes, set to 0 will disable auto refresh. |
| | **fortiext-refresh-cnt** integer | **Default:**50 | Max device number for FortiExtender auto refresh (1 - 10000). |
| | **install-image-timeout** integer | **Default:**3600 | Maximum waiting time for image transfer and device upgrade (600 - 7200 sec). |
| | **install-tunnel-retry-itvl** integer | **Default:**60 | Time to re-establish tunnel during install (10 - 60 sec). |
| | **max-revs** integer | **Default:**100 | Maximum number of revisions saved (1 - 250). |
| | **nr-retry** integer | **Default:**1 | Number of retries. |
| | **retry** string | **Choices:*** disable
* **enable** ←
| Enable/disable configuration install retry. disable - Disable. enable - Enable. |
| | **retry-intvl** integer | **Default:**15 | Retry interval. |
| | **rollback-allow-reboot** string | **Choices:*** **disable** ←
* enable
| Enable/disable FortiGate reboot to rollback when installing script/config. disable - Disable. enable - Enable. |
| | **script-logsize** integer | **Default:**100 | Maximum script log size per device (1 - 10000K). |
| | **skip-scep-check** string | **Choices:*** **disable** ←
* enable
| Enable/disable installing scep related objects even if scep url is configured. disable - Disable. enable - Enable. |
| | **skip-tunnel-fcp-req** string | **Choices:*** disable
* **enable** ←
| Enable/disable skip the fcp request sent from fgfm tunnel disable - Disable. enable - Enable. |
| | **verify-install** string | **Choices:*** disable
* optimal
* **enable** ←
| Verify install against remote configuration. disable - Disable. optimal - Verify installation for command errors. enable - Always verify installation. |
| **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 dm.
fmgr_system_dm:
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_dm:
concurrent-install-image-limit: <value of integer>
concurrent-install-limit: <value of integer>
concurrent-install-script-limit: <value of integer>
discover-timeout: <value of integer>
dpm-logsize: <value of integer>
fgfm-sock-timeout: <value of integer>
fgfm_keepalive_itvl: <value of integer>
force-remote-diff: <value in [disable, enable]>
fortiap-refresh-cnt: <value of integer>
fortiap-refresh-itvl: <value of integer>
fortiext-refresh-cnt: <value of integer>
install-image-timeout: <value of integer>
install-tunnel-retry-itvl: <value of integer>
max-revs: <value of integer>
nr-retry: <value of integer>
retry: <value in [disable, enable]>
retry-intvl: <value of integer>
rollback-allow-reboot: <value in [disable, enable]>
script-logsize: <value of integer>
skip-scep-check: <value in [disable, enable]>
skip-tunnel-fcp-req: <value in [disable, enable]>
verify-install: <value in [disable, optimal, enable]>
fgfm-install-refresh-count: <value of integer>
conf-merge-after-script: <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_dvmdb_workflow_discard – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_discard – 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_discard`.
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_discard:
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_securityconsole_import_dev_objs – Import objects from device to ADOM, or from ADOM to Global. fortinet.fortimanager.fmgr\_securityconsole\_import\_dev\_objs – Import objects from device to ADOM, or from ADOM to Global.
============================================================================================================================
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_securityconsole_import_dev_objs`.
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 |
| **securityconsole\_import\_dev\_objs** dictionary | | the top level parameters set |
| | **add\_mappings** string | **Choices:*** **disable** ←
* enable
| Automatically add required dynamic mappings for the device during the search stages.<br/>When used in policy\_search action, ad... |
| | **adom** string | | Source ADOM name. |
| | **dst\_name** string | | Name of the policy package where the objects are to be imported. If the package does not already exist in the database, a new ... |
| | **dst\_parent** string | | Path to the folder for the target package. If the package is to be placed in root, leave this field blank. |
| | **if\_all\_objs** string | **Choices:*** **none** ←
* all
* filter
| no description |
| | **if\_all\_policy** string | **Choices:*** **disable** ←
* enable
| no description |
| | **import\_action** string | **Choices:*** **do** ←
* policy\_search
* obj\_search
| do - Perform the policy and object import. policy\_search - Preprocess and scan through device database to gather information about policies that need to be imported. Can automatic... obj\_search - Preprocess and scan through device database to collect objects that are required to be imported. Can automatically add obje... |
| | **name** string | | Source device name. |
| | **position** string | **Choices:*** bottom
* **top** ←
| no description |
| | **vdom** 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: Import objects from device to ADOM, or from ADOM to Global.
fmgr_securityconsole_import_dev_objs:
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, ...]
securityconsole_import_dev_objs:
add_mappings: <value in [disable, enable]>
adom: <value of string>
dst_name: <value of string>
dst_parent: <value of string>
if_all_objs: <value in [none, all, filter]>
if_all_policy: <value in [disable, enable]>
import_action: <value in [do, policy_search, obj_search]>
name: <value of string>
position: <value in [bottom, top]>
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)
ansible fortinet.fortimanager.fmgr_system_replacemsggroup_devicedetectionportal – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_devicedetectionportal – 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_devicedetectionportal`.
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\_devicedetectionportal** 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. |
| **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_devicedetectionportal:
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_devicedetectionportal:
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_application_list – Configure application control lists. fortinet.fortimanager.fmgr\_application\_list – Configure application control lists.
====================================================================================
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`.
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** dictionary | | the top level parameters set |
| | **app-replacemsg** string | **Choices:*** disable
* enable
| Enable/disable replacement messages for blocked applications. |
| | **comment** string | | comments |
| | **control-default-network-services** string | **Choices:*** disable
* enable
| Enable/disable enforcement of protocols over selected ports. |
| | **deep-app-inspection** string | **Choices:*** disable
* enable
| Enable/disable deep application inspection. |
| | **default-network-services** list / elements=string | | no description |
| | | **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. |
| | **enforce-default-app-port** string | **Choices:*** disable
* enable
| Enable/disable default application port enforcement for allowed applications. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* reset
| Pass or block traffic, or reset connection for traffic from this application. |
| | | **application** integer | | no description |
| | | **behavior** string | | no description |
| | | **category** string | | Category ID list. |
| | | **exclusion** integer | | no description |
| | | **id** integer | | Entry ID. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging for this application list. |
| | | **log-packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | | **parameters** list / elements=string | | no description |
| | | | **id** integer | | Parameter ID. |
| | | | **members** list / elements=string | | no description |
| | | | | **id** integer | | Parameter. |
| | | | | **name** string | | Parameter name. |
| | | | | **value** string | | Parameter value. |
| | | | **value** string | | Parameter value. |
| | | **per-ip-shaper** string | | Per-IP traffic shaper. |
| | | **popularity** list / elements=string | **Choices:*** 1
* 2
* 3
* 4
* 5
| no description |
| | | **protocols** string | | no description |
| | | **quarantine** string | **Choices:*** none
* attacker
| Quarantine method. |
| | | **quarantine-expiry** string | | Duration of quarantine. (Format ###d##h##m, minimum 1m, maximum 364d23h59m, default = 5m). Requires quarantine set to ... |
| | | **quarantine-log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **rate-count** integer | | Count of the rate. |
| | | **rate-duration** integer | | Duration (sec) of the rate. |
| | | **rate-mode** string | **Choices:*** periodical
* continuous
| Rate limit mode. |
| | | **rate-track** string | **Choices:*** none
* src-ip
* dest-ip
* dhcp-client-mac
* dns-domain
| Track the packet protocol field. |
| | | **risk** integer | | no description |
| | | **session-ttl** integer | | Session TTL (0 = default). |
| | | **shaper** string | | Traffic shaper. |
| | | **shaper-reverse** string | | Reverse traffic shaper. |
| | | **sub-category** integer | | no description |
| | | **technology** string | | no description |
| | | **vendor** string | | no description |
| | **extended-log** string | **Choices:*** disable
* enable
| Enable/disable extended logging. |
| | **force-inclusion-ssl-di-sigs** string | **Choices:*** disable
* enable
| Enable/disable forced inclusion of SSL deep inspection signatures. |
| | **name** string | | List name. |
| | **options** list / elements=string | **Choices:*** allow-dns
* allow-icmp
* allow-http
* allow-ssl
* allow-quic
| no description |
| | **other-application-action** string | **Choices:*** pass
* block
| Action for other applications. |
| | **other-application-log** string | **Choices:*** disable
* enable
| Enable/disable logging for other applications. |
| | **p2p-black-list** list / elements=string | **Choices:*** skype
* edonkey
* bittorrent
| no description |
| | **p2p-block-list** list / elements=string | **Choices:*** skype
* edonkey
* bittorrent
| no description |
| | **replacemsg-group** string | | Replacement message group. |
| | **unknown-application-action** string | **Choices:*** pass
* block
| Pass or block traffic from unknown applications. |
| | **unknown-application-log** string | **Choices:*** disable
* enable
| Enable/disable logging for unknown applications. |
| **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 |
| **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 application control lists.
fmgr_application_list:
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]>
application_list:
app-replacemsg: <value in [disable, enable]>
comment: <value of string>
deep-app-inspection: <value in [disable, enable]>
entries:
-
action: <value in [pass, block, reset]>
application: <value of integer>
behavior: <value of string>
category: <value of string>
id: <value of integer>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
parameters:
-
id: <value of integer>
value: <value of string>
members:
-
id: <value of integer>
name: <value of string>
value: <value of string>
per-ip-shaper: <value of string>
popularity:
- 1
- 2
- 3
- 4
- 5
protocols: <value of string>
quarantine: <value in [none, attacker]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
rate-count: <value of integer>
rate-duration: <value of integer>
rate-mode: <value in [periodical, continuous]>
rate-track: <value in [none, src-ip, dest-ip, ...]>
risk: <value of integer>
session-ttl: <value of integer>
shaper: <value of string>
shaper-reverse: <value of string>
sub-category: <value of integer>
technology: <value of string>
vendor: <value of string>
exclusion: <value of integer>
extended-log: <value in [disable, enable]>
name: <value of string>
options:
- allow-dns
- allow-icmp
- allow-http
- allow-ssl
- allow-quic
other-application-action: <value in [pass, block]>
other-application-log: <value in [disable, enable]>
p2p-black-list:
- skype
- edonkey
- bittorrent
replacemsg-group: <value of string>
unknown-application-action: <value in [pass, block]>
unknown-application-log: <value in [disable, enable]>
control-default-network-services: <value in [disable, enable]>
default-network-services:
-
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]>
enforce-default-app-port: <value in [disable, enable]>
force-inclusion-ssl-di-sigs: <value in [disable, enable]>
p2p-block-list:
- skype
- edonkey
- bittorrent
```
Return Values
-------------
Common return 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_move – Move fortimanager defined Object. fortinet.fortimanager.fmgr\_move – Move fortimanager defined 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_move`.
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 |
| **move** dictionary | | the top level parameters set |
| **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.
* 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: fortimanager01
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Move a firewall vip object
fmgr_move:
move:
selector: 'firewall_vip'
target: 'ansible-test-vip_first'
action: 'before'
self:
adom: 'root'
vip: 'ansible-test-vip_second'
```
Return Values
-------------
Common return 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_noippolicy – No IP policy. fortinet.fortimanager.fmgr\_firewall\_gtp\_noippolicy – No IP 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_noippolicy`.
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\_noippolicy** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* deny
| Action. |
| | **end** integer | | End of protocol range (0 - 255). |
| | **id** integer | | ID. |
| | **start** integer | | Start of protocol range (0 - 255). |
| | **type** string | **Choices:*** etsi
* ietf
| Protocol field type. |
| **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: No IP policy.
fmgr_firewall_gtp_noippolicy:
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_noippolicy:
action: <value in [allow, deny]>
end: <value of integer>
id: <value of integer>
start: <value of integer>
type: <value in [etsi, ietf]>
```
Return Values
-------------
Common return 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_vipgrp – Configure IPv4 virtual IP groups. fortinet.fortimanager.fmgr\_firewall\_vipgrp – Configure IPv4 virtual IP 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_vipgrp`.
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\_vipgrp** dictionary | | the top level parameters set |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1). |
| | **comments** string | | Comment. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **color** integer | | no description |
| | | **comments** string | | no description |
| | | **interface** string | | no description |
| | | **member** string | | no description |
| | | **uuid** string | | no description |
| | **interface** string | | no description |
| | **member** string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | **name** string | | VIP group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 virtual IP groups.
fmgr_firewall_vipgrp:
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_vipgrp:
color: <value of integer>
comments: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
color: <value of integer>
comments: <value of string>
interface: <value of string>
member: <value of string>
uuid: <value of string>
interface: <value of string>
member: <value of string>
name: <value of string>
uuid: <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_service_group – Configure service groups. fortinet.fortimanager.fmgr\_firewall\_service\_group – Configure service 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_service_group`.
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\_service\_group** dictionary | | the top level parameters set |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | no description |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **global-object** integer | | Global Object. |
| | **member** string | | Service objects contained within the group. |
| | **name** string | | Address group name. |
| | **proxy** string | **Choices:*** disable
* enable
| Enable/disable web proxy service group. |
| **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 service groups.
fmgr_firewall_service_group:
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_service_group:
color: <value of integer>
comment: <value of string>
member: <value of string>
name: <value of string>
proxy: <value in [disable, enable]>
global-object: <value of integer>
fabric-object: <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_vpnsslweb_portal_bookmarkgroup_bookmarks – Bookmark table. fortinet.fortimanager.fmgr\_vpnsslweb\_portal\_bookmarkgroup\_bookmarks – Bookmark table.
=========================================================================================
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`.
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 |
| **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** dictionary | | the top level parameters set |
| | **additional-params** string | | Additional parameters. |
| | **apptype** string | **Choices:*** web
* telnet
* ssh
* ftp
* smb
* vnc
* rdp
* citrix
* rdpnative
* portforward
* sftp
| Application type. |
| | **description** string | | Description. |
| | **domain** string | | Login domain. |
| | **folder** string | | Network shared file folder parameter. |
| | **form-data** list / elements=string | | no description |
| | | **name** string | | 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 | | no description |
| | **logon-user** string | | Logon user. |
| | **name** string | | 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:*** en-us-qwerty
* de-de-qwertz
* fr-fr-azerty
* it-it-qwerty
* sv-se-qwerty
* failsafe
* en-gb-qwerty
* es-es-qwerty
* fr-ch-qwertz
* ja-jp-qwerty
* pt-br-qwerty
* tr-tr-qwerty
* fr-ca-qwerty
| Server side keyboard layout. |
| | **show-status-window** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Single sign-on credentials are only sent once to remote server. |
| | **sso-password** string | | no description |
| | **sso-username** string | | SSO user name. |
| | **url** string | | URL parameter. |
| **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: Bookmark table.
fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks:
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>
state: <value in [present, absent]>
vpnsslweb_portal_bookmarkgroup_bookmarks:
additional-params: <value of string>
apptype: <value in [web, telnet, ssh, ...]>
description: <value of string>
folder: <value of string>
form-data:
-
name: <value of string>
value: <value of string>
host: <value of string>
listening-port: <value of integer>
load-balancing-info: <value of string>
logon-password: <value of string>
logon-user: <value of string>
name: <value of string>
port: <value of integer>
preconnection-blob: <value of string>
preconnection-id: <value of integer>
remote-port: <value of integer>
security: <value in [rdp, nla, tls, ...]>
server-layout: <value in [en-us-qwerty, de-de-qwertz, fr-fr-azerty, ...]>
show-status-window: <value in [disable, enable]>
sso: <value in [disable, static, auto]>
sso-credential: <value in [sslvpn-login, alternative]>
sso-credential-sent-once: <value in [disable, enable]>
sso-password: <value of string>
sso-username: <value of string>
url: <value of string>
domain: <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_icap_server – Configure ICAP servers. fortinet.fortimanager.fmgr\_icap\_server – Configure ICAP servers.
==================================================================
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_server`.
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\_server** dictionary | | the top level parameters set |
| | **ip-address** string | | IPv4 address of the ICAP server. |
| | **ip-version** string | **Choices:*** 4
* 6
| IP version. |
| | **ip6-address** string | | IPv6 address of the ICAP server. |
| | **max-connections** integer | | Maximum number of concurrent connections to ICAP server. |
| | **name** string | | Server name. |
| | **port** integer | | ICAP server port. |
| | **secure** string | **Choices:*** disable
* enable
| Enable/disable secure connection to ICAP server. |
| | **ssl-cert** string | | CA certificate 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 ICAP servers.
fmgr_icap_server:
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]>
icap_server:
ip-address: <value of string>
ip-version: <value in [4, 6]>
ip6-address: <value of string>
max-connections: <value of integer>
name: <value of string>
port: <value of integer>
secure: <value in [disable, enable]>
ssl-cert: <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_device_profile_fortiguard – no description fortinet.fortimanager.fmgr\_devprof\_device\_profile\_fortiguard – 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_devprof_device_profile_fortiguard`.
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\_device\_profile\_fortiguard** dictionary | | the top level parameters set |
| | **target** string | **Choices:*** none
* direct
* this-fmg
| no description |
| | **target-ip** string | | no description |
| **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: no description
fmgr_devprof_device_profile_fortiguard:
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_device_profile_fortiguard:
target: <value in [none, direct, this-fmg]>
target-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_pkg_firewall_interfacepolicy_sectionvalue – Configure IPv4 interface policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_interfacepolicy\_sectionvalue – Configure IPv4 interface policies.
=============================================================================================================
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_interfacepolicy_sectionvalue`.
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 |
| **interface-policy** string / required | | the parameter (interface-policy) in requested url |
| **pkg** string / required | | the parameter (pkg) in requested url |
| **pkg\_firewall\_interfacepolicy\_sectionvalue** dictionary | | the top level parameters set |
| | **attr** string | **Choices:*** label
* global-label
| 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: Configure IPv4 interface policies.
fmgr_pkg_firewall_interfacepolicy_sectionvalue:
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>
interface-policy: <your own value>
state: <value in [present, absent]>
pkg_firewall_interfacepolicy_sectionvalue:
attr: <value in [label, global-label]>
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_switchcontroller_managedswitch – Configure FortiSwitch devices that are managed by this FortiGate. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch – Configure FortiSwitch devices that are managed by this FortiGate.
===============================================================================================================================
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`.
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 |
| **switchcontroller\_managedswitch** dictionary | | the top level parameters set |
| | **\_platform** string | | no description |
| | **custom-command** list / elements=string | | no description |
| | | **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. |
| | **description** string | | Description. |
| | **firmware-provision** string | **Choices:*** disable
* enable
| 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). |
| | **ip-source-guard** list / elements=string | | no description |
| | | **binding-entry** list / elements=string | | no description |
| | | | **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 | | Ingress interface to which source guard is bound. |
| | **l3-discovered** integer | | no description |
| | **mclag-igmp-snooping-aware** string | **Choices:*** disable
* enable
| Enable/disable MCLAG IGMP-snooping awareness. |
| | **name** string | | Managed-switch name. |
| | **override-snmp-community** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable/disable overriding the global SNMP trap threshold values. |
| | **override-snmp-user** string | **Choices:*** disable
* enable
| Enable/disable overriding the global SNMP users. |
| | **poe-detection-type** integer | | no description |
| | **ports** list / elements=string | | no description |
| | | **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** string | | Configure switch port tagged vlans |
| | | **allowed-vlans-all** string | **Choices:*** disable
* enable
| Enable/disable all defined vlans on this port. |
| | | **arp-inspection-trust** string | **Choices:*** untrusted
* trusted
| Trusted or untrusted dynamic ARP inspection. |
| | | **bundle** string | **Choices:*** disable
* enable
| Enable/disable Link Aggregation Group (LAG) bundling for non-FortiLink interfaces. |
| | | **description** string | | Description for port. |
| | | **dhcp-snoop-option82-trust** string | **Choices:*** disable
* enable
| Enable/disable allowance of DHCP with option-82 on untrusted interface. |
| | | **dhcp-snooping** string | **Choices:*** trusted
* untrusted
| Trusted or untrusted DHCP-snooping interface. |
| | | **discard-mode** string | **Choices:*** none
* all-untagged
* all-tagged
| Configure discard mode for port. |
| | | **edge-port** string | **Choices:*** disable
* enable
| Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. |
| | | **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. |
| | | **flow-control** string | **Choices:*** disable
* tx
* rx
* both
| Flow control direction. |
| | | **igmp-snooping** string | **Choices:*** disable
* enable
| Set IGMP snooping mode for the physical port interface. |
| | | **igmps-flood-reports** string | **Choices:*** disable
* enable
| Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled. |
| | | **igmps-flood-traffic** string | **Choices:*** disable
* enable
| Enable/disable flooding of IGMP snooping traffic to this interface. |
| | | **ip-source-guard** string | **Choices:*** disable
* enable
| Enable/disable IP source guard. |
| | | **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. |
| | | **lldp-status** string | **Choices:*** disable
* rx-only
* tx-only
* tx-rx
| LLDP transmit and receive status. |
| | | **loop-guard** string | **Choices:*** disabled
* enabled
| 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, default = 45). |
| | | **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, default = 24) |
| | | **mclag** string | **Choices:*** disable
* enable
| Enable/disable multi-chassis link aggregation (MCLAG). |
| | | **mclag-icl-port** integer | | no description |
| | | **media-type** string | | no description |
| | | **member-withdrawal-behavior** string | **Choices:*** forward
* block
| Port behavior after it withdraws because of loss of control packets. |
| | | **members** string | | no description |
| | | **min-bundle** integer | | Minimum size of LAG bundle (1 - 24, default = 1) |
| | | **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 | | no description |
| | | **packet-sample-rate** integer | | Packet sampling rate (0 - 99999 p/sec). |
| | | **packet-sampler** string | **Choices:*** disabled
* enabled
| Enable/disable packet sampling on this interface. |
| | | **pause-meter** integer | | Configure ingress pause metering rate, in kbps (default = 0, disabled). |
| | | **pause-meter-resume** string | **Choices:*** 25%
* 50%
* 75%
| Resume threshold for resuming traffic on ingress port. |
| | | **poe-pre-standard-detection** string | **Choices:*** disable
* enable
| Enable/disable PoE pre-standard detection. |
| | | **poe-status** string | **Choices:*** disable
* enable
| Enable/disable PoE status. |
| | | **port-name** string | | Switch port name. |
| | | **port-owner** string | | Switch port name. |
| | | **port-policy** string | | Switch controller dynamic port policy from available options. |
| | | **port-security-policy** string | | Switch controller authentication policy to apply to this managed switch from available options. |
| | | **port-selection-criteria** string | **Choices:*** src-mac
* dst-mac
* src-dst-mac
* src-ip
* dst-ip
* src-dst-ip
| Algorithm for aggregate port selection. |
| | | **qos-policy** string | | Switch controller QoS policy from available options. |
| | | **rpvst-port** string | **Choices:*** disabled
* enabled
| Enable/disable inter-operability with rapid PVST on this interface. |
| | | **sample-direction** string | **Choices:*** rx
* tx
* 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:*** disabled
* enabled
| Enable/disable sFlow protocol on this interface. |
| | | **status** string | **Choices:*** down
* up
| Switch port admin status: up or down. |
| | | **sticky-mac** string | **Choices:*** disable
* enable
| Enable or disable sticky-mac on the interface. |
| | | **storm-control-policy** string | | Switch controller storm control policy from available options. |
| | | **stp-bpdu-guard** string | **Choices:*** disabled
* enabled
| 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:*** disabled
* enabled
| Enable/disable STP root guard on this interface. |
| | | **stp-state** string | **Choices:*** disabled
* enabled
| Enable/disable Spanning Tree Protocol (STP) on this interface. |
| | | **trunk-member** integer | | Trunk member. |
| | | **type** string | **Choices:*** physical
* trunk
| Interface type: physical or trunk port. |
| | | **untagged-vlans** string | | Configure switch port untagged vlans |
| | | **vlan** string | | Assign switch ports to a VLAN. |
| | **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 | | no description |
| | | **csv** string | **Choices:*** disable
* enable
| 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 | | 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:*** disable
* enable
| Enable/disable logging by FortiSwitch device to a remote syslog server. |
| | **snmp-community** list / elements=string | | no description |
| | | **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. |
| | **snmp-user** list / elements=string | | no description |
| | | **auth-proto** string | **Choices:*** md5
* sha
| Authentication protocol. |
| | | **auth-pwd** string | | no description |
| | | **name** string | | SNMP user name. |
| | | **priv-proto** string | **Choices:*** des
* aes
| Privacy (encryption) protocol. |
| | | **priv-pwd** string | | no description |
| | | **queries** string | **Choices:*** disable
* enable
| Enable/disable SNMP queries for this user. |
| | | **query-port** integer | | SNMPv3 query port (default = 161). |
| | | **security-level** string | **Choices:*** no-auth-no-priv
* auth-no-priv
* auth-priv
| Security level for message authentication and encryption. |
| | **switch-dhcp\_opt43\_key** string | | DHCP option43 key. |
| | **switch-id** string | | Managed-switch id. |
| | **tdr-supported** 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: Configure FortiSwitch devices that are managed by this FortiGate.
fmgr_switchcontroller_managedswitch:
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]>
switchcontroller_managedswitch:
_platform: <value of string>
description: <value of string>
name: <value of string>
ports:
-
allowed-vlans: <value of string>
allowed-vlans-all: <value in [disable, enable]>
arp-inspection-trust: <value in [untrusted, trusted]>
bundle: <value in [disable, enable]>
description: <value of string>
dhcp-snoop-option82-trust: <value in [disable, enable]>
dhcp-snooping: <value in [trusted, untrusted]>
discard-mode: <value in [none, all-untagged, all-tagged]>
edge-port: <value in [disable, enable]>
igmp-snooping: <value in [disable, enable]>
igmps-flood-reports: <value in [disable, enable]>
igmps-flood-traffic: <value in [disable, enable]>
lacp-speed: <value in [slow, fast]>
learning-limit: <value of integer>
lldp-profile: <value of string>
lldp-status: <value in [disable, rx-only, tx-only, ...]>
loop-guard: <value in [disabled, enabled]>
loop-guard-timeout: <value of integer>
max-bundle: <value of integer>
mclag: <value in [disable, enable]>
member-withdrawal-behavior: <value in [forward, block]>
members: <value of string>
min-bundle: <value of integer>
mode: <value in [static, lacp-passive, lacp-active]>
poe-pre-standard-detection: <value in [disable, enable]>
poe-status: <value in [disable, enable]>
port-name: <value of string>
port-owner: <value of string>
port-security-policy: <value of string>
port-selection-criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
qos-policy: <value of string>
sample-direction: <value in [rx, tx, both]>
sflow-counter-interval: <value of integer>
sflow-sample-rate: <value of integer>
sflow-sampler: <value in [disabled, enabled]>
stp-bpdu-guard: <value in [disabled, enabled]>
stp-bpdu-guard-timeout: <value of integer>
stp-root-guard: <value in [disabled, enabled]>
stp-state: <value in [disabled, enabled]>
type: <value in [physical, trunk]>
untagged-vlans: <value of string>
vlan: <value of string>
export-to-pool-flag: <value of integer>
mac-addr: <value of string>
packet-sample-rate: <value of integer>
packet-sampler: <value in [disabled, enabled]>
sticky-mac: <value in [disable, enable]>
storm-control-policy: <value of string>
access-mode: <value in [normal, nac, dynamic, ...]>
ip-source-guard: <value in [disable, enable]>
mclag-icl-port: <value of integer>
p2p-port: <value of integer>
aggregator-mode: <value in [bandwidth, count]>
rpvst-port: <value in [disabled, enabled]>
flow-control: <value in [disable, tx, rx, ...]>
media-type: <value of string>
pause-meter: <value of integer>
pause-meter-resume: <value in [25%, 50%, 75%]>
trunk-member: <value of integer>
fec-capable: <value of integer>
fec-state: <value in [disabled, cl74, cl91]>
matched-dpp-intf-tags: <value of string>
matched-dpp-policy: <value of string>
port-policy: <value of string>
status: <value in [down, up]>
switch-id: <value of string>
override-snmp-community: <value in [disable, enable]>
override-snmp-sysinfo: <value in [disable, enable]>
override-snmp-trap-threshold: <value in [disable, enable]>
override-snmp-user: <value in [disable, enable]>
poe-detection-type: <value of integer>
remote-log:
-
csv: <value in [disable, enable]>
facility: <value in [kernel, user, mail, ...]>
name: <value of string>
port: <value of integer>
server: <value of string>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
snmp-community:
-
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]>
snmp-user:
-
auth-proto: <value in [md5, sha]>
auth-pwd: <value of string>
name: <value of string>
priv-proto: <value in [des, aes]>
priv-pwd: <value of string>
queries: <value in [disable, enable]>
query-port: <value of integer>
security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
mclag-igmp-snooping-aware: <value in [disable, enable]>
ip-source-guard:
-
binding-entry:
-
entry-name: <value of string>
ip: <value of string>
mac: <value of string>
description: <value of string>
port: <value of string>
l3-discovered: <value of integer>
qos-drop-policy: <value in [taildrop, random-early-detection]>
qos-red-probability: <value of integer>
switch-dhcp_opt43_key: <value of string>
tdr-supported: <value of string>
custom-command:
-
command-entry: <value of string>
command-name: <value of string>
firmware-provision: <value in [disable, enable]>
firmware-provision-version: <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_pkg_footer_policy6 – Configure IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_footer\_policy6 – Configure IPv6 policies.
===========================================================================
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_footer_policy6`.
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 |
| **pkg** string / required | | the parameter (pkg) in requested url |
| **pkg\_footer\_policy6** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
* ipsec
* ssl-vpn
| no description |
| | **anti-replay** string | **Choices:*** disable
* enable
| no description |
| | **app-category** string | | no description |
| | **app-group** string | | no description |
| | **application** integer | | no description |
| | **application-charts** list / elements=string | **Choices:*** top10-app
* top10-p2p-user
* top10-media-user
| no description |
| | **application-list** string | | no description |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| no description |
| | **av-profile** string | | no description |
| | **casi-profile** string | | no description |
| | **cgn-log-server-grp** string | | no description |
| | **cifs-profile** string | | no description |
| | **comments** string | | no description |
| | **custom-log-fields** string | | no description |
| | **decrypted-traffic-mirror** string | | no description |
| | **deep-inspection-options** string | | no description |
| | **device-detection-portal** string | **Choices:*** disable
* enable
| no description |
| | **devices** string | | no description |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| no description |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| no description |
| | **diffservcode-forward** string | | no description |
| | **diffservcode-rev** string | | no description |
| | **dlp-sensor** string | | no description |
| | **dnsfilter-profile** string | | no description |
| | **dscp-match** string | **Choices:*** disable
* enable
| no description |
| | **dscp-negate** string | **Choices:*** disable
* enable
| no description |
| | **dscp-value** string | | no description |
| | **dsri** string | **Choices:*** disable
* enable
| no description |
| | **dstaddr** string | | no description |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| no description |
| | **dstintf** string | | no description |
| | **dynamic-profile** string | **Choices:*** disable
* enable
| no description |
| | **dynamic-profile-access** list / elements=string | **Choices:*** imap
* smtp
* pop3
* http
* ftp
* im
* nntp
* imaps
* smtps
* pop3s
* https
* ftps
| no description |
| | **dynamic-profile-group** string | | no description |
| | **email-collection-portal** string | **Choices:*** disable
* enable
| no description |
| | **emailfilter-profile** string | | no description |
| | **file-filter-profile** string | | no description |
| | **firewall-session-dirty** string | **Choices:*** check-all
* check-new
| no description |
| | **fixedport** string | **Choices:*** disable
* enable
| no description |
| | **fsae** string | **Choices:*** disable
* enable
| no description |
| | **fsso-groups** string | | no description |
| | **global-label** string | | no description |
| | **groups** string | | no description |
| | **http-policy-redirect** string | **Choices:*** disable
* enable
| no description |
| | **icap-profile** string | | no description |
| | **identity-based** string | **Choices:*** disable
* enable
| no description |
| | **identity-based-policy6** list / elements=string | | no description |
| | | **action** string | **Choices:*** deny
* accept
| no description |
| | | **application-list** string | | no description |
| | | **av-profile** string | | no description |
| | | **deep-inspection-options** string | | no description |
| | | **devices** string | | no description |
| | | **dlp-sensor** string | | no description |
| | | **endpoint-compliance** string | **Choices:*** disable
* enable
| no description |
| | | **groups** string | | no description |
| | | **icap-profile** string | | no description |
| | | **id** integer | | no description |
| | | **ips-sensor** string | | no description |
| | | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| no description |
| | | **mms-profile** string | | no description |
| | | **per-ip-shaper** string | | no description |
| | | **profile-group** string | | no description |
| | | **profile-protocol-options** string | | no description |
| | | **profile-type** string | **Choices:*** single
* group
| no description |
| | | **replacemsg-group** string | | no description |
| | | **schedule** string | | no description |
| | | **send-deny-packet** string | **Choices:*** disable
* enable
| no description |
| | | **service** string | | no description |
| | | **service-negate** string | **Choices:*** disable
* enable
| no description |
| | | **spamfilter-profile** string | | no description |
| | | **sslvpn-portal** string | | no description |
| | | **sslvpn-realm** string | | no description |
| | | **traffic-shaper** string | | no description |
| | | **traffic-shaper-reverse** string | | no description |
| | | **utm-status** string | **Choices:*** disable
* enable
| no description |
| | | **voip-profile** string | | no description |
| | | **webfilter-profile** string | | no description |
| | **identity-from** string | **Choices:*** auth
* device
| no description |
| | **inbound** string | **Choices:*** disable
* enable
| no description |
| | **inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | **ippool** string | **Choices:*** disable
* enable
| no description |
| | **ips-sensor** string | | no description |
| | **label** string | | no description |
| | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| no description |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| no description |
| | **mms-profile** string | | no description |
| | **name** string | | no description |
| | **nat** string | **Choices:*** disable
* enable
| no description |
| | **natinbound** string | **Choices:*** disable
* enable
| no description |
| | **natoutbound** string | **Choices:*** disable
* enable
| no description |
| | **np-accelation** string | **Choices:*** disable
* enable
| no description |
| | **np-acceleration** string | **Choices:*** disable
* enable
| no description |
| | **outbound** string | **Choices:*** disable
* enable
| no description |
| | **per-ip-shaper** string | | no description |
| | **policy-offload** string | **Choices:*** disable
* enable
| no description |
| | **policyid** integer | | no description |
| | **poolname** string | | no description |
| | **profile-group** string | | no description |
| | **profile-protocol-options** string | | no description |
| | **profile-type** string | **Choices:*** single
* group
| no description |
| | **replacemsg-group** string | | no description |
| | **replacemsg-override-group** string | | no description |
| | **rsso** string | **Choices:*** disable
* enable
| no description |
| | **schedule** string | | no description |
| | **send-deny-packet** string | **Choices:*** disable
* enable
| no description |
| | **service** string | | no description |
| | **service-negate** string | **Choices:*** disable
* enable
| no description |
| | **session-ttl** integer | | no description |
| | **spamfilter-profile** string | | no description |
| | **srcaddr** string | | no description |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| no description |
| | **srcintf** string | | no description |
| | **ssh-filter-profile** string | | no description |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| no description |
| | **ssl-mirror** string | **Choices:*** disable
* enable
| no description |
| | **ssl-mirror-intf** string | | no description |
| | **ssl-ssh-profile** string | | no description |
| | **sslvpn-auth** string | **Choices:*** any
* local
* radius
* ldap
* tacacs+
| no description |
| | **sslvpn-ccert** string | **Choices:*** disable
* enable
| no description |
| | **sslvpn-cipher** string | **Choices:*** any
* high
* medium
| no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **tags** string | | no description |
| | **tcp-mss-receiver** integer | | no description |
| | **tcp-mss-sender** integer | | no description |
| | **tcp-session-without-syn** string | **Choices:*** all
* data-only
* disable
| no description |
| | **timeout-send-rst** string | **Choices:*** disable
* enable
| no description |
| | **tos** string | | no description |
| | **tos-mask** string | | no description |
| | **tos-negate** string | **Choices:*** disable
* enable
| no description |
| | **traffic-shaper** string | | no description |
| | **traffic-shaper-reverse** string | | no description |
| | **url-category** string | | no description |
| | **users** string | | no description |
| | **utm-inspection-mode** string | **Choices:*** proxy
* flow
| no description |
| | **utm-status** string | **Choices:*** disable
* enable
| no description |
| | **uuid** string | | no description |
| | **vlan-cos-fwd** integer | | no description |
| | **vlan-cos-rev** integer | | no description |
| | **vlan-filter** string | | no description |
| | **voip-profile** string | | no description |
| | **vpntunnel** string | | no description |
| | **waf-profile** string | | no description |
| | **webcache** string | **Choices:*** disable
* enable
| no description |
| | **webcache-https** string | **Choices:*** disable
* enable
| no description |
| | **webfilter-profile** string | | no description |
| | **webproxy-forward-server** string | | no description |
| | **webproxy-profile** 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: Configure IPv6 policies.
fmgr_pkg_footer_policy6:
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, ...]
pkg: <your own value>
state: <value in [present, absent]>
pkg_footer_policy6:
action: <value in [deny, accept, ipsec, ...]>
anti-replay: <value in [disable, enable]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-charts:
- top10-app
- top10-p2p-user
- top10-media-user
application-list: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
casi-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
custom-log-fields: <value of string>
deep-inspection-options: <value of string>
device-detection-portal: <value in [disable, enable]>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstintf: <value of string>
dynamic-profile: <value in [disable, enable]>
dynamic-profile-access:
- imap
- smtp
- pop3
- http
- ftp
- im
- nntp
- imaps
- smtps
- pop3s
- https
- ftps
dynamic-profile-group: <value of string>
email-collection-portal: <value in [disable, enable]>
emailfilter-profile: <value of string>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
fsae: <value in [disable, enable]>
global-label: <value of string>
groups: <value of string>
http-policy-redirect: <value in [disable, enable]>
icap-profile: <value of string>
identity-based: <value in [disable, enable]>
identity-based-policy6:
-
action: <value in [deny, accept]>
application-list: <value of string>
av-profile: <value of string>
deep-inspection-options: <value of string>
devices: <value of string>
dlp-sensor: <value of string>
endpoint-compliance: <value in [disable, enable]>
groups: <value of string>
icap-profile: <value of string>
id: <value of integer>
ips-sensor: <value of string>
logtraffic: <value in [disable, enable, all, ...]>
mms-profile: <value of string>
per-ip-shaper: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
replacemsg-group: <value of string>
schedule: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
spamfilter-profile: <value of string>
sslvpn-portal: <value of string>
sslvpn-realm: <value of string>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
utm-status: <value in [disable, enable]>
voip-profile: <value of string>
webfilter-profile: <value of string>
identity-from: <value in [auth, device]>
inbound: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natoutbound: <value in [disable, enable]>
np-accelation: <value in [disable, enable]>
np-acceleration: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
replacemsg-group: <value of string>
replacemsg-override-group: <value of string>
rsso: <value in [disable, enable]>
schedule: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
sslvpn-auth: <value in [any, local, radius, ...]>
sslvpn-ccert: <value in [disable, enable]>
sslvpn-cipher: <value in [any, high, medium]>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-inspection-mode: <value in [proxy, flow]>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
vlan-filter: <value of string>
voip-profile: <value of string>
vpntunnel: <value of string>
webfilter-profile: <value of string>
waf-profile: <value of string>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, enable]>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
fsso-groups: <value of string>
decrypted-traffic-mirror: <value of string>
file-filter-profile: <value of string>
cgn-log-server-grp: <value of string>
policy-offload: <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_geoipcountry – no description fortinet.fortimanager.fmgr\_system\_geoipcountry – 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_system_geoipcountry`.
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\_geoipcountry** dictionary | | the top level parameters set |
| | **id** string | | no description |
| | **name** 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_system_geoipcountry:
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_geoipcountry:
id: <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_system_autodelete_reportautodeletion – Automatic deletion policy for reports. fortinet.fortimanager.fmgr\_system\_autodelete\_reportautodeletion – Automatic deletion policy for reports.
===========================================================================================================
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_autodelete_reportautodeletion`.
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\_autodelete\_reportautodeletion** dictionary | | the top level parameters set |
| | **retention** string | **Choices:*** **days** ←
* weeks
* months
| Automatic deletion in days, weeks, or months. days - Auto-delete data older than <value> days. weeks - Auto-delete data older than <value> weeks. months - Auto-delete data older than <value> months. |
| | **runat** integer | **Default:**0 | Automatic deletion run at (0 - 23) oclock. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable automatic deletion. disable - Disable automatic deletion. enable - Enable automatic deletion. |
| | **value** integer | **Default:**0 | Automatic deletion in x days, weeks, or months. |
| **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: Automatic deletion policy for reports.
fmgr_system_autodelete_reportautodeletion:
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_autodelete_reportautodeletion:
retention: <value in [days, weeks, months]>
runat: <value of integer>
status: <value in [disable, enable]>
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_system_replacemsggroup_icap – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_icap – 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_icap`.
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\_icap** 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. |
| **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_icap:
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_icap:
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_workspace_lock – Lock an entire ADOM. fortinet.fortimanager.fmgr\_dvmdb\_workspace\_lock – Lock an entire ADOM.
=========================================================================
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_lock`.
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 |
| **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: Lock an entire ADOM.
fmgr_dvmdb_workspace_lock:
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>
```
Return Values
-------------
Common return 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_dospolicy – Configure IPv4 DoS policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_dospolicy – Configure IPv4 DoS policies.
===================================================================================
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_dospolicy`.
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\_dospolicy** dictionary | | the top level parameters set |
| | **anomaly** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* proxy
| Action taken when the threshold is reached. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging for this anomaly. |
| | | **name** string | | Anomaly name. |
| | | **quarantine** string | **Choices:*** none
* attacker
* both
* interface
| Quarantine method. |
| | | **quarantine-expiry** string | | Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 minutes from now. (format: ###d##h##m, default = 5... |
| | | **quarantine-log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the active status of this anomaly sensor. |
| | | **threshold** integer | | Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). Note that each anomaly... |
| | | **threshold(default)** integer | | no description |
| | **comments** string | | Comment. |
| | **dstaddr** string | | Destination address name from available addresses. |
| | **interface** string | | Incoming interface name from available interfaces. |
| | **name** string | | Policy name. |
| | **policyid** integer | | Policy ID. |
| | **service** string | | Service object from available options. |
| | **srcaddr** string | | Source address name from available addresses. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this policy. |
| **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 DoS policies.
fmgr_pkg_firewall_dospolicy:
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>
state: <value in [present, absent]>
pkg_firewall_dospolicy:
anomaly:
-
action: <value in [pass, block, proxy]>
log: <value in [disable, enable]>
name: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
status: <value in [disable, enable]>
threshold: <value of integer>
threshold(default): <value of integer>
comments: <value of string>
dstaddr: <value of string>
interface: <value of string>
policyid: <value of integer>
service: <value of string>
srcaddr: <value of string>
status: <value in [disable, enable]>
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_firewall_ssh_localca – SSH proxy local CA. fortinet.fortimanager.fmgr\_firewall\_ssh\_localca – SSH proxy local CA.
========================================================================
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_ssh_localca`.
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\_ssh\_localca** dictionary | | the top level parameters set |
| | **name** string | | SSH proxy local CA name. |
| | **password** string | | no description |
| | **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. |
| **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: SSH proxy local CA.
fmgr_firewall_ssh_localca:
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_ssh_localca:
name: <value of string>
password: <value of string>
private-key: <value of string>
public-key: <value of string>
source: <value in [built-in, user]>
```
Return Values
-------------
Common return 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_bonjourprofile_policylist – Bonjour policy list. fortinet.fortimanager.fmgr\_bonjourprofile\_policylist – Bonjour policy 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_bonjourprofile_policylist`.
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 |
| **bonjour-profile** string / required | | the parameter (bonjour-profile) in requested url |
| **bonjourprofile\_policylist** dictionary | | the top level parameters set |
| | **description** string | | Description. |
| | **from-vlan** string | | VLAN ID from which the Bonjour service is advertised (0 - 4094, default = 0). |
| | **policy-id** integer | | Policy ID. |
| | **services** list / elements=string | **Choices:*** airplay
* afp
* bit-torrent
* ftp
* ichat
* itunes
* printers
* samba
* scanners
* ssh
* chromecast
* all
| no description |
| | **to-vlan** string | | VLAN ID to which the Bonjour service is made available (0 - 4094, default = all). |
| **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 |
| **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: Bonjour policy list.
fmgr_bonjourprofile_policylist:
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>
bonjour-profile: <your own value>
state: <value in [present, absent]>
bonjourprofile_policylist:
description: <value of string>
from-vlan: <value of string>
policy-id: <value of integer>
services:
- airplay
- afp
- bit-torrent
- ftp
- ichat
- itunes
- printers
- samba
- scanners
- ssh
- chromecast
- all
to-vlan: <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_metafields_device – no description fortinet.fortimanager.fmgr\_dvmdb\_metafields\_device – 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_metafields_device`.
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 |
| **dvmdb\_metafields\_device** dictionary | | the top level parameters set |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **length** integer | | no description |
| | **name** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| **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: no description
fmgr_dvmdb_metafields_device:
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, ...]
dvmdb_metafields_device:
importance: <value in [optional, required]>
length: <value of integer>
name: <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_system_replacemsggroup_mm7 – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mm7 – 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_mm7`.
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\_mm7** dictionary | | the top level parameters set |
| | **add-smil** string | **Choices:*** disable
* enable
| add message encapsulation |
| | **addr-type** string | **Choices:*** rfc2822-addr
* number
* short-code
| from address type |
| | **allow-content-adaptation** string | **Choices:*** disable
* enable
| allow content adaptations |
| | **charset** string | **Choices:*** us-ascii
* utf-8
| character encoding used for replacement message |
| | **class** string | **Choices:*** personal
* advertisement
* informational
* auto
* 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:*** success
* partial-success
* client-err
* oper-restrict
* addr-err
* addr-not-found
* content-refused
* msg-id-not-found
* link-id-not-found
* msg-fmt-corrupt
* app-id-not-found
* repl-app-id-not-found
* srv-err
* not-possible
* msg-rejected
* multiple-addr-not-supp
* app-addr-not-supp
* gen-service-err
* improper-ident
* unsupp-ver
* unsupp-oper
* validation-err
* service-err
* service-unavail
* service-denied
* app-denied
| response status |
| | **smil-part** string | | message encapsulation text |
| | **subject** string | | subject text string |
| **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_mm7:
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_mm7:
add-smil: <value in [disable, enable]>
addr-type: <value in [rfc2822-addr, number, short-code]>
allow-content-adaptation: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, informational, ...]>
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 [success, partial-success, client-err, ...]>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dvmdb_workspace_unlock_pkg – Unlock a specific package, where the url includes both the folder fortinet.fortimanager.fmgr\_dvmdb\_workspace\_unlock\_pkg – Unlock a specific package, where the url includes both the folder
=============================================================================================================================
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_pkg`.
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 |
| **package\_path\_name** string / required | | the parameter (package\_path\_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 package, where the url includes both the folder
fmgr_dvmdb_workspace_unlock_pkg:
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>
package_path_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_pkg_authentication_setting – Configure authentication setting. fortinet.fortimanager.fmgr\_pkg\_authentication\_setting – Configure authentication setting.
============================================================================================
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_authentication_setting`.
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\_authentication\_setting** dictionary | | the top level parameters set |
| | **active-auth-scheme** string | | Active authentication method (scheme name). |
| | **auth-https** string | **Choices:*** disable
* enable
| Enable/disable redirecting HTTP user authentication to HTTPS. |
| | **captive-portal** string | | Captive portal host 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, default = 7830). |
| | **captive-portal-ssl-port** integer | | Captive portal SSL port number (1 - 65535, default = 7831). |
| | **captive-portal-type** string | **Choices:*** fqdn
* ip
| Captive portal type. |
| | **captive-portal6** string | | IPv6 captive portal host name. |
| | **dev-range** string | | Address range for the IP based device query. |
| | **rewrite-https-port** integer | | Rewrite to HTTPS port (0 - 65535, default = 0). |
| | **sso-auth-scheme** string | | Single-Sign-On authentication method (scheme name). |
| | **user-cert-ca** string | | CA certificate used for client certificate verification. |
| **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 authentication setting.
fmgr_pkg_authentication_setting:
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>
pkg_authentication_setting:
active-auth-scheme: <value of string>
auth-https: <value in [disable, enable]>
captive-portal: <value of string>
captive-portal-ip: <value of string>
captive-portal-ip6: <value of string>
captive-portal-port: <value of integer>
captive-portal-ssl-port: <value of integer>
captive-portal-type: <value in [fqdn, ip]>
captive-portal6: <value of string>
rewrite-https-port: <value of integer>
sso-auth-scheme: <value of string>
dev-range: <value of string>
user-cert-ca: <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_pm_config_upgrade – Upgrade an ADOM to the next version. fortinet.fortimanager.fmgr\_pm\_config\_upgrade – Upgrade an ADOM to the next version.
======================================================================================
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_pm_config_upgrade`.
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 |
| **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: Upgrade an ADOM to the next version.
fmgr_pm_config_upgrade:
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>
```
Return Values
-------------
Common return 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_antivirus_profile_outbreakprevention – Configure Virus Outbreak Prevention settings. fortinet.fortimanager.fmgr\_antivirus\_profile\_outbreakprevention – Configure Virus Outbreak Prevention 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_outbreakprevention`.
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\_outbreakprevention** dictionary | | the top level parameters set |
| | **external-blocklist** string | **Choices:*** disable
* enable
| Enable/disable external malware blocklist. |
| | **ftgd-service** string | **Choices:*** disable
* enable
| Enable/disable FortiGuard Virus outbreak prevention service. |
| **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 Virus Outbreak Prevention settings.
fmgr_antivirus_profile_outbreakprevention:
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_outbreakprevention:
external-blocklist: <value in [disable, enable]>
ftgd-service: <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_user_ldap – Configure LDAP server entries. fortinet.fortimanager.fmgr\_user\_ldap – Configure LDAP server 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_user_ldap`.
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\_ldap** dictionary | | the top level parameters set |
| | **account-key-filter** string | | Account key filter, using the UPN as the search filter. |
| | **account-key-processing** string | **Choices:*** same
* strip
| Account key processing operation, either keep or strip domain string of UPN in the token. |
| | **antiphish** string | **Choices:*** disable
* enable
| Enable/disable AntiPhishing credential backend. |
| | **ca-cert** string | | CA certificate name. |
| | **cnid** string | | Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn". |
| | **dn** string | | Distinguished name used to look up entries on the LDAP server. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **account-key-filter** string | | no description |
| | | **account-key-name** string | | no description |
| | | **account-key-processing** string | **Choices:*** same
* strip
| no description |
| | | **antiphish** string | **Choices:*** disable
* enable
| Enable/disable AntiPhishing credential backend. |
| | | **ca-cert** string | | no description |
| | | **cnid** string | | no description |
| | | **dn** string | | no description |
| | | **filter** string | | no description |
| | | **group** string | | no description |
| | | **group-filter** string | | no description |
| | | **group-member-check** string | **Choices:*** user-attr
* group-object
* posix-group-object
| no description |
| | | **group-object-filter** string | | no description |
| | | **group-object-search-base** string | | no description |
| | | **group-search-base** string | | no description |
| | | **interface** string | | no description |
| | | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | | **member-attr** string | | no description |
| | | **obtain-user-info** string | **Choices:*** disable
* enable
| no description |
| | | **password** string | | no description |
| | | **password-attr** string | | Name of attribute to get password hash. |
| | | **password-expiry-warning** string | **Choices:*** disable
* enable
| no description |
| | | **password-renewal** string | **Choices:*** disable
* enable
| no description |
| | | **port** integer | | no description |
| | | **retrieve-protection-profile** string | | no description |
| | | **search-type** list / elements=string | **Choices:*** nested
* recursive
| no description |
| | | **secondary-server** string | | no description |
| | | **secure** string | **Choices:*** disable
* starttls
* ldaps
| no description |
| | | **server** string | | no description |
| | | **server-identity-check** string | **Choices:*** disable
* enable
| no description |
| | | **source-ip** string | | no description |
| | | **source-port** integer | | Source port to be used for communication with the LDAP server. |
| | | **ssl-min-proto-version** string | **Choices:*** default
* TLSv1
* TLSv1-1
* TLSv1-2
* SSLv3
| no description |
| | | **tertiary-server** string | | no description |
| | | **two-factor** string | **Choices:*** disable
* fortitoken-cloud
| no description |
| | | **two-factor-authentication** string | **Choices:*** fortitoken
* email
* sms
| no description |
| | | **two-factor-notification** string | **Choices:*** email
* sms
| no description |
| | | **type** string | **Choices:*** simple
* anonymous
* regular
| no description |
| | | **user-info-exchange-server** string | | no description |
| | | **username** string | | no description |
| | **group-filter** string | | Filter used for group matching. |
| | **group-member-check** string | **Choices:*** user-attr
* group-object
* posix-group-object
| Group member checking methods. |
| | **group-object-filter** string | | Filter used for group searching. |
| | **group-search-base** string | | Search base used for group searching. |
| | **interface** string | | Specify outgoing interface to reach server. |
| | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| Specify how to select outgoing interface to reach server. |
| | **member-attr** string | | Name of attribute from which to get group membership. |
| | **name** string | | LDAP server entry name. |
| | **obtain-user-info** string | **Choices:*** disable
* enable
| Enable/disable obtaining of user information. |
| | **password** string | | no description |
| | **password-attr** string | | Name of attribute to get password hash. |
| | **password-expiry-warning** string | **Choices:*** disable
* enable
| Enable/disable password expiry warnings. |
| | **password-renewal** string | **Choices:*** disable
* enable
| Enable/disable online password renewal. |
| | **port** integer | | Port to be used for communication with the LDAP server (default = 389). |
| | **search-type** list / elements=string | **Choices:*** nested
* recursive
| no description |
| | **secondary-server** string | | Secondary LDAP server CN domain name or IP. |
| | **secure** string | **Choices:*** disable
* starttls
* ldaps
| Port to be used for authentication. |
| | **server** string | | LDAP server CN domain name or IP. |
| | **server-identity-check** string | **Choices:*** disable
* enable
| Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). |
| | **source-ip** string | | Source IP for communications to LDAP server. |
| | **source-port** integer | | Source port to be used for communication with the LDAP server. |
| | **ssl-min-proto-version** string | **Choices:*** default
* TLSv1
* TLSv1-1
* TLSv1-2
* SSLv3
| Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). |
| | **tertiary-server** string | | Tertiary LDAP server CN domain name or IP. |
| | **two-factor** string | **Choices:*** disable
* fortitoken-cloud
| Enable/disable two-factor authentication. |
| | **two-factor-authentication** string | **Choices:*** fortitoken
* email
* sms
| Authentication method by FortiToken Cloud. |
| | **two-factor-notification** string | **Choices:*** email
* sms
| Notification method for user activation by FortiToken Cloud. |
| | **type** string | **Choices:*** simple
* anonymous
* regular
| Authentication type for LDAP searches. |
| | **user-info-exchange-server** string | | MS Exchange server from which to fetch user information. |
| | **username** string | | Username (full DN) for initial binding. |
| **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 LDAP server entries.
fmgr_user_ldap:
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_ldap:
account-key-filter: <value of string>
account-key-processing: <value in [same, strip]>
ca-cert: <value of string>
cnid: <value of string>
dn: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
account-key-filter: <value of string>
account-key-name: <value of string>
account-key-processing: <value in [same, strip]>
ca-cert: <value of string>
cnid: <value of string>
dn: <value of string>
filter: <value of string>
group: <value of string>
group-filter: <value of string>
group-member-check: <value in [user-attr, group-object, posix-group-object]>
group-object-filter: <value of string>
group-object-search-base: <value of string>
group-search-base: <value of string>
member-attr: <value of string>
obtain-user-info: <value in [disable, enable]>
password: <value of string>
password-expiry-warning: <value in [disable, enable]>
password-renewal: <value in [disable, enable]>
port: <value of integer>
retrieve-protection-profile: <value of string>
search-type:
- nested
- recursive
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
server-identity-check: <value in [disable, enable]>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
tertiary-server: <value of string>
type: <value in [simple, anonymous, regular]>
user-info-exchange-server: <value of string>
username: <value of string>
two-factor: <value in [disable, fortitoken-cloud]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
two-factor-authentication: <value in [fortitoken, email, sms]>
two-factor-notification: <value in [email, sms]>
antiphish: <value in [disable, enable]>
password-attr: <value of string>
source-port: <value of integer>
group-filter: <value of string>
group-member-check: <value in [user-attr, group-object, posix-group-object]>
group-object-filter: <value of string>
group-search-base: <value of string>
member-attr: <value of string>
name: <value of string>
password: <value of string>
password-expiry-warning: <value in [disable, enable]>
password-renewal: <value in [disable, enable]>
port: <value of integer>
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
server-identity-check: <value in [disable, enable]>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
tertiary-server: <value of string>
type: <value in [simple, anonymous, regular]>
username: <value of string>
obtain-user-info: <value in [disable, enable]>
search-type:
- nested
- recursive
user-info-exchange-server: <value of string>
two-factor: <value in [disable, fortitoken-cloud]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
two-factor-authentication: <value in [fortitoken, email, sms]>
two-factor-notification: <value in [email, sms]>
antiphish: <value in [disable, enable]>
password-attr: <value of string>
source-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_adgrp – Configure FSSO groups. fortinet.fortimanager.fmgr\_user\_adgrp – Configure FSSO 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_user_adgrp`.
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\_adgrp** dictionary | | the top level parameters set |
| | **connector-source** string | | FSSO connector source. |
| | **id** integer | | no description |
| | **name** string | | Name. |
| | **server-name** string | | FSSO agent 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 FSSO groups.
fmgr_user_adgrp:
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_adgrp:
name: <value of string>
server-name: <value of string>
id: <value of integer>
connector-source: <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_exception – HTTP constraint exception. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_exception – HTTP constraint exception.
============================================================================================
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_exception`.
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\_exception** dictionary | | the top level parameters set |
| | **address** string | | Host address. |
| | **content-length** string | **Choices:*** disable
* enable
| HTTP content length in request. |
| | **header-length** string | **Choices:*** disable
* enable
| HTTP header length in request. |
| | **hostname** string | **Choices:*** disable
* enable
| Enable/disable hostname check. |
| | **id** integer | | Exception ID. |
| | **line-length** string | **Choices:*** disable
* enable
| HTTP line length in request. |
| | **malformed** string | **Choices:*** disable
* enable
| Enable/disable malformed HTTP request check. |
| | **max-cookie** string | **Choices:*** disable
* enable
| Maximum number of cookies in HTTP request. |
| | **max-header-line** string | **Choices:*** disable
* enable
| Maximum number of HTTP header line. |
| | **max-range-segment** string | **Choices:*** disable
* enable
| Maximum number of range segments in HTTP range line. |
| | **max-url-param** string | **Choices:*** disable
* enable
| Maximum number of parameters in URL. |
| | **method** string | **Choices:*** disable
* enable
| Enable/disable HTTP method check. |
| | **param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL, HTTP POST request or HTTP body. |
| | **pattern** string | | URL pattern. |
| | **regex** string | **Choices:*** disable
* enable
| Enable/disable regular expression based pattern match. |
| | **url-param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL. |
| | **version** string | **Choices:*** disable
* enable
| Enable/disable HTTP version check. |
| **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: HTTP constraint exception.
fmgr_waf_profile_constraint_exception:
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_constraint_exception:
address: <value of string>
content-length: <value in [disable, enable]>
header-length: <value in [disable, enable]>
hostname: <value in [disable, enable]>
id: <value of integer>
line-length: <value in [disable, enable]>
malformed: <value in [disable, enable]>
max-cookie: <value in [disable, enable]>
max-header-line: <value in [disable, enable]>
max-range-segment: <value in [disable, enable]>
max-url-param: <value in [disable, enable]>
method: <value in [disable, enable]>
param-length: <value in [disable, enable]>
pattern: <value of string>
regex: <value in [disable, enable]>
url-param-length: <value in [disable, enable]>
version: <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_user_clearpass – no description fortinet.fortimanager.fmgr\_user\_clearpass – 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_user_clearpass`.
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\_clearpass** dictionary | | the top level parameters set |
| | **client** string | | no description |
| | **name** string | | no description |
| | **password** string | | no description |
| | **server** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **user** 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_user_clearpass:
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_clearpass:
client: <value of string>
name: <value of string>
password: <value of string>
server: <value of string>
status: <value in [disable, enable]>
user: <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_hotspot20_qosmap_dscprange – Differentiated Services Code Point fortinet.fortimanager.fmgr\_hotspot20\_qosmap\_dscprange – Differentiated Services Code Point
=============================================================================================
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_qosmap_dscprange`.
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\_qosmap\_dscprange** dictionary | | the top level parameters set |
| | **high** integer | | DSCP high value. |
| | **index** integer | | DSCP range index. |
| | **low** integer | | DSCP low value. |
| | **up** integer | | User priority. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **qos-map** string / required | | the parameter (qos-map) 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 |
| **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: Differentiated Services Code Point
fmgr_hotspot20_qosmap_dscprange:
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>
qos-map: <your own value>
state: <value in [present, absent]>
hotspot20_qosmap_dscprange:
high: <value of integer>
index: <value of integer>
low: <value of integer>
up: <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_system_mcpolicydisabledadoms – Multicast policy disabled adoms. fortinet.fortimanager.fmgr\_system\_mcpolicydisabledadoms – Multicast policy disabled adoms.
============================================================================================
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_mcpolicydisabledadoms`.
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\_mcpolicydisabledadoms** dictionary | | the top level parameters set |
| | **adom-name** string | | Adom 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: Multicast policy disabled adoms.
fmgr_system_mcpolicydisabledadoms:
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_mcpolicydisabledadoms:
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_emailfilter_mheader – Configure AntiSpam MIME header. fortinet.fortimanager.fmgr\_emailfilter\_mheader – Configure AntiSpam MIME header.
==================================================================================
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_mheader`.
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\_mheader** 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. |
| | | **fieldbody** string | | Pattern for the header field body. |
| | | **fieldname** string | | Pattern for header field name. |
| | | **id** integer | | Mime header entry ID. |
| | | **pattern-type** string | **Choices:*** wildcard
* regexp
| Wildcard pattern or regular expression. |
| | | **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 MIME header.
fmgr_emailfilter_mheader:
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_mheader:
comment: <value of string>
entries:
-
action: <value in [spam, clear]>
fieldbody: <value of string>
fieldname: <value of string>
id: <value of integer>
pattern-type: <value in [wildcard, regexp]>
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)
ansible fortinet.fortimanager.fmgr_antivirus_profile_ftp – Configure FTP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_ftp – Configure FTP 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_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 |
| **antivirus\_profile\_ftp** 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. |
| | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | **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 FTP AntiVirus options.
fmgr_antivirus_profile_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>
profile: <your own value>
antivirus_profile_ftp:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
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_proxy_json – Send and receive JSON request to/from managed devices. fortinet.fortimanager.fmgr\_sys\_proxy\_json – Send and receive JSON request to/from managed 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_sys_proxy_json`.
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 |
| **sys\_proxy\_json** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** get
* post
* put
* delete
| Specify HTTP action for the request. |
| | **payload** dictionary | | no description |
| | **resource** string | | URL on the remote device to be accessed. |
| | **target** list / elements=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: Send and receive JSON request to/from managed devices.
fmgr_sys_proxy_json:
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, ...]
sys_proxy_json:
action: <value in [get, post, put, ...]>
payload: <value of dict>
resource: <value of string>
target: <value of list>
```
Return Values
-------------
Common return 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_admin_group – User group. fortinet.fortimanager.fmgr\_system\_admin\_group – User 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_system_admin_group`.
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\_group** dictionary | | the top level parameters set |
| | **member** list / elements=string | | no description |
| | | **name** string | | Group member name. |
| | **name** string | | 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: User group.
fmgr_system_admin_group:
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_admin_group:
member:
-
name: <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_firewall_vipgrp6 – Configure IPv6 virtual IP groups. fortinet.fortimanager.fmgr\_firewall\_vipgrp6 – Configure IPv6 virtual IP 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_vipgrp6`.
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\_vipgrp6** dictionary | | the top level parameters set |
| | **color** integer | | Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1). |
| | **comments** string | | Comment. |
| | **member** string | | Member VIP objects of the group (Separate multiple objects with a space). |
| | **name** string | | IPv6 VIP group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 IPv6 virtual IP groups.
fmgr_firewall_vipgrp6:
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_vipgrp6:
color: <value of integer>
comments: <value of string>
member: <value of string>
name: <value of string>
uuid: <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_spam – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_spam – 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_spam`.
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\_spam** 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_spam:
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_spam:
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_switchcontroller_qos_queuepolicy – Configure FortiSwitch QoS egress queue policy. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_queuepolicy – Configure FortiSwitch QoS egress queue 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_switchcontroller_qos_queuepolicy`.
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 |
| **switchcontroller\_qos\_queuepolicy** dictionary | | the top level parameters set |
| | **cos-queue** list / elements=string | | no description |
| | | **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 (0f link speed). |
| | | **min-rate** integer | | Minimum rate (0 - 4294967295 kbps, 0 to disable). |
| | | **min-rate-percent** integer | | Minimum rate (0f link speed). |
| | | **name** string | | Cos queue ID. |
| | | **weight** integer | | Weight of weighted round robin scheduling. |
| | **name** string | | 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. |
| **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 FortiSwitch QoS egress queue policy.
fmgr_switchcontroller_qos_queuepolicy:
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]>
switchcontroller_qos_queuepolicy:
cos-queue:
-
description: <value of string>
drop-policy: <value in [taildrop, weighted-random-early-detection]>
max-rate: <value of integer>
min-rate: <value of integer>
name: <value of string>
weight: <value of integer>
max-rate-percent: <value of integer>
min-rate-percent: <value of integer>
ecn: <value in [disable, enable]>
name: <value of string>
schedule: <value in [strict, round-robin, weighted]>
rate-by: <value in [kbps, percent]>
```
Return Values
-------------
Common return 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_addrgrp6 – Configure IPv6 address groups. fortinet.fortimanager.fmgr\_firewall\_addrgrp6 – Configure IPv6 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_addrgrp6`.
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\_addrgrp6** 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 the value to 1). |
| | **comment** string | | Comment. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_image-base64** string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **color** integer | | no description |
| | | **comment** 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 |
| | | **uuid** string | | no description |
| | | **visibility** string | **Choices:*** disable
* enable
| no description |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **global-object** integer | | Global Object. |
| | **member** string | | Address objects contained within the group. |
| | **name** string | | IPv6 address group name. |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable address group6 visibility 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: Configure IPv6 address groups.
fmgr_firewall_addrgrp6:
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_addrgrp6:
color: <value of integer>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
color: <value of integer>
comment: <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>
fabric-object: <value in [disable, enable]>
member: <value of string>
name: <value of string>
tagging:
-
category: <value of string>
name: <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>
fabric-object: <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_waf_profile_constraint_urlparamlength – Maximum length of parameter in URL. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_urlparamlength – Maximum length of parameter in URL.
==========================================================================================================
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_urlparamlength`.
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\_urlparamlength** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **length** integer | | Maximum length of URL parameter in bytes (0 to 2147483647). |
| | **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: Maximum length of parameter in URL.
fmgr_waf_profile_constraint_urlparamlength:
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_urlparamlength:
action: <value in [allow, block]>
length: <value of integer>
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_system_locallog_fortianalyzer_setting – Settings for locallog to fortianalyzer. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer\_setting – Settings for locallog to fortianalyzer.
==============================================================================================================
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_locallog_fortianalyzer_setting`.
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\_locallog\_fortianalyzer\_setting** dictionary | | the top level parameters set |
| | **reliable** string | **Choices:*** **disable** ←
* enable
| Enable/disable reliable realtime logging. disable - Disable reliable realtime logging. enable - Enable reliable realtime logging. |
| | **secure-connection** string | **Choices:*** **disable** ←
* enable
| Enable/disable connection secured by TLS/SSL. disable - Disable SSL connection. enable - Enable SSL connection. |
| | **server** string | | Remote FortiAnalyzer server FQDN, hostname, or IP address |
| | **server-ip** string | **Default:**"0.0.0.0" | Remote FortiAnalyzer server IP address. |
| | **severity** string | **Choices:*** emergency
* alert
* critical
* error
* warning
* **notification** ←
* information
* debug
| Least severity level to log. emergency - Emergency level. alert - Alert level. critical - Critical level. error - Error level. warning - Warning level. notification - Notification level. information - Information level. debug - Debug level. |
| | **status** string | **Choices:*** **disable** ←
* realtime
* upload
| Log to FortiAnalyzer status. disable - Log to FortiAnalyzer disabled. realtime - Log to FortiAnalyzer in realtime. upload - Log to FortiAnalyzer at schedule time. |
| | **upload-time** 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: Settings for locallog to fortianalyzer.
fmgr_system_locallog_fortianalyzer_setting:
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_locallog_fortianalyzer_setting:
reliable: <value in [disable, enable]>
secure-connection: <value in [disable, enable]>
server-ip: <value of string>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, realtime, upload]>
upload-time: <value of string>
server: <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_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles. fortinet.fortimanager.fmgr\_switchcontroller\_lldpprofile – Configure FortiSwitch LLDP 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_switchcontroller_lldpprofile`.
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 |
| **switchcontroller\_lldpprofile** dictionary | | the top level parameters set |
| | **802.1-tlvs** list / elements=string | **Choices:*** port-vlan-id
| no description |
| | **802.3-tlvs** list / elements=string | **Choices:*** max-frame-size
* power-negotiation
| no description |
| | **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, default = 3). |
| | **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, default = 9). |
| | **auto-mclag-icl** string | **Choices:*** disable
* enable
| Enable/disable MCLAG inter chassis link. |
| | **custom-tlvs** list / elements=string | | no description |
| | | **information-string** string | | Organizationally defined information string (0 - 507 hexadecimal bytes). |
| | | **name** string | | 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 | | no description |
| | | **name** string | | Location service type name. |
| | | **status** string | **Choices:*** disable
* enable
| Enable or disable this TLV. |
| | | **sys-location-id** string | | Location service ID. |
| | **med-network-policy** list / elements=string | | no description |
| | | **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 requ... |
| | | **name** string | | 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. |
| | **med-tlvs** list / elements=string | **Choices:*** inventory-management
* network-policy
* power-management
* location-identification
| no description |
| | **name** string | | Profile 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 FortiSwitch LLDP profiles.
fmgr_switchcontroller_lldpprofile:
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]>
switchcontroller_lldpprofile:
802.1-tlvs:
- port-vlan-id
802.3-tlvs:
- max-frame-size
- power-negotiation
auto-isl: <value in [disable, enable]>
auto-isl-hello-timer: <value of integer>
auto-isl-port-group: <value of integer>
auto-isl-receive-timeout: <value of integer>
custom-tlvs:
-
information-string: <value of string>
name: <value of string>
oui: <value of string>
subtype: <value of integer>
med-network-policy:
-
dscp: <value of integer>
name: <value of string>
priority: <value of integer>
status: <value in [disable, enable]>
vlan: <value of integer>
vlan-intf: <value of string>
assign-vlan: <value in [disable, enable]>
med-tlvs:
- inventory-management
- network-policy
- power-management
- location-identification
name: <value of string>
med-location-service:
-
name: <value of string>
status: <value in [disable, enable]>
sys-location-id: <value of string>
auto-mclag-icl: <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_locallog_fortianalyzer_filter – Filter for FortiAnalyzer logging. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer\_filter – Filter for FortiAnalyzer logging.
=======================================================================================================
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_locallog_fortianalyzer_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 |
| --- | --- | --- |
| **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\_locallog\_fortianalyzer\_filter** dictionary | | the top level parameters set |
| | **aid** string | **Choices:*** disable
* **enable** ←
| Log aid messages. disable - Disable setting. enable - Enable setting. |
| | **devcfg** string | **Choices:*** disable
* **enable** ←
| Log device configuration message. disable - Disable setting. enable - Enable setting. |
| | **devops** string | **Choices:*** disable
* **enable** ←
| Managered devices operations messages. disable - Disable setting. enable - Enable setting. |
| | **diskquota** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer disk quota messages. disable - Disable setting. enable - Enable setting. |
| | **dm** string | **Choices:*** disable
* **enable** ←
| Log deployment manager message. disable - Disable setting. enable - Enable setting. |
| | **docker** string | **Choices:*** disable
* **enable** ←
| Docker application generic messages. disable - Disable setting. enable - Enable setting. |
| | **dvm** string | **Choices:*** disable
* **enable** ←
| Log device manager messages. disable - Disable setting. enable - Enable setting. |
| | **ediscovery** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer ediscovery messages. disable - Disable setting. enable - Enable setting. |
| | **epmgr** string | **Choices:*** disable
* **enable** ←
| Log endpoint manager message. disable - Disable setting. enable - Enable setting. |
| | **event** string | **Choices:*** disable
* **enable** ←
| Log event messages. disable - Disable setting. enable - Enable setting. |
| | **eventmgmt** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer event handler messages. disable - Disable setting. enable - Enable setting. |
| | **faz** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer messages. disable - Disable setting. enable - Enable setting. |
| | **fazha** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer HA messages. disable - Disable setting. enable - Enable setting. |
| | **fazsys** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer system messages. disable - Disable setting. enable - Enable setting. |
| | **fgd** string | **Choices:*** disable
* **enable** ←
| Log FortiGuard service message. disable - Disable setting. enable - Enable setting. |
| | **fgfm** string | **Choices:*** disable
* **enable** ←
| Log FGFM protocol message. disable - Disable setting. enable - Enable setting. |
| | **fips** string | **Choices:*** disable
* **enable** ←
| Whether to log fips messages. disable - Disable setting. enable - Enable setting. |
| | **fmgws** string | **Choices:*** disable
* **enable** ←
| Log web service messages. disable - Disable setting. enable - Enable setting. |
| | **fmlmgr** string | **Choices:*** disable
* **enable** ←
| Log FortiMail manager message. disable - Disable setting. enable - Enable setting. |
| | **fmwmgr** string | **Choices:*** disable
* **enable** ←
| Log firmware manager message. disable - Disable setting. enable - Enable setting. |
| | **fortiview** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer FortiView messages. disable - Disable setting. enable - Enable setting. |
| | **glbcfg** string | **Choices:*** disable
* **enable** ←
| Log global database message. disable - Disable setting. enable - Enable setting. |
| | **ha** string | **Choices:*** disable
* **enable** ←
| Log HA message. disable - Disable setting. enable - Enable setting. |
| | **hcache** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer hcache messages. disable - Disable setting. enable - Enable setting. |
| | **incident** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer incident messages. disable - Disable setting. enable - Enable setting. |
| | **iolog** string | **Choices:*** disable
* **enable** ←
| Log debug IO log message. disable - Disable setting. enable - Enable setting. |
| | **logd** string | **Choices:*** disable
* **enable** ←
| Log the status of log daemon. disable - Disable setting. enable - Enable setting. |
| | **logdb** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log DB messages. disable - Disable setting. enable - Enable setting. |
| | **logdev** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer log device messages. disable - Disable setting. enable - Enable setting. |
| | **logfile** string | **Choices:*** enable
* disable
| Log Fortianalyzer log file messages. enable - Enable setting. disable - Disable setting. |
| | **logging** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer logging messages. disable - Disable setting. enable - Enable setting. |
| | **lrmgr** string | **Choices:*** disable
* **enable** ←
| Log log and report manager message. disable - Disable setting. enable - Enable setting. |
| | **objcfg** string | **Choices:*** disable
* **enable** ←
| Log object configuration change message. disable - Disable setting. enable - Enable setting. |
| | **report** string | **Choices:*** disable
* **enable** ←
| Log Fortianalyzer report messages. disable - Disable setting. enable - Enable setting. |
| | **rev** string | **Choices:*** disable
* **enable** ←
| Log revision history message. disable - Disable setting. enable - Enable setting. |
| | **rtmon** string | **Choices:*** disable
* **enable** ←
| Log real-time monitor message. disable - Disable setting. enable - Enable setting. |
| | **scfw** string | **Choices:*** disable
* **enable** ←
| Log firewall objects message. disable - Disable setting. enable - Enable setting. |
| | **scply** string | **Choices:*** disable
* **enable** ←
| Log policy console message. disable - Disable setting. enable - Enable setting. |
| | **scrmgr** string | **Choices:*** disable
* **enable** ←
| Log script manager message. disable - Disable setting. enable - Enable setting. |
| | **scvpn** string | **Choices:*** disable
* **enable** ←
| Log VPN console message. disable - Disable setting. enable - Enable setting. |
| | **system** string | **Choices:*** disable
* **enable** ←
| Log system manager message. disable - Disable setting. enable - Enable setting. |
| | **webport** string | **Choices:*** disable
* **enable** ←
| Log web portal message. disable - Disable setting. enable - Enable 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: Filter for FortiAnalyzer logging.
fmgr_system_locallog_fortianalyzer_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, ...]
system_locallog_fortianalyzer_filter:
devcfg: <value in [disable, enable]>
devops: <value in [disable, enable]>
diskquota: <value in [disable, enable]>
dm: <value in [disable, enable]>
dvm: <value in [disable, enable]>
ediscovery: <value in [disable, enable]>
epmgr: <value in [disable, enable]>
event: <value in [disable, enable]>
eventmgmt: <value in [disable, enable]>
faz: <value in [disable, enable]>
fazha: <value in [disable, enable]>
fazsys: <value in [disable, enable]>
fgd: <value in [disable, enable]>
fgfm: <value in [disable, enable]>
fips: <value in [disable, enable]>
fmgws: <value in [disable, enable]>
fmlmgr: <value in [disable, enable]>
fmwmgr: <value in [disable, enable]>
fortiview: <value in [disable, enable]>
glbcfg: <value in [disable, enable]>
ha: <value in [disable, enable]>
hcache: <value in [disable, enable]>
iolog: <value in [disable, enable]>
logd: <value in [disable, enable]>
logdb: <value in [disable, enable]>
logdev: <value in [disable, enable]>
logfile: <value in [enable, disable]>
logging: <value in [disable, enable]>
lrmgr: <value in [disable, enable]>
objcfg: <value in [disable, enable]>
report: <value in [disable, enable]>
rev: <value in [disable, enable]>
rtmon: <value in [disable, enable]>
scfw: <value in [disable, enable]>
scply: <value in [disable, enable]>
scrmgr: <value in [disable, enable]>
scvpn: <value in [disable, enable]>
system: <value in [disable, enable]>
webport: <value in [disable, enable]>
incident: <value in [disable, enable]>
aid: <value in [disable, enable]>
docker: <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_address_list – IP address list. fortinet.fortimanager.fmgr\_firewall\_address\_list – IP address 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_address_list`.
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 |
| --- | --- | --- |
| **address** string / required | | the parameter (address) 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\_address\_list** dictionary | | the top level parameters set |
| | **ip** string | | IP. |
| | **net-id** string | | Network ID. |
| | **obj-id** string | | Object 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: IP address list.
fmgr_firewall_address_list:
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>
address: <your own value>
state: <value in [present, absent]>
firewall_address_list:
ip: <value of string>
net-id: <value of string>
obj-id: <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_dynamic_interface_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_interface\_dynamicmapping – 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_dynamic_interface_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_interface\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **egress-shaping-profile** string | | no description |
| | **ingress-shaping-profile** string | | no description |
| | **intrazone-deny** string | **Choices:*** disable
* enable
| no description |
| | **local-intf** string | | no description |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **interface** string / required | | the parameter (interface) 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_dynamic_interface_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>
interface: <your own value>
state: <value in [present, absent]>
dynamic_interface_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
egress-shaping-profile: <value of string>
intrazone-deny: <value in [disable, enable]>
local-intf: <value of string>
ingress-shaping-profile: <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_waf_profile_constraint – WAF HTTP protocol restrictions. fortinet.fortimanager.fmgr\_waf\_profile\_constraint – WAF HTTP protocol restrictions.
======================================================================================
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`.
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** dictionary | | the top level parameters set |
| | **content-length** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **length** integer | | Length of HTTP content in bytes (0 to 2147483647). |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **exception** list / elements=string | | no description |
| | | **address** string | | Host address. |
| | | **content-length** string | **Choices:*** disable
* enable
| HTTP content length in request. |
| | | **header-length** string | **Choices:*** disable
* enable
| HTTP header length in request. |
| | | **hostname** string | **Choices:*** disable
* enable
| Enable/disable hostname check. |
| | | **id** integer | | Exception ID. |
| | | **line-length** string | **Choices:*** disable
* enable
| HTTP line length in request. |
| | | **malformed** string | **Choices:*** disable
* enable
| Enable/disable malformed HTTP request check. |
| | | **max-cookie** string | **Choices:*** disable
* enable
| Maximum number of cookies in HTTP request. |
| | | **max-header-line** string | **Choices:*** disable
* enable
| Maximum number of HTTP header line. |
| | | **max-range-segment** string | **Choices:*** disable
* enable
| Maximum number of range segments in HTTP range line. |
| | | **max-url-param** string | **Choices:*** disable
* enable
| Maximum number of parameters in URL. |
| | | **method** string | **Choices:*** disable
* enable
| Enable/disable HTTP method check. |
| | | **param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL, HTTP POST request or HTTP body. |
| | | **pattern** string | | URL pattern. |
| | | **regex** string | **Choices:*** disable
* enable
| Enable/disable regular expression based pattern match. |
| | | **url-param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL. |
| | | **version** string | **Choices:*** disable
* enable
| Enable/disable HTTP version check. |
| | **header-length** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **length** integer | | Length of HTTP header in bytes (0 to 2147483647). |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **hostname** dictionary | | no description |
| | | **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. |
| | **line-length** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **length** integer | | Length of HTTP line in bytes (0 to 2147483647). |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **malformed** dictionary | | no description |
| | | **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. |
| | **max-cookie** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **max-cookie** integer | | Maximum number of cookies in HTTP request (0 to 2147483647). |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **max-header-line** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **max-header-line** integer | | Maximum number HTTP header lines (0 to 2147483647). |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **max-range-segment** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **max-range-segment** integer | | Maximum number of range segments in HTTP range line (0 to 2147483647). |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **max-url-param** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **max-url-param** integer | | Maximum number of parameters in URL (0 to 2147483647). |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **method** dictionary | | no description |
| | | **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. |
| | **param-length** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **length** integer | | Maximum length of parameter in URL, HTTP POST request or HTTP body in bytes (0 to 2147483647). |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **url-param-length** dictionary | | no description |
| | | **action** string | **Choices:*** allow
* block
| Action. |
| | | **length** integer | | Maximum length of URL parameter in bytes (0 to 2147483647). |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | **version** dictionary | | no description |
| | | **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: WAF HTTP protocol restrictions.
fmgr_waf_profile_constraint:
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:
content-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
exception:
-
address: <value of string>
content-length: <value in [disable, enable]>
header-length: <value in [disable, enable]>
hostname: <value in [disable, enable]>
id: <value of integer>
line-length: <value in [disable, enable]>
malformed: <value in [disable, enable]>
max-cookie: <value in [disable, enable]>
max-header-line: <value in [disable, enable]>
max-range-segment: <value in [disable, enable]>
max-url-param: <value in [disable, enable]>
method: <value in [disable, enable]>
param-length: <value in [disable, enable]>
pattern: <value of string>
regex: <value in [disable, enable]>
url-param-length: <value in [disable, enable]>
version: <value in [disable, enable]>
header-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
hostname:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
line-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
malformed:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-cookie:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-cookie: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-header-line:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-header-line: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-range-segment:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-range-segment: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-url-param:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-url-param: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
method:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
param-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
url-param-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
version:
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_user_vcenter – no description fortinet.fortimanager.fmgr\_user\_vcenter – 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_user_vcenter`.
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\_vcenter** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **password** string | | no description |
| | **rule** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **rule** string | | no description |
| | **server** string | | no description |
| | **status** string | **Choices:*** **disable** ←
* enable
| no description |
| | **upd\_interval** integer | **Default:**180 | no description |
| | **user** 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_user_vcenter:
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_vcenter:
name: <value of string>
password: <value of string>
rule:
-
name: <value of string>
rule: <value of string>
server: <value of string>
status: <value in [disable, enable]>
upd_interval: <value of integer>
user: <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_hotspot20_anqproamingconsortium_oilist – Organization identifier list. fortinet.fortimanager.fmgr\_hotspot20\_anqproamingconsortium\_oilist – Organization identifier 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_hotspot20_anqproamingconsortium_oilist`.
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 |
| **anqp-roaming-consortium** string / required | | the parameter (anqp-roaming-consortium) 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\_anqproamingconsortium\_oilist** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **index** integer | | OI index. |
| | **oi** string | | Organization identifier. |
| **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: Organization identifier list.
fmgr_hotspot20_anqproamingconsortium_oilist:
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>
anqp-roaming-consortium: <your own value>
state: <value in [present, absent]>
hotspot20_anqproamingconsortium_oilist:
comment: <value of string>
index: <value of integer>
oi: <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_adom – ADOM table, most attributes are read-only and can only be changed internally. fortinet.fortimanager.fmgr\_dvmdb\_adom – ADOM table, most attributes are read-only and can only be changed internally.
=======================================================================================================================
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_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 |
| **dvmdb\_adom** dictionary | | the top level parameters set |
| | **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 |
| **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: ADOM table, most attributes are read-only and can only be changed internally.
fmgr_dvmdb_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, ...]
state: <value in [present, absent]>
dvmdb_adom:
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>
```
Return Values
-------------
Common return 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 – Configure user groups. fortinet.fortimanager.fmgr\_user\_group – Configure user 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_user_group`.
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\_group** dictionary | | the top level parameters set |
| | **auth-concurrent-override** string | **Choices:*** disable
* enable
| 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
* directory-service
* fsso-service
* guest
* rsso
| Set the group to be for firewall authentication, FSSO, RSSO, or guest users. |
| | **guest** list / elements=string | | no description |
| | | **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. |
| | **http-digest-realm** string | | Realm attribute for MD5-digest authentication. |
| | **id** integer | | Group ID. |
| | **match** list / elements=string | | no description |
| | | **\_gui\_meta** string | | no description |
| | | **group-name** string | | Name of matching group on remote authentication server. |
| | | **id** integer | | ID. |
| | | **server-name** string | | Name of remote auth server. |
| | **max-accounts** integer | | Maximum number of guest accounts that can be created for this group (0 means unlimited). |
| | **member** list / elements=string | | no description |
| | **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 | | Group name. |
| | **password** string | **Choices:*** auto-generate
* specify
* disable
| Guest user password type. |
| | **sms-custom-server** string | | SMS server. |
| | **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. |
| **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 user groups.
fmgr_user_group:
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_group:
auth-concurrent-override: <value in [disable, enable]>
auth-concurrent-value: <value of integer>
authtimeout: <value of integer>
company: <value in [optional, mandatory, disabled]>
email: <value in [disable, enable]>
expire: <value of integer>
expire-type: <value in [immediately, first-successful-login]>
group-type: <value in [firewall, directory-service, fsso-service, ...]>
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>
http-digest-realm: <value of string>
id: <value of integer>
match:
-
_gui_meta: <value of string>
group-name: <value of string>
id: <value of integer>
server-name: <value of string>
max-accounts: <value of integer>
member: <value of list>
mobile-phone: <value in [disable, enable]>
multiple-guest-add: <value in [disable, enable]>
name: <value of string>
password: <value in [auto-generate, specify, disable]>
sms-custom-server: <value of string>
sms-server: <value in [fortiguard, custom]>
sponsor: <value in [optional, mandatory, disabled]>
sso-attribute-value: <value of string>
user-id: <value in [email, auto-generate, specify]>
user-name: <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_devprof_system_snmp_sysinfo – SNMP system info configuration. fortinet.fortimanager.fmgr\_devprof\_system\_snmp\_sysinfo – SNMP system info 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_devprof_system_snmp_sysinfo`.
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\_snmp\_sysinfo** dictionary | | the top level parameters set |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable SNMP. |
| **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: SNMP system info configuration.
fmgr_devprof_system_snmp_sysinfo:
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_snmp_sysinfo:
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_devprof_system_replacemsg_webproxy – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_webproxy – 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_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 |
| --- | --- | --- |
| **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\_webproxy** 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_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, ...]
adom: <your own value>
devprof: <your own value>
devprof_system_replacemsg_webproxy:
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_webproxy_profile – Configure web proxy profiles. fortinet.fortimanager.fmgr\_webproxy\_profile – Configure web proxy 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_webproxy_profile`.
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\_profile** dictionary | | the top level parameters set |
| | **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 hea... |
| | **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 | | no description |
| | | **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 headers content. |
| | | **dstaddr** string | | Destination address and address group names. |
| | | **dstaddr6** string | | Destination address and address group names (IPv6). |
| | | **id** integer | | HTTP forwarded header id. |
| | | **name** string | | HTTP forwarded header name. |
| | | **protocol** list / elements=string | **Choices:*** https
* http
| no description |
| | **log-header-change** string | **Choices:*** disable
* enable
| Enable/disable logging HTTP header changes. |
| | **name** string | | Profile name. |
| | **strip-encoding** string | **Choices:*** disable
* enable
| Enable/disable stripping unsupported encoding from the request header. |
| **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 web proxy profiles.
fmgr_webproxy_profile:
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_profile:
header-client-ip: <value in [pass, add, remove]>
header-front-end-https: <value in [pass, add, remove]>
header-via-request: <value in [pass, add, remove]>
header-via-response: <value in [pass, add, remove]>
header-x-authenticated-groups: <value in [pass, add, remove]>
header-x-authenticated-user: <value in [pass, add, remove]>
header-x-forwarded-for: <value in [pass, add, remove]>
headers:
-
action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
content: <value of string>
id: <value of integer>
name: <value of string>
add-option: <value in [append, new-on-not-found, new]>
base64-encoding: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr6: <value of string>
protocol:
- https
- http
log-header-change: <value in [disable, enable]>
name: <value of string>
strip-encoding: <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_ha – HA configuration. fortinet.fortimanager.fmgr\_system\_ha – HA 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_ha`.
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** dictionary | | the top level parameters set |
| | **clusterid** integer | **Default:**1 | Cluster ID range (1 - 64). |
| | **file-quota** integer | **Default:**4096 | File quota in MB (2048 - 20480). |
| | **hb-interval** integer | **Default:**5 | Heartbeat interval (1 - 255). |
| | **hb-lost-threshold** integer | **Default:**3 | Heartbeat lost threshold (1 - 255). |
| | **local-cert** string | | set the ha local certificate. |
| | **mode** string | **Choices:*** **standalone** ←
* master
* slave
* primary
* secondary
| Mode. standalone - Standalone. master - Master. slave - Slave. |
| | **password** string | | no description |
| | **peer** list / elements=string | | no description |
| | | **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. |
| | | **status** string | **Choices:*** disable
* **enable** ←
| Peer admin status. disable - Disable. enable - Enable. |
| **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: HA configuration.
fmgr_system_ha:
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_ha:
clusterid: <value of integer>
file-quota: <value of integer>
hb-interval: <value of integer>
hb-lost-threshold: <value of integer>
mode: <value in [standalone, master, slave, ...]>
password: <value of string>
peer:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
serial-number: <value of string>
status: <value in [disable, enable]>
local-cert: <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_internetservicecustom – Configure custom Internet Services. fortinet.fortimanager.fmgr\_firewall\_internetservicecustom – Configure custom Internet Services.
=================================================================================================
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`.
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** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **disable-entry** list / elements=string | | no description |
| | | **id** integer | | Disable entry ID. |
| | | **ip-range** list / elements=string | | no description |
| | | | **end-ip** string | | End IP address. |
| | | | **id** integer | | Disable entry range ID. |
| | | | **start-ip** string | | Start IP address. |
| | | **port** integer | | no description |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **entry** list / elements=string | | no description |
| | | **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). |
| | **id** integer | | Internet Service ID. |
| | **master-service-id** string | | Internet Service ID in the Internet Service database. |
| | **name** string | | Internet Service name. |
| | **reputation** integer | | Reputation level of the custom Internet Service. |
| **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 custom Internet Services.
fmgr_firewall_internetservicecustom:
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_internetservicecustom:
comment: <value of string>
disable-entry:
-
id: <value of integer>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
port: <value of integer>
protocol: <value of integer>
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>
master-service-id: <value of string>
name: <value of string>
reputation: <value of integer>
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_system_replacemsggroup_mm4 – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mm4 – 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_mm4`.
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\_mm4** 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
* informational
* auto
* not-included
| message class |
| | **domain** string | | from address domain |
| | **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-net-prob
* err-content-not-accept
* err-unsupp-msg
| response status |
| | **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_mm4:
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_mm4:
add-smil: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, informational, ...]>
domain: <value of string>
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, ...]>
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_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs. fortinet.fortimanager.fmgr\_firewall\_vip64 – Configure IPv6 to IPv4 virtual IPs.
=================================================================================
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_vip64`.
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\_vip64** dictionary | | the top level parameters set |
| | **arp-reply** string | **Choices:*** disable
* enable
| Enable ARP reply. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **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 |
| | | **extip** string | | no description |
| | | **extport** string | | no description |
| | | **id** integer | | no description |
| | | **ldb-method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| no description |
| | | **mappedip** string | | no description |
| | | **mappedport** string | | no description |
| | | **monitor** string | | no description |
| | | **portforward** string | **Choices:*** disable
* enable
| no description |
| | | **protocol** string | **Choices:*** tcp
* udp
| no description |
| | | **server-type** string | **Choices:*** http
* tcp
* udp
* ip
| no description |
| | | **src-filter** string | | no description |
| | | **type** string | **Choices:*** static-nat
* server-load-balance
| no description |
| | | **uuid** string | | no description |
| | **extip** string | | Start-external-IP [-end-external-IP]. |
| | **extport** string | | External service port. |
| | **id** integer | | Custom defined id. |
| | **ldb-method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| Load balance method. |
| | **mappedip** string | | Start-mapped-IP [-end-mapped-IP]. |
| | **mappedport** string | | Mapped service port. |
| | **monitor** string | | Health monitors. |
| | **name** string | | VIP64 name. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable port forwarding. |
| | **protocol** string | **Choices:*** tcp
* udp
| Mapped port protocol. |
| | **realservers** list / elements=string | | no description |
| | | **client-ip** string | | Restrict server to a client IP in this range. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | | **holddown-interval** integer | | Hold down interval. |
| | | **id** integer | | Real server ID. |
| | | **ip** string | | Mapped server IP. |
| | | **max-connections** integer | | Maximum number of connections allowed to server. |
| | | **monitor** string | | Health monitors. |
| | | **port** integer | | Mapped server port. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | | **weight** integer | | no description |
| | **server-type** string | **Choices:*** http
* tcp
* udp
* ip
| Server type. |
| | **src-filter** string | | no description |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| VIP type: static NAT. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 IPv6 to IPv4 virtual IPs.
fmgr_firewall_vip64:
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_vip64:
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
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>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <value of string>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
name: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
id: <value of integer>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <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_metadata_admins – Configure admins. fortinet.fortimanager.fmgr\_system\_metadata\_admins – Configure admins.
========================================================================
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_metadata_admins`.
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\_metadata\_admins** dictionary | | the top level parameters set |
| | **fieldlength** string | **Choices:*** 20
* **50** ←
* 255
| Field length. 20 - Field length of 20. 50 - Field length of 50. 255 - Field length of 255. |
| | **fieldname** string | | Field name. |
| | **importance** string | **Choices:*** optional
* **required** ←
| Field importance. optional - This field is optional. required - This field is required. |
| | **status** string | **Choices:*** disabled
* **enabled** ←
| Field status. disabled - This field is disabled. enabled - This field is enabled. |
| **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 admins.
fmgr_system_metadata_admins:
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_metadata_admins:
fieldlength: <value in [20, 50, 255]>
fieldname: <value of string>
importance: <value in [optional, required]>
status: <value in [disabled, enabled]>
```
Return Values
-------------
Common return 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_ec – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_ec – 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_ec`.
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\_ec** 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_ec:
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_ec:
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_system_saml – Global settings for SAML authentication. fortinet.fortimanager.fmgr\_system\_saml – Global settings for SAML authentication.
===================================================================================
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_saml`.
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\_saml** dictionary | | the top level parameters set |
| | **acs-url** string | | SP ACS(login) URL. |
| | **cert** string | | Certificate name. |
| | **default-profile** string | **Default:**"Restricted\_User" | Default Profile Name. |
| | **entity-id** string | | SP entity ID. |
| | **fabric-idp** list / elements=string | | no description |
| | | **dev-id** string | | IDP Device ID. |
| | | **idp-cert** string | | IDP Certificate name. |
| | | **idp-entity-id** string | | IDP entity ID. |
| | | **idp-single-logout-url** string | | IDP single logout url. |
| | | **idp-single-sign-on-url** string | | IDP single sign-on URL. |
| | | **idp-status** string | **Choices:*** **disable** ←
* enable
| Enable/disable SAML authentication (default = disable). disable - Disable SAML authentication. enable - Enabld SAML authentication. |
| | **forticloud-sso** string | **Choices:*** **disable** ←
* enable
| Enable/disable FortiCloud SSO (default = disable). disable - Disable Forticloud SSO. enable - Enabld Forticloud SSO. |
| | **idp-cert** string | | IDP Certificate name. |
| | **idp-entity-id** string | | IDP entity ID. |
| | **idp-single-logout-url** string | | IDP single logout url. |
| | **idp-single-sign-on-url** string | | IDP single sign-on URL. |
| | **login-auto-redirect** string | **Choices:*** **disable** ←
* enable
| Enable/Disable auto redirect to IDP login page. disable - Disable auto redirect to IDP Login Page. enable - Enable auto redirect to IDP Login Page. |
| | **role** string | **Choices:*** IDP
* **SP** ←
* FAB-SP
| SAML role. IDP - IDentiy Provider. SP - Service Provider. |
| | **server-address** string | | server address. |
| | **service-providers** list / elements=string | | no description |
| | | **idp-entity-id** string | | IDP Entity ID. |
| | | **idp-single-logout-url** string | | IDP single logout url. |
| | | **idp-single-sign-on-url** string | | IDP single sign-on URL. |
| | | **name** string | | Name. |
| | | **prefix** string | | Prefix. |
| | | **sp-cert** string | | SP certificate name. |
| | | **sp-entity-id** string | | SP Entity ID. |
| | | **sp-single-logout-url** string | | SP single logout URL. |
| | | **sp-single-sign-on-url** string | | SP single sign-on URL. |
| | **sls-url** string | | SP SLS(logout) URL. |
| | **status** string | **Choices:*** **disable** ←
* enable
| Enable/disable SAML authentication (default = disable). disable - Disable SAML authentication. enable - Enabld SAML authentication. |
| **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: Global settings for SAML authentication.
fmgr_system_saml:
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_saml:
acs-url: <value of string>
cert: <value of string>
entity-id: <value of string>
idp-cert: <value of string>
idp-entity-id: <value of string>
idp-single-logout-url: <value of string>
idp-single-sign-on-url: <value of string>
login-auto-redirect: <value in [disable, enable]>
role: <value in [IDP, SP, FAB-SP]>
server-address: <value of string>
service-providers:
-
idp-entity-id: <value of string>
idp-single-logout-url: <value of string>
idp-single-sign-on-url: <value of string>
name: <value of string>
prefix: <value of string>
sp-cert: <value of string>
sp-entity-id: <value of string>
sp-single-logout-url: <value of string>
sp-single-sign-on-url: <value of string>
sls-url: <value of string>
status: <value in [disable, enable]>
default-profile: <value of string>
fabric-idp:
-
dev-id: <value of string>
idp-cert: <value of string>
idp-entity-id: <value of string>
idp-single-logout-url: <value of string>
idp-single-sign-on-url: <value of string>
idp-status: <value in [disable, enable]>
forticloud-sso: <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_replacemsggroup_mms – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mms – 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_mms`.
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\_mms** dictionary | | the top level parameters set |
| | **buffer** string | | Message string. |
| | **charset** string | **Choices:*** us-ascii
* utf-8
| character encoding used for replacement message |
| | **format** string | **Choices:*** none
* text
* html
* wml
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **image** string | | Message string. |
| | **msg-type** string | | Message 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: Replacement message table entries.
fmgr_system_replacemsggroup_mms:
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_mms:
buffer: <value of string>
charset: <value in [us-ascii, utf-8]>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
image: <value of string>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dynamic_multicast_interface – no description fortinet.fortimanager.fmgr\_dynamic\_multicast\_interface – 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_dynamic_multicast_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 |
| --- | --- | --- |
| **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 |
| **dynamic\_multicast\_interface** dictionary | | the top level parameters set |
| | **default-mapping** string | **Choices:*** disable
* enable
| no description |
| | **defmap-intf** string | | no description |
| | **description** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **local-intf** string | | no description |
| | **name** string | | no description |
| **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: no description
fmgr_dynamic_multicast_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, ...]
adom: <your own value>
state: <value in [present, absent]>
dynamic_multicast_interface:
default-mapping: <value in [disable, enable]>
defmap-intf: <value of string>
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
local-intf: <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_pkg_firewall_policy – Configure IPv4 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy – Configure IPv4 policies.
============================================================================
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`.
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** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
* ipsec
* ssl-vpn
| Policy action (allow/deny/ipsec). |
| | **anti-replay** string | **Choices:*** disable
* enable
| Enable/disable anti-replay check. |
| | **app-category** string | | Application category ID list. |
| | **app-group** string | | Application group names. |
| | **application** integer | | no description |
| | **application-list** string | | Name of an existing Application list. |
| | **auth-cert** string | | HTTPS server certificate for policy authentication. |
| | **auth-path** string | **Choices:*** disable
* enable
| Enable/disable authentication-based routing. |
| | **auth-redirect-addr** string | | HTTP-to-HTTPS redirect address for firewall authentication. |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| Enable/disable offloading security profile processing to CP processors. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **best-route** string | **Choices:*** disable
* enable
| Enable/disable the use of best route. |
| | **block-notification** string | **Choices:*** disable
* enable
| Enable/disable block notification. |
| | **captive-portal-exempt** string | **Choices:*** disable
* enable
| Enable to exempt some users from the captive portal. |
| | **capture-packet** string | **Choices:*** disable
* enable
| Enable/disable capture packets. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | no description |
| | **custom-log-fields** string | | Custom fields to append to log messages for this policy. |
| | **decrypted-traffic-mirror** string | | Decrypted traffic mirror. |
| | **delay-tcp-npu-session** string | **Choices:*** disable
* enable
| Enable TCP NPU session delay to guarantee packet order of 3-way handshake. |
| | **devices** string | | Names of devices or device groups that can be matched by the policy. |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| Enable to change packets DiffServ values to the specified diffservcode-forward value. |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode-forward** string | | Change packets DiffServ to this value. |
| | **diffservcode-rev** string | | Change packets reverse (reply) DiffServ to this value. |
| | **disclaimer** string | **Choices:*** disable
* enable
| Enable/disable user authentication disclaimer. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **dscp-match** string | **Choices:*** disable
* enable
| Enable DSCP check. |
| | **dscp-negate** string | **Choices:*** disable
* enable
| Enable negated DSCP match. |
| | **dscp-value** string | | DSCP value. |
| | **dsri** string | **Choices:*** disable
* enable
| Enable DSRI to ignore HTTP server responses. |
| | **dstaddr** string | | Destination address and address group names. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **dstaddr6** string | | Destination IPv6 address name and address group names. |
| | **dstintf** string | | Outgoing (egress) interface. |
| | **dynamic-shaping** string | **Choices:*** disable
* enable
| Enable/disable dynamic RADIUS defined traffic shaping. |
| | **email-collect** string | **Choices:*** disable
* enable
| Enable/disable email collection. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **file-filter-profile** string | | Name of an existing file-filter profile. |
| | **firewall-session-dirty** string | **Choices:*** check-all
* check-new
| How to handle sessions if the configuration of this firewall policy changes. |
| | **fixedport** string | **Choices:*** disable
* enable
| Enable to prevent source NAT from changing a sessions source port. |
| | **fsso** string | **Choices:*** disable
* enable
| Enable/disable Fortinet Single Sign-On. |
| | **fsso-agent-for-ntlm** string | | FSSO agent to use for NTLM authentication. |
| | **fsso-groups** string | | Names of FSSO groups. |
| | **geoip-anycast** string | **Choices:*** disable
* enable
| Enable/disable recognition of anycast IP addresses using the geography IP database. |
| | **geoip-match** string | **Choices:*** physical-location
* registered-location
| Match geography address based either on its physical location or registered location. |
| | **global-label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** string | | Names of user groups that can authenticate with this policy. |
| | **gtp-profile** string | | GTP profile. |
| | **http-policy-redirect** string | **Choices:*** disable
* enable
| Redirect HTTP(S) traffic to matching transparent web proxy policy. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **identity-based-route** string | | Name of identity-based routing rule. |
| | **inbound** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service Name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-name** string | | Internet Service name. |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| When enabled internet-service specifies what the service must NOT be. |
| | **internet-service-src** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet-service-src-custom** string | | Custom Internet Service source name. |
| | **internet-service-src-custom-group** string | | Custom Internet Service source group name. |
| | **internet-service-src-group** string | | Internet Service source group name. |
| | **internet-service-src-id** string | | Internet Service source ID. |
| | **internet-service-src-name** string | | Internet Service source name. |
| | **internet-service-src-negate** string | **Choices:*** disable
* enable
| When enabled internet-service-src specifies what the service must NOT be. |
| | **ippool** string | **Choices:*** disable
* enable
| Enable to use IP Pools for source NAT. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **label** string | | Label for the policy that appears when the GUI is in Section View mode. |
| | **learning-mode** string | **Choices:*** disable
* enable
| Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be g... |
| | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts and ends. |
| | **match-vip** string | **Choices:*** disable
* enable
| Enable to match packets that have had their destination addresses changed by a VIP. |
| | **match-vip-only** string | **Choices:*** disable
* enable
| Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **nat** string | **Choices:*** disable
* enable
| Enable/disable source NAT. |
| | **natinbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: apply destination NAT to inbound traffic. |
| | **natip** string | | Policy-based IPsec VPN: source NAT IP address for outgoing traffic. |
| | **natoutbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: apply source NAT to outbound traffic. |
| | **np-acceleration** string | **Choices:*** disable
* enable
| Enable/disable UTM Network Processor acceleration. |
| | **ntlm** string | **Choices:*** disable
* enable
| Enable/disable NTLM authentication. |
| | **ntlm-enabled-browsers** string | | no description |
| | **ntlm-guest** string | **Choices:*** disable
* enable
| Enable/disable NTLM guest user access. |
| | **object position** list / elements=string | | no description |
| | **outbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. |
| | **passive-wan-health-measurement** string | **Choices:*** disable
* enable
| Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. |
| | **per-ip-shaper** string | | Per-IP traffic shaper. |
| | **permit-any-host** string | **Choices:*** disable
* enable
| Accept UDP packets from any host. |
| | **permit-stun-host** string | **Choices:*** disable
* enable
| Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. |
| | **policyid** integer | | Policy ID. |
| | **poolname** string | | IP Pool names. |
| | **poolname6** string | | IPv6 pool names. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **radius-mac-auth-bypass** string | **Choices:*** disable
* enable
| Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. |
| | **redirect-url** string | | URL users are directed to after seeing and accepting the disclaimer or authenticating. |
| | **replacemsg-override-group** string | | Override the default replacement message group for this policy. |
| | **reputation-direction** string | **Choices:*** source
* destination
| Direction of the initial traffic for reputation to take effect. |
| | **reputation-minimum** integer | | Minimum Reputation to take action. |
| | **rsso** string | **Choices:*** disable
* enable
| Enable/disable RADIUS single sign-on (RSSO). |
| | **rtp-addr** string | | Address names if this is an RTP NAT policy. |
| | **rtp-nat** string | **Choices:*** disable
* enable
| Enable Real Time Protocol (RTP) NAT. |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| Block or monitor connections to Botnet servers or disable Botnet scanning. |
| | **schedule** string | | Schedule name. |
| | **schedule-timeout** string | **Choices:*** disable
* enable
| Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity. |
| | **send-deny-packet** string | **Choices:*** disable
* enable
| Enable to send a reply when a session is denied or blocked by a firewall policy. |
| | **service** string | | Service and service group names. |
| | **service-negate** string | **Choices:*** disable
* enable
| When enabled service specifies what the service must NOT be. |
| | **session-ttl** integer | | Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. |
| | **spamfilter-profile** string | | Name of an existing Spam filter profile. |
| | **src-vendor-mac** string | | Vendor MAC source ID. |
| | **srcaddr** string | | Source address and address group names. |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **srcaddr6** string | | Source IPv6 address name and address group names. |
| | **srcintf** string | | Incoming (ingress) interface. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl-mirror** string | **Choices:*** disable
* enable
| Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). |
| | **ssl-mirror-intf** string | | SSL mirror interface name. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| Enable or disable this policy. |
| | **tags** string | | Names of object-tags applied to this policy. |
| | **tcp-mss-receiver** integer | | Receiver TCP maximum segment size (MSS). |
| | **tcp-mss-sender** integer | | Sender TCP maximum segment size (MSS). |
| | **tcp-session-without-syn** string | **Choices:*** all
* data-only
* disable
| Enable/disable creation of TCP session without SYN flag. |
| | **timeout-send-rst** string | **Choices:*** disable
* enable
| Enable/disable sending RST packets when TCP sessions expire. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos-mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos-negate** string | **Choices:*** disable
* enable
| Enable negated TOS match. |
| | **traffic-shaper** string | | Traffic shaper. |
| | **traffic-shaper-reverse** string | | Reverse traffic shaper. |
| | **url-category** string | | URL category ID list. |
| | **users** string | | Names of individual users that can authenticate with this policy. |
| | **utm-status** string | **Choices:*** disable
* enable
| Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **vlan-cos-fwd** integer | | VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. |
| | **vlan-cos-rev** integer | | VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest.. |
| | **vlan-filter** string | | Set VLAN filters. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **vpn\_dst\_node** list / elements=string | | no description |
| | | **host** string | | no description |
| | | **seq** integer | | no description |
| | | **subnet** string | | no description |
| | **vpn\_src\_node** list / elements=string | | no description |
| | | **host** string | | no description |
| | | **seq** integer | | no description |
| | | **subnet** string | | no description |
| | **vpntunnel** string | | Policy-based IPsec VPN: name of the IPsec VPN Phase 1. |
| | **waf-profile** string | | Name of an existing Web application firewall profile. |
| | **wanopt** string | **Choices:*** disable
* enable
| Enable/disable WAN optimization. |
| | **wanopt-detection** string | **Choices:*** active
* passive
* off
| WAN optimization auto-detection mode. |
| | **wanopt-passive-opt** string | **Choices:*** default
* transparent
* non-transparent
| WAN optimization passive mode options. This option decides what IP address will be used to connect server. |
| | **wanopt-peer** string | | WAN optimization peer. |
| | **wanopt-profile** string | | WAN optimization profile. |
| | **wccp** string | **Choices:*** disable
* enable
| Enable/disable forwarding traffic matching this policy to a configured WCCP server. |
| | **webcache** string | **Choices:*** disable
* enable
| Enable/disable web cache. |
| | **webcache-https** string | **Choices:*** disable
* ssl-server
* any
* enable
| Enable/disable web cache for HTTPS. |
| | **webfilter-profile** string | | Name of an existing Web filter profile. |
| | **webproxy-forward-server** string | | Webproxy forward server name. |
| | **webproxy-profile** string | | Webproxy profile name. |
| | **wsso** string | **Choices:*** disable
* enable
| Enable/disable WiFi Single Sign On (WSSO). |
| | **ztna-ems-tag** string | | Source ztna-ems-tag names. |
| | **ztna-geo-tag** string | | Source ztna-geo-tag names. |
| | **ztna-status** string | **Choices:*** disable
* enable
| Enable/disable zero trust access. |
| **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 policies.
fmgr_pkg_firewall_policy:
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>
state: <value in [present, absent]>
pkg_firewall_policy:
action: <value in [deny, accept, ipsec, ...]>
app-category: <value of string>
application: <value of integer>
application-list: <value of string>
auth-cert: <value of string>
auth-path: <value in [disable, enable]>
auth-redirect-addr: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
block-notification: <value in [disable, enable]>
captive-portal-exempt: <value in [disable, enable]>
capture-packet: <value in [disable, enable]>
comments: <value of string>
custom-log-fields: <value of string>
delay-tcp-npu-session: <value in [disable, enable]>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
disclaimer: <value in [disable, enable]>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstintf: <value of string>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
fsso: <value in [disable, enable]>
fsso-agent-for-ntlm: <value of string>
global-label: <value of string>
groups: <value of string>
gtp-profile: <value of string>
icap-profile: <value of string>
identity-based-route: <value of string>
inbound: <value in [disable, enable]>
internet-service: <value in [disable, enable]>
internet-service-custom: <value of string>
internet-service-id: <value of string>
internet-service-negate: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
learning-mode: <value in [disable, enable]>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-start: <value in [disable, enable]>
match-vip: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natip: <value of string>
natoutbound: <value in [disable, enable]>
ntlm: <value in [disable, enable]>
ntlm-enabled-browsers: <value of string>
ntlm-guest: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
permit-any-host: <value in [disable, enable]>
permit-stun-host: <value in [disable, enable]>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
radius-mac-auth-bypass: <value in [disable, enable]>
redirect-url: <value of string>
replacemsg-override-group: <value of string>
rsso: <value in [disable, enable]>
rtp-addr: <value of string>
rtp-nat: <value in [disable, enable]>
scan-botnet-connections: <value in [disable, block, monitor]>
schedule: <value of string>
schedule-timeout: <value in [disable, enable]>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcintf: <value of string>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
voip-profile: <value of string>
vpn_dst_node:
-
host: <value of string>
seq: <value of integer>
subnet: <value of string>
vpn_src_node:
-
host: <value of string>
seq: <value of integer>
subnet: <value of string>
vpntunnel: <value of string>
waf-profile: <value of string>
wanopt: <value in [disable, enable]>
wanopt-detection: <value in [active, passive, off]>
wanopt-passive-opt: <value in [default, transparent, non-transparent]>
wanopt-peer: <value of string>
wanopt-profile: <value of string>
wccp: <value in [disable, enable]>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, ssl-server, any, ...]>
webfilter-profile: <value of string>
wsso: <value in [disable, enable]>
anti-replay: <value in [disable, enable]>
app-group: <value of string>
cifs-profile: <value of string>
email-collect: <value in [disable, enable]>
emailfilter-profile: <value of string>
fsso-groups: <value of string>
geoip-anycast: <value in [disable, enable]>
http-policy-redirect: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
internet-service-src-negate: <value in [disable, enable]>
match-vip-only: <value in [disable, enable]>
np-acceleration: <value in [disable, enable]>
reputation-direction: <value in [source, destination]>
reputation-minimum: <value of integer>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
vlan-filter: <value of string>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
best-route: <value in [disable, enable]>
decrypted-traffic-mirror: <value of string>
dstaddr6: <value of string>
geoip-match: <value in [physical-location, registered-location]>
internet-service-name: <value of string>
internet-service-src-name: <value of string>
poolname6: <value of string>
src-vendor-mac: <value of string>
srcaddr6: <value of string>
file-filter-profile: <value of string>
dynamic-shaping: <value in [disable, enable]>
passive-wan-health-measurement: <value in [disable, enable]>
videofilter-profile: <value of string>
ztna-ems-tag: <value of string>
ztna-geo-tag: <value of string>
ztna-status: <value in [disable, enable]>
object position: <value of list>
```
Return Values
-------------
Common return 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_pkg_firewall_securitypolicy – Configure NGFW IPv4/IPv6 application policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_securitypolicy – Configure NGFW IPv4/IPv6 application policies.
==========================================================================================================
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_securitypolicy`.
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\_securitypolicy** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
| Policy action (accept/deny). |
| | **app-category** string | | Application category ID list. |
| | **app-group** string | | Application group names. |
| | **application** integer | | no description |
| | **application-list** string | | Name of an existing Application list. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | Comment. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **dstaddr** string | | Destination IPv4 address name and address group names. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. |
| | **dstaddr4** string | | Destination IPv4 address name and address group names. |
| | **dstaddr6** string | | Destination IPv6 address name and address group names. |
| | **dstintf** string | | Outgoing (egress) interface. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **enforce-default-app-port** string | **Choices:*** disable
* enable
| Enable/disable default application port enforcement for allowed applications. |
| | **file-filter-profile** string | | Name of an existing file-filter profile. |
| | **fsso-groups** string | | Names of FSSO groups. |
| | **global-label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** string | | Names of user groups that can authenticate with this policy. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **internet-service** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-name** string | | Internet Service name. |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| When enabled internet-service specifies what the service must NOT be. |
| | **internet-service-src** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet-service-src-custom** string | | Custom Internet Service source name. |
| | **internet-service-src-custom-group** string | | Custom Internet Service source group name. |
| | **internet-service-src-group** string | | Internet Service source group name. |
| | **internet-service-src-id** string | | Internet Service source ID. |
| | **internet-service-src-name** string | | Internet Service source name. |
| | **internet-service-src-negate** string | **Choices:*** disable
* enable
| When enabled internet-service-src specifies what the service must NOT be. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **learning-mode** string | **Choices:*** disable
* enable
| Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be g... |
| | **logtraffic** string | **Choices:*** disable
* all
* utm
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **policyid** integer | | Policy ID. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **schedule** string | | Schedule 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** string | | Service and service group names. |
| | **service-negate** string | **Choices:*** disable
* enable
| When enabled service specifies what the service must NOT be. |
| | **srcaddr** string | | Source IPv4 address name and address group names. |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. |
| | **srcaddr4** string | | Source IPv4 address name and address group names. |
| | **srcaddr6** string | | Source IPv6 address name and address group names. |
| | **srcintf** string | | Incoming (ingress) interface. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| Enable or disable this policy. |
| | **url-category** string | | URL category ID list. |
| | **users** string | | Names of individual users that can authenticate with this policy. |
| | **utm-status** string | **Choices:*** disable
* enable
| Enable security profiles. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **videofilter-profile** string | | Name of an existing VideoFilter profile. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **webfilter-profile** string | | Name of an existing Web filter profile. |
| **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 NGFW IPv4/IPv6 application policies.
fmgr_pkg_firewall_securitypolicy:
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>
state: <value in [present, absent]>
pkg_firewall_securitypolicy:
action: <value in [deny, accept]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-list: <value of string>
av-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dstaddr4: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
emailfilter-profile: <value of string>
enforce-default-app-port: <value in [disable, enable]>
groups: <value of string>
icap-profile: <value of string>
internet-service: <value in [disable, enable]>
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>
internet-service-negate: <value in [disable, enable]>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
internet-service-src-negate: <value in [disable, enable]>
ips-sensor: <value of string>
logtraffic: <value in [disable, all, utm]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
policyid: <value of integer>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
schedule: <value of string>
service: <value of string>
service-negate: <value in [disable, enable]>
srcaddr4: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
voip-profile: <value of string>
webfilter-profile: <value of string>
fsso-groups: <value of string>
global-label: <value of string>
send-deny-packet: <value in [disable, enable]>
dstaddr: <value of string>
internet-service-name: <value of string>
internet-service-src-name: <value of string>
srcaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
file-filter-profile: <value of string>
srcaddr-negate: <value in [disable, enable]>
learning-mode: <value in [disable, enable]>
videofilter-profile: <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_logfetch_serversettings – Log-fetch server settings. fortinet.fortimanager.fmgr\_system\_logfetch\_serversettings – Log-fetch server 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_logfetch_serversettings`.
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\_logfetch\_serversettings** dictionary | | the top level parameters set |
| | **max-conn-per-session** integer | **Default:**3 | Max concurrent file download connections per session. |
| | **max-sessions** integer | **Default:**1 | Max concurrent fetch sessions. |
| | **session-timeout** integer | **Default:**10 | Fetch session timeout in minute. |
| **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-fetch server settings.
fmgr_system_logfetch_serversettings:
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_logfetch_serversettings:
max-conn-per-session: <value of integer>
max-sessions: <value of integer>
session-timeout: <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_pm_config_metafields_firewall_service_custom – no description fortinet.fortimanager.fmgr\_pm\_config\_metafields\_firewall\_service\_custom – 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_pm_config_metafields_firewall_service_custom`.
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 |
| **pm\_config\_metafields\_firewall\_service\_custom** dictionary | | the top level parameters set |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **length** integer | | 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_pm_config_metafields_firewall_service_custom:
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, ...]
pm_config_metafields_firewall_service_custom:
importance: <value in [optional, required]>
length: <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_dvm_cmd_del_devlist – Delete a list of devices. fortinet.fortimanager.fmgr\_dvm\_cmd\_del\_devlist – Delete a list of 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_del_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\_del\_devlist** dictionary | | the top level parameters set |
| | **adom** string | | Name or ID of the ADOM where the command is to be executed on. |
| | **del-dev-member-list** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **flags** list / elements=string | **Choices:*** none
* create\_task
* nonblocking
* log\_dev
| 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: Delete a list of devices.
fmgr_dvm_cmd_del_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_del_devlist:
adom: <value of string>
del-dev-member-list:
-
name: <value of string>
vdom: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
```
Return Values
-------------
Common return 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_metafields_group – no description fortinet.fortimanager.fmgr\_dvmdb\_metafields\_group – 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_metafields_group`.
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 |
| **dvmdb\_metafields\_group** dictionary | | the top level parameters set |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **length** integer | | no description |
| | **name** string | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| **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: no description
fmgr_dvmdb_metafields_group:
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, ...]
dvmdb_metafields_group:
importance: <value in [optional, required]>
length: <value of integer>
name: <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_waf_profile – Web application firewall configuration. fortinet.fortimanager.fmgr\_waf\_profile – Web application firewall 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_waf_profile`.
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 |
| **waf\_profile** dictionary | | the top level parameters set |
| | **address-list** dictionary | | no description |
| | | **blocked-address** string | | Blocked address. |
| | | **blocked-log** string | **Choices:*** disable
* enable
| Enable/disable logging on blocked addresses. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Status. |
| | | **trusted-address** string | | Trusted address. |
| | **comment** string | | Comment. |
| | **constraint** dictionary | | no description |
| | | **content-length** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP content in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **exception** list / elements=string | | no description |
| | | | **address** string | | Host address. |
| | | | **content-length** string | **Choices:*** disable
* enable
| HTTP content length in request. |
| | | | **header-length** string | **Choices:*** disable
* enable
| HTTP header length in request. |
| | | | **hostname** string | **Choices:*** disable
* enable
| Enable/disable hostname check. |
| | | | **id** integer | | Exception ID. |
| | | | **line-length** string | **Choices:*** disable
* enable
| HTTP line length in request. |
| | | | **malformed** string | **Choices:*** disable
* enable
| Enable/disable malformed HTTP request check. |
| | | | **max-cookie** string | **Choices:*** disable
* enable
| Maximum number of cookies in HTTP request. |
| | | | **max-header-line** string | **Choices:*** disable
* enable
| Maximum number of HTTP header line. |
| | | | **max-range-segment** string | **Choices:*** disable
* enable
| Maximum number of range segments in HTTP range line. |
| | | | **max-url-param** string | **Choices:*** disable
* enable
| Maximum number of parameters in URL. |
| | | | **method** string | **Choices:*** disable
* enable
| Enable/disable HTTP method check. |
| | | | **param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL, HTTP POST request or HTTP body. |
| | | | **pattern** string | | URL pattern. |
| | | | **regex** string | **Choices:*** disable
* enable
| Enable/disable regular expression based pattern match. |
| | | | **url-param-length** string | **Choices:*** disable
* enable
| Maximum length of parameter in URL. |
| | | | **version** string | **Choices:*** disable
* enable
| Enable/disable HTTP version check. |
| | | **header-length** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP header in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **hostname** dictionary | | no description |
| | | | **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. |
| | | **line-length** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Length of HTTP line in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **malformed** dictionary | | no description |
| | | | **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. |
| | | **max-cookie** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **max-cookie** integer | | Maximum number of cookies in HTTP request (0 to 2147483647). |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **max-header-line** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **max-header-line** integer | | Maximum number HTTP header lines (0 to 2147483647). |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **max-range-segment** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **max-range-segment** integer | | Maximum number of range segments in HTTP range line (0 to 2147483647). |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **max-url-param** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **max-url-param** integer | | Maximum number of parameters in URL (0 to 2147483647). |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **method** dictionary | | no description |
| | | | **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. |
| | | **param-length** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Maximum length of parameter in URL, HTTP POST request or HTTP body in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **url-param-length** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
| Action. |
| | | | **length** integer | | Maximum length of URL parameter in bytes (0 to 2147483647). |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Enable/disable the constraint. |
| | | **version** dictionary | | no description |
| | | | **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. |
| | **extended-log** string | **Choices:*** disable
* enable
| Enable/disable extended logging. |
| | **external** string | **Choices:*** disable
* enable
| Disable/Enable external HTTP Inspection. |
| | **method** dictionary | | no description |
| | | **default-allowed-methods** list / elements=string | **Choices:*** delete
* get
* head
* options
* post
* put
* trace
* others
* connect
| no description |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | **method-policy** list / elements=string | | no description |
| | | | **address** string | | Host address. |
| | | | **allowed-methods** list / elements=string | **Choices:*** delete
* get
* head
* options
* post
* put
* trace
* others
* connect
| no description |
| | | | **id** integer | | HTTP method policy ID. |
| | | | **pattern** string | | URL pattern. |
| | | | **regex** string | **Choices:*** disable
* enable
| Enable/disable regular expression based pattern match. |
| | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | **status** string | **Choices:*** disable
* enable
| Status. |
| | **name** string | | WAF Profile name. |
| | **signature** dictionary | | no description |
| | | **credit-card-detection-threshold** integer | | The minimum number of Credit cards to detect violation. |
| | | **custom-signature** list / elements=string | | no description |
| | | | **action** string | **Choices:*** allow
* block
* erase
| Action. |
| | | | **case-sensitivity** string | **Choices:*** disable
* enable
| Case sensitivity in pattern. |
| | | | **direction** string | **Choices:*** request
* response
| Traffic direction. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **name** string | | Signature name. |
| | | | **pattern** string | | Match pattern. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Status. |
| | | | **target** list / elements=string | **Choices:*** arg
* arg-name
* req-body
* req-cookie
* req-cookie-name
* req-filename
* req-header
* req-header-name
* req-raw-uri
* req-uri
* resp-body
* resp-hdr
* resp-status
| no description |
| | | **disabled-signature** string | | Disabled signatures |
| | | **disabled-sub-class** string | | Disabled signature subclasses. |
| | | **main-class** dictionary | | no description |
| | | | **action** string | **Choices:*** allow
* block
* erase
| Action. |
| | | | **id** integer | | Main signature class ID. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | | | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | | | **status** string | **Choices:*** disable
* enable
| Status. |
| | **url-access** list / elements=string | | no description |
| | | **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: Web application firewall configuration.
fmgr_waf_profile:
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]>
waf_profile:
comment: <value of string>
extended-log: <value in [disable, enable]>
external: <value in [disable, enable]>
name: <value of string>
url-access:
-
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]>
address-list:
blocked-address: <value of string>
blocked-log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
trusted-address: <value of string>
constraint:
content-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
exception:
-
address: <value of string>
content-length: <value in [disable, enable]>
header-length: <value in [disable, enable]>
hostname: <value in [disable, enable]>
id: <value of integer>
line-length: <value in [disable, enable]>
malformed: <value in [disable, enable]>
max-cookie: <value in [disable, enable]>
max-header-line: <value in [disable, enable]>
max-range-segment: <value in [disable, enable]>
max-url-param: <value in [disable, enable]>
method: <value in [disable, enable]>
param-length: <value in [disable, enable]>
pattern: <value of string>
regex: <value in [disable, enable]>
url-param-length: <value in [disable, enable]>
version: <value in [disable, enable]>
header-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
hostname:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
line-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
malformed:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-cookie:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-cookie: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-header-line:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-header-line: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-range-segment:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-range-segment: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
max-url-param:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-url-param: <value of integer>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
method:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
param-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
url-param-length:
action: <value in [allow, block]>
length: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
version:
action: <value in [allow, block]>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
method:
default-allowed-methods:
- delete
- get
- head
- options
- post
- put
- trace
- others
- connect
log: <value in [disable, enable]>
method-policy:
-
address: <value of string>
allowed-methods:
- delete
- get
- head
- options
- post
- put
- trace
- others
- connect
id: <value of integer>
pattern: <value of string>
regex: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
signature:
credit-card-detection-threshold: <value of integer>
custom-signature:
-
action: <value in [allow, block, erase]>
case-sensitivity: <value in [disable, enable]>
direction: <value in [request, response]>
log: <value in [disable, enable]>
name: <value of string>
pattern: <value of string>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
target:
- arg
- arg-name
- req-body
- req-cookie
- req-cookie-name
- req-filename
- req-header
- req-header-name
- req-raw-uri
- req-uri
- resp-body
- resp-hdr
- resp-status
disabled-signature: <value of string>
disabled-sub-class: <value of string>
main-class:
action: <value in [allow, block, erase]>
id: <value of integer>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_dvmdb_workspace_unlock – Unlock an entire ADOM. fortinet.fortimanager.fmgr\_dvmdb\_workspace\_unlock – Unlock an entire ADOM.
=============================================================================
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`.
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 |
| **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 an entire ADOM.
fmgr_dvmdb_workspace_unlock:
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>
```
Return Values
-------------
Common return 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_anqpnairealm_nailist – NAI list. fortinet.fortimanager.fmgr\_hotspot20\_anqpnairealm\_nailist – NAI 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_hotspot20_anqpnairealm_nailist`.
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 |
| **anqp-nai-realm** string / required | | the parameter (anqp-nai-realm) 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\_anqpnairealm\_nailist** dictionary | | the top level parameters set |
| | **eap-method** list / elements=string | | no description |
| | | **auth-param** list / elements=string | | no description |
| | | | **id** string | **Choices:*** non-eap-inner-auth
* inner-auth-eap
* credential
* tunneled-credential
| ID of authentication parameter. |
| | | | **index** integer | | 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 | | 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 | | NAI realm 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: NAI list.
fmgr_hotspot20_anqpnairealm_nailist:
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>
anqp-nai-realm: <your own value>
state: <value in [present, absent]>
hotspot20_anqpnairealm_nailist:
eap-method:
-
auth-param:
-
id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
index: <value of integer>
val: <value in [eap-identity, eap-md5, eap-tls, ...]>
index: <value of integer>
method: <value in [eap-identity, eap-md5, eap-tls, ...]>
encoding: <value in [disable, enable]>
nai-realm: <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_fsp_vlan_interface_vrrp – VRRP configuration. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface\_vrrp – VRRP 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_fsp_vlan_interface_vrrp`.
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 |
| **fsp\_vlan\_interface\_vrrp** dictionary | | the top level parameters set |
| | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | **adv-interval** integer | | no description |
| | **ignore-default-route** string | **Choices:*** disable
* enable
| no description |
| | **preempt** string | **Choices:*** disable
* enable
| no description |
| | **priority** integer | | no description |
| | **start-time** integer | | no description |
| | **status** string | **Choices:*** disable
* enable
| no description |
| | **version** string | **Choices:*** 2
* 3
| no description |
| | **vrdst** string | | no description |
| | **vrdst-priority** integer | | no description |
| | **vrgrp** integer | | no description |
| | **vrid** integer | | no description |
| | **vrip** 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 |
| **vlan** string / required | | the parameter (vlan) 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: VRRP configuration.
fmgr_fsp_vlan_interface_vrrp:
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>
vlan: <your own value>
state: <value in [present, absent]>
fsp_vlan_interface_vrrp:
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
ignore-default-route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <value of string>
vrdst-priority: <value of integer>
vrgrp: <value of integer>
vrid: <value of integer>
vrip: <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_meta_sysmetafields – no description fortinet.fortimanager.fmgr\_system\_meta\_sysmetafields – 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_system_meta_sysmetafields`.
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 |
| **meta** string / required | | the parameter (meta) 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\_meta\_sysmetafields** dictionary | | the top level parameters set |
| | **fieldlength** integer | | no description |
| | **importance** string | **Choices:*** optional
* required
| no description |
| | **name** 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_system_meta_sysmetafields:
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>
meta: <your own value>
state: <value in [present, absent]>
system_meta_sysmetafields:
fieldlength: <value of integer>
importance: <value in [optional, required]>
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_firewall_vipgrp_dynamicmapping – Configure IPv4 virtual IP groups. fortinet.fortimanager.fmgr\_firewall\_vipgrp\_dynamicmapping – Configure IPv4 virtual IP 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_vipgrp_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 |
| --- | --- | --- |
| **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\_vipgrp\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **color** integer | | no description |
| | **comments** string | | no description |
| | **interface** string | | no description |
| | **member** string | | no description |
| | **uuid** 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 |
| **vipgrp** string / required | | the parameter (vipgrp) 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: Configure IPv4 virtual IP groups.
fmgr_firewall_vipgrp_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>
vipgrp: <your own value>
state: <value in [present, absent]>
firewall_vipgrp_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
color: <value of integer>
comments: <value of string>
interface: <value of string>
member: <value of string>
uuid: <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_ips_sensor_entries_exemptip – Traffic from selected source or destination IP addresses is exempt from this signature. fortinet.fortimanager.fmgr\_ips\_sensor\_entries\_exemptip – Traffic from selected source or destination IP addresses is exempt from this signature.
====================================================================================================================================================
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_ips_sensor_entries_exemptip`.
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 |
| **entries** string / required | | the parameter (entries) in requested url |
| **ips\_sensor\_entries\_exemptip** dictionary | | the top level parameters set |
| | **dst-ip** string | | Destination IP address and netmask. |
| | **id** integer | | Exempt IP ID. |
| | **src-ip** string | | Source IP address and netmask. |
| **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 |
| **sensor** string / required | | the parameter (sensor) in requested url |
| **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: Traffic from selected source or destination IP addresses is exempt from this signature.
fmgr_ips_sensor_entries_exemptip:
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>
sensor: <your own value>
entries: <your own value>
state: <value in [present, absent]>
ips_sensor_entries_exemptip:
dst-ip: <value of string>
id: <value of integer>
src-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_adom_options – no description fortinet.fortimanager.fmgr\_adom\_options – 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_adom_options`.
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 |
| **adom\_options** dictionary | | the top level parameters set |
| | **assign\_excluded** string | **Choices:*** disable
* enable
| no description |
| | **specify\_assign\_pkg\_list** string | **Choices:*** disable
* enable
| no description |
| **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 |
| **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_adom_options:
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>
adom_options:
assign_excluded: <value in [disable, enable]>
specify_assign_pkg_list: <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_categories – no description fortinet.fortimanager.fmgr\_webfilter\_categories – 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_webfilter_categories`.
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 |
| **webfilter\_categories** dictionary | | the top level parameters set |
| | **id** 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_webfilter_categories:
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]>
webfilter_categories:
id: <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_saml – SAML server entry configuration. fortinet.fortimanager.fmgr\_user\_saml – SAML 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_saml`.
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\_saml** dictionary | | the top level parameters set |
| | **adfs-claim** string | **Choices:*** disable
* enable
| Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable). |
| | **cert** string | | Certificate to sign SAML messages. |
| | **digest-method** string | **Choices:*** sha1
* sha256
| Digest Method Algorithm. (default = sha1). |
| | **entity-id** string | | SP entity ID. |
| | **group-claim-type** string | **Choices:*** email
* given-name
* name
* upn
* common-name
* email-adfs-1x
* group
* upn-adfs-1x
* role
* sur-name
* ppid
* name-identifier
* authentication-method
* deny-only-group-sid
* deny-only-primary-sid
* deny-only-primary-group-sid
* group-sid
* primary-group-sid
* primary-sid
* windows-account-name
| Group claim in assertion statement. |
| | **group-name** string | | Group name in assertion statement. |
| | **idp-cert** string | | IDP Certificate name. |
| | **idp-entity-id** string | | IDP entity ID. |
| | **idp-single-logout-url** string | | IDP single logout url. |
| | **idp-single-sign-on-url** string | | IDP single sign-on URL. |
| | **limit-relaystate** string | **Choices:*** disable
* enable
| Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). |
| | **name** string | | SAML server entry name. |
| | **single-logout-url** string | | SP single logout URL. |
| | **single-sign-on-url** string | | SP single sign-on URL. |
| | **user-claim-type** string | **Choices:*** email
* given-name
* name
* upn
* common-name
* email-adfs-1x
* group
* upn-adfs-1x
* role
* sur-name
* ppid
* name-identifier
* authentication-method
* deny-only-group-sid
* deny-only-primary-sid
* deny-only-primary-group-sid
* group-sid
* primary-group-sid
* primary-sid
* windows-account-name
| User name claim in assertion statement. |
| | **user-name** string | | User name in assertion statement. |
| **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: SAML server entry configuration.
fmgr_user_saml:
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_saml:
cert: <value of string>
entity-id: <value of string>
group-name: <value of string>
idp-cert: <value of string>
idp-entity-id: <value of string>
idp-single-logout-url: <value of string>
idp-single-sign-on-url: <value of string>
name: <value of string>
single-logout-url: <value of string>
single-sign-on-url: <value of string>
user-name: <value of string>
adfs-claim: <value in [disable, enable]>
digest-method: <value in [sha1, sha256]>
group-claim-type: <value in [email, given-name, name, ...]>
limit-relaystate: <value in [disable, enable]>
user-claim-type: <value in [email, given-name, 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 |
| --- | --- | --- |
| **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_securityconsole_package_clone – Clone a policy package within the same ADOM. fortinet.fortimanager.fmgr\_securityconsole\_package\_clone – Clone a policy package within the same ADOM.
==========================================================================================================
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_securityconsole_package_clone`.
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 |
| **securityconsole\_package\_clone** dictionary | | the top level parameters set |
| | **adom** string | | Source ADOM name. |
| | **dst\_name** string | | Name of the new policy package. |
| | **dst\_parent** string | | Path to the folder for the target package. If the package is to be placed in root, leave this field blank. |
| | **pkg** string | | Source package path and name. |
| | **scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** 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: Clone a policy package within the same ADOM.
fmgr_securityconsole_package_clone:
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, ...]
securityconsole_package_clone:
adom: <value of string>
dst_name: <value of string>
dst_parent: <value of string>
pkg: <value of string>
scope:
-
name: <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)
ansible fortinet.fortimanager.fmgr_system_log_ratelimit – Logging rate limit. fortinet.fortimanager.fmgr\_system\_log\_ratelimit – Logging rate limit.
========================================================================
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_ratelimit`.
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\_ratelimit** dictionary | | the top level parameters set |
| | **device** list / elements=string | | no description |
| | | **device** string | | Device(s) filter according to filter-type setting, wildcard expression supported. |
| | | **filter-type** string | **Choices:*** **devid** ←
| Device filter type. devid - Device ID. |
| | | **id** integer | **Default:**0 | Device filter ID. |
| | | **ratelimit** integer | **Default:**0 | Maximum device log rate limit. |
| | **device-ratelimit-default** integer | **Default:**0 | Default maximum device log rate limit. |
| | **mode** string | **Choices:*** **disable** ←
* manual
| Logging rate limit mode. disable - Logging rate limit function disabled. manual - System rate limit and device rate limit both configurable, no limit if not configured. |
| | **system-ratelimit** integer | **Default:**0 | Maximum system log rate limit. |
| **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: Logging rate limit.
fmgr_system_log_ratelimit:
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_ratelimit:
device:
-
device: <value of string>
filter-type: <value in [devid]>
id: <value of integer>
ratelimit: <value of integer>
device-ratelimit-default: <value of integer>
mode: <value in [disable, manual]>
system-ratelimit: <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_devprof_system_centralmanagement – Configure central management. fortinet.fortimanager.fmgr\_devprof\_system\_centralmanagement – Configure central management.
==============================================================================================
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_centralmanagement`.
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\_centralmanagement** dictionary | | the top level parameters set |
| | **include-default-servers** string | **Choices:*** disable
* enable
| Enable/disable inclusion of public FortiGuard servers in the override server list. |
| | **server-list** list / elements=string | | no description |
| | | **addr-type** string | **Choices:*** fqdn
* ipv4
* ipv6
| 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 | | ID. |
| | | **server-address** string | | IPv4 address of override server. |
| | | **server-address6** string | | IPv6 address of override server. |
| | | **server-type** list / elements=string | **Choices:*** update
* rating
| no description |
| **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 central management.
fmgr_devprof_system_centralmanagement:
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_centralmanagement:
include-default-servers: <value in [disable, enable]>
server-list:
-
addr-type: <value in [fqdn, ipv4, ipv6]>
fqdn: <value of string>
id: <value of integer>
server-address: <value of string>
server-address6: <value of string>
server-type:
- update
- rating
```
Return Values
-------------
Common return 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_templategroup – no description fortinet.fortimanager.fmgr\_templategroup – 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_templategroup`.
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 |
| **templategroup** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **member** list / elements=string | | no description |
| | **modification-time** string | | no description |
| | **name** 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_templategroup:
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]>
templategroup:
description: <value of string>
member: <value of list>
modification-time: <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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_wagprofile – Configure wireless access gateway fortinet.fortimanager.fmgr\_wagprofile – Configure wireless access 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_wagprofile`.
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 |
| **wagprofile** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **dhcp-ip-addr** string | | IP address of the monitoring DHCP request packet sent through the tunnel. |
| | **name** string | | Tunnel profile name. |
| | **ping-interval** integer | | Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1). |
| | **ping-number** integer | | Number of the tunnel monitoring echo packets (1 - 65535, default = 5). |
| | **return-packet-timeout** integer | | Window of time for the return packets from the tunnels remote end (1 - 65535 sec, default = 160). |
| | **tunnel-type** string | **Choices:*** gre
* l2tpv3
| Tunnel type. |
| | **wag-ip** string | | IP Address of the wireless access gateway. |
| | **wag-port** integer | | UDP port of the wireless access gateway. |
| **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 wireless access gateway
fmgr_wagprofile:
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]>
wagprofile:
comment: <value of string>
dhcp-ip-addr: <value of string>
name: <value of string>
ping-interval: <value of integer>
ping-number: <value of integer>
return-packet-timeout: <value of integer>
tunnel-type: <value in [gre, l2tpv3]>
wag-ip: <value of string>
wag-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)
ansible fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_excluderange – Exclude one or more ranges of IP addresses from being assigned to clients. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_excluderange – Exclude one or more ranges of IP addresses from being assigned to clients.
============================================================================================================================================================
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_fsp_vlan_dynamicmapping_dhcpserver_excluderange`.
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 |
| **dynamic\_mapping** string / required | | the parameter (dynamic\_mapping) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **fsp\_vlan\_dynamicmapping\_dhcpserver\_excluderange** dictionary | | the top level parameters set |
| | **end-ip** string | | no description |
| | **id** integer | | no description |
| | **start-ip** 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 |
| **vlan** string / required | | the parameter (vlan) 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: Exclude one or more ranges of IP addresses from being assigned to clients.
fmgr_fsp_vlan_dynamicmapping_dhcpserver_excluderange:
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>
vlan: <your own value>
dynamic_mapping: <your own value>
state: <value in [present, absent]>
fsp_vlan_dynamicmapping_dhcpserver_excluderange:
end-ip: <value of string>
id: <value of integer>
start-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_waf_profile_constraint_paramlength – Maximum length of parameter in URL, HTTP POST request or HTTP body. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_paramlength – Maximum length of parameter in URL, HTTP POST request or HTTP body.
=======================================================================================================================================
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_paramlength`.
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\_paramlength** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **length** integer | | Maximum length of parameter in URL, HTTP POST request or HTTP body in bytes (0 to 2147483647). |
| | **log** string | **Choices:*** 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: Maximum length of parameter in URL, HTTP POST request or HTTP body.
fmgr_waf_profile_constraint_paramlength:
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_paramlength:
action: <value in [allow, block]>
length: <value of integer>
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_system_replacemsggroup_automation – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_automation – 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_automation`.
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\_automation** dictionary | | the top level parameters set |
| | **buffer** string | | Message string. |
| | **format** string | **Choices:*** none
* text
* html
| Format flag. |
| | **header** string | **Choices:*** none
* http
* 8bit
| Header flag. |
| | **msg-type** string | | Message type. |
| **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_automation:
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_automation:
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_wtpprofile_radio3 – Configuration options for radio 3. fortinet.fortimanager.fmgr\_wtpprofile\_radio3 – Configuration options for radio 3.
===================================================================================
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_wtpprofile_radio3`.
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 |
| **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 |
| **wtp-profile** string / required | | the parameter (wtp-profile) in requested url |
| **wtpprofile\_radio3** dictionary | | the top level parameters set |
| | **airtime-fairness** string | **Choices:*** disable
* enable
| Enable/disable airtime fairness (default = disable). |
| | **amsdu** string | **Choices:*** disable
* enable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). |
| | **ap-handoff** string | **Choices:*** disable
* enable
| Enable/disable AP handoff of clients to other APs (default = disable). |
| | **ap-sniffer-addr** string | | MAC address to monitor. |
| | **ap-sniffer-bufsize** integer | | Sniffer buffer size (1 - 32 MB, default = 16). |
| | **ap-sniffer-chan** integer | | Channel on which to operate the sniffer (default = 6). |
| | **ap-sniffer-ctl** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi control frame (default = enable). |
| | **ap-sniffer-data** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi data frame (default = enable). |
| | **ap-sniffer-mgmt-beacon** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management Beacon frames (default = enable). |
| | **ap-sniffer-mgmt-other** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management other frames (default = enable). |
| | **ap-sniffer-mgmt-probe** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management probe frames (default = enable). |
| | **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 t... |
| | **auto-power-level** string | **Choices:*** disable
* enable
| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). |
| | **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 t... |
| | **auto-power-target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
| | **band** string | **Choices:*** 802.11b
* 802.11a
* 802.11g
* 802.11n
* 802.11ac
* 802.11n-5G
* 802.11ax-5G
* 802.11ax
* 802.11g-only
* 802.11n-only
* 802.11n,g-only
* 802.11ac-only
* 802.11ac,n-only
* 802.11n-5G-only
* 802.11ax-5G-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-only
* 802.11ax,n-only
* 802.11ax,n,g-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:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireles... |
| | **bandwidth-capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
| | **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. default = 0). |
| | **call-admission-control** string | **Choices:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are ... |
| | **call-capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
| | **channel** string | | no description |
| | **channel-bonding** string | **Choices:*** 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | **channel-utilization** string | **Choices:*** disable
* enable
| Enable/disable measuring channel utilization. |
| | **coexistence** string | **Choices:*** disable
* enable
| Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). |
| | **darrp** string | **Choices:*** disable
* enable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optim... |
| | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) (default = disable). |
| | **drma-sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). |
| | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client in power-... |
| | **frag-threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
| | **frequency-handoff** string | **Choices:*** disable
* enable
| Enable/disable frequency handoff of clients to other channels (default = disable). |
| | **iperf-protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol (default = "UDP"). |
| | **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, default = 0). |
| | **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, default = 100). |
| | **power-mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentage). This... |
| | **power-value** integer | | Radio EIRP power in dBm (1 - 33, default = 27). |
| | **powersave-optimize** list / elements=string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| no description |
| | **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 | | no description |
| | **rts-threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes, defa... |
| | **sam-bssid** string | | BSSID for WiFi network. |
| | **sam-captive-portal** string | **Choices:*** disable
* enable
| Enable/disable Captive Portal Authentication (default = disable). |
| | **sam-password** string | | no description |
| | **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 (default = "wpa-personal"). |
| | **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 (default = "PING"). |
| | **sam-username** string | | Username for WiFi network connection. |
| | **short-guard-interval** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
* scan-only
| Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. |
| | **transmit-optimize** list / elements=string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| no description |
| | **vap-all** string | **Choices:*** disable
* enable
* tunnel
* bridge
* manual
| Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable). |
| | **vap1** string | | Virtual Access Point (VAP) for wlan ID 1 |
| | **vap2** string | | Virtual Access Point (VAP) for wlan ID 2 |
| | **vap3** string | | Virtual Access Point (VAP) for wlan ID 3 |
| | **vap4** string | | Virtual Access Point (VAP) for wlan ID 4 |
| | **vap5** string | | Virtual Access Point (VAP) for wlan ID 5 |
| | **vap6** string | | Virtual Access Point (VAP) for wlan ID 6 |
| | **vap7** string | | Virtual Access Point (VAP) for wlan ID 7 |
| | **vap8** string | | Virtual Access Point (VAP) for wlan ID 8 |
| | **vaps** string | | Manually selected list of Virtual Access Points (VAPs). |
| | **wids-profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
| | **zero-wait-dfs** string | **Choices:*** disable
* enable
| Enable/disable zero wait DFS on radio (default = enable). |
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 options for radio 3.
fmgr_wtpprofile_radio3:
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>
wtp-profile: <your own value>
wtpprofile_radio3:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
dtim: <value of integer>
frag-threshold: <value of integer>
frequency-handoff: <value in [disable, enable]>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vaps: <value of string>
wids-profile: <value of string>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
zero-wait-dfs: <value in [disable, enable]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
bss-color: <value of integer>
auto-power-target: <value of string>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-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)
ansible fortinet.fortimanager.fmgr_system_report_estbrowsetime – Report estimated browse time settings fortinet.fortimanager.fmgr\_system\_report\_estbrowsetime – Report estimated browse time 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_report_estbrowsetime`.
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\_report\_estbrowsetime** dictionary | | the top level parameters set |
| | **max-read-time** integer | **Default:**180 | Read time threshold for each page view. |
| | **status** string | **Choices:*** disable
* **enable** ←
| Estimate browse time status. disable - Disable estimating browse time. enable - Enable estimating browse time. |
| **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: Report estimated browse time settings
fmgr_system_report_estbrowsetime:
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_report_estbrowsetime:
max-read-time: <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_wtpprofile_platform – WTP, FortiAP, or AP platform. fortinet.fortimanager.fmgr\_wtpprofile\_platform – WTP, FortiAP, or AP platform.
================================================================================
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_wtpprofile_platform`.
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 |
| **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 |
| **wtp-profile** string / required | | the parameter (wtp-profile) in requested url |
| **wtpprofile\_platform** dictionary | | the top level parameters set |
| | **\_local\_platform\_str** string | | no description |
| | **ddscan** string | **Choices:*** disable
* enable
| Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat management. |
| | **mode** string | **Choices:*** dual-5G
* single-5G
| Configure operation mode of 5G radios (default = dual-5G). |
| | **type** string | **Choices:*** 30B-50B
* 60B
* 80CM-81CM
* 220A
* 220B
* 210B
* 60C
* 222B
* 112B
* 320B
* 11C
* 14C
* 223B
* 28C
* 320C
* 221C
* 25D
* 222C
* 224D
* 214B
* 21D
* 24D
* 112D
* 223C
* 321C
* C220C
* C225C
* S321C
* S323C
* FWF
* S311C
* S313C
* AP-11N
* S322C
* S321CR
* S322CR
* S323CR
* S421E
* S422E
* S423E
* 421E
* 423E
* C221E
* C226E
* C23JD
* C24JE
* C21D
* U421E
* U423E
* 221E
* 222E
* 223E
* S221E
* S223E
* U221EV
* U223EV
* U321EV
* U323EV
* 224E
* U422EV
* U24JEV
* 321E
* U431F
* U433F
* 231E
* 431F
* 433F
* 231F
* 432F
* 234F
* 23JF
* U231F
* 831F
* 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 ... |
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: WTP, FortiAP, or AP platform.
fmgr_wtpprofile_platform:
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>
wtp-profile: <your own value>
wtpprofile_platform:
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
mode: <value in [dual-5G, single-5G]>
ddscan: <value in [disable, enable]>
_local_platform_str: <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_customlanguage – Configure custom languages. fortinet.fortimanager.fmgr\_system\_customlanguage – Configure custom languages.
================================================================================
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_customlanguage`.
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\_customlanguage** dictionary | | the top level parameters set |
| | **comments** string | | Comment. |
| | **filename** string | | Custom language file path. |
| | **name** string | | 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 custom languages.
fmgr_system_customlanguage:
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_customlanguage:
comments: <value of string>
filename: <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_ldap_dynamicmapping – Configure LDAP server entries. fortinet.fortimanager.fmgr\_user\_ldap\_dynamicmapping – Configure LDAP server 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_user_ldap_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 |
| --- | --- | --- |
| **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 |
| **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 |
| **user\_ldap\_dynamicmapping** dictionary | | the top level parameters set |
| | **\_scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** string | | no description |
| | **account-key-filter** string | | no description |
| | **account-key-name** string | | no description |
| | **account-key-processing** string | **Choices:*** same
* strip
| no description |
| | **antiphish** string | **Choices:*** disable
* enable
| Enable/disable AntiPhishing credential backend. |
| | **ca-cert** string | | no description |
| | **cnid** string | | no description |
| | **dn** string | | no description |
| | **filter** string | | no description |
| | **group** string | | no description |
| | **group-filter** string | | no description |
| | **group-member-check** string | **Choices:*** user-attr
* group-object
* posix-group-object
| no description |
| | **group-object-filter** string | | no description |
| | **group-object-search-base** string | | no description |
| | **group-search-base** string | | no description |
| | **interface** string | | no description |
| | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | **member-attr** string | | no description |
| | **obtain-user-info** string | **Choices:*** disable
* enable
| no description |
| | **password** string | | no description |
| | **password-attr** string | | Name of attribute to get password hash. |
| | **password-expiry-warning** string | **Choices:*** disable
* enable
| no description |
| | **password-renewal** string | **Choices:*** disable
* enable
| no description |
| | **port** integer | | no description |
| | **retrieve-protection-profile** string | | no description |
| | **search-type** list / elements=string | **Choices:*** nested
* recursive
| no description |
| | **secondary-server** string | | no description |
| | **secure** string | **Choices:*** disable
* starttls
* ldaps
| no description |
| | **server** string | | no description |
| | **server-identity-check** string | **Choices:*** disable
* enable
| no description |
| | **source-ip** string | | no description |
| | **source-port** integer | | Source port to be used for communication with the LDAP server. |
| | **ssl-min-proto-version** string | **Choices:*** default
* TLSv1
* TLSv1-1
* TLSv1-2
* SSLv3
| no description |
| | **tertiary-server** string | | no description |
| | **two-factor** string | **Choices:*** disable
* fortitoken-cloud
| no description |
| | **two-factor-authentication** string | **Choices:*** fortitoken
* email
* sms
| no description |
| | **two-factor-notification** string | **Choices:*** email
* sms
| no description |
| | **type** string | **Choices:*** simple
* anonymous
* regular
| no description |
| | **user-info-exchange-server** string | | no description |
| | **username** 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: Configure LDAP server entries.
fmgr_user_ldap_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>
ldap: <your own value>
state: <value in [present, absent]>
user_ldap_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
account-key-filter: <value of string>
account-key-name: <value of string>
account-key-processing: <value in [same, strip]>
ca-cert: <value of string>
cnid: <value of string>
dn: <value of string>
filter: <value of string>
group: <value of string>
group-filter: <value of string>
group-member-check: <value in [user-attr, group-object, posix-group-object]>
group-object-filter: <value of string>
group-object-search-base: <value of string>
group-search-base: <value of string>
member-attr: <value of string>
obtain-user-info: <value in [disable, enable]>
password: <value of string>
password-expiry-warning: <value in [disable, enable]>
password-renewal: <value in [disable, enable]>
port: <value of integer>
retrieve-protection-profile: <value of string>
search-type:
- nested
- recursive
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
server-identity-check: <value in [disable, enable]>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
tertiary-server: <value of string>
type: <value in [simple, anonymous, regular]>
user-info-exchange-server: <value of string>
username: <value of string>
two-factor: <value in [disable, fortitoken-cloud]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
two-factor-authentication: <value in [fortitoken, email, sms]>
two-factor-notification: <value in [email, sms]>
antiphish: <value in [disable, enable]>
password-attr: <value of string>
source-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)
ansible fortinet.fortimanager.fmgr_firewall_internetserviceaddition – Configure Internet Services Addition. fortinet.fortimanager.fmgr\_firewall\_internetserviceaddition – Configure Internet Services Addition.
=====================================================================================================
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`.
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\_internetserviceaddition** dictionary | | the top level parameters set |
| | **comment** string | | Comment. |
| | **entry** list / elements=string | | no description |
| | | **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). |
| | **id** string | | Internet Service ID in the Internet Service database. |
| **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 Internet Services Addition.
fmgr_firewall_internetserviceaddition:
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_internetserviceaddition:
comment: <value of string>
entry:
-
id: <value of integer>
port-range:
-
end-port: <value of integer>
id: <value of integer>
start-port: <value of integer>
protocol: <value of integer>
id: <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_ips_custom – Configure IPS custom signature. fortinet.fortimanager.fmgr\_ips\_custom – Configure IPS custom signature.
=========================================================================
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_ips_custom`.
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 |
| **ips\_custom** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** block
* pass
| Default action (pass or block) for this signature. |
| | **application** string | | no description |
| | **comment** string | | Comment. |
| | **location** string | | no description |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **log-packet** string | **Choices:*** disable
* enable
| Enable/disable packet logging. |
| | **os** string | | no description |
| | **protocol** string | | Protocol(s) that the signature scans. Blank for all protocols. |
| | **rule-id** integer | | no description |
| | **severity** string | | Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity. |
| | **sig-name** string | | no description |
| | **signature** string | | Custom signature enclosed in single quotes. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this signature. |
| | **tag** string | | Signature tag. |
| **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 IPS custom signature.
fmgr_ips_custom:
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]>
ips_custom:
action: <value in [block, pass]>
application: <value of string>
comment: <value of string>
location: <value of string>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
os: <value of string>
protocol: <value of string>
rule-id: <value of integer>
severity: <value of string>
sig-name: <value of string>
signature: <value of string>
status: <value in [disable, enable]>
tag: <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_vip_realservers – Select the real servers that this server load balancing VIP will distribute traffic to. fortinet.fortimanager.fmgr\_firewall\_vip\_realservers – Select the real servers that this server load balancing VIP will distribute traffic to.
================================================================================================================================================
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_realservers`.
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\_realservers** dictionary | | the top level parameters set |
| | **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 real servers. |
| | **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 sent. |
| | **type** string | **Choices:*** ip
* address
| Type of address. |
| | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| **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 |
| **vip** string / required | | the parameter (vip) 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: Select the real servers that this server load balancing VIP will distribute traffic to.
fmgr_firewall_vip_realservers:
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>
vip: <your own value>
state: <value in [present, absent]>
firewall_vip_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]>
```
Return Values
-------------
Common return 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_import – no description fortinet.fortimanager.fmgr\_devprof\_import – 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_devprof_import`.
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\_import** dictionary | | the top level parameters set |
| | **device** string | | no description |
| | **devprof** 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: no description
fmgr_devprof_import:
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_import:
device: <value of string>
devprof: <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_antivirus_profile_nntp – Configure NNTP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_nntp – Configure NNTP 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_nntp`.
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\_nntp** 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. |
| | **emulator** string | **Choices:*** disable
* enable
| Enable/disable the virus emulator. |
| | **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 NNTP AntiVirus options.
fmgr_antivirus_profile_nntp:
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_nntp:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
emulator: <value in [disable, enable]>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6 – IPv6 of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface\_ipv6 – IPv6 of interface.
===========================================================================
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_fsp_vlan_interface_ipv6`.
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 |
| **fsp\_vlan\_interface\_ipv6** dictionary | | the top level parameters set |
| | **autoconf** string | **Choices:*** disable
* enable
| no description |
| | **cli-conn6-status** integer | | no description |
| | **dhcp6-client-options** list / elements=string | **Choices:*** rapid
* iapd
* iana
* dns
* dnsname
| no description |
| | **dhcp6-information-request** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-prefix-delegation** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-prefix-hint** string | | no description |
| | **dhcp6-prefix-hint-plt** integer | | no description |
| | **dhcp6-prefix-hint-vlt** integer | | no description |
| | **dhcp6-relay-ip** string | | no description |
| | **dhcp6-relay-service** string | **Choices:*** disable
* enable
| no description |
| | **dhcp6-relay-type** string | **Choices:*** regular
| no description |
| | **icmp6-send-redirect** string | **Choices:*** disable
* enable
| Enable/disable sending of ICMPv6 redirects. |
| | **interface-identifier** string | | no description |
| | **ip6-address** string | | no description |
| | **ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* capwap
* fabric
| no description |
| | **ip6-default-life** integer | | no description |
| | **ip6-delegated-prefix-list** list / elements=string | | no description |
| | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | **prefix-id** integer | | no description |
| | | **rdnss** string | | no description |
| | | **rdnss-service** string | **Choices:*** delegated
* default
* specify
| no description |
| | | **subnet** string | | no description |
| | | **upstream-interface** string | | no description |
| | **ip6-dns-server-override** string | **Choices:*** disable
* enable
| no description |
| | **ip6-extra-addr** list / elements=string | | no description |
| | | **prefix** string | | no description |
| | **ip6-hop-limit** integer | | no description |
| | **ip6-link-mtu** integer | | no description |
| | **ip6-manage-flag** string | **Choices:*** disable
* enable
| no description |
| | **ip6-max-interval** integer | | no description |
| | **ip6-min-interval** integer | | no description |
| | **ip6-mode** string | **Choices:*** static
* dhcp
* pppoe
* delegated
| no description |
| | **ip6-other-flag** string | **Choices:*** disable
* enable
| no description |
| | **ip6-prefix-list** list / elements=string | | no description |
| | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | **dnssl** string | | no description |
| | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | **preferred-life-time** integer | | no description |
| | | **prefix** string | | no description |
| | | **rdnss** string | | no description |
| | | **valid-life-time** integer | | no description |
| | **ip6-prefix-mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from DHCP or RA. |
| | **ip6-reachable-time** integer | | no description |
| | **ip6-retrans-time** integer | | no description |
| | **ip6-send-adv** string | **Choices:*** disable
* enable
| no description |
| | **ip6-subnet** string | | no description |
| | **ip6-upstream-interface** string | | no description |
| | **nd-cert** string | | no description |
| | **nd-cga-modifier** string | | no description |
| | **nd-mode** string | **Choices:*** basic
* SEND-compatible
| no description |
| | **nd-security-level** integer | | no description |
| | **nd-timestamp-delta** integer | | no description |
| | **nd-timestamp-fuzz** integer | | no description |
| | **ra-send-mtu** string | **Choices:*** disable
* enable
| Enable/disable sending link MTU in RA packet. |
| | **unique-autoconf-addr** string | **Choices:*** disable
* enable
| no description |
| | **vrip6\_link\_local** string | | no description |
| | **vrrp-virtual-mac6** string | **Choices:*** disable
* enable
| no description |
| | **vrrp6** list / elements=string | | no description |
| | | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | | **adv-interval** integer | | no description |
| | | **preempt** string | **Choices:*** disable
* enable
| no description |
| | | **priority** integer | | no description |
| | | **start-time** integer | | no description |
| | | **status** string | **Choices:*** disable
* enable
| no description |
| | | **vrdst6** string | | no description |
| | | **vrgrp** integer | | no description |
| | | **vrid** integer | | no description |
| | | **vrip6** 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 |
| **vlan** string / required | | the parameter (vlan) 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: IPv6 of interface.
fmgr_fsp_vlan_interface_ipv6:
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>
vlan: <your own value>
fsp_vlan_interface_ipv6:
autoconf: <value in [disable, enable]>
dhcp6-client-options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6-information-request: <value in [disable, enable]>
dhcp6-prefix-delegation: <value in [disable, enable]>
dhcp6-prefix-hint: <value of string>
dhcp6-prefix-hint-plt: <value of integer>
dhcp6-prefix-hint-vlt: <value of integer>
dhcp6-relay-ip: <value of string>
dhcp6-relay-service: <value in [disable, enable]>
dhcp6-relay-type: <value in [regular]>
ip6-address: <value of string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <value of integer>
ip6-dns-server-override: <value in [disable, enable]>
ip6-hop-limit: <value of integer>
ip6-link-mtu: <value of integer>
ip6-manage-flag: <value in [disable, enable]>
ip6-max-interval: <value of integer>
ip6-min-interval: <value of integer>
ip6-mode: <value in [static, dhcp, pppoe, ...]>
ip6-other-flag: <value in [disable, enable]>
ip6-reachable-time: <value of integer>
ip6-retrans-time: <value of integer>
ip6-send-adv: <value in [disable, enable]>
ip6-subnet: <value of string>
ip6-upstream-interface: <value of string>
nd-cert: <value of string>
nd-cga-modifier: <value of string>
nd-mode: <value in [basic, SEND-compatible]>
nd-security-level: <value of integer>
nd-timestamp-delta: <value of integer>
nd-timestamp-fuzz: <value of integer>
vrip6_link_local: <value of string>
vrrp-virtual-mac6: <value in [disable, enable]>
ip6-delegated-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <value of string>
ip6-extra-addr:
-
prefix: <value of string>
ip6-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
dnssl: <value of string>
onlink-flag: <value in [disable, enable]>
preferred-life-time: <value of integer>
prefix: <value of string>
rdnss: <value of string>
valid-life-time: <value of integer>
vrrp6:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <value of string>
interface-identifier: <value of string>
unique-autoconf-addr: <value in [disable, enable]>
icmp6-send-redirect: <value in [disable, enable]>
cli-conn6-status: <value of integer>
ip6-prefix-mode: <value in [dhcp6, ra]>
ra-send-mtu: <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_securityconsole_reinstall_package – Re-install a policy package that had been previously installed. fortinet.fortimanager.fmgr\_securityconsole\_reinstall\_package – Re-install a policy package that had been previously installed.
=================================================================================================================================
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_securityconsole_reinstall_package`.
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 |
| **securityconsole\_reinstall\_package** dictionary | | the top level parameters set |
| | **adom** string | | Source ADOM name. |
| | **flags** list / elements=string | **Choices:*** none
* cp\_all\_objs
* preview
* generate\_rev
* copy\_assigned\_pkg
* unassign
* ifpolicy\_only
* no\_ifpolicy
* objs\_only
* auto\_lock\_ws
* check\_pkg\_st
* copy\_only
| no description |
| | **target** list / elements=string | | no description |
| | | **pkg** string | | Source package path and name. |
| | | **scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** 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: Re-install a policy package that had been previously installed.
fmgr_securityconsole_reinstall_package:
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, ...]
securityconsole_reinstall_package:
adom: <value of string>
flags:
- none
- cp_all_objs
- preview
- generate_rev
- copy_assigned_pkg
- unassign
- ifpolicy_only
- no_ifpolicy
- objs_only
- auto_lock_ws
- check_pkg_st
- copy_only
target:
-
pkg: <value of string>
scope:
-
name: <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)
ansible fortinet.fortimanager.fmgr_system_replacemsggroup_mail – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mail – 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_mail`.
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\_mail** 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. |
| **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_mail:
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_mail:
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_gtp_tunnellimit – GTP tunnel limiter. fortinet.fortimanager.fmgr\_gtp\_tunnellimit – GTP tunnel limiter.
==================================================================
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_gtp_tunnellimit`.
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 |
| **gtp\_tunnellimit** dictionary | | the top level parameters set |
| | **name** string | | Tunnel limiter name. |
| | **tunnel-limit** integer | | Tunnel limit [1, 16000000]. |
| **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: GTP tunnel limiter.
fmgr_gtp_tunnellimit:
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]>
gtp_tunnellimit:
name: <value of string>
tunnel-limit: <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_simprofile_autoswitchprofile – no description fortinet.fortimanager.fmgr\_extendercontroller\_simprofile\_autoswitchprofile – 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_simprofile_autoswitchprofile`.
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\_simprofile\_autoswitchprofile** dictionary | | the top level parameters set |
| | **dataplan** string | **Choices:*** **disable** ←
* enable
| no description |
| | **disconnect** string | **Choices:*** **disable** ←
* enable
| no description |
| | **disconnect-period** integer | **Default:**600 | no description |
| | **disconnect-threshold** integer | **Default:**3 | no description |
| | **signal** string | **Choices:*** **disable** ←
* enable
| no description |
| | **status** string | **Choices:*** disable
* **enable** ←
| no description |
| | **switch-back** list / elements=string | **Choices:*** time
* timer
| no description |
| | **switch-back-time** string | **Default:**"00:01" | no description |
| | **switch-back-timer** integer | **Default:**86400 | 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 |
| **sim\_profile** string / required | | the parameter (sim\_profile) in requested url |
| **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_simprofile_autoswitchprofile:
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>
sim_profile: <your own value>
extendercontroller_simprofile_autoswitchprofile:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect-period: <value of integer>
disconnect-threshold: <value of integer>
signal: <value in [disable, enable]>
status: <value in [disable, enable]>
switch-back:
- time
- timer
switch-back-time: <value of string>
switch-back-timer: <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_fssopolling – Configure FSSO active directory servers for polling mode. fortinet.fortimanager.fmgr\_user\_fssopolling – Configure FSSO active directory servers for polling mode.
=========================================================================================================
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_fssopolling`.
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\_fssopolling** dictionary | | the top level parameters set |
| | **\_gui\_meta** string | | no description |
| | **adgrp** list / elements=string | | no description |
| | | **name** string | | Name. |
| | **default-domain** string | | Default domain managed by this Active Directory server. |
| | **id** integer | | Active Directory server ID. |
| | **ldap-server** string | | LDAP server name used in LDAP connection strings. |
| | **logon-history** integer | | Number of hours of logon history to keep, 0 means keep all history. |
| | **password** string | | no description |
| | **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:*** disable
* enable
| Enable/disable support of NTLMv1 for Samba authentication. |
| | **smbv1** string | **Choices:*** disable
* enable
| Enable/disable support of SMBv1 for Samba. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable polling for the status of this Active Directory server. |
| | **user** string | | User name required to log into this Active Directory server. |
| **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 FSSO active directory servers for polling mode.
fmgr_user_fssopolling:
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_fssopolling:
_gui_meta: <value of string>
adgrp:
-
name: <value of string>
default-domain: <value of string>
id: <value of integer>
ldap-server: <value of string>
logon-history: <value of integer>
password: <value of string>
polling-frequency: <value of integer>
port: <value of integer>
server: <value of string>
status: <value in [disable, enable]>
user: <value of string>
smb-ntlmv1-auth: <value in [disable, enable]>
smbv1: <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_dhcp_server – Configure DHCP servers. fortinet.fortimanager.fmgr\_system\_dhcp\_server – Configure DHCP servers.
==========================================================================
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_dhcp_server`.
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\_dhcp\_server** dictionary | | the top level parameters set |
| | **auto-configuration** string | **Choices:*** disable
* enable
| Enable/disable auto configuration. |
| | **auto-managed-status** string | **Choices:*** disable
* enable
| Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. |
| | **conflicted-ip-timeout** integer | | Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. |
| | **ddns-auth** string | **Choices:*** disable
* tsig
| DDNS authentication mode. |
| | **ddns-key** string | | DDNS update key (base 64 encoding). |
| | **ddns-keyname** string | | DDNS update key name. |
| | **ddns-server-ip** string | | DDNS server IP. |
| | **ddns-ttl** integer | | TTL. |
| | **ddns-update** string | **Choices:*** disable
* enable
| Enable/disable DDNS update for DHCP. |
| | **ddns-update-override** string | **Choices:*** disable
* enable
| Enable/disable DDNS update override for DHCP. |
| | **ddns-zone** string | | Zone of your domain name (ex. DDNS.com). |
| | **default-gateway** string | | Default gateway IP address assigned by the DHCP server. |
| | **dhcp-settings-from-fortiipam** string | **Choices:*** disable
* enable
| Enable/disable populating of DHCP server settings from FortiIPAM. |
| | **dns-server1** string | | DNS server 1. |
| | **dns-server2** string | | DNS server 2. |
| | **dns-server3** string | | DNS server 3. |
| | **dns-server4** string | | DNS server 4. |
| | **dns-service** string | **Choices:*** default
* specify
* local
| Options for assigning DNS servers to DHCP clients. |
| | **domain** string | | Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
| | **exclude-range** list / elements=string | | no description |
| | | **end-ip** string | | End of IP range. |
| | | **id** integer | | ID. |
| | | **start-ip** string | | Start of IP range. |
| | **filename** string | | Name of the boot file on the TFTP server. |
| | **forticlient-on-net-status** string | **Choices:*** disable
* enable
| Enable/disable FortiClient-On-Net service for this DHCP server. |
| | **id** integer | | ID. |
| | **interface** string | | DHCP server can assign IP configurations to clients connected to this interface. |
| | **ip-mode** string | **Choices:*** range
* usrgrp
| Method used to assign client IP. |
| | **ip-range** list / elements=string | | no description |
| | | **end-ip** string | | End of IP range. |
| | | **id** integer | | ID. |
| | | **start-ip** string | | Start of IP range. |
| | **ipsec-lease-hold** integer | | DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). |
| | **lease-time** integer | | Lease time in seconds, 0 means unlimited. |
| | **mac-acl-default-action** string | **Choices:*** assign
* block
| MAC access control default action (allow or block assigning IP settings). |
| | **netmask** string | | Netmask assigned by the DHCP server. |
| | **next-server** string | | IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. |
| | **ntp-server1** string | | NTP server 1. |
| | **ntp-server2** string | | NTP server 2. |
| | **ntp-server3** string | | NTP server 3. |
| | **ntp-service** string | **Choices:*** default
* specify
* local
| Options for assigning Network Time Protocol (NTP) servers to DHCP clients. |
| | **options** list / elements=string | | no description |
| | | **code** integer | | DHCP option code. |
| | | **id** integer | | ID. |
| | | **ip** string | | no description |
| | | **type** string | **Choices:*** hex
* string
* ip
* fqdn
| DHCP option type. |
| | | **value** string | | DHCP option value. |
| | **reserved-address** list / elements=string | | no description |
| | | **action** string | **Choices:*** assign
* block
* reserved
| Options for the DHCP server to configure the client with the reserved MAC address. |
| | | **circuit-id** string | | Option 82 circuit-ID of the client that will get the reserved IP address. |
| | | **circuit-id-type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | **description** string | | Description. |
| | | **id** integer | | ID. |
| | | **ip** string | | IP address to be reserved for the MAC address. |
| | | **mac** string | | MAC address of the client that will get the reserved IP address. |
| | | **remote-id** string | | Option 82 remote-ID of the client that will get the reserved IP address. |
| | | **remote-id-type** string | **Choices:*** hex
* string
| DHCP option type. |
| | | **type** string | **Choices:*** mac
* option82
| DHCP reserved-address type. |
| | **server-type** string | **Choices:*** regular
* ipsec
| DHCP server can be a normal DHCP server or an IPsec DHCP server. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this DHCP configuration. |
| | **tftp-server** string | | no description |
| | **timezone** string | **Choices:*** 00
* 01
* 02
* 03
* 04
* 05
* 06
* 07
* 08
* 09
* 10
* 11
* 12
* 13
* 14
* 15
* 16
* 17
* 18
* 19
* 20
* 21
* 22
* 23
* 24
* 25
* 26
* 27
* 28
* 29
* 30
* 31
* 32
* 33
* 34
* 35
* 36
* 37
* 38
* 39
* 40
* 41
* 42
* 43
* 44
* 45
* 46
* 47
* 48
* 49
* 50
* 51
* 52
* 53
* 54
* 55
* 56
* 57
* 58
* 59
* 60
* 61
* 62
* 63
* 64
* 65
* 66
* 67
* 68
* 69
* 70
* 71
* 72
* 73
* 74
* 75
* 76
* 77
* 78
* 79
* 80
* 81
* 82
* 83
* 84
* 85
* 86
* 87
| Select the time zone to be assigned to DHCP clients. |
| | **timezone-option** string | **Choices:*** disable
* default
* specify
| Options for the DHCP server to set the clients time zone. |
| | **vci-match** string | **Choices:*** disable
* enable
| Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. |
| | **vci-string** string | | no description |
| | **wifi-ac-service** string | **Choices:*** specify
* local
| Options for assigning WiFi Access Controllers to DHCP clients |
| | **wifi-ac1** string | | WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). |
| | **wifi-ac2** string | | WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). |
| | **wifi-ac3** string | | WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). |
| | **wins-server1** string | | WINS server 1. |
| | **wins-server2** string | | WINS server 2. |
| **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 DHCP servers.
fmgr_system_dhcp_server:
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_dhcp_server:
auto-configuration: <value in [disable, enable]>
conflicted-ip-timeout: <value of integer>
ddns-auth: <value in [disable, tsig]>
ddns-key: <value of string>
ddns-keyname: <value of string>
ddns-server-ip: <value of string>
ddns-ttl: <value of integer>
ddns-update: <value in [disable, enable]>
ddns-update-override: <value in [disable, enable]>
ddns-zone: <value of string>
default-gateway: <value of string>
dns-server1: <value of string>
dns-server2: <value of string>
dns-server3: <value of string>
dns-service: <value in [default, specify, local]>
domain: <value of string>
exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
filename: <value of string>
forticlient-on-net-status: <value in [disable, enable]>
id: <value of integer>
interface: <value of string>
ip-mode: <value in [range, usrgrp]>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipsec-lease-hold: <value of integer>
lease-time: <value of integer>
mac-acl-default-action: <value in [assign, block]>
netmask: <value of string>
next-server: <value of string>
ntp-server1: <value of string>
ntp-server2: <value of string>
ntp-server3: <value of string>
ntp-service: <value in [default, specify, local]>
options:
-
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <value of string>
reserved-address:
-
action: <value in [assign, block, reserved]>
description: <value of string>
id: <value of integer>
ip: <value of string>
mac: <value of string>
circuit-id: <value of string>
circuit-id-type: <value in [hex, string]>
remote-id: <value of string>
remote-id-type: <value in [hex, string]>
type: <value in [mac, option82]>
server-type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp-server: <value of string>
timezone: <value in [00, 01, 02, ...]>
timezone-option: <value in [disable, default, specify]>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
wifi-ac1: <value of string>
wifi-ac2: <value of string>
wifi-ac3: <value of string>
wins-server1: <value of string>
wins-server2: <value of string>
dns-server4: <value of string>
wifi-ac-service: <value in [specify, local]>
auto-managed-status: <value in [disable, enable]>
dhcp-settings-from-fortiipam: <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_wanprof_system_sdwan_neighbor – Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status. fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_neighbor – Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.
======================================================================================================================================================================
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_neighbor`.
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\_neighbor** dictionary | | the top level parameters set |
| | **health-check** string | | SD-WAN health-check name. |
| | **ip** string | | IP/IPv6 address of neighbor. |
| | **member** string | | Member sequence number. |
| | **role** string | **Choices:*** primary
* secondary
* standalone
| Role of neighbor. |
| | **sla-id** integer | | SLA 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: Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.
fmgr_wanprof_system_sdwan_neighbor:
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_neighbor:
health-check: <value of string>
ip: <value of string>
member: <value of string>
role: <value in [primary, secondary, standalone]>
sla-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_pkg_firewall_dospolicy6 – Configure IPv6 DoS policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_dospolicy6 – Configure IPv6 DoS policies.
====================================================================================
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_dospolicy6`.
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\_dospolicy6** dictionary | | the top level parameters set |
| | **anomaly** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* proxy
| Action taken when the threshold is reached. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging for this anomaly. |
| | | **name** string | | Anomaly name. |
| | | **quarantine** string | **Choices:*** none
* attacker
* both
* interface
| Quarantine method. |
| | | **quarantine-expiry** string | | Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 minutes from now. (format: ###d##h##m, default = 5... |
| | | **quarantine-log** string | **Choices:*** disable
* enable
| Enable/disable quarantine logging. |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable the active status of this anomaly sensor. |
| | | **threshold** integer | | Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). Note that each anomaly... |
| | | **threshold(default)** integer | | no description |
| | **comments** string | | Comment. |
| | **dstaddr** string | | Destination address name from available addresses. |
| | **interface** string | | Incoming interface name from available interfaces. |
| | **name** string | | Policy name. |
| | **policyid** integer | | Policy ID. |
| | **service** string | | Service object from available options. |
| | **srcaddr** string | | Source address name from available addresses. |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this policy. |
| **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 IPv6 DoS policies.
fmgr_pkg_firewall_dospolicy6:
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>
state: <value in [present, absent]>
pkg_firewall_dospolicy6:
anomaly:
-
action: <value in [pass, block, proxy]>
log: <value in [disable, enable]>
name: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
status: <value in [disable, enable]>
threshold: <value of integer>
threshold(default): <value of integer>
comments: <value of string>
dstaddr: <value of string>
interface: <value of string>
policyid: <value of integer>
service: <value of string>
srcaddr: <value of string>
status: <value in [disable, enable]>
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_proxyaddress_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_proxyaddress\_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_proxyaddress_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 |
| --- | --- | --- |
| **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\_proxyaddress\_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 |
| **proxy-address** string / required | | the parameter (proxy-address) 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 |
| **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_proxyaddress_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>
proxy-address: <your own value>
state: <value in [present, absent]>
firewall_proxyaddress_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_sys_reboot – Restart FortiManager. fortinet.fortimanager.fmgr\_sys\_reboot – Restart FortiManager.
===============================================================
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_reboot`.
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 |
| **sys\_reboot** dictionary | | the top level parameters set |
| | **message** string | | Optional message to be stored in event log. |
| **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: Restart FortiManager.
fmgr_sys_reboot:
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, ...]
sys_reboot:
message: <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_gtp_apngrp – Configure APN groups for GTP. fortinet.fortimanager.fmgr\_gtp\_apngrp – Configure APN groups for GTP.
=======================================================================
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_gtp_apngrp`.
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 |
| **gtp\_apngrp** dictionary | | the top level parameters set |
| | **member** string | | APN group member. |
| | **name** string | | GTP APN group 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 APN groups for GTP.
fmgr_gtp_apngrp:
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]>
gtp_apngrp:
member: <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_vpnmgr_node_ipv4excluderange – no description fortinet.fortimanager.fmgr\_vpnmgr\_node\_ipv4excluderange – 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_node_ipv4excluderange`.
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 |
| **node** string / required | | the parameter (node) 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 |
| **vpnmgr\_node\_ipv4excluderange** dictionary | | the top level parameters set |
| | **end-ip** string | | no description |
| | **id** integer | | no description |
| | **start-ip** 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_node_ipv4excluderange:
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>
node: <your own value>
state: <value in [present, absent]>
vpnmgr_node_ipv4excluderange:
end-ip: <value of string>
id: <value of integer>
start-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_devprof_log_fortianalyzer_setting – Global FortiAnalyzer settings. fortinet.fortimanager.fmgr\_devprof\_log\_fortianalyzer\_setting – Global FortiAnalyzer 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_devprof_log_fortianalyzer_setting`.
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\_fortianalyzer\_setting** dictionary | | the top level parameters set |
| | **access-config** string | **Choices:*** disable
* enable
| Enable/disable FortiAnalyzer access to configuration and data. |
| | **certificate** string | | Certificate used to communicate with FortiAnalyzer. |
| | **certificate-verification** string | **Choices:*** disable
* enable
| 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:*** default
* high
* low
* disable
* high-medium
* low-medium
| Enable/disable sending FortiAnalyzer log data with SSL encryption. |
| | **hmac-algorithm** string | **Choices:*** sha256
* sha1
| FortiAnalyzer IPsec tunnel HMAC algorithm. |
| | **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. |
| | **ips-archive** string | **Choices:*** disable
* enable
| Enable/disable IPS packet archive logging. |
| | **max-log-rate** integer | | FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
| | **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:*** low
* default
| Set log transmission priority. |
| | **reliable** string | **Choices:*** disable
* enable
| Enable/disable reliable logging to FortiAnalyzer. |
| | **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). |
| | **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). |
| **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: Global FortiAnalyzer settings.
fmgr_devprof_log_fortianalyzer_setting:
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_fortianalyzer_setting:
certificate: <value of string>
conn-timeout: <value of integer>
enc-algorithm: <value in [default, high, low, ...]>
hmac-algorithm: <value in [sha256, sha1]>
ips-archive: <value in [disable, enable]>
monitor-failure-retry-period: <value of integer>
monitor-keepalive-period: <value of integer>
reliable: <value in [disable, enable]>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
upload-day: <value of string>
upload-interval: <value in [daily, weekly, monthly]>
upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
upload-time: <value of string>
access-config: <value in [disable, enable]>
certificate-verification: <value in [disable, enable]>
max-log-rate: <value of integer>
priority: <value in [low, default]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
preshared-key: <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_mpskprofile – Configure MPSK profile. fortinet.fortimanager.fmgr\_mpskprofile – Configure MPSK profile.
=================================================================
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_mpskprofile`.
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 |
| **mpskprofile** dictionary | | the top level parameters set |
| | **mpsk-concurrent-clients** integer | | Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535, default... |
| | **mpsk-group** list / elements=string | | no description |
| | | **mpsk-key** list / elements=string | | no description |
| | | | **comment** string | | Comment. |
| | | | **concurrent-client-limit-type** string | **Choices:*** default
* unlimited
* specified
| MPSK client limit type options. |
| | | | **concurrent-clients** integer | | Number of clients that can connect using this pre-shared key (1 - 65535, default is 256). |
| | | | **mac** string | | MAC address. |
| | | | **mpsk-schedules** string | | Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. |
| | | | **name** string | | Pre-shared key name. |
| | | | **passphrase** string | | no description |
| | | | **pmk** string | | no description |
| | | **name** string | | MPSK group name. |
| | | **vlan-id** integer | | Optional VLAN ID. |
| | | **vlan-type** string | **Choices:*** no-vlan
* fixed-vlan
| MPSK group VLAN options. |
| | **name** string | | MPSK profile name. |
| | **ssid** string | | SSID of the VAP in which the MPSK profile is configured. |
| **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 MPSK profile.
fmgr_mpskprofile:
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]>
mpskprofile:
mpsk-concurrent-clients: <value of integer>
mpsk-group:
-
mpsk-key:
-
comment: <value of string>
concurrent-client-limit-type: <value in [default, unlimited, specified]>
concurrent-clients: <value of integer>
mac: <value of string>
mpsk-schedules: <value of string>
name: <value of string>
passphrase: <value of string>
pmk: <value of string>
name: <value of string>
vlan-id: <value of integer>
vlan-type: <value in [no-vlan, fixed-vlan]>
name: <value of string>
ssid: <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_pkg_firewall_consolidated_policy – Configure consolidated IPv4/IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_consolidated\_policy – Configure consolidated IPv4/IPv6 policies.
============================================================================================================
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_consolidated_policy`.
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\_consolidated\_policy** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
* ipsec
| Policy action (allow/deny/ipsec). |
| | **app-category** string | | Application category ID list. |
| | **app-group** string | | Application group names. |
| | **application** integer | | no description |
| | **application-list** string | | Name of an existing Application list. |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| Enable/disable offloading security profile processing to CP processors. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **captive-portal-exempt** string | **Choices:*** disable
* enable
| Enable exemption of some users from the captive portal. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | Comment. |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| Enable to change packets DiffServ values to the specified diffservcode-forward value. |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode-forward** string | | Change packets DiffServ to this value. |
| | **diffservcode-rev** string | | Change packets reverse (reply) DiffServ to this value. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **dstaddr4** string | | Destination IPv4 address name and address group names. |
| | **dstaddr6** string | | Destination IPv6 address name and address group names. |
| | **dstintf** string | | Outgoing (egress) interface. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **fixedport** string | **Choices:*** disable
* enable
| Enable to prevent source NAT from changing a sessions source port. |
| | **fsso-groups** string | | Names of FSSO groups. |
| | **global-label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** string | | Names of user groups that can authenticate with this policy. |
| | **http-policy-redirect** string | **Choices:*** disable
* enable
| Redirect HTTP(S) traffic to matching transparent web proxy policy. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **inbound** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. |
| | **internet-service-custom** string | | Custom Internet Service name. |
| | **internet-service-custom-group** string | | Custom Internet Service group name. |
| | **internet-service-group** string | | Internet Service group name. |
| | **internet-service-id** string | | Internet Service ID. |
| | **internet-service-negate** string | **Choices:*** disable
* enable
| When enabled internet-service specifies what the service must NOT be. |
| | **internet-service-src** string | **Choices:*** disable
* enable
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. |
| | **internet-service-src-custom** string | | Custom Internet Service source name. |
| | **internet-service-src-custom-group** string | | Custom Internet Service source group name. |
| | **internet-service-src-group** string | | Internet Service source group name. |
| | **internet-service-src-id** string | | Internet Service source ID. |
| | **internet-service-src-negate** string | **Choices:*** disable
* enable
| When enabled internet-service-src specifies what the service must NOT be. |
| | **ippool** string | **Choices:*** disable
* enable
| Enable to use IP Pools for source NAT. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **logtraffic** string | **Choices:*** disable
* all
* utm
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **nat** string | **Choices:*** disable
* enable
| Enable/disable source NAT. |
| | **outbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. |
| | **per-ip-shaper** string | | Per-IP traffic shaper. |
| | **policyid** integer | | Policy ID (0 - 4294967294). |
| | **poolname4** string | | IPv4 pool names. |
| | **poolname6** string | | IPv6 pool names. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **schedule** string | | Schedule name. |
| | **service** string | | Service and service group names. |
| | **service-negate** string | **Choices:*** disable
* enable
| 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 default session TTL). |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **srcaddr4** string | | Source IPv4 address name and address group names. |
| | **srcaddr6** string | | Source IPv6 address name and address group names. |
| | **srcintf** string | | Incoming (ingress) interface. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| 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. |
| | **traffic-shaper-reverse** string | | Reverse traffic shaper. |
| | **url-category** string | | URL category ID list. |
| | **users** string | | Names of individual users that can authenticate with this policy. |
| | **utm-status** string | **Choices:*** disable
* enable
| 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. |
| | **vpntunnel** string | | Policy-based IPsec VPN: name of the IPsec VPN Phase 1. |
| | **waf-profile** string | | Name of an existing Web application firewall profile. |
| | **wanopt** string | **Choices:*** disable
* enable
| Enable/disable WAN optimization. |
| | **wanopt-detection** string | **Choices:*** active
* passive
* off
| 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. |
| | **wanopt-profile** string | | WAN optimization profile. |
| | **webcache** string | **Choices:*** disable
* enable
| 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. |
| | **webproxy-forward-server** string | | Webproxy forward server name. |
| | **webproxy-profile** string | | Webproxy profile 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 consolidated IPv4/IPv6 policies.
fmgr_pkg_firewall_consolidated_policy:
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>
state: <value in [present, absent]>
pkg_firewall_consolidated_policy:
action: <value in [deny, accept, ipsec]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-list: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dstaddr4: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
emailfilter-profile: <value of string>
fixedport: <value in [disable, enable]>
groups: <value of string>
http-policy-redirect: <value in [disable, enable]>
icap-profile: <value of string>
inbound: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
internet-service: <value in [disable, enable]>
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>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
logtraffic: <value in [disable, all, utm]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
policyid: <value of integer>
poolname4: <value of string>
poolname6: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
schedule: <value of string>
service: <value of string>
session-ttl: <value of integer>
srcaddr4: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
voip-profile: <value of string>
vpntunnel: <value of string>
waf-profile: <value of string>
wanopt: <value in [disable, enable]>
wanopt-detection: <value in [active, passive, off]>
wanopt-passive-opt: <value in [default, transparent, non-transparent]>
wanopt-peer: <value of string>
wanopt-profile: <value of string>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, enable]>
webfilter-profile: <value of string>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
captive-portal-exempt: <value in [disable, enable]>
dstaddr-negate: <value in [disable, enable]>
fsso-groups: <value of string>
global-label: <value of string>
internet-service-negate: <value in [disable, enable]>
internet-service-src-negate: <value in [disable, enable]>
service-negate: <value in [disable, enable]>
srcaddr-negate: <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_address6_tagging – Config object tagging fortinet.fortimanager.fmgr\_firewall\_address6\_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_address6_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 |
| --- | --- | --- |
| **address6** string / required | | the parameter (address6) 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\_address6\_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_address6_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>
address6: <your own value>
state: <value in [present, absent]>
firewall_address6_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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_waf_profile_constraint_method – Enable/disable HTTP method check. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_method – Enable/disable HTTP method 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_method`.
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\_method** 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 HTTP method check.
fmgr_waf_profile_constraint_method:
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_method:
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_firewall_internetservice – Show Internet Service application. fortinet.fortimanager.fmgr\_firewall\_internetservice – Show Internet Service application.
==========================================================================================
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_internetservice`.
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\_internetservice** dictionary | | the top level parameters set |
| | **city** integer | | no description |
| | **country** integer | | no description |
| | **database** string | **Choices:*** isdb
* irdb
| no description |
| | **direction** string | **Choices:*** src
* dst
* both
| no description |
| | **entry** list / elements=string | | no description |
| | | **id** integer | | Entry ID. |
| | | **ip-number** integer | | Total number of IP addresses. |
| | | **ip-range-number** integer | | Total number of IP ranges. |
| | | **port** integer | | no description |
| | | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| | **extra-ip-range-number** integer | | no description |
| | **icon-id** integer | | no description |
| | **id** integer | | no description |
| | **ip-number** integer | | no description |
| | **ip-range-number** integer | | no description |
| | **jitter-threshold** integer | | no description |
| | **latency-threshold** integer | | no description |
| | **name** string | | no description |
| | **obsolete** integer | | no description |
| | **offset** integer | | no description |
| | **packetloss-threshold** integer | | no description |
| | **region** integer | | no description |
| | **reputation** integer | | no description |
| | **singularity** integer | | no description |
| | **sld-id** integer | | 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: Show Internet Service application.
fmgr_firewall_internetservice:
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>
firewall_internetservice:
database: <value in [isdb, irdb]>
direction: <value in [src, dst, both]>
entry:
-
id: <value of integer>
ip-number: <value of integer>
ip-range-number: <value of integer>
port: <value of integer>
protocol: <value of integer>
icon-id: <value of integer>
id: <value of integer>
name: <value of string>
offset: <value of integer>
reputation: <value of integer>
sld-id: <value of integer>
extra-ip-range-number: <value of integer>
ip-number: <value of integer>
ip-range-number: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
obsolete: <value of integer>
packetloss-threshold: <value of integer>
singularity: <value of integer>
city: <value of integer>
country: <value of integer>
region: <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_hotspot20_qosmap_dscpexcept – Differentiated Services Code Point fortinet.fortimanager.fmgr\_hotspot20\_qosmap\_dscpexcept – Differentiated Services Code Point
==============================================================================================
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_qosmap_dscpexcept`.
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\_qosmap\_dscpexcept** dictionary | | the top level parameters set |
| | **dscp** integer | | DSCP value. |
| | **index** integer | | DSCP exception index. |
| | **up** integer | | User priority. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **qos-map** string / required | | the parameter (qos-map) 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 |
| **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: Differentiated Services Code Point
fmgr_hotspot20_qosmap_dscpexcept:
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>
qos-map: <your own value>
state: <value in [present, absent]>
hotspot20_qosmap_dscpexcept:
dscp: <value of integer>
index: <value of integer>
up: <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_dnsbl_entries – Spam filter DNSBL and ORBL server. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 |
| **emailfilter\_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. |
| **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: Spam filter DNSBL and ORBL server.
fmgr_emailfilter_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]>
emailfilter_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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_videofilter_profile_fortiguardcategory – Configure FortiGuard categories. fortinet.fortimanager.fmgr\_videofilter\_profile\_fortiguardcategory – Configure FortiGuard categories.
=======================================================================================================
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_videofilter_profile_fortiguardcategory`.
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 |
| **videofilter\_profile\_fortiguardcategory** dictionary | | the top level parameters set |
| | **filters** list / elements=string | | no description |
| | | **action** string | **Choices:*** block
* bypass
* monitor
| VideoFilter action. |
| | | **category-id** integer | | Category ID. |
| | | **id** integer | | ID. |
| | | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| **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 FortiGuard categories.
fmgr_videofilter_profile_fortiguardcategory:
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>
videofilter_profile_fortiguardcategory:
filters:
-
action: <value in [block, bypass, monitor]>
category-id: <value of integer>
id: <value of integer>
log: <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_vpnmgr_node_iprange – no description fortinet.fortimanager.fmgr\_vpnmgr\_node\_iprange – 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_node_iprange`.
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 |
| **node** string / required | | the parameter (node) 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 |
| **vpnmgr\_node\_iprange** dictionary | | the top level parameters set |
| | **end-ip** string | | no description |
| | **id** integer | | no description |
| | **start-ip** 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_node_iprange:
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>
node: <your own value>
state: <value in [present, absent]>
vpnmgr_node_iprange:
end-ip: <value of string>
id: <value of integer>
start-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_vap_vlanpool – VLAN pool. fortinet.fortimanager.fmgr\_vap\_vlanpool – VLAN pool.
======================================================
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_vap_vlanpool`.
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 |
| **vap** string / required | | the parameter (vap) in requested url |
| **vap\_vlanpool** dictionary | | the top level parameters set |
| | **\_wtp-group** string | | no description |
| | **id** integer | | ID. |
| | **wtp-group** string | | WTP group 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: VLAN pool.
fmgr_vap_vlanpool:
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>
vap: <your own value>
state: <value in [present, absent]>
vap_vlanpool:
_wtp-group: <value of string>
id: <value of integer>
wtp-group: <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_switchcontroller_qos_ipdscpmap_map – Maps between IP-DSCP value to COS queue. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_ipdscpmap\_map – Maps between IP-DSCP value to COS queue.
============================================================================================================
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_qos_ipdscpmap_map`.
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 |
| **ip-dscp-map** string / required | | the parameter (ip-dscp-map) 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\_qos\_ipdscpmap\_map** dictionary | | the top level parameters set |
| | **cos-queue** integer | | COS queue number. |
| | **diffserv** list / elements=string | **Choices:*** CS0
* CS1
* AF11
* AF12
* AF13
* CS2
* AF21
* AF22
* AF23
* CS3
* AF31
* AF32
* AF33
* CS4
* AF41
* AF42
* AF43
* CS5
* EF
* CS6
* CS7
| no description |
| | **ip-precedence** list / elements=string | **Choices:*** network-control
* internetwork-control
* critic-ecp
* flashoverride
* flash
* immediate
* priority
* routine
| no description |
| | **name** string | | Dscp mapping entry name. |
| | **value** string | | Raw values of DSCP (0 - 63). |
| **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: Maps between IP-DSCP value to COS queue.
fmgr_switchcontroller_qos_ipdscpmap_map:
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>
ip-dscp-map: <your own value>
state: <value in [present, absent]>
switchcontroller_qos_ipdscpmap_map:
cos-queue: <value of integer>
diffserv:
- CS0
- CS1
- AF11
- AF12
- AF13
- CS2
- AF21
- AF22
- AF23
- CS3
- AF31
- AF32
- AF33
- CS4
- AF41
- AF42
- AF43
- CS5
- EF
- CS6
- CS7
ip-precedence:
- network-control
- internetwork-control
- critic-ecp
- flashoverride
- flash
- immediate
- priority
- routine
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_system_saml_fabricidp – Authorized identity providers. fortinet.fortimanager.fmgr\_system\_saml\_fabricidp – Authorized identity providers.
====================================================================================
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_saml_fabricidp`.
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\_saml\_fabricidp** dictionary | | the top level parameters set |
| | **dev-id** string | | IDP Device ID. |
| | **idp-cert** string | | IDP Certificate name. |
| | **idp-entity-id** string | | IDP entity ID. |
| | **idp-single-logout-url** string | | IDP single logout url. |
| | **idp-single-sign-on-url** string | | IDP single sign-on URL. |
| | **idp-status** string | **Choices:*** **disable** ←
* enable
| Enable/disable SAML authentication (default = disable). disable - Disable SAML authentication. enable - Enabld SAML authentication. |
| **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: Authorized identity providers.
fmgr_system_saml_fabricidp:
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_saml_fabricidp:
dev-id: <value of string>
idp-cert: <value of string>
idp-entity-id: <value of string>
idp-single-logout-url: <value of string>
idp-single-sign-on-url: <value of string>
idp-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_perapnshaper – Per APN shaper. fortinet.fortimanager.fmgr\_firewall\_gtp\_perapnshaper – Per APN shaper.
=========================================================================
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_perapnshaper`.
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\_perapnshaper** dictionary | | the top level parameters set |
| | **apn** string | | APN name. |
| | **id** integer | | ID. |
| | **rate-limit** integer | | Rate limit (packets/s) for create PDP context request. |
| | **version** integer | | GTP version number: 0 or 1. |
| **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: Per APN shaper.
fmgr_firewall_gtp_perapnshaper:
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_perapnshaper:
apn: <value of string>
id: <value of integer>
rate-limit: <value of integer>
version: <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_dvmdb_revision – ADOM revision table. fortinet.fortimanager.fmgr\_dvmdb\_revision – ADOM revision table.
==================================================================
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_revision`.
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\_revision** dictionary | | the top level parameters set |
| | **created\_by** string | | no description |
| | **created\_time** integer | | no description |
| | **desc** string | | no description |
| | **locked** integer | | no description |
| | **name** string | | no description |
| | **version** integer | | no description |
| **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: ADOM revision table.
fmgr_dvmdb_revision:
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]>
dvmdb_revision:
created_by: <value of string>
created_time: <value of integer>
desc: <value of string>
locked: <value of integer>
name: <value of string>
version: <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_webfilter_content_entries – Configure banned word entries. fortinet.fortimanager.fmgr\_webfilter\_content\_entries – Configure banned word 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_webfilter_content_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 |
| **content** string / required | | the parameter (content) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **webfilter\_content\_entries** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** exempt
* block
| 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 | | 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, default = 10). |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable banned word. |
| **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 banned word entries.
fmgr_webfilter_content_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>
content: <your own value>
state: <value in [present, absent]>
webfilter_content_entries:
action: <value in [exempt, block]>
lang: <value in [western, simch, trach, ...]>
name: <value of string>
pattern-type: <value in [wildcard, regexp]>
score: <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_application_categories – no description fortinet.fortimanager.fmgr\_application\_categories – 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_application_categories`.
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\_categories** dictionary | | the top level parameters set |
| | **id** integer | | no description |
| **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 |
| **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_application_categories:
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]>
application_categories:
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_devprof_system_replacemsg_admin – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_admin – 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_admin`.
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\_admin** 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_admin:
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_admin:
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_switchcontroller_managedswitch_switchstpsettings – Configure spanning tree protocol fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_switchstpsettings – Configure spanning tree 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_switchstpsettings`.
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 |
| **device** string / required | | the parameter (device) in requested url |
| **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 |
| **vdom** string / required | | the parameter (vdom) 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: Configure spanning tree protocol
fmgr_switchcontroller_managedswitch_switchstpsettings:
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, ...]
device: <your own value>
vdom: <your own value>
managed-switch: <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_firewall_address_dynamicmapping – Configure IPv4 addresses. fortinet.fortimanager.fmgr\_firewall\_address\_dynamicmapping – Configure IPv4 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_firewall_address_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 |
| --- | --- | --- |
| **address** string / required | | the parameter (address) 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\_address\_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 |
| | **associated-interface** string | | no description |
| | **cache-ttl** integer | | no description |
| | **clearpass-spt** string | **Choices:*** unknown
* healthy
* quarantine
* checkup
* transition
* infected
* transient
| no description |
| | **color** integer | | no description |
| | **comment** dictionary | | no description |
| | **country** string | | no description |
| | **end-ip** string | | no description |
| | **end-mac** string | | no description |
| | **epg-name** string | | no description |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **filter** string | | no description |
| | **fqdn** string | | no description |
| | **fsso-group** string | | no description |
| | **global-object** integer | | no description |
| | **interface** string | | no description |
| | **macaddr** string | | no description |
| | **node-ip-only** string | **Choices:*** disable
* enable
| Enable/disable collection of node addresses only in Kubernetes. |
| | **obj-id** string | | no description |
| | **obj-tag** string | | no description |
| | **obj-type** string | **Choices:*** ip
* mac
| no description |
| | **organization** string | | no description |
| | **policy-group** string | | no description |
| | **sdn** string | **Choices:*** aci
* aws
* nsx
* nuage
* azure
* gcp
* oci
* openstack
| no description |
| | **sdn-addr-type** string | **Choices:*** private
* public
* all
| no description |
| | **sdn-tag** string | | no description |
| | **start-ip** string | | no description |
| | **start-mac** string | | no description |
| | **sub-type** string | **Choices:*** sdn
* clearpass-spt
* fsso
* ems-tag
| no description |
| | **subnet** string | | no description |
| | **subnet-name** string | | no description |
| | **tags** string | | no description |
| | **tenant** string | | no description |
| | **type** string | **Choices:*** ipmask
* iprange
* fqdn
* wildcard
* geography
* url
* wildcard-fqdn
* nsx
* aws
* dynamic
* interface-subnet
* mac
| no description |
| | **url** string | | no description |
| | **uuid** string | | no description |
| | **visibility** string | **Choices:*** disable
* enable
| no description |
| | **wildcard** string | | no description |
| | **wildcard-fqdn** 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: Configure IPv4 addresses.
fmgr_firewall_address_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>
address: <your own value>
state: <value in [present, absent]>
firewall_address_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of dict>
country: <value of string>
end-ip: <value of string>
end-mac: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
interface: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-addr-type: <value in [private, public, all]>
sdn-tag: <value of string>
start-ip: <value of string>
start-mac: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
url: <value of string>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
_image-base64: <value of string>
clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
fsso-group: <value of string>
sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
global-object: <value of integer>
obj-tag: <value of string>
obj-type: <value in [ip, mac]>
fabric-object: <value in [disable, enable]>
macaddr: <value of string>
node-ip-only: <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_pkg_firewall_multicastpolicy6 – Configure IPv6 multicast NAT policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_multicastpolicy6 – Configure IPv6 multicast NAT policies.
====================================================================================================
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_multicastpolicy6`.
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\_multicastpolicy6** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
| Accept or deny traffic matching the policy. |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| Enable/disable offloading policy traffic for hardware acceleration. |
| | **comments** string | | Comment. |
| | **dstaddr** string | | IPv6 destination address name. |
| | **dstintf** string | | IPv6 destination interface name. |
| | **end-port** integer | | Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 65535). |
| | **id** integer | | Policy ID. |
| | **logtraffic** string | **Choices:*** disable
* enable
| 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, default = 0). |
| | **srcaddr** string | | IPv6 source address name. |
| | **srcintf** string | | IPv6 source interface name. |
| | **start-port** integer | | Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1). |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this policy. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 IPv6 multicast NAT policies.
fmgr_pkg_firewall_multicastpolicy6:
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>
state: <value in [present, absent]>
pkg_firewall_multicastpolicy6:
action: <value in [deny, accept]>
auto-asic-offload: <value in [disable, enable]>
dstaddr: <value of string>
dstintf: <value of string>
end-port: <value of integer>
id: <value of integer>
logtraffic: <value in [disable, enable]>
protocol: <value of integer>
srcaddr: <value of string>
srcintf: <value of string>
start-port: <value of integer>
status: <value in [disable, enable]>
name: <value of string>
comments: <value of string>
uuid: <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_waf_profile_signature_mainclass – Main signature class. fortinet.fortimanager.fmgr\_waf\_profile\_signature\_mainclass – Main signature class.
======================================================================================
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_signature_mainclass`.
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\_signature\_mainclass** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
* erase
| Action. |
| | **id** integer | | Main signature class ID. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **severity** string | **Choices:*** low
* medium
* high
| Severity. |
| | **status** string | **Choices:*** disable
* enable
| Status. |
| **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: Main signature class.
fmgr_waf_profile_signature_mainclass:
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_signature_mainclass:
action: <value in [allow, block, erase]>
id: <value of integer>
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_fsp_vlan_interface – Configure interfaces. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface – Configure interfaces.
========================================================================
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_fsp_vlan_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 |
| --- | --- | --- |
| **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 |
| **fsp\_vlan\_interface** dictionary | | the top level parameters set |
| | **ac-name** string | | no description |
| | **aggregate** string | | no description |
| | **algorithm** string | **Choices:*** L2
* L3
* L4
| no description |
| | **alias** string | | no description |
| | **allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
* dnp
* ftm
* fabric
| no description |
| | **ap-discover** string | **Choices:*** disable
* enable
| no description |
| | **arpforward** string | **Choices:*** disable
* enable
| no description |
| | **atm-protocol** string | **Choices:*** none
* ipoa
| no description |
| | **auth-type** string | **Choices:*** auto
* pap
* chap
* mschapv1
* mschapv2
| no description |
| | **auto-auth-extension-device** string | **Choices:*** disable
* enable
| no description |
| | **bandwidth-measure-time** integer | | no description |
| | **bfd** string | **Choices:*** global
* enable
* disable
| no description |
| | **bfd-desired-min-tx** integer | | no description |
| | **bfd-detect-mult** integer | | no description |
| | **bfd-required-min-rx** integer | | no description |
| | **broadcast-forticlient-discovery** string | **Choices:*** disable
* enable
| no description |
| | **broadcast-forward** string | **Choices:*** disable
* enable
| no description |
| | **captive-portal** integer | | no description |
| | **cli-conn-status** integer | | no description |
| | **color** integer | | no description |
| | **ddns** string | **Choices:*** disable
* enable
| no description |
| | **ddns-auth** string | **Choices:*** disable
* tsig
| no description |
| | **ddns-domain** string | | no description |
| | **ddns-key** string | | no description |
| | **ddns-keyname** string | | no description |
| | **ddns-password** string | | no description |
| | **ddns-server** string | **Choices:*** dhs.org
* dyndns.org
* dyns.net
* tzo.com
* ods.org
* vavic.com
* now.net.cn
* dipdns.net
* easydns.com
* genericDDNS
| no description |
| | **ddns-server-ip** string | | no description |
| | **ddns-sn** string | | no description |
| | **ddns-ttl** integer | | no description |
| | **ddns-username** string | | no description |
| | **ddns-zone** string | | no description |
| | **dedicated-to** string | **Choices:*** none
* management
| no description |
| | **defaultgw** string | **Choices:*** disable
* enable
| no description |
| | **description** string | | no description |
| | **detected-peer-mtu** integer | | no description |
| | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| no description |
| | **detectserver** string | | no description |
| | **device-access-list** string | | no description |
| | **device-identification** string | **Choices:*** disable
* enable
| no description |
| | **device-identification-active-scan** string | **Choices:*** disable
* enable
| no description |
| | **device-netscan** string | **Choices:*** disable
* enable
| no description |
| | **device-user-identification** string | **Choices:*** disable
* enable
| no description |
| | **devindex** integer | | no description |
| | **dhcp-client-identifier** string | | no description |
| | **dhcp-relay-agent-option** string | **Choices:*** disable
* enable
| no description |
| | **dhcp-relay-interface** string | | no description |
| | **dhcp-relay-interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | **dhcp-relay-ip** string | | no description |
| | **dhcp-relay-request-all-server** string | **Choices:*** disable
* enable
| Enable/disable sending of DHCP requests to all servers. |
| | **dhcp-relay-service** string | **Choices:*** disable
* enable
| no description |
| | **dhcp-relay-type** string | **Choices:*** regular
* ipsec
| no description |
| | **dhcp-renew-time** integer | | no description |
| | **disc-retry-timeout** integer | | no description |
| | **disconnect-threshold** integer | | no description |
| | **distance** integer | | no description |
| | **dns-query** string | **Choices:*** disable
* recursive
* non-recursive
| no description |
| | **dns-server-override** string | **Choices:*** disable
* enable
| no description |
| | **drop-fragment** string | **Choices:*** disable
* enable
| no description |
| | **drop-overlapped-fragment** string | **Choices:*** disable
* enable
| no description |
| | **egress-cos** string | **Choices:*** disable
* cos0
* cos1
* cos2
* cos3
* cos4
* cos5
* cos6
* cos7
| no description |
| | **egress-shaping-profile** string | | no description |
| | **eip** string | | no description |
| | **endpoint-compliance** string | **Choices:*** disable
* enable
| no description |
| | **estimated-downstream-bandwidth** integer | | no description |
| | **estimated-upstream-bandwidth** integer | | no description |
| | **explicit-ftp-proxy** string | **Choices:*** disable
* enable
| no description |
| | **explicit-web-proxy** string | **Choices:*** disable
* enable
| no description |
| | **external** string | **Choices:*** disable
* enable
| no description |
| | **fail-action-on-extender** string | **Choices:*** soft-restart
* hard-restart
* reboot
| no description |
| | **fail-alert-interfaces** string | | no description |
| | **fail-alert-method** string | **Choices:*** link-failed-signal
* link-down
| no description |
| | **fail-detect** string | **Choices:*** disable
* enable
| no description |
| | **fail-detect-option** list / elements=string | **Choices:*** detectserver
* link-down
| no description |
| | **fdp** string | **Choices:*** disable
* enable
| no description |
| | **fortiheartbeat** string | **Choices:*** disable
* enable
| no description |
| | **fortilink** string | **Choices:*** disable
* enable
| no description |
| | **fortilink-backup-link** integer | | no description |
| | **fortilink-neighbor-detect** string | **Choices:*** lldp
* fortilink
| no description |
| | **fortilink-split-interface** string | **Choices:*** disable
* enable
| no description |
| | **fortilink-stacking** string | **Choices:*** disable
* enable
| no description |
| | **forward-domain** integer | | no description |
| | **forward-error-correction** string | **Choices:*** disable
* enable
* rs-fec
* base-r-fec
* fec-cl91
* fec-cl74
| no description |
| | **fp-anomaly** list / elements=string | **Choices:*** drop\_tcp\_fin\_noack
* pass\_winnuke
* pass\_tcpland
* pass\_udpland
* pass\_icmpland
* pass\_ipland
* pass\_iprr
* pass\_ipssrr
* pass\_iplsrr
* pass\_ipstream
* pass\_ipsecurity
* pass\_iptimestamp
* pass\_ipunknown\_option
* pass\_ipunknown\_prot
* pass\_icmp\_frag
* pass\_tcp\_no\_flag
* pass\_tcp\_fin\_noack
* drop\_winnuke
* drop\_tcpland
* drop\_udpland
* drop\_icmpland
* drop\_ipland
* drop\_iprr
* drop\_ipssrr
* drop\_iplsrr
* drop\_ipstream
* drop\_ipsecurity
* drop\_iptimestamp
* drop\_ipunknown\_option
* drop\_ipunknown\_prot
* drop\_icmp\_frag
* drop\_tcp\_no\_flag
| no description |
| | **fp-disable** list / elements=string | **Choices:*** all
* ipsec
* none
| no description |
| | **gateway-address** string | | no description |
| | **gi-gk** string | **Choices:*** disable
* enable
| no description |
| | **gwaddr** string | | no description |
| | **gwdetect** string | **Choices:*** disable
* enable
| no description |
| | **ha-priority** integer | | no description |
| | **icmp-accept-redirect** string | **Choices:*** disable
* enable
| no description |
| | **icmp-redirect** string | **Choices:*** disable
* enable
| no description |
| | **icmp-send-redirect** string | **Choices:*** disable
* enable
| no description |
| | **ident-accept** string | **Choices:*** disable
* enable
| no description |
| | **idle-timeout** integer | | no description |
| | **if-mdix** string | **Choices:*** auto
* normal
* crossover
| no description |
| | **if-media** string | **Choices:*** auto
* copper
* fiber
| no description |
| | **in-force-vlan-cos** integer | | no description |
| | **inbandwidth** integer | | no description |
| | **ingress-cos** string | **Choices:*** disable
* cos0
* cos1
* cos2
* cos3
* cos4
* cos5
* cos6
* cos7
| no description |
| | **ingress-shaping-profile** string | | no description |
| | **ingress-spillover-threshold** integer | | no description |
| | **internal** integer | | no description |
| | **ip** string | | no description |
| | **ip-managed-by-fortiipam** string | **Choices:*** disable
* enable
| no description |
| | **ipmac** string | **Choices:*** disable
* enable
| no description |
| | **ips-sniffer-mode** string | **Choices:*** disable
* enable
| no description |
| | **ipunnumbered** string | | no description |
| | **ipv6** dictionary | | no description |
| | | **autoconf** string | **Choices:*** disable
* enable
| no description |
| | | **cli-conn6-status** integer | | no description |
| | | **dhcp6-client-options** list / elements=string | **Choices:*** rapid
* iapd
* iana
* dns
* dnsname
| no description |
| | | **dhcp6-information-request** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp6-prefix-delegation** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp6-prefix-hint** string | | no description |
| | | **dhcp6-prefix-hint-plt** integer | | no description |
| | | **dhcp6-prefix-hint-vlt** integer | | no description |
| | | **dhcp6-relay-ip** string | | no description |
| | | **dhcp6-relay-service** string | **Choices:*** disable
* enable
| no description |
| | | **dhcp6-relay-type** string | **Choices:*** regular
| no description |
| | | **icmp6-send-redirect** string | **Choices:*** disable
* enable
| Enable/disable sending of ICMPv6 redirects. |
| | | **interface-identifier** string | | no description |
| | | **ip6-address** string | | no description |
| | | **ip6-allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* capwap
* fabric
| no description |
| | | **ip6-default-life** integer | | no description |
| | | **ip6-delegated-prefix-list** list / elements=string | | no description |
| | | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | | **prefix-id** integer | | no description |
| | | | **rdnss** string | | no description |
| | | | **rdnss-service** string | **Choices:*** delegated
* default
* specify
| no description |
| | | | **subnet** string | | no description |
| | | | **upstream-interface** string | | no description |
| | | **ip6-dns-server-override** string | **Choices:*** disable
* enable
| no description |
| | | **ip6-extra-addr** list / elements=string | | no description |
| | | | **prefix** string | | no description |
| | | **ip6-hop-limit** integer | | no description |
| | | **ip6-link-mtu** integer | | no description |
| | | **ip6-manage-flag** string | **Choices:*** disable
* enable
| no description |
| | | **ip6-max-interval** integer | | no description |
| | | **ip6-min-interval** integer | | no description |
| | | **ip6-mode** string | **Choices:*** static
* dhcp
* pppoe
* delegated
| no description |
| | | **ip6-other-flag** string | **Choices:*** disable
* enable
| no description |
| | | **ip6-prefix-list** list / elements=string | | no description |
| | | | **autonomous-flag** string | **Choices:*** disable
* enable
| no description |
| | | | **dnssl** string | | no description |
| | | | **onlink-flag** string | **Choices:*** disable
* enable
| no description |
| | | | **preferred-life-time** integer | | no description |
| | | | **prefix** string | | no description |
| | | | **rdnss** string | | no description |
| | | | **valid-life-time** integer | | no description |
| | | **ip6-prefix-mode** string | **Choices:*** dhcp6
* ra
| Assigning a prefix from DHCP or RA. |
| | | **ip6-reachable-time** integer | | no description |
| | | **ip6-retrans-time** integer | | no description |
| | | **ip6-send-adv** string | **Choices:*** disable
* enable
| no description |
| | | **ip6-subnet** string | | no description |
| | | **ip6-upstream-interface** string | | no description |
| | | **nd-cert** string | | no description |
| | | **nd-cga-modifier** string | | no description |
| | | **nd-mode** string | **Choices:*** basic
* SEND-compatible
| no description |
| | | **nd-security-level** integer | | no description |
| | | **nd-timestamp-delta** integer | | no description |
| | | **nd-timestamp-fuzz** integer | | no description |
| | | **ra-send-mtu** string | **Choices:*** disable
* enable
| Enable/disable sending link MTU in RA packet. |
| | | **unique-autoconf-addr** string | **Choices:*** disable
* enable
| no description |
| | | **vrip6\_link\_local** string | | no description |
| | | **vrrp-virtual-mac6** string | **Choices:*** disable
* enable
| no description |
| | | **vrrp6** list / elements=string | | no description |
| | | | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | | | **adv-interval** integer | | no description |
| | | | **preempt** string | **Choices:*** disable
* enable
| no description |
| | | | **priority** integer | | no description |
| | | | **start-time** integer | | no description |
| | | | **status** string | **Choices:*** disable
* enable
| no description |
| | | | **vrdst6** string | | no description |
| | | | **vrgrp** integer | | no description |
| | | | **vrid** integer | | no description |
| | | | **vrip6** string | | no description |
| | **l2forward** string | **Choices:*** disable
* enable
| no description |
| | **l2tp-client** string | **Choices:*** disable
* enable
| no description |
| | **lacp-ha-slave** string | **Choices:*** disable
* enable
| no description |
| | **lacp-mode** string | **Choices:*** static
* passive
* active
| no description |
| | **lacp-speed** string | **Choices:*** slow
* fast
| no description |
| | **lcp-echo-interval** integer | | no description |
| | **lcp-max-echo-fails** integer | | no description |
| | **link-up-delay** integer | | no description |
| | **listen-forticlient-connection** string | **Choices:*** disable
* enable
| no description |
| | **lldp-network-policy** string | | no description |
| | **lldp-reception** string | **Choices:*** disable
* enable
* vdom
| no description |
| | **lldp-transmission** string | **Choices:*** enable
* disable
* vdom
| no description |
| | **log** string | **Choices:*** disable
* enable
| no description |
| | **macaddr** string | | no description |
| | **managed-subnetwork-size** string | **Choices:*** 256
* 512
* 1024
* 2048
* 4096
* 8192
* 16384
* 32768
* 65536
| no description |
| | **management-ip** string | | no description |
| | **max-egress-burst-rate** integer | | no description |
| | **max-egress-rate** integer | | no description |
| | **measured-downstream-bandwidth** integer | | no description |
| | **measured-upstream-bandwidth** integer | | no description |
| | **mediatype** string | **Choices:*** serdes-sfp
* sgmii-sfp
* cfp2-sr10
* cfp2-lr4
* serdes-copper-sfp
* sr
* cr
* lr
* qsfp28-sr4
* qsfp28-lr4
* qsfp28-cr4
* sr4
* cr4
* lr4
| no description |
| | **member** string | | no description |
| | **min-links** integer | | no description |
| | **min-links-down** string | **Choices:*** operational
* administrative
| no description |
| | **mode** string | **Choices:*** static
* dhcp
* pppoe
* pppoa
* ipoa
* eoa
| no description |
| | **monitor-bandwidth** string | **Choices:*** disable
* enable
| no description |
| | **mtu** integer | | no description |
| | **mtu-override** string | **Choices:*** disable
* enable
| no description |
| | **mux-type** string | **Choices:*** llc-encaps
* vc-encaps
| no description |
| | **name** string | | no description |
| | **ndiscforward** string | **Choices:*** disable
* enable
| no description |
| | **netbios-forward** string | **Choices:*** disable
* enable
| no description |
| | **netflow-sampler** string | **Choices:*** disable
* tx
* rx
* both
| no description |
| | **np-qos-profile** integer | | no description |
| | **npu-fastpath** string | **Choices:*** disable
* enable
| no description |
| | **nst** string | **Choices:*** disable
* enable
| no description |
| | **out-force-vlan-cos** integer | | no description |
| | **outbandwidth** integer | | no description |
| | **padt-retry-timeout** integer | | no description |
| | **password** string | | no description |
| | **peer-interface** string | | no description |
| | **phy-mode** string | **Choices:*** auto
* adsl
* vdsl
| no description |
| | **ping-serv-status** integer | | no description |
| | **poe** string | **Choices:*** disable
* enable
| no description |
| | **polling-interval** integer | | no description |
| | **pppoe-unnumbered-negotiate** string | **Choices:*** disable
* enable
| no description |
| | **pptp-auth-type** string | **Choices:*** auto
* pap
* chap
* mschapv1
* mschapv2
| no description |
| | **pptp-client** string | **Choices:*** disable
* enable
| no description |
| | **pptp-password** string | | no description |
| | **pptp-server-ip** string | | no description |
| | **pptp-timeout** integer | | no description |
| | **pptp-user** string | | no description |
| | **preserve-session-route** string | **Choices:*** disable
* enable
| no description |
| | **priority** integer | | no description |
| | **priority-override** string | **Choices:*** disable
* enable
| no description |
| | **proxy-captive-portal** string | **Choices:*** disable
* enable
| no description |
| | **redundant-interface** string | | no description |
| | **remote-ip** string | | no description |
| | **replacemsg-override-group** string | | no description |
| | **retransmission** string | **Choices:*** disable
* enable
| no description |
| | **ring-rx** integer | | no description |
| | **ring-tx** integer | | no description |
| | **role** string | **Choices:*** lan
* wan
* dmz
* undefined
| no description |
| | **sample-direction** string | **Choices:*** rx
* tx
* both
| no description |
| | **sample-rate** integer | | no description |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| no description |
| | **secondary-IP** string | **Choices:*** disable
* enable
| no description |
| | **secondaryip** list / elements=string | | no description |
| | | **allowaccess** list / elements=string | **Choices:*** https
* ping
* ssh
* snmp
* http
* telnet
* fgfm
* auto-ipsec
* radius-acct
* probe-response
* capwap
* dnp
* ftm
* fabric
| no description |
| | | **detectprotocol** list / elements=string | **Choices:*** ping
* tcp-echo
* udp-echo
| no description |
| | | **detectserver** string | | no description |
| | | **gwdetect** string | **Choices:*** disable
* enable
| no description |
| | | **ha-priority** integer | | no description |
| | | **id** integer | | no description |
| | | **ip** string | | no description |
| | | **ping-serv-status** integer | | no description |
| | | **seq** integer | | no description |
| | **security-8021x-dynamic-vlan-id** integer | | no description |
| | **security-8021x-master** string | | no description |
| | **security-8021x-mode** string | **Choices:*** default
* dynamic-vlan
* fallback
* slave
| no description |
| | **security-exempt-list** string | | no description |
| | **security-external-logout** string | | no description |
| | **security-external-web** string | | no description |
| | **security-groups** string | | no description |
| | **security-mac-auth-bypass** string | **Choices:*** disable
* enable
* mac-auth-only
| no description |
| | **security-mode** string | **Choices:*** none
* captive-portal
* 802.1X
| no description |
| | **security-redirect-url** string | | no description |
| | **service-name** string | | no description |
| | **sflow-sampler** string | **Choices:*** disable
* enable
| no description |
| | **speed** string | **Choices:*** auto
* 10full
* 10half
* 100full
* 100half
* 1000full
* 1000half
* 10000full
* 1000auto
* 10000auto
* 40000full
* 100Gfull
* 25000full
* 40000auto
* 25000auto
* 100Gauto
| no description |
| | **spillover-threshold** integer | | no description |
| | **src-check** string | **Choices:*** disable
* enable
| no description |
| | **status** string | **Choices:*** down
* up
| no description |
| | **stp** string | **Choices:*** disable
* enable
| no description |
| | **stp-ha-secondary** string | **Choices:*** disable
* enable
* priority-adjust
| Control STP behaviour on HA secondary. |
| | **stp-ha-slave** string | **Choices:*** disable
* enable
* priority-adjust
| no description |
| | **stpforward** string | **Choices:*** disable
* enable
| no description |
| | **stpforward-mode** string | **Choices:*** rpl-all-ext-id
* rpl-bridge-ext-id
* rpl-nothing
| no description |
| | **strip-priority-vlan-tag** string | **Choices:*** disable
* enable
| no description |
| | **subst** string | **Choices:*** disable
* enable
| no description |
| | **substitute-dst-mac** string | | no description |
| | **swc-first-create** integer | | Initial create for switch-controller VLANs. |
| | **swc-vlan** integer | | no description |
| | **switch** string | | no description |
| | **switch-controller-access-vlan** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-arp-inspection** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-auth** string | **Choices:*** radius
* usergroup
| no description |
| | **switch-controller-dhcp-snooping** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-dhcp-snooping-option82** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-dhcp-snooping-verify-mac** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-dynamic** string | | Integrated FortiLink settings for managed FortiSwitch. |
| | **switch-controller-feature** string | **Choices:*** none
* default-vlan
* quarantine
* sniffer
* voice
* camera
* rspan
* video
* nac
| no description |
| | **switch-controller-igmp-snooping** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-igmp-snooping-fast-leave** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-igmp-snooping-proxy** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-iot-scanning** string | **Choices:*** disable
* enable
| Enable/disable managed FortiSwitch IoT scanning. |
| | **switch-controller-learning-limit** integer | | no description |
| | **switch-controller-mgmt-vlan** integer | | no description |
| | **switch-controller-nac** string | | no description |
| | **switch-controller-radius-server** string | | no description |
| | **switch-controller-rspan-mode** string | **Choices:*** disable
* enable
| no description |
| | **switch-controller-source-ip** string | **Choices:*** outbound
* fixed
| Source IP address used in FortiLink over L3 connections. |
| | **switch-controller-traffic-policy** string | | no description |
| | **tc-mode** string | **Choices:*** ptm
* atm
| no description |
| | **tcp-mss** integer | | no description |
| | **trunk** string | **Choices:*** disable
* enable
| no description |
| | **trust-ip-1** string | | no description |
| | **trust-ip-2** string | | no description |
| | **trust-ip-3** string | | no description |
| | **trust-ip6-1** string | | no description |
| | **trust-ip6-2** string | | no description |
| | **trust-ip6-3** string | | no description |
| | **type** string | **Choices:*** physical
* vlan
* aggregate
* redundant
* tunnel
* wireless
* vdom-link
* loopback
* switch
* hard-switch
* hdlc
* vap-switch
* wl-mesh
* fortilink
* switch-vlan
* fctrl-trunk
* tdm
* fext-wan
* vxlan
* emac-vlan
* geneve
* ssl
| no description |
| | **username** string | | no description |
| | **vci** integer | | no description |
| | **vectoring** string | **Choices:*** disable
* enable
| no description |
| | **vindex** integer | | no description |
| | **vlan-protocol** string | **Choices:*** 8021q
* 8021ad
| no description |
| | **vlanforward** string | **Choices:*** disable
* enable
| no description |
| | **vlanid** integer | | no description |
| | **vpi** integer | | no description |
| | **vrf** integer | | no description |
| | **vrrp** list / elements=string | | no description |
| | | **accept-mode** string | **Choices:*** disable
* enable
| no description |
| | | **adv-interval** integer | | no description |
| | | **ignore-default-route** string | **Choices:*** disable
* enable
| no description |
| | | **preempt** string | **Choices:*** disable
* enable
| no description |
| | | **priority** integer | | no description |
| | | **start-time** integer | | no description |
| | | **status** string | **Choices:*** disable
* enable
| no description |
| | | **version** string | **Choices:*** 2
* 3
| no description |
| | | **vrdst** string | | no description |
| | | **vrdst-priority** integer | | no description |
| | | **vrgrp** integer | | no description |
| | | **vrid** integer | | no description |
| | | **vrip** string | | no description |
| | **vrrp-virtual-mac** string | **Choices:*** disable
* enable
| no description |
| | **wccp** string | **Choices:*** disable
* enable
| no description |
| | **weight** integer | | no description |
| | **wifi-5g-threshold** string | | no description |
| | **wifi-acl** string | **Choices:*** deny
* allow
| no description |
| | **wifi-ap-band** string | **Choices:*** any
* 5g-preferred
* 5g-only
| no description |
| | **wifi-auth** string | **Choices:*** PSK
* RADIUS
* radius
* usergroup
| no description |
| | **wifi-auto-connect** string | **Choices:*** disable
* enable
| no description |
| | **wifi-auto-save** string | **Choices:*** disable
* enable
| no description |
| | **wifi-broadcast-ssid** string | **Choices:*** disable
* enable
| no description |
| | **wifi-encrypt** string | **Choices:*** TKIP
* AES
| no description |
| | **wifi-fragment-threshold** integer | | no description |
| | **wifi-key** string | | no description |
| | **wifi-keyindex** integer | | no description |
| | **wifi-mac-filter** string | **Choices:*** disable
* enable
| no description |
| | **wifi-passphrase** string | | no description |
| | **wifi-radius-server** string | | no description |
| | **wifi-rts-threshold** integer | | no description |
| | **wifi-security** string | **Choices:*** None
* WEP64
* wep64
* WEP128
* wep128
* WPA\_PSK
* WPA\_RADIUS
* WPA
* WPA2
* WPA2\_AUTO
* open
* wpa-personal
* wpa-enterprise
* wpa-only-personal
* wpa-only-enterprise
* wpa2-only-personal
* wpa2-only-enterprise
| no description |
| | **wifi-ssid** string | | no description |
| | **wifi-usergroup** string | | no description |
| | **wins-ip** 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 |
| **vlan** string / required | | the parameter (vlan) 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: Configure interfaces.
fmgr_fsp_vlan_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, ...]
adom: <your own value>
vlan: <your own value>
fsp_vlan_interface:
ac-name: <value of string>
aggregate: <value of string>
algorithm: <value in [L2, L3, L4]>
alias: <value of string>
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
ap-discover: <value in [disable, enable]>
arpforward: <value in [disable, enable]>
atm-protocol: <value in [none, ipoa]>
auth-type: <value in [auto, pap, chap, ...]>
auto-auth-extension-device: <value in [disable, enable]>
bfd: <value in [global, enable, disable]>
bfd-desired-min-tx: <value of integer>
bfd-detect-mult: <value of integer>
bfd-required-min-rx: <value of integer>
broadcast-forticlient-discovery: <value in [disable, enable]>
broadcast-forward: <value in [disable, enable]>
captive-portal: <value of integer>
cli-conn-status: <value of integer>
color: <value of integer>
ddns: <value in [disable, enable]>
ddns-auth: <value in [disable, tsig]>
ddns-domain: <value of string>
ddns-key: <value of string>
ddns-keyname: <value of string>
ddns-password: <value of string>
ddns-server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
ddns-server-ip: <value of string>
ddns-sn: <value of string>
ddns-ttl: <value of integer>
ddns-username: <value of string>
ddns-zone: <value of string>
dedicated-to: <value in [none, management]>
defaultgw: <value in [disable, enable]>
description: <value of string>
detected-peer-mtu: <value of integer>
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <value of string>
device-access-list: <value of string>
device-identification: <value in [disable, enable]>
device-identification-active-scan: <value in [disable, enable]>
device-netscan: <value in [disable, enable]>
device-user-identification: <value in [disable, enable]>
devindex: <value of integer>
dhcp-client-identifier: <value of string>
dhcp-relay-agent-option: <value in [disable, enable]>
dhcp-relay-ip: <value of string>
dhcp-relay-service: <value in [disable, enable]>
dhcp-relay-type: <value in [regular, ipsec]>
dhcp-renew-time: <value of integer>
disc-retry-timeout: <value of integer>
disconnect-threshold: <value of integer>
distance: <value of integer>
dns-query: <value in [disable, recursive, non-recursive]>
dns-server-override: <value in [disable, enable]>
drop-fragment: <value in [disable, enable]>
drop-overlapped-fragment: <value in [disable, enable]>
egress-cos: <value in [disable, cos0, cos1, ...]>
egress-shaping-profile: <value of string>
endpoint-compliance: <value in [disable, enable]>
estimated-downstream-bandwidth: <value of integer>
estimated-upstream-bandwidth: <value of integer>
explicit-ftp-proxy: <value in [disable, enable]>
explicit-web-proxy: <value in [disable, enable]>
external: <value in [disable, enable]>
fail-action-on-extender: <value in [soft-restart, hard-restart, reboot]>
fail-alert-interfaces: <value of string>
fail-alert-method: <value in [link-failed-signal, link-down]>
fail-detect: <value in [disable, enable]>
fail-detect-option:
- detectserver
- link-down
fdp: <value in [disable, enable]>
fortiheartbeat: <value in [disable, enable]>
fortilink: <value in [disable, enable]>
fortilink-backup-link: <value of integer>
fortilink-split-interface: <value in [disable, enable]>
fortilink-stacking: <value in [disable, enable]>
forward-domain: <value of integer>
forward-error-correction: <value in [disable, enable, rs-fec, ...]>
fp-anomaly:
- drop_tcp_fin_noack
- pass_winnuke
- pass_tcpland
- pass_udpland
- pass_icmpland
- pass_ipland
- pass_iprr
- pass_ipssrr
- pass_iplsrr
- pass_ipstream
- pass_ipsecurity
- pass_iptimestamp
- pass_ipunknown_option
- pass_ipunknown_prot
- pass_icmp_frag
- pass_tcp_no_flag
- pass_tcp_fin_noack
- drop_winnuke
- drop_tcpland
- drop_udpland
- drop_icmpland
- drop_ipland
- drop_iprr
- drop_ipssrr
- drop_iplsrr
- drop_ipstream
- drop_ipsecurity
- drop_iptimestamp
- drop_ipunknown_option
- drop_ipunknown_prot
- drop_icmp_frag
- drop_tcp_no_flag
fp-disable:
- all
- ipsec
- none
gateway-address: <value of string>
gi-gk: <value in [disable, enable]>
gwaddr: <value of string>
gwdetect: <value in [disable, enable]>
ha-priority: <value of integer>
icmp-accept-redirect: <value in [disable, enable]>
icmp-redirect: <value in [disable, enable]>
icmp-send-redirect: <value in [disable, enable]>
ident-accept: <value in [disable, enable]>
idle-timeout: <value of integer>
if-mdix: <value in [auto, normal, crossover]>
if-media: <value in [auto, copper, fiber]>
in-force-vlan-cos: <value of integer>
inbandwidth: <value of integer>
ingress-cos: <value in [disable, cos0, cos1, ...]>
ingress-spillover-threshold: <value of integer>
internal: <value of integer>
ip: <value of string>
ipmac: <value in [disable, enable]>
ips-sniffer-mode: <value in [disable, enable]>
ipunnumbered: <value of string>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6-client-options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6-information-request: <value in [disable, enable]>
dhcp6-prefix-delegation: <value in [disable, enable]>
dhcp6-prefix-hint: <value of string>
dhcp6-prefix-hint-plt: <value of integer>
dhcp6-prefix-hint-vlt: <value of integer>
dhcp6-relay-ip: <value of string>
dhcp6-relay-service: <value in [disable, enable]>
dhcp6-relay-type: <value in [regular]>
ip6-address: <value of string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <value of integer>
ip6-dns-server-override: <value in [disable, enable]>
ip6-hop-limit: <value of integer>
ip6-link-mtu: <value of integer>
ip6-manage-flag: <value in [disable, enable]>
ip6-max-interval: <value of integer>
ip6-min-interval: <value of integer>
ip6-mode: <value in [static, dhcp, pppoe, ...]>
ip6-other-flag: <value in [disable, enable]>
ip6-reachable-time: <value of integer>
ip6-retrans-time: <value of integer>
ip6-send-adv: <value in [disable, enable]>
ip6-subnet: <value of string>
ip6-upstream-interface: <value of string>
nd-cert: <value of string>
nd-cga-modifier: <value of string>
nd-mode: <value in [basic, SEND-compatible]>
nd-security-level: <value of integer>
nd-timestamp-delta: <value of integer>
nd-timestamp-fuzz: <value of integer>
vrip6_link_local: <value of string>
vrrp-virtual-mac6: <value in [disable, enable]>
ip6-delegated-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <value of string>
ip6-extra-addr:
-
prefix: <value of string>
ip6-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
dnssl: <value of string>
onlink-flag: <value in [disable, enable]>
preferred-life-time: <value of integer>
prefix: <value of string>
rdnss: <value of string>
valid-life-time: <value of integer>
vrrp6:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <value of string>
interface-identifier: <value of string>
unique-autoconf-addr: <value in [disable, enable]>
icmp6-send-redirect: <value in [disable, enable]>
cli-conn6-status: <value of integer>
ip6-prefix-mode: <value in [dhcp6, ra]>
ra-send-mtu: <value in [disable, enable]>
l2forward: <value in [disable, enable]>
l2tp-client: <value in [disable, enable]>
lacp-ha-slave: <value in [disable, enable]>
lacp-mode: <value in [static, passive, active]>
lacp-speed: <value in [slow, fast]>
lcp-echo-interval: <value of integer>
lcp-max-echo-fails: <value of integer>
link-up-delay: <value of integer>
listen-forticlient-connection: <value in [disable, enable]>
lldp-network-policy: <value of string>
lldp-reception: <value in [disable, enable, vdom]>
lldp-transmission: <value in [enable, disable, vdom]>
log: <value in [disable, enable]>
macaddr: <value of string>
management-ip: <value of string>
max-egress-burst-rate: <value of integer>
max-egress-rate: <value of integer>
mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
member: <value of string>
min-links: <value of integer>
min-links-down: <value in [operational, administrative]>
mode: <value in [static, dhcp, pppoe, ...]>
mtu: <value of integer>
mtu-override: <value in [disable, enable]>
mux-type: <value in [llc-encaps, vc-encaps]>
name: <value of string>
ndiscforward: <value in [disable, enable]>
netbios-forward: <value in [disable, enable]>
netflow-sampler: <value in [disable, tx, rx, ...]>
npu-fastpath: <value in [disable, enable]>
nst: <value in [disable, enable]>
out-force-vlan-cos: <value of integer>
outbandwidth: <value of integer>
padt-retry-timeout: <value of integer>
password: <value of string>
peer-interface: <value of string>
phy-mode: <value in [auto, adsl, vdsl]>
ping-serv-status: <value of integer>
poe: <value in [disable, enable]>
polling-interval: <value of integer>
pppoe-unnumbered-negotiate: <value in [disable, enable]>
pptp-auth-type: <value in [auto, pap, chap, ...]>
pptp-client: <value in [disable, enable]>
pptp-password: <value of string>
pptp-server-ip: <value of string>
pptp-timeout: <value of integer>
pptp-user: <value of string>
preserve-session-route: <value in [disable, enable]>
priority: <value of integer>
priority-override: <value in [disable, enable]>
proxy-captive-portal: <value in [disable, enable]>
redundant-interface: <value of string>
remote-ip: <value of string>
replacemsg-override-group: <value of string>
retransmission: <value in [disable, enable]>
role: <value in [lan, wan, dmz, ...]>
sample-direction: <value in [rx, tx, both]>
sample-rate: <value of integer>
scan-botnet-connections: <value in [disable, block, monitor]>
secondary-IP: <value in [disable, enable]>
secondaryip:
-
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <value of string>
gwdetect: <value in [disable, enable]>
ha-priority: <value of integer>
id: <value of integer>
ip: <value of string>
ping-serv-status: <value of integer>
seq: <value of integer>
security-8021x-dynamic-vlan-id: <value of integer>
security-8021x-master: <value of string>
security-8021x-mode: <value in [default, dynamic-vlan, fallback, ...]>
security-exempt-list: <value of string>
security-external-logout: <value of string>
security-external-web: <value of string>
security-groups: <value of string>
security-mac-auth-bypass: <value in [disable, enable, mac-auth-only]>
security-mode: <value in [none, captive-portal, 802.1X]>
security-redirect-url: <value of string>
service-name: <value of string>
sflow-sampler: <value in [disable, enable]>
speed: <value in [auto, 10full, 10half, ...]>
spillover-threshold: <value of integer>
src-check: <value in [disable, enable]>
status: <value in [down, up]>
stp: <value in [disable, enable]>
stp-ha-slave: <value in [disable, enable, priority-adjust]>
stpforward: <value in [disable, enable]>
stpforward-mode: <value in [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]>
strip-priority-vlan-tag: <value in [disable, enable]>
subst: <value in [disable, enable]>
substitute-dst-mac: <value of string>
switch: <value of string>
switch-controller-access-vlan: <value in [disable, enable]>
switch-controller-arp-inspection: <value in [disable, enable]>
switch-controller-auth: <value in [radius, usergroup]>
switch-controller-dhcp-snooping: <value in [disable, enable]>
switch-controller-dhcp-snooping-option82: <value in [disable, enable]>
switch-controller-dhcp-snooping-verify-mac: <value in [disable, enable]>
switch-controller-igmp-snooping: <value in [disable, enable]>
switch-controller-learning-limit: <value of integer>
switch-controller-radius-server: <value of string>
switch-controller-traffic-policy: <value of string>
tc-mode: <value in [ptm, atm]>
tcp-mss: <value of integer>
trunk: <value in [disable, enable]>
trust-ip-1: <value of string>
trust-ip-2: <value of string>
trust-ip-3: <value of string>
trust-ip6-1: <value of string>
trust-ip6-2: <value of string>
trust-ip6-3: <value of string>
type: <value in [physical, vlan, aggregate, ...]>
username: <value of string>
vci: <value of integer>
vectoring: <value in [disable, enable]>
vindex: <value of integer>
vlanforward: <value in [disable, enable]>
vlanid: <value of integer>
vpi: <value of integer>
vrf: <value of integer>
vrrp:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
ignore-default-route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <value of string>
vrdst-priority: <value of integer>
vrgrp: <value of integer>
vrid: <value of integer>
vrip: <value of string>
vrrp-virtual-mac: <value in [disable, enable]>
wccp: <value in [disable, enable]>
weight: <value of integer>
wifi-5g-threshold: <value of string>
wifi-acl: <value in [deny, allow]>
wifi-ap-band: <value in [any, 5g-preferred, 5g-only]>
wifi-auth: <value in [PSK, RADIUS, radius, ...]>
wifi-auto-connect: <value in [disable, enable]>
wifi-auto-save: <value in [disable, enable]>
wifi-broadcast-ssid: <value in [disable, enable]>
wifi-encrypt: <value in [TKIP, AES]>
wifi-fragment-threshold: <value of integer>
wifi-key: <value of string>
wifi-keyindex: <value of integer>
wifi-mac-filter: <value in [disable, enable]>
wifi-passphrase: <value of string>
wifi-radius-server: <value of string>
wifi-rts-threshold: <value of integer>
wifi-security: <value in [None, WEP64, wep64, ...]>
wifi-ssid: <value of string>
wifi-usergroup: <value of string>
wins-ip: <value of string>
eip: <value of string>
fortilink-neighbor-detect: <value in [lldp, fortilink]>
ingress-shaping-profile: <value of string>
ring-rx: <value of integer>
ring-tx: <value of integer>
switch-controller-igmp-snooping-fast-leave: <value in [disable, enable]>
switch-controller-igmp-snooping-proxy: <value in [disable, enable]>
switch-controller-rspan-mode: <value in [disable, enable]>
bandwidth-measure-time: <value of integer>
ip-managed-by-fortiipam: <value in [disable, enable]>
managed-subnetwork-size: <value in [256, 512, 1024, ...]>
measured-downstream-bandwidth: <value of integer>
measured-upstream-bandwidth: <value of integer>
monitor-bandwidth: <value in [disable, enable]>
swc-vlan: <value of integer>
switch-controller-feature: <value in [none, default-vlan, quarantine, ...]>
switch-controller-mgmt-vlan: <value of integer>
switch-controller-nac: <value of string>
vlan-protocol: <value in [8021q, 8021ad]>
dhcp-relay-interface: <value of string>
dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
np-qos-profile: <value of integer>
swc-first-create: <value of integer>
switch-controller-iot-scanning: <value in [disable, enable]>
switch-controller-source-ip: <value in [outbound, fixed]>
dhcp-relay-request-all-server: <value in [disable, enable]>
stp-ha-secondary: <value in [disable, enable, priority-adjust]>
switch-controller-dynamic: <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_mmsprofile_dupe – Duplicate configuration. fortinet.fortimanager.fmgr\_firewall\_mmsprofile\_dupe – Duplicate 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_mmsprofile_dupe`.
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\_mmsprofile\_dupe** dictionary | | the top level parameters set |
| | **action1** list / elements=string | **Choices:*** log
* archive
* intercept
* block
* archive-first
* alert-notif
| no description |
| | **action2** list / elements=string | **Choices:*** log
* archive
* intercept
* block
* archive-first
* alert-notif
| no description |
| | **action3** list / elements=string | **Choices:*** log
* archive
* intercept
* block
* archive-first
* alert-notif
| no description |
| | **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 | | Protocol. |
| | **status1** string | **Choices:*** disable
* enable
| Enable/disable status1 detection. |
| | **status2** string | **Choices:*** disable
* enable
| Enable/disable status2 detection. |
| | **status3** string | **Choices:*** disable
* enable
| 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). |
| **mms-profile** string / required | | the parameter (mms-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: Duplicate configuration.
fmgr_firewall_mmsprofile_dupe:
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>
mms-profile: <your own value>
firewall_mmsprofile_dupe:
action1:
- log
- archive
- intercept
- block
- archive-first
- alert-notif
action2:
- log
- archive
- intercept
- block
- archive-first
- alert-notif
action3:
- log
- archive
- intercept
- block
- archive-first
- alert-notif
block-time1: <value of integer>
block-time2: <value of integer>
block-time3: <value of integer>
limit1: <value of integer>
limit2: <value of integer>
limit3: <value of integer>
protocol: <value of string>
status1: <value in [disable, enable]>
status2: <value in [disable, enable]>
status3: <value in [disable, enable]>
window1: <value of integer>
window2: <value of integer>
window3: <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_firewall_internetservice_entry – Entries in the Internet Service database. fortinet.fortimanager.fmgr\_firewall\_internetservice\_entry – Entries in the Internet Service 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_internetservice_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\_internetservice\_entry** dictionary | | the top level parameters set |
| | **id** integer | | Entry ID. |
| | **ip-number** integer | | Total number of IP addresses. |
| | **ip-range-number** integer | | Total number of IP ranges. |
| | **port** integer | | no description |
| | **protocol** integer | | Integer value for the protocol type as defined by IANA (0 - 255). |
| **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 in the Internet Service database.
fmgr_firewall_internetservice_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>
state: <value in [present, absent]>
firewall_internetservice_entry:
id: <value of integer>
ip-number: <value of integer>
ip-range-number: <value of integer>
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_switchcontroller_managedswitch_ipsourceguard_bindingentry – IP and MAC address configuration. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_ipsourceguard\_bindingentry – IP and MAC address 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_switchcontroller_managedswitch_ipsourceguard_bindingentry`.
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 |
| **ip-source-guard** string / required | | the parameter (ip-source-guard) in requested url |
| **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\_ipsourceguard\_bindingentry** dictionary | | the top level parameters set |
| | **entry-name** string | | Configure binding pair. |
| | **ip** string | | Source IP for this rule. |
| | **mac** string | | MAC address for this rule. |
| **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: IP and MAC address configuration.
fmgr_switchcontroller_managedswitch_ipsourceguard_bindingentry:
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>
ip-source-guard: <your own value>
state: <value in [present, absent]>
switchcontroller_managedswitch_ipsourceguard_bindingentry:
entry-name: <value of string>
ip: <value of string>
mac: <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_maxheaderline – Maximum number of HTTP header line. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_maxheaderline – Maximum number of HTTP header line.
=========================================================================================================
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_maxheaderline`.
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\_maxheaderline** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **max-header-line** integer | | Maximum number HTTP header lines (0 to 2147483647). |
| | **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: Maximum number of HTTP header line.
fmgr_waf_profile_constraint_maxheaderline:
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_maxheaderline:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-header-line: <value of integer>
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)
| programming_docs |
ansible fortinet.fortimanager.fmgr_webfilter_profile – Configure Web filter profiles. fortinet.fortimanager.fmgr\_webfilter\_profile – Configure Web filter 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_webfilter_profile`.
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 |
| **webfilter\_profile** dictionary | | the top level parameters set |
| | **antiphish** dictionary | | no description |
| | | **authentication** string | **Choices:*** domain-controller
* ldap
| Authentication methods. |
| | | **check-basic-auth** string | **Choices:*** disable
* enable
| Enable/disable checking of HTTP Basic Auth field for known credentials. |
| | | **check-uri** string | **Choices:*** disable
* enable
| Enable/disable checking of GET URI parameters for known credentials. |
| | | **check-username-only** string | **Choices:*** disable
* enable
| Enable/disable acting only on valid username credentials. Action will be taken for valid usernames regardless of passw... |
| | | **custom-patterns** list / elements=string | | no description |
| | | | **category** string | **Choices:*** username
* password
| Category that the pattern matches. |
| | | | **pattern** string | | Target pattern. |
| | | | **type** string | **Choices:*** regex
* literal
| Pattern will be treated either as a regex pattern or literal string. |
| | | **default-action** string | **Choices:*** log
* block
* exempt
| Action to be taken when there is no matching rule. |
| | | **domain-controller** string | | Domain for which to verify received credentials against. |
| | | **inspection-entries** list / elements=string | | no description |
| | | | **action** string | **Choices:*** log
* block
* exempt
| Action to be taken upon an AntiPhishing match. |
| | | | **fortiguard-category** string | | no description |
| | | | **name** string | | Inspection target name. |
| | | **ldap** string | | LDAP server for which to verify received credentials against. |
| | | **max-body-len** integer | | Maximum size of a POST body to check for credentials. |
| | | **status** string | **Choices:*** disable
* enable
| Toggle AntiPhishing functionality. |
| | **comment** string | | Optional comments. |
| | **extended-log** string | **Choices:*** disable
* enable
| Enable/disable extended logging for web filtering. |
| | **feature-set** string | **Choices:*** proxy
* flow
| Flow/proxy feature set. |
| | **ftgd-wf** dictionary | | no description |
| | | **exempt-quota** string | | Do not stop quota for these categories. |
| | | **filters** list / elements=string | | no description |
| | | | **action** string | **Choices:*** block
* monitor
* warning
* authenticate
| Action to take for matches. |
| | | | **auth-usr-grp** string | | Groups with permission to authenticate. |
| | | | **category** string | | Categories and groups the filter examines. |
| | | | **id** integer | | ID number. |
| | | | **log** string | **Choices:*** disable
* enable
| 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** list / elements=string | **Choices:*** error-allow
* http-err-detail
* rate-image-urls
* strict-blocking
* rate-server-ip
* redir-block
* connect-request-bypass
* log-all-url
* ftgd-disable
| no description |
| | | **ovrd** string | | Allow web filter profile overrides. |
| | | **quota** list / elements=string | | no description |
| | | | **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. |
| | | **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
| no description |
| | | **rate-javascript-urls** string | **Choices:*** disable
* enable
| Enable/disable rating JavaScript by URL. |
| | **https-replacemsg** string | **Choices:*** disable
* enable
| Enable replacement messages for HTTPS. |
| | **inspection-mode** string | **Choices:*** proxy
* flow-based
* dns
| Web filtering inspection mode. |
| | **log-all-url** string | **Choices:*** disable
* enable
| Enable/disable logging all URLs visited. |
| | **name** string | | Profile name. |
| | **options** list / elements=string | **Choices:*** block-invalid-url
* jscript
* js
* vbs
* unknown
* wf-referer
* https-scan
* intrinsic
* wf-cookie
* per-user-bwl
* activexfilter
* cookiefilter
* https-url-scan
* javafilter
* rangeblock
* contenttype-check
* per-user-bal
| no description |
| | **override** dictionary | | no description |
| | | **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. |
| | **ovrd-perm** list / elements=string | **Choices:*** bannedword-override
* urlfilter-override
* fortiguard-wf-override
* contenttype-check-override
| no description |
| | **post-action** string | **Choices:*** normal
* comfort
* block
| Action taken for HTTP POST traffic. |
| | **replacemsg-group** string | | Replacement message group. |
| | **url-extraction** dictionary | | no description |
| | | **redirect-header** string | | HTTP header name to use for client redirect on blocked requests |
| | | **redirect-no-content** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable URL Extraction |
| | **web** dictionary | | no description |
| | | **allowlist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| no description |
| | | **blacklist** string | **Choices:*** disable
* enable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blacklist. |
| | | **blocklist** string | **Choices:*** disable
* enable
| Enable/disable automatic addition of URLs detected by FortiSandbox to blocklist. |
| | | **bword-table** string | | Banned word table ID. |
| | | **bword-threshold** integer | | Banned word score threshold. |
| | | **content-header-list** string | | Content header list. |
| | | **keyword-match** string | | no description |
| | | **log-search** string | **Choices:*** disable
* enable
| Enable/disable logging all search phrases. |
| | | **safe-search** list / elements=string | **Choices:*** google
* yahoo
* bing
* url
* header
| no description |
| | | **urlfilter-table** string | | URL filter table ID. |
| | | **whitelist** list / elements=string | **Choices:*** exempt-av
* exempt-webcontent
* exempt-activex-java-cookie
* exempt-dlp
* exempt-rangeblock
* extended-log-others
| no description |
| | | **youtube-restrict** string | **Choices:*** strict
* none
* moderate
| YouTube EDU filter level. |
| | **web-antiphishing-log** string | **Choices:*** disable
* enable
| Enable/disable logging of AntiPhishing checks. |
| | **web-content-log** string | **Choices:*** disable
* enable
| Enable/disable logging logging blocked web content. |
| | **web-extended-all-action-log** string | **Choices:*** disable
* enable
| Enable/disable extended any filter action logging for web filtering. |
| | **web-filter-activex-log** string | **Choices:*** disable
* enable
| Enable/disable logging ActiveX. |
| | **web-filter-applet-log** string | **Choices:*** disable
* enable
| Enable/disable logging Java applets. |
| | **web-filter-command-block-log** string | **Choices:*** disable
* enable
| Enable/disable logging blocked commands. |
| | **web-filter-cookie-log** string | **Choices:*** disable
* enable
| Enable/disable logging cookie filtering. |
| | **web-filter-cookie-removal-log** string | **Choices:*** disable
* enable
| Enable/disable logging blocked cookies. |
| | **web-filter-js-log** string | **Choices:*** disable
* enable
| Enable/disable logging Java scripts. |
| | **web-filter-jscript-log** string | **Choices:*** disable
* enable
| Enable/disable logging JScripts. |
| | **web-filter-referer-log** string | **Choices:*** disable
* enable
| Enable/disable logging referrers. |
| | **web-filter-unknown-log** string | **Choices:*** disable
* enable
| Enable/disable logging unknown scripts. |
| | **web-filter-vbs-log** string | **Choices:*** disable
* enable
| Enable/disable logging VBS scripts. |
| | **web-ftgd-err-log** string | **Choices:*** disable
* enable
| Enable/disable logging rating errors. |
| | **web-ftgd-quota-usage** string | **Choices:*** disable
* enable
| Enable/disable logging daily quota usage. |
| | **web-invalid-domain-log** string | **Choices:*** disable
* enable
| Enable/disable logging invalid domain names. |
| | **web-url-log** string | **Choices:*** disable
* enable
| Enable/disable logging URL filtering. |
| | **wisp** string | **Choices:*** disable
* enable
| Enable/disable web proxy WISP. |
| | **wisp-algorithm** string | **Choices:*** auto-learning
* primary-secondary
* round-robin
| WISP server selection algorithm. |
| | **wisp-servers** string | | WISP servers. |
| | **youtube-channel-filter** list / elements=string | | no description |
| | | **channel-id** string | | YouTube channel ID to be filtered. |
| | | **comment** string | | Comment. |
| | | **id** integer | | ID. |
| | **youtube-channel-status** string | **Choices:*** disable
* blacklist
* whitelist
| YouTube channel filter status. |
| **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 Web filter profiles.
fmgr_webfilter_profile:
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]>
webfilter_profile:
comment: <value of string>
extended-log: <value in [disable, enable]>
https-replacemsg: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow-based, dns]>
log-all-url: <value in [disable, enable]>
name: <value of string>
options:
- block-invalid-url
- jscript
- js
- vbs
- unknown
- wf-referer
- https-scan
- intrinsic
- wf-cookie
- per-user-bwl
- activexfilter
- cookiefilter
- https-url-scan
- javafilter
- rangeblock
- contenttype-check
- per-user-bal
ovrd-perm:
- bannedword-override
- urlfilter-override
- fortiguard-wf-override
- contenttype-check-override
post-action: <value in [normal, comfort, block]>
replacemsg-group: <value of string>
web-content-log: <value in [disable, enable]>
web-extended-all-action-log: <value in [disable, enable]>
web-filter-activex-log: <value in [disable, enable]>
web-filter-applet-log: <value in [disable, enable]>
web-filter-command-block-log: <value in [disable, enable]>
web-filter-cookie-log: <value in [disable, enable]>
web-filter-cookie-removal-log: <value in [disable, enable]>
web-filter-js-log: <value in [disable, enable]>
web-filter-jscript-log: <value in [disable, enable]>
web-filter-referer-log: <value in [disable, enable]>
web-filter-unknown-log: <value in [disable, enable]>
web-filter-vbs-log: <value in [disable, enable]>
web-ftgd-err-log: <value in [disable, enable]>
web-ftgd-quota-usage: <value in [disable, enable]>
web-invalid-domain-log: <value in [disable, enable]>
web-url-log: <value in [disable, enable]>
wisp: <value in [disable, enable]>
wisp-algorithm: <value in [auto-learning, primary-secondary, round-robin]>
wisp-servers: <value of string>
youtube-channel-filter:
-
channel-id: <value of string>
comment: <value of string>
id: <value of integer>
youtube-channel-status: <value in [disable, blacklist, whitelist]>
feature-set: <value in [proxy, flow]>
web-antiphishing-log: <value in [disable, enable]>
antiphish:
check-basic-auth: <value in [disable, enable]>
check-uri: <value in [disable, enable]>
check-username-only: <value in [disable, enable]>
custom-patterns:
-
category: <value in [username, password]>
pattern: <value of string>
type: <value in [regex, literal]>
default-action: <value in [log, block, exempt]>
domain-controller: <value of string>
inspection-entries:
-
action: <value in [log, block, exempt]>
fortiguard-category: <value of string>
name: <value of string>
max-body-len: <value of integer>
status: <value in [disable, enable]>
authentication: <value in [domain-controller, ldap]>
ldap: <value of string>
ftgd-wf:
exempt-quota: <value of string>
filters:
-
action: <value in [block, monitor, warning, ...]>
auth-usr-grp: <value of string>
category: <value of string>
id: <value of integer>
log: <value in [disable, enable]>
override-replacemsg: <value of string>
warn-duration: <value of string>
warning-duration-type: <value in [session, timeout]>
warning-prompt: <value in [per-domain, per-category]>
max-quota-timeout: <value of integer>
options:
- error-allow
- http-err-detail
- rate-image-urls
- strict-blocking
- rate-server-ip
- redir-block
- connect-request-bypass
- log-all-url
- ftgd-disable
ovrd: <value of string>
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>
rate-crl-urls: <value in [disable, enable]>
rate-css-urls: <value in [disable, enable]>
rate-image-urls: <value in [disable, enable]>
rate-javascript-urls: <value in [disable, enable]>
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]>
url-extraction:
redirect-header: <value of string>
redirect-no-content: <value in [disable, enable]>
redirect-url: <value of string>
server-fqdn: <value of string>
status: <value in [disable, enable]>
web:
blacklist: <value in [disable, enable]>
bword-table: <value of string>
bword-threshold: <value of integer>
content-header-list: <value of string>
keyword-match: <value of string>
log-search: <value in [disable, enable]>
safe-search:
- google
- yahoo
- bing
- url
- header
urlfilter-table: <value of string>
whitelist:
- exempt-av
- exempt-webcontent
- exempt-activex-java-cookie
- exempt-dlp
- exempt-rangeblock
- extended-log-others
youtube-restrict: <value in [strict, none, moderate]>
allowlist:
- exempt-av
- exempt-webcontent
- exempt-activex-java-cookie
- exempt-dlp
- exempt-rangeblock
- extended-log-others
blocklist: <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_setting – Report settings. fortinet.fortimanager.fmgr\_system\_report\_setting – Report 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_report_setting`.
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\_report\_setting** dictionary | | the top level parameters set |
| | **aggregate-report** string | **Choices:*** **disable** ←
* enable
| Enable/disable including a group report along with the per-device reports. disable - Exclude a group report along with the per-device reports. enable - Include a group report along with the per-device reports. |
| | **capwap-port** integer | **Default:**5246 | Exclude capwap traffic by port. |
| | **capwap-service** string | | Exclude capwap traffic by service. |
| | **exclude-capwap** string | **Choices:*** disable
* **by-port** ←
* by-service
| Exclude capwap traffic. disable - Disable. by-port - By port. by-service - By service. |
| | **hcache-lossless** string | **Choices:*** **disable** ←
* enable
| Usableness of ready-with-loss hcaches. disable - Use ready-with-loss hcaches. enable - Do not use ready-with-loss hcaches. |
| | **ldap-cache-timeout** integer | **Default:**60 | LDAP cache timeout in minutes, default 60, 0 means not use cache. |
| | **max-table-rows** integer | **Default:**10000 | Maximum number of rows can be generated in a single table. |
| | **report-priority** string | **Choices:*** high
* low
* **auto** ←
| Priority of sql report. high - High low - Low auto - Auto |
| | **template-auto-install** string | **Choices:*** **default** ←
* english
| The language used for new ADOMs (default = default). default - Default. english - English. |
| | **week-start** string | **Choices:*** **sun** ←
* mon
| Day of the week on which the week starts. sun - Sunday. mon - Monday. |
| **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: Report settings.
fmgr_system_report_setting:
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_report_setting:
aggregate-report: <value in [disable, enable]>
hcache-lossless: <value in [disable, enable]>
ldap-cache-timeout: <value of integer>
max-table-rows: <value of integer>
report-priority: <value in [high, low, auto]>
template-auto-install: <value in [default, english]>
week-start: <value in [sun, mon]>
capwap-port: <value of integer>
capwap-service: <value of string>
exclude-capwap: <value in [disable, by-port, by-service]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **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_smtp – Configure SMTP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_smtp – Configure SMTP 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_smtp`.
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\_smtp** dictionary | | the top level parameters set |
| | **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). |
| **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: Configure SMTP protocol options.
fmgr_firewall_profileprotocoloptions_smtp:
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>
firewall_profileprotocoloptions_smtp:
inspect-all: <value in [disable, enable]>
options:
- oversize
- fragmail
- no-content-summary
- splice
oversize-limit: <value of integer>
ports: <value of integer>
scan-bzip2: <value in [disable, enable]>
server-busy: <value in [disable, enable]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
ssl-offloaded: <value in [no, yes]>
proxy-after-tcp-handshake: <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_wanprof_system_virtualwanlink_healthcheck_sla – Service level agreement fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_healthcheck\_sla – Service level agreement
=======================================================================================================
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_healthcheck_sla`.
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 |
| **health-check** string / required | | the parameter (health-check) 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 |
| **wanprof** string / required | | the parameter (wanprof) in requested url |
| **wanprof\_system\_virtualwanlink\_healthcheck\_sla** dictionary | | the top level parameters set |
| | **id** integer | | SLA ID. |
| | **jitter-threshold** integer | | Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | **latency-threshold** integer | | Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5). |
| | **link-cost-factor** list / elements=string | **Choices:*** latency
* jitter
* packet-loss
| no description |
| | **packetloss-threshold** integer | | Packet loss for SLA to make decision in percentage. (0 - 100, default = 0). |
| **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: Service level agreement
fmgr_wanprof_system_virtualwanlink_healthcheck_sla:
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>
health-check: <your own value>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_healthcheck_sla:
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
packetloss-threshold: <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_system_certificate_local – Local keys and certificates. fortinet.fortimanager.fmgr\_system\_certificate\_local – Local keys and certificates.
=====================================================================================
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_certificate_local`.
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\_certificate\_local** dictionary | | the top level parameters set |
| | **certificate** string | | no description |
| | **comment** string | | Local certificate comment. |
| | **csr** string | | no description |
| | **name** string | | Name of local certificate. |
| | **password** string | | no description |
| | **private-key** 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: Local keys and certificates.
fmgr_system_certificate_local:
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_certificate_local:
certificate: <value of string>
comment: <value of string>
csr: <value of string>
name: <value of string>
password: <value of string>
private-key: <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_dvmdb_group – Device group table. fortinet.fortimanager.fmgr\_dvmdb\_group – Device group table.
==============================================================
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_group`.
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\_group** dictionary | | the top level parameters set |
| | **desc** string | | no description |
| | **meta fields** dictionary | | no description |
| | **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 |
| | **type** string | **Choices:*** **normal** ←
* default
* auto
| no description |
| **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: Device group table.
fmgr_dvmdb_group:
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]>
dvmdb_group:
desc: <value of string>
meta fields: <value of dict>
name: <value of string>
os_type: <value in [unknown, fos, fsw, ...]>
type: <value in [normal, default, auto]>
```
Return Values
-------------
Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module:
| Key | Returned | Description |
| --- | --- | --- |
| **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_utmprofile – Configure UTM fortinet.fortimanager.fmgr\_utmprofile – Configure UTM
======================================================
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_utmprofile`.
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 |
| **utmprofile** dictionary | | the top level parameters set |
| | **antivirus-profile** string | | AntiVirus profile name. |
| | **application-list** string | | Application control list name. |
| | **comment** string | | Comment. |
| | **ips-sensor** string | | IPS sensor name. |
| | **name** string | | UTM profile name. |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| Block or monitor connections to Botnet servers or disable Botnet scanning. |
| | **utm-log** string | **Choices:*** disable
* enable
| Enable/disable UTM logging. |
| | **webfilter-profile** string | | WebFilter profile 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 UTM
fmgr_utmprofile:
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]>
utmprofile:
antivirus-profile: <value of string>
application-list: <value of string>
comment: <value of string>
ips-sensor: <value of string>
name: <value of string>
scan-botnet-connections: <value in [disable, block, monitor]>
utm-log: <value in [disable, enable]>
webfilter-profile: <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_routetable_route – Configure Azure route. fortinet.fortimanager.fmgr\_system\_sdnconnector\_routetable\_route – Configure Azure route.
============================================================================================
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_routetable_route`.
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 |
| **route-table** string / required | | the parameter (route-table) in requested url |
| **sdn-connector** string / required | | the parameter (sdn-connector) in requested url |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_sdnconnector\_routetable\_route** dictionary | | the top level parameters set |
| | **name** string | | Route name. |
| | **next-hop** string | | Next hop address. |
| **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 Azure route.
fmgr_system_sdnconnector_routetable_route:
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>
sdn-connector: <your own value>
route-table: <your own value>
state: <value in [present, absent]>
system_sdnconnector_routetable_route:
name: <value of string>
next-hop: <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_fmupdate_fdssetting_serveroverride – Server override configure. fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_serveroverride – Server override configure.
=============================================================================================
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_serveroverride`.
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\_serveroverride** dictionary | | the top level parameters set |
| | **servlist** list / elements=string | | no description |
| | | **id** integer | **Default:**0 | Override server ID (1 - 10). |
| | | **ip** string | **Default:**"0.0.0.0" | IPv4 address of the override server. |
| | | **ip6** string | **Default:**"::" | IPv6 address of the override server. |
| | | **port** integer | **Default:**443 | Port number to use when contacting FortiGuard (1 - 65535, default = 443). |
| | | **service-type** list / elements=string | **Choices:*** fds
* fct
| no description |
| | **status** string | **Choices:*** **disable** ←
* enable
| Override status. 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: Server override configure.
fmgr_fmupdate_fdssetting_serveroverride:
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_serveroverride:
servlist:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
port: <value of integer>
service-type:
- fds
- fct
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_securityconsole_install_package – Copy and install a policy package to devices. fortinet.fortimanager.fmgr\_securityconsole\_install\_package – Copy and install a policy package to 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_securityconsole_install_package`.
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 |
| **securityconsole\_install\_package** dictionary | | the top level parameters set |
| | **adom** string | | Source ADOM name. |
| | **adom\_rev\_comments** string | | If "generate\_rev" flag is set, the comment for the new ADOM revision. |
| | **adom\_rev\_name** string | | If "generate\_rev" flag is set, the name for the new ADOM revision. |
| | **dev\_rev\_comments** string | | Comments for the device configuration revision that will be generated during install. |
| | **flags** list / elements=string | **Choices:*** none
* cp\_all\_objs
* preview
* generate\_rev
* copy\_assigned\_pkg
* unassign
* ifpolicy\_only
* no\_ifpolicy
* objs\_only
* auto\_lock\_ws
* check\_pkg\_st
* copy\_only
| no description |
| | **pkg** string | | Source package path and name. |
| | **scope** list / elements=string | | no description |
| | | **name** string | | no description |
| | | **vdom** 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: Copy and install a policy package to devices.
fmgr_securityconsole_install_package:
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, ...]
securityconsole_install_package:
adom: <value of string>
adom_rev_comments: <value of string>
adom_rev_name: <value of string>
dev_rev_comments: <value of string>
flags:
- none
- cp_all_objs
- preview
- generate_rev
- copy_assigned_pkg
- unassign
- ifpolicy_only
- no_ifpolicy
- objs_only
- auto_lock_ws
- check_pkg_st
- copy_only
pkg: <value of string>
scope:
-
name: <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_icap_profile_respmodforwardrules_headergroup – HTTP header group. fortinet.fortimanager.fmgr\_icap\_profile\_respmodforwardrules\_headergroup – HTTP header 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_icap_profile_respmodforwardrules_headergroup`.
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\_respmodforwardrules\_headergroup** dictionary | | the top level parameters set |
| | **case-sensitivity** string | **Choices:*** disable
* enable
| Enable/disable case sensitivity when matching header. |
| | **header** string | | HTTP header regular expression. |
| | **header-name** string | | HTTP header. |
| | **id** integer | | ID. |
| **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 |
| **respmod-forward-rules** string / required | | the parameter (respmod-forward-rules) in requested url |
| **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: HTTP header group.
fmgr_icap_profile_respmodforwardrules_headergroup:
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>
respmod-forward-rules: <your own value>
state: <value in [present, absent]>
icap_profile_respmodforwardrules_headergroup:
case-sensitivity: <value in [disable, enable]>
header: <value of string>
header-name: <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_dvmdb_workflow_save – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_save – 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_save`.
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_save:
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_apcfgprofile_commandlist – AP local configuration command list. fortinet.fortimanager.fmgr\_apcfgprofile\_commandlist – AP local configuration command 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_apcfgprofile_commandlist`.
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 |
| **apcfg-profile** string / required | | the parameter (apcfg-profile) in requested url |
| **apcfgprofile\_commandlist** dictionary | | the top level parameters set |
| | **id** integer | | Command ID. |
| | **name** string | | AP local configuration command name. |
| | **passwd-value** string | | no description |
| | **type** string | **Choices:*** non-password
* password
| The command type (default = non-password). |
| | **value** string | | AP local configuration command value. |
| **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 |
| **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: AP local configuration command list.
fmgr_apcfgprofile_commandlist:
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>
apcfg-profile: <your own value>
state: <value in [present, absent]>
apcfgprofile_commandlist:
id: <value of integer>
name: <value of string>
passwd-value: <value of string>
type: <value in [non-password, password]>
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)
ansible fortinet.fortimanager.fmgr_waf_profile_constraint_maxrangesegment – Maximum number of range segments in HTTP range line. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_maxrangesegment – Maximum number of range segments in HTTP range line.
============================================================================================================================
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_maxrangesegment`.
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\_maxrangesegment** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** allow
* block
| Action. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| | **max-range-segment** integer | | Maximum number of range segments in HTTP range line (0 to 2147483647). |
| | **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: Maximum number of range segments in HTTP range line.
fmgr_waf_profile_constraint_maxrangesegment:
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_maxrangesegment:
action: <value in [allow, block]>
log: <value in [disable, enable]>
max-range-segment: <value of integer>
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_spamfilter_dnsbl – Configure AntiSpam DNSBL/ORBL. fortinet.fortimanager.fmgr\_spamfilter\_dnsbl – Configure AntiSpam DNSBL/ORBL.
==============================================================================
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`.
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 |
| **spamfilter\_dnsbl** dictionary | | the top level parameters set |
| | **comment** string | | Optional comments. |
| | **entries** list / elements=string | | no description |
| | | **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. |
| | **id** integer | | ID. |
| | **name** string | | Name of table. |
| **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 DNSBL/ORBL.
fmgr_spamfilter_dnsbl:
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]>
spamfilter_dnsbl:
comment: <value of string>
entries:
-
action: <value in [spam, reject]>
id: <value of integer>
server: <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_webfilter_profile_antiphish – AntiPhishing profile. fortinet.fortimanager.fmgr\_webfilter\_profile\_antiphish – AntiPhishing profile.
=================================================================================
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_antiphish`.
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\_antiphish** dictionary | | the top level parameters set |
| | **authentication** string | **Choices:*** domain-controller
* ldap
| Authentication methods. |
| | **check-basic-auth** string | **Choices:*** disable
* enable
| Enable/disable checking of HTTP Basic Auth field for known credentials. |
| | **check-uri** string | **Choices:*** disable
* enable
| Enable/disable checking of GET URI parameters for known credentials. |
| | **check-username-only** string | **Choices:*** disable
* enable
| Enable/disable acting only on valid username credentials. Action will be taken for valid usernames regardless of password vali... |
| | **custom-patterns** list / elements=string | | no description |
| | | **category** string | **Choices:*** username
* password
| Category that the pattern matches. |
| | | **pattern** string | | Target pattern. |
| | | **type** string | **Choices:*** regex
* literal
| Pattern will be treated either as a regex pattern or literal string. |
| | **default-action** string | **Choices:*** log
* block
* exempt
| Action to be taken when there is no matching rule. |
| | **domain-controller** string | | Domain for which to verify received credentials against. |
| | **inspection-entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** log
* block
* exempt
| Action to be taken upon an AntiPhishing match. |
| | | **fortiguard-category** string | | no description |
| | | **name** string | | Inspection target name. |
| | **ldap** string | | LDAP server for which to verify received credentials against. |
| | **max-body-len** integer | | Maximum size of a POST body to check for credentials. |
| | **status** string | **Choices:*** disable
* enable
| Toggle AntiPhishing functionality. |
| **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: AntiPhishing profile.
fmgr_webfilter_profile_antiphish:
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_antiphish:
check-basic-auth: <value in [disable, enable]>
check-uri: <value in [disable, enable]>
custom-patterns:
-
category: <value in [username, password]>
pattern: <value of string>
type: <value in [regex, literal]>
default-action: <value in [log, block, exempt]>
domain-controller: <value of string>
inspection-entries:
-
action: <value in [log, block, exempt]>
fortiguard-category: <value of string>
name: <value of string>
max-body-len: <value of integer>
status: <value in [disable, enable]>
check-username-only: <value in [disable, enable]>
authentication: <value in [domain-controller, ldap]>
ldap: <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_internetservicecustom_disableentry_iprange – IP ranges in the disable entry. fortinet.fortimanager.fmgr\_firewall\_internetservicecustom\_disableentry\_iprange – IP ranges in the disable 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_internetservicecustom_disableentry_iprange`.
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 |
| **disable-entry** string / required | | the parameter (disable-entry) in requested url |
| **enable\_log** boolean | **Choices:*** **no** ←
* yes
| Enable/Disable logging for task |
| **firewall\_internetservicecustom\_disableentry\_iprange** dictionary | | the top level parameters set |
| | **end-ip** string | | End IP address. |
| | **id** integer | | Disable entry range ID. |
| | **start-ip** string | | Start IP address. |
| **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: IP ranges in the disable entry.
fmgr_firewall_internetservicecustom_disableentry_iprange:
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>
disable-entry: <your own value>
state: <value in [present, absent]>
firewall_internetservicecustom_disableentry_iprange:
end-ip: <value of string>
id: <value of integer>
start-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_vpn_ssl_settings – Configure SSL VPN. fortinet.fortimanager.fmgr\_vpn\_ssl\_settings – Configure SSL VPN.
===================================================================
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_vpn_ssl_settings`.
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 |
| **device** string / required | | the parameter (device) 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 |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **vdom** string / required | | the parameter (vdom) in requested url |
| **vpn\_ssl\_settings** dictionary | | the top level parameters set |
| | **algorithm** string | **Choices:*** default
* high
* low
* medium
| Force the SSL VPN security level. High allows only high. Medium allows medium and high. Low allows any. |
| | **auth-session-check-source-ip** string | **Choices:*** disable
* enable
| Enable/disable checking of source IP for authentication session. |
| | **auth-timeout** integer | | SSL VPN authentication timeout (1 - 259200 sec (3 days), 0 for no timeout). |
| | **authentication-rule** list / elements=string | | no description |
| | | **auth** string | **Choices:*** any
* local
* radius
* ldap
* tacacs+
| SSL VPN authentication method restriction. |
| | | **cipher** string | **Choices:*** any
* high
* medium
| SSL VPN cipher strength. |
| | | **client-cert** string | **Choices:*** disable
* enable
| Enable/disable SSL VPN client certificate restrictive. |
| | | **groups** string | | User groups. |
| | | **id** integer | | ID (0 - 4294967295). |
| | | **portal** string | | SSL VPN portal. |
| | | **realm** string | | SSL VPN realm. |
| | | **source-address** string | | Source address of incoming traffic. |
| | | **source-address-negate** string | **Choices:*** disable
* enable
| Enable/disable negated source address match. |
| | | **source-address6** string | | IPv6 source address of incoming traffic. |
| | | **source-address6-negate** string | **Choices:*** disable
* enable
| Enable/disable negated source IPv6 address match. |
| | | **source-interface** string | | SSL VPN source interface of incoming traffic. |
| | | **user-peer** string | | Name of user peer. |
| | | **users** string | | User name. |
| | **auto-tunnel-static-route** string | **Choices:*** disable
* enable
| Enable/disable to auto-create static routes for the SSL VPN tunnel IP addresses. |
| | **banned-cipher** list / elements=string | **Choices:*** RSA
* DH
* DHE
* ECDH
* ECDHE
* DSS
* ECDSA
* AES
* AESGCM
* CAMELLIA
* 3DES
* SHA1
* SHA256
* SHA384
* STATIC
| no description |
| | **check-referer** string | **Choices:*** disable
* enable
| Enable/disable verification of referer field in HTTP request header. |
| | **default-portal** string | | Default SSL VPN portal. |
| | **deflate-compression-level** integer | | Compression level (0~9). |
| | **deflate-min-data-size** integer | | Minimum amount of data that triggers compression (200 - 65535 bytes). |
| | **dns-server1** string | | DNS server 1. |
| | **dns-server2** string | | DNS server 2. |
| | **dns-suffix** string | | DNS suffix used for SSL VPN clients. |
| | **dtls-hello-timeout** integer | | SSLVPN maximum DTLS hello timeout (10 - 60 sec, default = 10). |
| | **dtls-max-proto-ver** string | **Choices:*** dtls1-0
* dtls1-2
| DTLS maximum protocol version. |
| | **dtls-min-proto-ver** string | **Choices:*** dtls1-0
* dtls1-2
| DTLS minimum protocol version. |
| | **dtls-tunnel** string | **Choices:*** disable
* enable
| Enable/disable DTLS to prevent eavesdropping, tampering, or message forgery. |
| | **encode-2f-sequence** string | **Choices:*** disable
* enable
| Encode 2F sequence to forward slash in URLs. |
| | **encrypt-and-store-password** string | **Choices:*** disable
* enable
| Encrypt and store user passwords for SSL VPN web sessions. |
| | **force-two-factor-auth** string | **Choices:*** disable
* enable
| Enable/disable only PKI users with two-factor authentication for SSL VPNs. |
| | **header-x-forwarded-for** string | **Choices:*** pass
* add
* remove
| Forward the same, add, or remove HTTP header. |
| | **hsts-include-subdomains** string | **Choices:*** disable
* enable
| Add HSTS includeSubDomains response header. |
| | **http-compression** string | **Choices:*** disable
* enable
| Enable/disable to allow HTTP compression over SSL VPN tunnels. |
| | **http-only-cookie** string | **Choices:*** disable
* enable
| Enable/disable SSL VPN support for HttpOnly cookies. |
| | **http-request-body-timeout** integer | | SSL VPN session is disconnected if an HTTP request body is not received within this time (1 - 60 sec, default = 20). |
| | **http-request-header-timeout** integer | | SSL VPN session is disconnected if an HTTP request header is not received within this time (1 - 60 sec, default = 20). |
| | **https-redirect** string | **Choices:*** disable
* enable
| Enable/disable redirect of port 80 to SSL VPN port. |
| | **idle-timeout** integer | | SSL VPN disconnects if idle for specified time in seconds. |
| | **ipv6-dns-server1** string | | IPv6 DNS server 1. |
| | **ipv6-dns-server2** string | | IPv6 DNS server 2. |
| | **ipv6-wins-server1** string | | IPv6 WINS server 1. |
| | **ipv6-wins-server2** string | | IPv6 WINS server 2. |
| | **login-attempt-limit** integer | | SSL VPN maximum login attempt times before block (0 - 10, default = 2, 0 = no limit). |
| | **login-block-time** integer | | Time for which a user is blocked from logging in after too many failed login attempts (0 - 86400 sec, default = 60). |
| | **login-timeout** integer | | SSLVPN maximum login timeout (10 - 180 sec, default = 30). |
| | **port** integer | | SSL VPN access port (1 - 65535). |
| | **port-precedence** string | **Choices:*** disable
* enable
| Enable/disable, Enable means that if SSL VPN connections are allowed on an interface admin GUI connections are blocked on that... |
| | **reqclientcert** string | **Choices:*** disable
* enable
| Enable/disable to require client certificates for all SSL VPN users. |
| | **route-source-interface** string | **Choices:*** disable
* enable
| Enable/disable to allow SSL VPN sessions to bypass routing and bind to the incoming interface. |
| | **servercert** string | | Name of the server certificate to be used for SSL VPNs. |
| | **source-address** string | | Source address of incoming traffic. |
| | **source-address-negate** string | **Choices:*** disable
* enable
| Enable/disable negated source address match. |
| | **source-address6** string | | IPv6 source address of incoming traffic. |
| | **source-address6-negate** string | **Choices:*** disable
* enable
| Enable/disable negated source IPv6 address match. |
| | **source-interface** string | | SSL VPN source interface of incoming traffic. |
| | **ssl-client-renegotiation** string | **Choices:*** disable
* enable
| Enable/disable to allow client renegotiation by the server if the tunnel goes down. |
| | **ssl-insert-empty-fragment** string | **Choices:*** disable
* enable
| Enable/disable insertion of empty fragment. |
| | **ssl-max-proto-ver** string | **Choices:*** tls1-0
* tls1-1
* tls1-2
* tls1-3
| SSL maximum protocol version. |
| | **ssl-min-proto-ver** string | **Choices:*** tls1-0
* tls1-1
* tls1-2
* tls1-3
| SSL minimum protocol version. |
| | **tlsv1-0** string | **Choices:*** disable
* enable
| no description |
| | **tlsv1-1** string | **Choices:*** disable
* enable
| no description |
| | **tlsv1-2** string | **Choices:*** disable
* enable
| no description |
| | **tlsv1-3** string | **Choices:*** disable
* enable
| no description |
| | **transform-backward-slashes** string | **Choices:*** disable
* enable
| Transform backward slashes to forward slashes in URLs. |
| | **tunnel-connect-without-reauth** string | **Choices:*** disable
* enable
| Enable/disable tunnel connection without re-authorization if previous connection dropped. |
| | **tunnel-ip-pools** string | | Names of the IPv4 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
| | **tunnel-ipv6-pools** string | | Names of the IPv6 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
| | **tunnel-user-session-timeout** integer | | Time out value to clean up user session after tunnel connection is dropped (1 - 255 sec, default=30). |
| | **unsafe-legacy-renegotiation** string | **Choices:*** disable
* enable
| Enable/disable unsafe legacy re-negotiation. |
| | **url-obscuration** string | **Choices:*** disable
* enable
| Enable/disable to obscure the host name of the URL of the web browser display. |
| | **user-peer** string | | Name of user peer. |
| | **wins-server1** string | | WINS server 1. |
| | **wins-server2** string | | WINS server 2. |
| | **x-content-type-options** string | **Choices:*** disable
* enable
| Add HTTP X-Content-Type-Options header. |
| **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 SSL VPN.
fmgr_vpn_ssl_settings:
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, ...]
device: <your own value>
vdom: <your own value>
vpn_ssl_settings:
algorithm: <value in [default, high, low, ...]>
auth-session-check-source-ip: <value in [disable, enable]>
auth-timeout: <value of integer>
authentication-rule:
-
auth: <value in [any, local, radius, ...]>
cipher: <value in [any, high, medium]>
client-cert: <value in [disable, enable]>
groups: <value of string>
id: <value of integer>
portal: <value of string>
realm: <value of string>
source-address: <value of string>
source-address-negate: <value in [disable, enable]>
source-address6: <value of string>
source-address6-negate: <value in [disable, enable]>
source-interface: <value of string>
user-peer: <value of string>
users: <value of string>
auto-tunnel-static-route: <value in [disable, enable]>
banned-cipher:
- RSA
- DH
- DHE
- ECDH
- ECDHE
- DSS
- ECDSA
- AES
- AESGCM
- CAMELLIA
- 3DES
- SHA1
- SHA256
- SHA384
- STATIC
check-referer: <value in [disable, enable]>
default-portal: <value of string>
deflate-compression-level: <value of integer>
deflate-min-data-size: <value of integer>
dns-server1: <value of string>
dns-server2: <value of string>
dns-suffix: <value of string>
dtls-hello-timeout: <value of integer>
dtls-max-proto-ver: <value in [dtls1-0, dtls1-2]>
dtls-min-proto-ver: <value in [dtls1-0, dtls1-2]>
dtls-tunnel: <value in [disable, enable]>
encode-2f-sequence: <value in [disable, enable]>
encrypt-and-store-password: <value in [disable, enable]>
force-two-factor-auth: <value in [disable, enable]>
header-x-forwarded-for: <value in [pass, add, remove]>
hsts-include-subdomains: <value in [disable, enable]>
http-compression: <value in [disable, enable]>
http-only-cookie: <value in [disable, enable]>
http-request-body-timeout: <value of integer>
http-request-header-timeout: <value of integer>
https-redirect: <value in [disable, enable]>
idle-timeout: <value of integer>
ipv6-dns-server1: <value of string>
ipv6-dns-server2: <value of string>
ipv6-wins-server1: <value of string>
ipv6-wins-server2: <value of string>
login-attempt-limit: <value of integer>
login-block-time: <value of integer>
login-timeout: <value of integer>
port: <value of integer>
port-precedence: <value in [disable, enable]>
reqclientcert: <value in [disable, enable]>
route-source-interface: <value in [disable, enable]>
servercert: <value of string>
source-address: <value of string>
source-address-negate: <value in [disable, enable]>
source-address6: <value of string>
source-address6-negate: <value in [disable, enable]>
source-interface: <value of string>
ssl-client-renegotiation: <value in [disable, enable]>
ssl-insert-empty-fragment: <value in [disable, enable]>
ssl-max-proto-ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
ssl-min-proto-ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
tlsv1-0: <value in [disable, enable]>
tlsv1-1: <value in [disable, enable]>
tlsv1-2: <value in [disable, enable]>
tlsv1-3: <value in [disable, enable]>
transform-backward-slashes: <value in [disable, enable]>
tunnel-connect-without-reauth: <value in [disable, enable]>
tunnel-ip-pools: <value of string>
tunnel-ipv6-pools: <value of string>
tunnel-user-session-timeout: <value of integer>
unsafe-legacy-renegotiation: <value in [disable, enable]>
url-obscuration: <value in [disable, enable]>
user-peer: <value of string>
wins-server1: <value of string>
wins-server2: <value of string>
x-content-type-options: <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_ips_sensor – Configure IPS sensor. fortinet.fortimanager.fmgr\_ips\_sensor – Configure IPS sensor.
===============================================================
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_ips_sensor`.
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 |
| **ips\_sensor** dictionary | | the top level parameters set |
| | **block-malicious-url** string | **Choices:*** disable
* enable
| Enable/disable malicious URL blocking. |
| | **comment** string | | Comment. |
| | **entries** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* reset
* default
| Action taken with traffic in which signatures are detected. |
| | | **application** string | | no description |
| | | **cve** string | | no description |
| | | **exempt-ip** list / elements=string | | no description |
| | | | **dst-ip** string | | Destination IP address and netmask. |
| | | | **id** integer | | Exempt IP ID. |
| | | | **src-ip** string | | Source IP address and netmask. |
| | | **id** integer | | Rule ID in IPS database (0 - 4294967295). |
| | | **location** string | | no description |
| | | **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 pca... |
| | | **os** string | | no description |
| | | **protocol** string | | no description |
| | | **quarantine** string | **Choices:*** none
* attacker
* both
* interface
| Quarantine method. |
| | | **quarantine-expiry** string | | Duration of quarantine. (Format ###d##h##m, minimum 1m, maximum 364d23h59m, default = 5m). Requires quarantine set to ... |
| | | **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** string | | Identifies the predefined or custom IPS signatures to add to the sensor. |
| | | **severity** string | | no description |
| | | **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 en... |
| | **extended-log** string | **Choices:*** disable
* enable
| Enable/disable extended logging. |
| | **filter** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* default
* reset
| Action of selected rules. |
| | | **application** string | | no description |
| | | **location** string | | no description |
| | | **log** string | **Choices:*** disable
* enable
* default
| Enable/disable logging of selected rules. |
| | | **log-packet** string | **Choices:*** disable
* enable
* default
| Enable/disable packet logging of selected rules. |
| | | **name** string | | Filter name. |
| | | **os** string | | no description |
| | | **protocol** string | | no description |
| | | **quarantine** string | **Choices:*** none
* attacker
* both
* interface
| 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 | | no description |
| | | **status** string | **Choices:*** disable
* enable
* default
| Selected rules status. |
| | **name** string | | Sensor name. |
| | **override** list / elements=string | | no description |
| | | **action** string | **Choices:*** pass
* block
* reset
| Action of override rule. |
| | | **exempt-ip** list / elements=string | | no description |
| | | | **dst-ip** string | | Destination IP address and netmask. |
| | | | **id** integer | | 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
* both
* interface
| 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. |
| | **scan-botnet-connections** string | **Choices:*** disable
* block
* monitor
| Block or monitor connections to Botnet servers, or disable Botnet scanning. |
| **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 IPS sensor.
fmgr_ips_sensor:
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]>
ips_sensor:
block-malicious-url: <value in [disable, enable]>
comment: <value of string>
entries:
-
action: <value in [pass, block, reset, ...]>
application: <value of string>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
id: <value of integer>
location: <value of string>
log: <value in [disable, enable]>
log-attack-context: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
os: <value of string>
protocol: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
rate-count: <value of integer>
rate-duration: <value of integer>
rate-mode: <value in [periodical, continuous]>
rate-track: <value in [none, src-ip, dest-ip, ...]>
rule: <value of string>
severity: <value of string>
status: <value in [disable, enable, default]>
cve: <value of string>
extended-log: <value in [disable, enable]>
filter:
-
action: <value in [pass, block, default, ...]>
application: <value of string>
location: <value of string>
log: <value in [disable, enable, default]>
log-packet: <value in [disable, enable, default]>
name: <value of string>
os: <value of string>
protocol: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
severity: <value of string>
status: <value in [disable, enable, default]>
name: <value of string>
override:
-
action: <value in [pass, block, reset]>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
rule-id: <value of integer>
status: <value in [disable, enable]>
replacemsg-group: <value of string>
scan-botnet-connections: <value in [disable, block, monitor]>
```
Return Values
-------------
Common return 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 – Configure DNS domain filter profiles. fortinet.fortimanager.fmgr\_dnsfilter\_profile – Configure DNS domain filter 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_dnsfilter_profile`.
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** dictionary | | the top level parameters set |
| | **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 | | no description |
| | | **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 sin... |
| | | **dst6** string | | IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be sin... |
| | | **id** integer | | 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, defaul... |
| | | **src** string | | IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol... |
| | | **src6** string | | IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol... |
| | | **status** string | **Choices:*** disable
* enable
| Enable/disable this DNS translation entry. |
| | **domain-filter** dictionary | | no description |
| | | **domain-filter-table** integer | | DNS domain filter table ID. |
| | **external-ip-blocklist** string | | One or more external IP block lists. |
| | **ftgd-dns** dictionary | | no description |
| | | **filters** list / elements=string | | no description |
| | | | **action** string | **Choices:*** monitor
* block
| Action to take for DNS requests matching the category. |
| | | | **category** string | | Category number. |
| | | | **id** integer | | ID number. |
| | | | **log** string | **Choices:*** disable
* enable
| Enable/disable DNS filter logging for this DNS profile. |
| | | **options** list / elements=string | **Choices:*** error-allow
* ftgd-disable
| no description |
| | **log-all-domain** string | **Choices:*** disable
* enable
| Enable/disable logging of all domains visited (detailed DNS logging). |
| | **name** string | | 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:*** disable
* enable
| Enable/disable domain filtering and botnet domain logging. |
| | **sdns-ftgd-err-log** string | **Choices:*** disable
* enable
| 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 |
| **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 DNS domain filter profiles.
fmgr_dnsfilter_profile:
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]>
dnsfilter_profile:
block-action: <value in [block, redirect]>
block-botnet: <value in [disable, enable]>
comment: <value of string>
external-ip-blocklist: <value of string>
log-all-domain: <value in [disable, enable]>
name: <value of string>
redirect-portal: <value of string>
safe-search: <value in [disable, enable]>
sdns-domain-log: <value in [disable, enable]>
sdns-ftgd-err-log: <value in [disable, enable]>
youtube-restrict: <value in [strict, moderate]>
dns-translation:
-
dst: <value of string>
id: <value of integer>
netmask: <value of string>
src: <value of string>
status: <value in [disable, enable]>
addr-type: <value in [ipv4, ipv6]>
dst6: <value of string>
prefix: <value of integer>
src6: <value of string>
redirect-portal6: <value of string>
domain-filter:
domain-filter-table: <value of integer>
ftgd-dns:
filters:
-
action: <value in [monitor, block]>
category: <value of string>
id: <value of integer>
log: <value in [disable, enable]>
options:
- error-allow
- ftgd-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 |
| --- | --- | --- |
| **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_dnsfilter_profile_dnstranslation – DNS translation settings. fortinet.fortimanager.fmgr\_dnsfilter\_profile\_dnstranslation – DNS translation 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_dnstranslation`.
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\_dnstranslation** dictionary | | the top level parameters set |
| | **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 a... |
| | **dst6** string | | IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP a... |
| | **id** integer | | 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, default = 128). |
| | **src** string | | IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved addr... |
| | **src6** string | | IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved addr... |
| | **status** string | **Choices:*** disable
* enable
| Enable/disable this DNS translation entry. |
| **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: DNS translation settings.
fmgr_dnsfilter_profile_dnstranslation:
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]>
dnsfilter_profile_dnstranslation:
dst: <value of string>
id: <value of integer>
netmask: <value of string>
src: <value of string>
status: <value in [disable, enable]>
addr-type: <value in [ipv4, ipv6]>
dst6: <value of string>
prefix: <value of integer>
src6: <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_dlp_fpsensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source. fortinet.fortimanager.fmgr\_dlp\_fpsensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source.
===============================================================================================================================================================
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_dlp_fpsensitivity`.
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 |
| **dlp\_fpsensitivity** dictionary | | the top level parameters set |
| | **name** string | | DLP Sensitivity Levels. |
| **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: Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source.
fmgr_dlp_fpsensitivity:
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]>
dlp_fpsensitivity:
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_address – Configure IPv4 addresses. fortinet.fortimanager.fmgr\_firewall\_address – Configure IPv4 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_firewall_address`.
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\_address** dictionary | | the top level parameters set |
| | **\_image-base64** string | | no description |
| | **allow-routing** string | **Choices:*** disable
* enable
| Enable/disable use of this address in the static route configuration. |
| | **associated-interface** string | | Network interface associated with address. |
| | **cache-ttl** integer | | Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. |
| | **clearpass-spt** string | **Choices:*** unknown
* healthy
* quarantine
* checkup
* transition
* infected
* transient
| SPT (System Posture Token) value. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | no description |
| | **country** string | | IP addresses associated to a specific country. |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_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 |
| | | **associated-interface** string | | no description |
| | | **cache-ttl** integer | | no description |
| | | **clearpass-spt** string | **Choices:*** unknown
* healthy
* quarantine
* checkup
* transition
* infected
* transient
| no description |
| | | **color** integer | | no description |
| | | **comment** string | | no description |
| | | **country** string | | no description |
| | | **end-ip** string | | no description |
| | | **end-mac** string | | no description |
| | | **epg-name** string | | no description |
| | | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | | **filter** string | | no description |
| | | **fqdn** string | | no description |
| | | **fsso-group** string | | no description |
| | | **global-object** integer | | no description |
| | | **interface** string | | no description |
| | | **macaddr** string | | no description |
| | | **node-ip-only** string | **Choices:*** disable
* enable
| Enable/disable collection of node addresses only in Kubernetes. |
| | | **obj-id** string | | no description |
| | | **obj-tag** string | | no description |
| | | **obj-type** string | **Choices:*** ip
* mac
| no description |
| | | **organization** string | | no description |
| | | **policy-group** string | | no description |
| | | **sdn** string | **Choices:*** aci
* aws
* nsx
* nuage
* azure
* gcp
* oci
* openstack
| no description |
| | | **sdn-addr-type** string | **Choices:*** private
* public
* all
| no description |
| | | **sdn-tag** string | | no description |
| | | **start-ip** string | | no description |
| | | **start-mac** string | | no description |
| | | **sub-type** string | **Choices:*** sdn
* clearpass-spt
* fsso
* ems-tag
| no description |
| | | **subnet** string | | no description |
| | | **subnet-name** string | | no description |
| | | **tags** string | | no description |
| | | **tenant** string | | no description |
| | | **type** string | **Choices:*** ipmask
* iprange
* fqdn
* wildcard
* geography
* wildcard-fqdn
* dynamic
| no description |
| | | **url** string | | no description |
| | | **uuid** string | | no description |
| | | **visibility** string | **Choices:*** disable
* enable
| no description |
| | | **wildcard** string | | no description |
| | | **wildcard-fqdn** string | | no description |
| | **end-ip** string | | Final IP address (inclusive) in the range for the address. |
| | **end-mac** string | | Last MAC address in the range. |
| | **epg-name** string | | Endpoint group name. |
| | **fabric-object** string | **Choices:*** disable
* enable
| Security Fabric global object setting. |
| | **filter** string | | Match criteria filter. |
| | **fqdn** string | | Fully Qualified Domain Name address. |
| | **fsso-group** string | | FSSO group(s). |
| | **global-object** integer | | Global Object. |
| | **interface** string | | Name of interface whose IP address is to be used. |
| | **list** list / elements=string | | no description |
| | | **ip** string | | IP. |
| | | **net-id** string | | Network ID. |
| | | **obj-id** string | | Object ID. |
| | **macaddr** string | | no description |
| | **name** string | | Address name. |
| | **node-ip-only** string | **Choices:*** disable
* enable
| Enable/disable collection of node addresses only in Kubernetes. |
| | **obj-id** string | | Object ID for NSX. |
| | **obj-tag** string | | Tag of dynamic address object. |
| | **obj-type** string | **Choices:*** ip
* mac
| Object type. |
| | **organization** string | | Organization domain name (Syntax: organization/domain). |
| | **policy-group** string | | Policy group name. |
| | **sdn** string | **Choices:*** aci
* aws
* nsx
* nuage
* azure
* gcp
* oci
* openstack
| SDN. |
| | **sdn-addr-type** string | **Choices:*** private
* public
* all
| Type of addresses to collect. |
| | **sdn-tag** string | | SDN Tag. |
| | **start-ip** string | | First IP address (inclusive) in the range for the address. |
| | **start-mac** string | | First MAC address in the range. |
| | **sub-type** string | **Choices:*** sdn
* clearpass-spt
* fsso
* ems-tag
| Sub-type of address. |
| | **subnet** string | | IP address and subnet mask of address. |
| | **subnet-name** string | | Subnet name. |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **tenant** string | | Tenant. |
| | **type** string | **Choices:*** ipmask
* iprange
* fqdn
* wildcard
* geography
* wildcard-fqdn
* dynamic
| Type of address. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable address visibility in the GUI. |
| | **wildcard** string | | IP address and wildcard netmask. |
| | **wildcard-fqdn** string | | Fully Qualified Domain Name with wildcard characters. |
| **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 addresses.
fmgr_firewall_address:
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_address:
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
country: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
country: <value of string>
end-ip: <value of string>
end-mac: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
interface: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-addr-type: <value in [private, public, all]>
sdn-tag: <value of string>
start-ip: <value of string>
start-mac: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
url: <value of string>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
_image-base64: <value of string>
clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
fsso-group: <value of string>
sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
global-object: <value of integer>
obj-tag: <value of string>
obj-type: <value in [ip, mac]>
fabric-object: <value in [disable, enable]>
macaddr: <value of string>
node-ip-only: <value in [disable, enable]>
end-ip: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
list:
-
ip: <value of string>
net-id: <value of string>
obj-id: <value of string>
name: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-tag: <value of string>
start-ip: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
end-mac: <value of string>
interface: <value of string>
sdn-addr-type: <value in [private, public, all]>
start-mac: <value of string>
_image-base64: <value of string>
clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
fsso-group: <value of string>
sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
global-object: <value of integer>
obj-tag: <value of string>
obj-type: <value in [ip, mac]>
fabric-object: <value in [disable, enable]>
macaddr: <value of string>
node-ip-only: <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_meta – no description fortinet.fortimanager.fmgr\_system\_meta – 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_system_meta`.
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\_meta** dictionary | | the top level parameters set |
| | **name** string | | no description |
| | **sys\_meta\_fields** list / elements=string | | no description |
| | | **fieldlength** integer | | no description |
| | | **importance** string | **Choices:*** optional
* required
| no description |
| | | **name** 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_system_meta:
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_meta:
name: <value of string>
sys_meta_fields:
-
fieldlength: <value of integer>
importance: <value in [optional, required]>
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_nic – Configure Azure network interface. fortinet.fortimanager.fmgr\_system\_sdnconnector\_nic – Configure Azure network interface.
==========================================================================================
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_nic`.
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 |
| **sdn-connector** string / required | | the parameter (sdn-connector) in requested url |
| **state** string / required | **Choices:*** present
* absent
| the directive to create, update or delete an object |
| **system\_sdnconnector\_nic** dictionary | | the top level parameters set |
| | **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. |
| **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 Azure network interface.
fmgr_system_sdnconnector_nic:
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>
sdn-connector: <your own value>
state: <value in [present, absent]>
system_sdnconnector_nic:
ip:
-
name: <value of string>
public-ip: <value of string>
resource-group: <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_fmupdate_serveraccesspriorities – Configure priorities for FortiGate units accessing antivirus updates and web filtering services. fortinet.fortimanager.fmgr\_fmupdate\_serveraccesspriorities – Configure priorities for FortiGate units accessing antivirus updates and web filtering services.
===============================================================================================================================================================
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_serveraccesspriorities`.
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\_serveraccesspriorities** dictionary | | the top level parameters set |
| | **access-public** string | **Choices:*** **disable** ←
* enable
| Enable/disable FortiGates to Access Public FortiGuard Servers when Private Servers are Unavailable (default = disable). disable - Disable setting. enable - Enable setting. |
| | **av-ips** string | **Choices:*** **disable** ←
* enable
| Enable/disable Antivirus and IPS Update Service for Private Server(default = disable). disable - Disable setting. enable - Enable setting. |
| | **private-server** list / elements=string | | no description |
| | | **id** integer | **Default:**0 | Private server ID (1 - 10). |
| | | **ip** string | **Default:**"0.0.0.0" | IPv4 address of the FortiManager unit or private server. |
| | | **ip6** string | **Default:**"::" | IPv6 address of the FortiManager unit or private server. |
| | | **time\_zone** integer | **Default:**-24 | Time zone of the private server (-24 = local time zone, default = -24). |
| | **web-spam** string | **Choices:*** disable
* **enable** ←
| Enable/disable Web Filter and Email Filter Update Service for Private Server (default = enable). 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: Configure priorities for FortiGate units accessing antivirus updates and web filtering services.
fmgr_fmupdate_serveraccesspriorities:
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_serveraccesspriorities:
access-public: <value in [disable, enable]>
av-ips: <value in [disable, enable]>
private-server:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
time_zone: <value of integer>
web-spam: <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_hotspot20_h2qpoperatorname – Configure operator friendly name. fortinet.fortimanager.fmgr\_hotspot20\_h2qpoperatorname – Configure operator friendly name.
===========================================================================================
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_h2qpoperatorname`.
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\_h2qpoperatorname** dictionary | | the top level parameters set |
| | **name** string | | Friendly name ID. |
| | **value-list** list / elements=string | | no description |
| | | **index** integer | | Value index. |
| | | **lang** string | | Language code. |
| | | **value** string | | Friendly name value. |
| **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 operator friendly name.
fmgr_hotspot20_h2qpoperatorname:
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_h2qpoperatorname:
name: <value of string>
value-list:
-
index: <value of integer>
lang: <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_gtp_messageratelimitv1 – Message rate limiting for GTP version 1. fortinet.fortimanager.fmgr\_firewall\_gtp\_messageratelimitv1 – Message rate limiting for GTP version 1.
========================================================================================================
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_messageratelimitv1`.
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\_messageratelimitv1** dictionary | | the top level parameters set |
| | **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. |
| **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: Message rate limiting for GTP version 1.
fmgr_firewall_gtp_messageratelimitv1:
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>
firewall_gtp_messageratelimitv1:
create-pdp-request: <value of integer>
delete-pdp-request: <value of integer>
echo-request: <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_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs. fortinet.fortimanager.fmgr\_firewall\_vip46 – Configure IPv4 to IPv6 virtual IPs.
=================================================================================
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_vip46`.
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\_vip46** dictionary | | the top level parameters set |
| | **arp-reply** string | **Choices:*** disable
* enable
| Enable ARP reply. |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **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 |
| | | **extip** string | | no description |
| | | **extport** string | | no description |
| | | **id** integer | | no description |
| | | **ldb-method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| no description |
| | | **mappedip** string | | no description |
| | | **mappedport** string | | no description |
| | | **monitor** string | | no description |
| | | **portforward** string | **Choices:*** disable
* enable
| no description |
| | | **protocol** string | **Choices:*** tcp
* udp
| no description |
| | | **server-type** string | **Choices:*** http
* tcp
* udp
* ip
| no description |
| | | **src-filter** string | | no description |
| | | **srcintf-filter** string | | Interfaces to which the VIP46 applies. Separate the names with spaces. |
| | | **type** string | **Choices:*** static-nat
* server-load-balance
| no description |
| | | **uuid** string | | no description |
| | **extip** string | | Start-external-IP [-end-external-IP]. |
| | **extport** string | | External service port. |
| | **id** integer | | Custom defined id. |
| | **ldb-method** string | **Choices:*** static
* round-robin
* weighted
* least-session
* least-rtt
* first-alive
| Load balance method. |
| | **mappedip** string | | Start-mapped-IP [-end mapped-IP]. |
| | **mappedport** string | | Mapped service port. |
| | **monitor** string | | Health monitors. |
| | **name** string | | VIP46 name. |
| | **portforward** string | **Choices:*** disable
* enable
| Enable port forwarding. |
| | **protocol** string | **Choices:*** tcp
* udp
| Mapped port protocol. |
| | **realservers** list / elements=string | | no description |
| | | **client-ip** string | | Restrict server to a client IP in this range. |
| | | **healthcheck** string | **Choices:*** disable
* enable
* vip
| Per server health check. |
| | | **holddown-interval** integer | | Hold down interval. |
| | | **id** integer | | Real server ID. |
| | | **ip** string | | Mapped server IPv6. |
| | | **max-connections** integer | | Maximum number of connections allowed to server. |
| | | **monitor** string | | Health monitors. |
| | | **port** integer | | Mapped server port. |
| | | **status** string | **Choices:*** active
* standby
* disable
| Server administrative status. |
| | | **weight** integer | | no description |
| | **server-type** string | **Choices:*** http
* tcp
* udp
* ip
| Server type. |
| | **src-filter** string | | no description |
| | **srcintf-filter** string | | Interfaces to which the VIP46 applies. Separate the names with spaces. |
| | **type** string | **Choices:*** static-nat
* server-load-balance
| VIP type: static NAT. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| **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 to IPv6 virtual IPs.
fmgr_firewall_vip46:
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_vip46:
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
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>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <value of string>
srcintf-filter: <value of string>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
name: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
id: <value of integer>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <value of string>
srcintf-filter: <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_dynamic_ippool – no description fortinet.fortimanager.fmgr\_dynamic\_ippool – 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_dynamic_ippool`.
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 |
| **dynamic\_ippool** dictionary | | the top level parameters set |
| | **description** string | | no description |
| | **name** string | | no description |
| **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: no description
fmgr_dynamic_ippool:
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]>
dynamic_ippool:
description: <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_firewall_gtp_messageratelimit – Message rate limiting. fortinet.fortimanager.fmgr\_firewall\_gtp\_messageratelimit – Message rate limiting.
====================================================================================
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_messageratelimit`.
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\_messageratelimit** dictionary | | the top level parameters set |
| | **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). |
| **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: Message rate limiting.
fmgr_firewall_gtp_messageratelimit:
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>
firewall_gtp_messageratelimit:
create-aa-pdp-request: <value of integer>
create-aa-pdp-response: <value of integer>
create-mbms-request: <value of integer>
create-mbms-response: <value of integer>
create-pdp-request: <value of integer>
create-pdp-response: <value of integer>
delete-aa-pdp-request: <value of integer>
delete-aa-pdp-response: <value of integer>
delete-mbms-request: <value of integer>
delete-mbms-response: <value of integer>
delete-pdp-request: <value of integer>
delete-pdp-response: <value of integer>
echo-reponse: <value of integer>
echo-request: <value of integer>
error-indication: <value of integer>
failure-report-request: <value of integer>
failure-report-response: <value of integer>
fwd-reloc-complete-ack: <value of integer>
fwd-relocation-complete: <value of integer>
fwd-relocation-request: <value of integer>
fwd-relocation-response: <value of integer>
fwd-srns-context: <value of integer>
fwd-srns-context-ack: <value of integer>
g-pdu: <value of integer>
identification-request: <value of integer>
identification-response: <value of integer>
mbms-de-reg-request: <value of integer>
mbms-de-reg-response: <value of integer>
mbms-notify-rej-request: <value of integer>
mbms-notify-rej-response: <value of integer>
mbms-notify-request: <value of integer>
mbms-notify-response: <value of integer>
mbms-reg-request: <value of integer>
mbms-reg-response: <value of integer>
mbms-ses-start-request: <value of integer>
mbms-ses-start-response: <value of integer>
mbms-ses-stop-request: <value of integer>
mbms-ses-stop-response: <value of integer>
note-ms-request: <value of integer>
note-ms-response: <value of integer>
pdu-notify-rej-request: <value of integer>
pdu-notify-rej-response: <value of integer>
pdu-notify-request: <value of integer>
pdu-notify-response: <value of integer>
ran-info: <value of integer>
relocation-cancel-request: <value of integer>
relocation-cancel-response: <value of integer>
send-route-request: <value of integer>
send-route-response: <value of integer>
sgsn-context-ack: <value of integer>
sgsn-context-request: <value of integer>
sgsn-context-response: <value of integer>
support-ext-hdr-notify: <value of integer>
update-mbms-request: <value of integer>
update-mbms-response: <value of integer>
update-pdp-request: <value of integer>
update-pdp-response: <value of integer>
version-not-support: <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_hotspot20_h2qpoperatorname_valuelist – Name list. fortinet.fortimanager.fmgr\_hotspot20\_h2qpoperatorname\_valuelist – Name 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_hotspot20_h2qpoperatorname_valuelist`.
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 |
| **h2qp-operator-name** string / required | | the parameter (h2qp-operator-name) in requested url |
| **hotspot20\_h2qpoperatorname\_valuelist** dictionary | | the top level parameters set |
| | **index** integer | | Value index. |
| | **lang** string | | Language code. |
| | **value** string | | Friendly name value. |
| **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: Name list.
fmgr_hotspot20_h2qpoperatorname_valuelist:
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>
h2qp-operator-name: <your own value>
state: <value in [present, absent]>
hotspot20_h2qpoperatorname_valuelist:
index: <value of integer>
lang: <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)
ansible fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup – HTTP header group. fortinet.fortimanager.fmgr\_firewall\_proxyaddress\_headergroup – HTTP header 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_firewall_proxyaddress_headergroup`.
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\_proxyaddress\_headergroup** dictionary | | the top level parameters set |
| | **case-sensitivity** string | **Choices:*** disable
* enable
| Case sensitivity in pattern. |
| | **header** string | | HTTP header regular expression. |
| | **header-name** string | | HTTP header. |
| | **id** integer | | ID. |
| **proposed\_method** string | **Choices:*** update
* set
* add
| The overridden method for the underlying Json RPC request |
| **proxy-address** string / required | | the parameter (proxy-address) 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 |
| **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: HTTP header group.
fmgr_firewall_proxyaddress_headergroup:
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>
proxy-address: <your own value>
state: <value in [present, absent]>
firewall_proxyaddress_headergroup:
case-sensitivity: <value in [disable, enable]>
header: <value of string>
header-name: <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_sshfilter_profile_filefilter_entries – File filter entries. fortinet.fortimanager.fmgr\_sshfilter\_profile\_filefilter\_entries – File filter 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_sshfilter_profile_filefilter_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 |
| **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 |
| **sshfilter\_profile\_filefilter\_entries** dictionary | | the top level parameters set |
| | **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. |
| | **password-protected** string | **Choices:*** any
* yes
| Match password-protected files. |
| | **protocol** list / elements=string | **Choices:*** ssh
| 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: File filter entries.
fmgr_sshfilter_profile_filefilter_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>
profile: <your own value>
state: <value in [present, absent]>
sshfilter_profile_filefilter_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>
password-protected: <value in [any, yes]>
protocol:
- ssh
```
Return Values
-------------
Common return 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_mapi – MAPI. fortinet.fortimanager.fmgr\_spamfilter\_profile\_mapi – MAPI.
=============================================================
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_mapi`.
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\_mapi** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** pass
* discard
| Action for spam email. |
| | **log** string | **Choices:*** disable
* enable
| Enable/disable logging. |
| **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: MAPI.
fmgr_spamfilter_profile_mapi:
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_mapi:
action: <value in [pass, discard]>
log: <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_multicastaddress6 – Configure IPv6 multicast address. fortinet.fortimanager.fmgr\_firewall\_multicastaddress6 – Configure IPv6 multicast address.
===========================================================================================
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_multicastaddress6`.
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\_multicastaddress6** dictionary | | the top level parameters set |
| | **color** integer | | Color of icon on the GUI. |
| | **comment** string | | Comment. |
| | **ip6** string | | IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). |
| | **name** string | | IPv6 multicast address name. |
| | **tagging** list / elements=string | | no description |
| | | **category** string | | Tag category. |
| | | **name** string | | Tagging entry name. |
| | | **tags** string | | no description |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable visibility of the IPv6 multicast address on 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: Configure IPv6 multicast address.
fmgr_firewall_multicastaddress6:
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_multicastaddress6:
color: <value of integer>
comment: <value of string>
ip6: <value of string>
name: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
visibility: <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_webfilter_profile_urlextraction – Configure URL Extraction fortinet.fortimanager.fmgr\_webfilter\_profile\_urlextraction – Configure URL Extraction
========================================================================================
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_urlextraction`.
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\_urlextraction** dictionary | | the top level parameters set |
| | **redirect-header** string | | HTTP header name to use for client redirect on blocked requests |
| | **redirect-no-content** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
| Enable URL Extraction |
| **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 URL Extraction
fmgr_webfilter_profile_urlextraction:
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_urlextraction:
redirect-header: <value of string>
redirect-no-content: <value in [disable, enable]>
redirect-url: <value of string>
server-fqdn: <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_vpnmgr_node – VPN node for VPN Manager. fortinet.fortimanager.fmgr\_vpnmgr\_node – VPN node for VPN Manager.
====================================================================
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_node`.
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\_node** dictionary | | the top level parameters set |
| | **add-route** string | **Choices:*** disable
* enable
| no description |
| | **assign-ip** string | **Choices:*** disable
* enable
| no description |
| | **assign-ip-from** string | **Choices:*** range
* usrgrp
* dhcp
* name
| no description |
| | **authpasswd** string | | no description |
| | **authusr** string | | no description |
| | **authusrgrp** string | | no description |
| | **auto-configuration** string | **Choices:*** disable
* enable
| no description |
| | **automatic\_routing** string | **Choices:*** disable
* enable
| no description |
| | **banner** string | | no description |
| | **default-gateway** string | | no description |
| | **dhcp-server** string | **Choices:*** disable
* enable
| no description |
| | **dns-mode** string | **Choices:*** auto
* manual
| no description |
| | **dns-service** string | **Choices:*** default
* specify
* local
| no description |
| | **domain** string | | no description |
| | **exchange-interface-ip** string | **Choices:*** disable
* enable
| no description |
| | **extgw** string | | no description |
| | **extgw\_hubip** string | | no description |
| | **extgw\_p2\_per\_net** string | **Choices:*** disable
* enable
| no description |
| | **extgwip** string | | no description |
| | **hub-public-ip** string | | no description |
| | **hub\_iface** string | | no description |
| | **id** integer | | no description |
| | **iface** string | | no description |
| | **ip-range** list / elements=string | | no description |
| | | **end-ip** string | | no description |
| | | **id** integer | | no description |
| | | **start-ip** string | | no description |
| | **ipsec-lease-hold** integer | | no description |
| | **ipv4-dns-server1** string | | no description |
| | **ipv4-dns-server2** string | | no description |
| | **ipv4-dns-server3** string | | no description |
| | **ipv4-end-ip** string | | no description |
| | **ipv4-exclude-range** list / elements=string | | no description |
| | | **end-ip** string | | no description |
| | | **id** integer | | no description |
| | | **start-ip** string | | no description |
| | **ipv4-netmask** string | | no description |
| | **ipv4-split-exclude** string | | no description |
| | **ipv4-split-include** string | | no description |
| | **ipv4-start-ip** string | | no description |
| | **ipv4-wins-server1** string | | no description |
| | **ipv4-wins-server2** string | | no description |
| | **local-gw** string | | no description |
| | **localid** string | | no description |
| | **mode-cfg** string | **Choices:*** disable
* enable
| no description |
| | **mode-cfg-ip-version** string | **Choices:*** 4
* 6
| no description |
| | **net-device** string | **Choices:*** disable
* enable
| no description |
| | **peer** string | | no description |
| | **peergrp** string | | no description |
| | **peerid** string | | no description |
| | **peertype** string | **Choices:*** any
* one
* dialup
* peer
* peergrp
| no description |
| | **protected\_subnet** list / elements=string | | no description |
| | | **addr** string | | no description |
| | | **seq** integer | | no description |
| | **public-ip** string | | no description |
| | **role** string | **Choices:*** hub
* spoke
| no description |
| | **route-overlap** string | **Choices:*** use-old
* use-new
* allow
| no description |
| | **scope member** list / elements=string | | no description |
| | | **name** string | | name of scope member |
| | | **vdom** string | | vdom of scope member |
| | **spoke-zone** string | | no description |
| | **summary\_addr** list / elements=string | | no description |
| | | **addr** string | | no description |
| | | **priority** integer | | no description |
| | | **seq** integer | | no description |
| | **tunnel-search** string | **Choices:*** selectors
* nexthop
| no description |
| | **unity-support** string | **Choices:*** disable
* enable
| no description |
| | **usrgrp** string | | no description |
| | **vpn-interface-priority** integer | | no description |
| | **vpn-zone** string | | no description |
| | **vpntable** string | | no description |
| | **xauthtype** string | **Choices:*** disable
* client
* pap
* chap
* auto
| 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: VPN node for VPN Manager.
fmgr_vpnmgr_node:
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_node:
add-route: <value in [disable, enable]>
assign-ip: <value in [disable, enable]>
assign-ip-from: <value in [range, usrgrp, dhcp, ...]>
authpasswd: <value of string>
authusr: <value of string>
authusrgrp: <value of string>
auto-configuration: <value in [disable, enable]>
automatic_routing: <value in [disable, enable]>
banner: <value of string>
default-gateway: <value of string>
dhcp-server: <value in [disable, enable]>
dns-mode: <value in [auto, manual]>
dns-service: <value in [default, specify, local]>
domain: <value of string>
extgw: <value of string>
extgw_hubip: <value of string>
extgw_p2_per_net: <value in [disable, enable]>
extgwip: <value of string>
hub_iface: <value of string>
id: <value of integer>
iface: <value of string>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipsec-lease-hold: <value of integer>
ipv4-dns-server1: <value of string>
ipv4-dns-server2: <value of string>
ipv4-dns-server3: <value of string>
ipv4-end-ip: <value of string>
ipv4-exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipv4-netmask: <value of string>
ipv4-split-include: <value of string>
ipv4-start-ip: <value of string>
ipv4-wins-server1: <value of string>
ipv4-wins-server2: <value of string>
local-gw: <value of string>
localid: <value of string>
mode-cfg: <value in [disable, enable]>
mode-cfg-ip-version: <value in [4, 6]>
net-device: <value in [disable, enable]>
peer: <value of string>
peergrp: <value of string>
peerid: <value of string>
peertype: <value in [any, one, dialup, ...]>
protected_subnet:
-
addr: <value of string>
seq: <value of integer>
public-ip: <value of string>
role: <value in [hub, spoke]>
route-overlap: <value in [use-old, use-new, allow]>
spoke-zone: <value of string>
summary_addr:
-
addr: <value of string>
priority: <value of integer>
seq: <value of integer>
tunnel-search: <value in [selectors, nexthop]>
unity-support: <value in [disable, enable]>
usrgrp: <value of string>
vpn-interface-priority: <value of integer>
vpn-zone: <value of string>
vpntable: <value of string>
xauthtype: <value in [disable, client, pap, ...]>
exchange-interface-ip: <value in [disable, enable]>
hub-public-ip: <value of string>
ipv4-split-exclude: <value of string>
scope member:
-
name: <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)
ansible fortinet.fortimanager.fmgr_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. fortinet.fortimanager.fmgr\_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
================================================================================================================================================
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_wtpprofile`.
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 |
| **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 |
| **wtpprofile** dictionary | | the top level parameters set |
| | **allowaccess** list / elements=string | **Choices:*** https
* ssh
* snmp
* http
* telnet
| no description |
| | **ap-country** string | **Choices:*** AL
* DZ
* AR
* AM
* AU
* AT
* AZ
* BH
* BD
* BY
* BE
* BZ
* BO
* BA
* BR
* BN
* BG
* CA
* CL
* CN
* CO
* CR
* HR
* CY
* CZ
* DK
* DO
* EC
* EG
* SV
* EE
* FI
* FR
* GE
* DE
* GR
* GT
* HN
* HK
* HU
* IS
* IN
* ID
* IR
* IE
* IL
* IT
* JM
* JP
* JO
* KZ
* KE
* KP
* KR
* KW
* LV
* LB
* LI
* LT
* LU
* MO
* MK
* MY
* MT
* MX
* MC
* MA
* NP
* NL
* AN
* NZ
* NO
* OM
* PK
* PA
* PG
* PE
* PH
* PL
* PT
* PR
* QA
* RO
* RU
* SA
* SG
* SK
* SI
* ZA
* ES
* LK
* SE
* CH
* SY
* TW
* TH
* TT
* TN
* TR
* AE
* UA
* GB
* US
* PS
* UY
* UZ
* VE
* VN
* YE
* ZW
* NA
* KH
* TZ
* SD
* AO
* RW
* MZ
* RS
* ME
* BB
* GD
* GL
* GU
* PY
* HT
* AW
* MM
* ZB
* CF
* BS
* VC
* MV
* SN
* CI
* GH
* MW
* UG
* BF
* KY
* TC
* TM
* VU
* FM
* GY
* KN
* LC
* CX
* AF
* CM
* ML
* BJ
* MG
* TD
* BW
* LY
* LS
* MU
* SL
* NE
* TG
* RE
* MD
* BM
* VI
* PM
* MF
* IM
* FO
* GI
* LA
* WF
* MH
* BT
* PF
* NI
* GF
* AS
* MP
* PW
* GP
* ET
* SR
* DM
* MQ
* YT
* BL
* ZM
* CG
* CD
* MR
* IQ
* FJ
| Country in which this WTP, FortiAP or AP will operate (default = NA, automatically use the country configured for the current ... |
| | **ap-handoff** string | **Choices:*** disable
* enable
| Enable/disable AP handoff of clients to other APs (default = disable). |
| | **apcfg-profile** string | | AP local configuration profile name. |
| | **ble-profile** string | | Bluetooth Low Energy 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
| no description |
| | **deny-mac-list** list / elements=string | | no description |
| | | **id** integer | | ID. |
| | | **mac** string | | A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. |
| | **dtls-in-kernel** string | **Choices:*** disable
* enable
| Enable/disable data channel DTLS in kernel. |
| | **dtls-policy** list / elements=string | **Choices:*** clear-text
* dtls-enabled
* ipsec-vpn
| no description |
| | **energy-efficient-ethernet** string | **Choices:*** disable
* enable
| Enable/disable use of energy efficient Ethernet on WTP. |
| | **ext-info-enable** string | **Choices:*** disable
* enable
| Enable/disable station/VAP/radio extension information. |
| | **frequency-handoff** string | **Choices:*** disable
* enable
| Enable/disable frequency handoff of clients to other channels (default = disable). |
| | **handoff-roaming** string | **Choices:*** disable
* enable
| Enable/disable client load balancing during roaming to avoid roaming delay (default = disable). |
| | **handoff-rssi** integer | | Minimum received signal strength indicator (RSSI) value for handoff (20 - 30, default = 25). |
| | **handoff-sta-thresh** integer | | Threshold value for AP handoff. |
| | **ip-fragment-preventing** list / elements=string | **Choices:*** tcp-mss-adjust
* icmp-unreachable
| no description |
| | **lan** dictionary | | no description |
| | | **port-esl-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| ESL port mode. |
| | | **port-esl-ssid** string | | Bridge ESL port to SSID. |
| | | **port-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port mode. |
| | | **port-ssid** string | | Bridge LAN port to SSID. |
| | | **port1-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 1 mode. |
| | | **port1-ssid** string | | Bridge LAN port 1 to SSID. |
| | | **port2-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 2 mode. |
| | | **port2-ssid** string | | Bridge LAN port 2 to SSID. |
| | | **port3-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 3 mode. |
| | | **port3-ssid** string | | Bridge LAN port 3 to SSID. |
| | | **port4-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 4 mode. |
| | | **port4-ssid** string | | Bridge LAN port 4 to SSID. |
| | | **port5-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 5 mode. |
| | | **port5-ssid** string | | Bridge LAN port 5 to SSID. |
| | | **port6-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 6 mode. |
| | | **port6-ssid** string | | Bridge LAN port 6 to SSID. |
| | | **port7-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 7 mode. |
| | | **port7-ssid** string | | Bridge LAN port 7 to SSID. |
| | | **port8-mode** string | **Choices:*** offline
* bridge-to-wan
* bridge-to-ssid
* nat-to-wan
| LAN port 8 mode. |
| | | **port8-ssid** string | | Bridge LAN port 8 to SSID. |
| | **lbs** dictionary | | no description |
| | | **aeroscout** string | **Choices:*** disable
* enable
| Enable/disable AeroScout Real Time Location Service (RTLS) support (default = disable). |
| | | **aeroscout-ap-mac** string | **Choices:*** bssid
* board-mac
| Use BSSID or board MAC address as AP MAC address in AeroScout AP messages (default = bssid). |
| | | **aeroscout-mmu-report** string | **Choices:*** disable
* enable
| Enable/disable compounded AeroScout tag and MU report (default = enable). |
| | | **aeroscout-mu** string | **Choices:*** disable
* enable
| Enable/disable AeroScout Mobile Unit (MU) support (default = disable). |
| | | **aeroscout-mu-factor** integer | | AeroScout MU mode dilution factor (default = 20). |
| | | **aeroscout-mu-timeout** integer | | AeroScout MU mode timeout (0 - 65535 sec, default = 5). |
| | | **aeroscout-server-ip** string | | IP address of AeroScout server. |
| | | **aeroscout-server-port** integer | | AeroScout server UDP listening port. |
| | | **ekahau-blink-mode** string | **Choices:*** disable
* enable
| Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags (default = disable). |
| | | **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:*** disable
* enable
* enable2
* foreign
* both
| Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this Wi... |
| | | **fortipresence-ble** string | **Choices:*** disable
* enable
| Enable/disable FortiPresence finding and reporting BLE devices. |
| | | **fortipresence-frequency** integer | | FortiPresence report transmit frequency (5 - 65535 sec, default = 30). |
| | | **fortipresence-port** integer | | FortiPresence server UDP listening port (default = 3000). |
| | | **fortipresence-project** string | | FortiPresence project name (max. 16 characters, default = fortipresence). |
| | | **fortipresence-rogue** string | **Choices:*** disable
* enable
| Enable/disable FortiPresence finding and reporting rogue APs. |
| | | **fortipresence-secret** string | | no description |
| | | **fortipresence-server** string | | FortiPresence server IP address. |
| | | **fortipresence-unassoc** string | **Choices:*** disable
* enable
| Enable/disable FortiPresence finding and reporting unassociated stations. |
| | | **station-locate** string | **Choices:*** disable
* enable
| Enable/disable client station locating services for all clients, whether associated or not (default = disable). |
| | **led-schedules** string | | Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least... |
| | **led-state** string | **Choices:*** disable
* enable
| Enable/disable use of LEDs on WTP (default = disable). |
| | **lldp** string | **Choices:*** disable
* enable
| Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP (default = disable). |
| | **login-passwd** string | | no description |
| | **login-passwd-change** string | **Choices:*** no
* yes
* default
| Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no, default = no). |
| | **max-clients** integer | | Maximum number of stations (STAs) supported by the WTP (default = 0, meaning no client limitation). |
| | **name** string | | WTP (or FortiAP or AP) profile name. |
| | **platform** dictionary | | no description |
| | | **\_local\_platform\_str** string | | no description |
| | | **ddscan** string | **Choices:*** disable
* enable
| Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat man... |
| | | **mode** string | **Choices:*** dual-5G
* single-5G
| Configure operation mode of 5G radios (default = single-5G). |
| | | **type** string | **Choices:*** 30B-50B
* 60B
* 80CM-81CM
* 220A
* 220B
* 210B
* 60C
* 222B
* 112B
* 320B
* 11C
* 14C
* 223B
* 28C
* 320C
* 221C
* 25D
* 222C
* 224D
* 214B
* 21D
* 24D
* 112D
* 223C
* 321C
* C220C
* C225C
* S321C
* S323C
* FWF
* S311C
* S313C
* AP-11N
* S322C
* S321CR
* S322CR
* S323CR
* S421E
* S422E
* S423E
* 421E
* 423E
* C221E
* C226E
* C23JD
* C24JE
* C21D
* U421E
* U423E
* 221E
* 222E
* 223E
* S221E
* S223E
* U221EV
* U223EV
* U321EV
* U323EV
* 224E
* U422EV
* U24JEV
* 321E
* U431F
* U433F
* 231E
* 431F
* 433F
* 231F
* 432F
* 234F
* 23JF
* U231F
* 831F
* U234F
* U432F
| WTP, FortiAP or AP platform type. There are built-in WTP profiles for all supported FortiAP models. You can select a b... |
| | **poe-mode** string | **Choices:*** auto
* 8023af
* 8023at
* power-adapter
* full
* high
* low
| Set the WTP, FortiAP, or APs PoE mode. |
| | **radio-1** dictionary | | no description |
| | | **airtime-fairness** string | **Choices:*** disable
* enable
| Enable/disable airtime fairness (default = disable). |
| | | **amsdu** string | **Choices:*** disable
* enable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). |
| | | **ap-sniffer-addr** string | | MAC address to monitor. |
| | | **ap-sniffer-bufsize** integer | | Sniffer buffer size (1 - 32 MB, default = 16). |
| | | **ap-sniffer-chan** integer | | Channel on which to operate the sniffer (default = 6). |
| | | **ap-sniffer-ctl** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi control frame (default = enable). |
| | | **ap-sniffer-data** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi data frame (default = enable). |
| | | **ap-sniffer-mgmt-beacon** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management Beacon frames (default = enable). |
| | | **ap-sniffer-mgmt-other** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management other frames (default = enable). |
| | | **ap-sniffer-mgmt-probe** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management probe frames (default = enable). |
| | | **auto-power-high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-level** string | **Choices:*** disable
* enable
| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). |
| | | **auto-power-low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
| | | **band** string | **Choices:*** 802.11b
* 802.11a
* 802.11g
* 802.11n
* 802.11ac
* 802.11n-5G
* 802.11ax-5G
* 802.11ax
* 802.11ac-2G
* 802.11g-only
* 802.11n-only
* 802.11n,g-only
* 802.11ac-only
* 802.11ac,n-only
* 802.11n-5G-only
* 802.11ax-5G-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-only
* 802.11ax,n-only
* 802.11ax,n,g-only
| 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:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the... |
| | | **bandwidth-capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
| | | **beacon-interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor... |
| | | **bss-color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0). |
| | | **call-admission-control** string | **Choices:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca... |
| | | **call-capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
| | | **channel** string | | no description |
| | | **channel-bonding** string | **Choices:*** disable
* enable
* 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel-utilization** string | **Choices:*** disable
* enable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** disable
* enable
| Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). |
| | | **darrp** string | **Choices:*** disable
* enable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo... |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) (default = disable). |
| | | **drma-sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i... |
| | | **frag-threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
| | | **iperf-protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol (default = "UDP"). |
| | | **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, default = 0). |
| | | **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, default = 100). |
| | | **power-mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag... |
| | | **power-value** integer | | Radio EIRP power in dBm (1 - 33, default = 27). |
| | | **powersave-optimize** list / elements=string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| no description |
| | | **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 | | no description |
| | | **rts-threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt... |
| | | **sam-bssid** string | | BSSID for WiFi network. |
| | | **sam-captive-portal** string | **Choices:*** disable
* enable
| Enable/disable Captive Portal Authentication (default = disable). |
| | | **sam-password** string | | no description |
| | | **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 (default = "wpa-personal"). |
| | | **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 (default = "PING"). |
| | | **sam-username** string | | Username for WiFi network connection. |
| | | **short-guard-interval** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
* scan-only
| no description |
| | | **transmit-optimize** list / elements=string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| no description |
| | | **vap-all** string | **Choices:*** disable
* enable
* tunnel
* bridge
* manual
| Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs). |
| | | **vap1** string | | Virtual Access Point (VAP) for wlan ID 1 |
| | | **vap2** string | | Virtual Access Point (VAP) for wlan ID 2 |
| | | **vap3** string | | Virtual Access Point (VAP) for wlan ID 3 |
| | | **vap4** string | | Virtual Access Point (VAP) for wlan ID 4 |
| | | **vap5** string | | Virtual Access Point (VAP) for wlan ID 5 |
| | | **vap6** string | | Virtual Access Point (VAP) for wlan ID 6 |
| | | **vap7** string | | Virtual Access Point (VAP) for wlan ID 7 |
| | | **vap8** string | | Virtual Access Point (VAP) for wlan ID 8 |
| | | **vaps** string | | Manually selected list of Virtual Access Points (VAPs). |
| | | **wids-profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
| | | **zero-wait-dfs** string | **Choices:*** disable
* enable
| Enable/disable zero wait DFS on radio (default = enable). |
| | **radio-2** dictionary | | no description |
| | | **airtime-fairness** string | **Choices:*** disable
* enable
| Enable/disable airtime fairness (default = disable). |
| | | **amsdu** string | **Choices:*** disable
* enable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). |
| | | **ap-sniffer-addr** string | | MAC address to monitor. |
| | | **ap-sniffer-bufsize** integer | | Sniffer buffer size (1 - 32 MB, default = 16). |
| | | **ap-sniffer-chan** integer | | Channel on which to operate the sniffer (default = 6). |
| | | **ap-sniffer-ctl** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi control frame (default = enable). |
| | | **ap-sniffer-data** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi data frame (default = enable). |
| | | **ap-sniffer-mgmt-beacon** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management Beacon frames (default = enable). |
| | | **ap-sniffer-mgmt-other** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management other frames (default = enable). |
| | | **ap-sniffer-mgmt-probe** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management probe frames (default = enable). |
| | | **auto-power-high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-level** string | **Choices:*** disable
* enable
| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). |
| | | **auto-power-low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
| | | **band** string | **Choices:*** 802.11b
* 802.11a
* 802.11g
* 802.11n
* 802.11ac
* 802.11n-5G
* 802.11ax-5G
* 802.11ax
* 802.11ac-2G
* 802.11g-only
* 802.11n-only
* 802.11n,g-only
* 802.11ac-only
* 802.11ac,n-only
* 802.11n-5G-only
* 802.11ax-5G-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-only
* 802.11ax,n-only
* 802.11ax,n,g-only
| 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:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the... |
| | | **bandwidth-capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
| | | **beacon-interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor... |
| | | **bss-color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0). |
| | | **call-admission-control** string | **Choices:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca... |
| | | **call-capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
| | | **channel** string | | no description |
| | | **channel-bonding** string | **Choices:*** disable
* enable
* 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel-utilization** string | **Choices:*** disable
* enable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** disable
* enable
| Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). |
| | | **darrp** string | **Choices:*** disable
* enable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo... |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) (default = disable). |
| | | **drma-sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i... |
| | | **frag-threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
| | | **iperf-protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol (default = "UDP"). |
| | | **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, default = 0). |
| | | **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, default = 100). |
| | | **power-mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag... |
| | | **power-value** integer | | Radio EIRP power in dBm (1 - 33, default = 27). |
| | | **powersave-optimize** list / elements=string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| no description |
| | | **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 | | no description |
| | | **rts-threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt... |
| | | **sam-bssid** string | | BSSID for WiFi network. |
| | | **sam-captive-portal** string | **Choices:*** disable
* enable
| Enable/disable Captive Portal Authentication (default = disable). |
| | | **sam-password** string | | no description |
| | | **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 (default = "wpa-personal"). |
| | | **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 (default = "PING"). |
| | | **sam-username** string | | Username for WiFi network connection. |
| | | **short-guard-interval** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
* scan-only
| no description |
| | | **transmit-optimize** list / elements=string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| no description |
| | | **vap-all** string | **Choices:*** disable
* enable
* tunnel
* bridge
* manual
| Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs). |
| | | **vap1** string | | Virtual Access Point (VAP) for wlan ID 1 |
| | | **vap2** string | | Virtual Access Point (VAP) for wlan ID 2 |
| | | **vap3** string | | Virtual Access Point (VAP) for wlan ID 3 |
| | | **vap4** string | | Virtual Access Point (VAP) for wlan ID 4 |
| | | **vap5** string | | Virtual Access Point (VAP) for wlan ID 5 |
| | | **vap6** string | | Virtual Access Point (VAP) for wlan ID 6 |
| | | **vap7** string | | Virtual Access Point (VAP) for wlan ID 7 |
| | | **vap8** string | | Virtual Access Point (VAP) for wlan ID 8 |
| | | **vaps** string | | Manually selected list of Virtual Access Points (VAPs). |
| | | **wids-profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
| | | **zero-wait-dfs** string | **Choices:*** disable
* enable
| Enable/disable zero wait DFS on radio (default = enable). |
| | **radio-3** dictionary | | no description |
| | | **airtime-fairness** string | **Choices:*** disable
* enable
| Enable/disable airtime fairness (default = disable). |
| | | **amsdu** string | **Choices:*** disable
* enable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). |
| | | **ap-sniffer-addr** string | | MAC address to monitor. |
| | | **ap-sniffer-bufsize** integer | | Sniffer buffer size (1 - 32 MB, default = 16). |
| | | **ap-sniffer-chan** integer | | Channel on which to operate the sniffer (default = 6). |
| | | **ap-sniffer-ctl** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi control frame (default = enable). |
| | | **ap-sniffer-data** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi data frame (default = enable). |
| | | **ap-sniffer-mgmt-beacon** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management Beacon frames (default = enable). |
| | | **ap-sniffer-mgmt-other** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management other frames (default = enable). |
| | | **ap-sniffer-mgmt-probe** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management probe frames (default = enable). |
| | | **auto-power-high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-level** string | **Choices:*** disable
* enable
| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). |
| | | **auto-power-low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
| | | **band** string | **Choices:*** 802.11b
* 802.11a
* 802.11g
* 802.11n
* 802.11ac
* 802.11n-5G
* 802.11ax-5G
* 802.11ax
* 802.11ac-2G
* 802.11g-only
* 802.11n-only
* 802.11n,g-only
* 802.11ac-only
* 802.11ac,n-only
* 802.11n-5G-only
* 802.11ax-5G-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-only
* 802.11ax,n-only
* 802.11ax,n,g-only
| 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:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the... |
| | | **bandwidth-capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
| | | **beacon-interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor... |
| | | **bss-color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0). |
| | | **call-admission-control** string | **Choices:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca... |
| | | **call-capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
| | | **channel** string | | no description |
| | | **channel-bonding** string | **Choices:*** 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel-utilization** string | **Choices:*** disable
* enable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** disable
* enable
| Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). |
| | | **darrp** string | **Choices:*** disable
* enable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo... |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) (default = disable). |
| | | **drma-sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i... |
| | | **frag-threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
| | | **iperf-protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol (default = "UDP"). |
| | | **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, default = 0). |
| | | **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, default = 100). |
| | | **power-mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag... |
| | | **power-value** integer | | Radio EIRP power in dBm (1 - 33, default = 27). |
| | | **powersave-optimize** list / elements=string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| no description |
| | | **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 | | no description |
| | | **rts-threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt... |
| | | **sam-bssid** string | | BSSID for WiFi network. |
| | | **sam-captive-portal** string | **Choices:*** disable
* enable
| Enable/disable Captive Portal Authentication (default = disable). |
| | | **sam-password** string | | no description |
| | | **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 (default = "wpa-personal"). |
| | | **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 (default = "PING"). |
| | | **sam-username** string | | Username for WiFi network connection. |
| | | **short-guard-interval** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
* scan-only
| no description |
| | | **transmit-optimize** list / elements=string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| no description |
| | | **vap-all** string | **Choices:*** disable
* enable
* tunnel
* bridge
* manual
| Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs). |
| | | **vap1** string | | Virtual Access Point (VAP) for wlan ID 1 |
| | | **vap2** string | | Virtual Access Point (VAP) for wlan ID 2 |
| | | **vap3** string | | Virtual Access Point (VAP) for wlan ID 3 |
| | | **vap4** string | | Virtual Access Point (VAP) for wlan ID 4 |
| | | **vap5** string | | Virtual Access Point (VAP) for wlan ID 5 |
| | | **vap6** string | | Virtual Access Point (VAP) for wlan ID 6 |
| | | **vap7** string | | Virtual Access Point (VAP) for wlan ID 7 |
| | | **vap8** string | | Virtual Access Point (VAP) for wlan ID 8 |
| | | **vaps** string | | Manually selected list of Virtual Access Points (VAPs). |
| | | **wids-profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
| | | **zero-wait-dfs** string | **Choices:*** disable
* enable
| Enable/disable zero wait DFS on radio (default = enable). |
| | **radio-4** dictionary | | no description |
| | | **airtime-fairness** string | **Choices:*** disable
* enable
| Enable/disable airtime fairness (default = disable). |
| | | **amsdu** string | **Choices:*** disable
* enable
| Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). |
| | | **ap-sniffer-addr** string | | MAC address to monitor. |
| | | **ap-sniffer-bufsize** integer | | Sniffer buffer size (1 - 32 MB, default = 16). |
| | | **ap-sniffer-chan** integer | | Channel on which to operate the sniffer (default = 6). |
| | | **ap-sniffer-ctl** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi control frame (default = enable). |
| | | **ap-sniffer-data** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi data frame (default = enable). |
| | | **ap-sniffer-mgmt-beacon** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management Beacon frames (default = enable). |
| | | **ap-sniffer-mgmt-other** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management other frames (default = enable). |
| | | **ap-sniffer-mgmt-probe** string | **Choices:*** disable
* enable
| Enable/disable sniffer on WiFi management probe frames (default = enable). |
| | | **auto-power-high** integer | | The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-level** string | **Choices:*** disable
* enable
| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). |
| | | **auto-power-low** integer | | The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl... |
| | | **auto-power-target** string | | The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
| | | **band** string | **Choices:*** 802.11b
* 802.11a
* 802.11g
* 802.11n
* 802.11ac
* 802.11n-5G
* 802.11ax-5G
* 802.11ax
* 802.11ac-2G
* 802.11g-only
* 802.11n-only
* 802.11n,g-only
* 802.11ac-only
* 802.11ac,n-only
* 802.11n-5G-only
* 802.11ax-5G-only
* 802.11ax,ac-only
* 802.11ax,ac,n-only
* 802.11ax-only
* 802.11ax,n-only
* 802.11ax,n,g-only
| 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:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the... |
| | | **bandwidth-capacity** integer | | Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
| | | **beacon-interval** integer | | Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor... |
| | | **bss-color** integer | | BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0). |
| | | **call-admission-control** string | **Choices:*** disable
* enable
| Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca... |
| | | **call-capacity** integer | | Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
| | | **channel** string | | no description |
| | | **channel-bonding** string | **Choices:*** 80MHz
* 40MHz
* 20MHz
* 160MHz
| Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. |
| | | **channel-utilization** string | **Choices:*** disable
* enable
| Enable/disable measuring channel utilization. |
| | | **coexistence** string | **Choices:*** disable
* enable
| Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). |
| | | **darrp** string | **Choices:*** disable
* enable
| Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo... |
| | | **drma** string | **Choices:*** disable
* enable
| Enable/disable dynamic radio mode assignment (DRMA) (default = disable). |
| | | **drma-sensitivity** string | **Choices:*** low
* medium
* high
| Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). |
| | | **dtim** integer | | Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i... |
| | | **frag-threshold** integer | | Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
| | | **iperf-protocol** string | **Choices:*** udp
* tcp
| Iperf test protocol (default = "UDP"). |
| | | **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, default = 0). |
| | | **mode** string | **Choices:*** ap
* monitor
* sniffer
* disabled
* 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, default = 100). |
| | | **power-mode** string | **Choices:*** dBm
* percentage
| Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag... |
| | | **power-value** integer | | Radio EIRP power in dBm (1 - 33, default = 27). |
| | | **powersave-optimize** list / elements=string | **Choices:*** tim
* ac-vo
* no-obss-scan
* no-11b-rate
* client-rate-follow
| no description |
| | | **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 | | no description |
| | | **rts-threshold** integer | | Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt... |
| | | **sam-bssid** string | | BSSID for WiFi network. |
| | | **sam-captive-portal** string | **Choices:*** disable
* enable
| Enable/disable Captive Portal Authentication (default = disable). |
| | | **sam-password** string | | no description |
| | | **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 (default = "wpa-personal"). |
| | | **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 (default = "PING"). |
| | | **sam-username** string | | Username for WiFi network connection. |
| | | **short-guard-interval** string | **Choices:*** disable
* enable
| 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:*** disable
* enable
* scan-only
| no description |
| | | **transmit-optimize** list / elements=string | **Choices:*** disable
* power-save
* aggr-limit
* retry-limit
* send-bar
| no description |
| | | **vap-all** string | **Choices:*** disable
* enable
* tunnel
* bridge
* manual
| Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs). |
| | | **vap1** string | | Virtual Access Point (VAP) for wlan ID 1 |
| | | **vap2** string | | Virtual Access Point (VAP) for wlan ID 2 |
| | | **vap3** string | | Virtual Access Point (VAP) for wlan ID 3 |
| | | **vap4** string | | Virtual Access Point (VAP) for wlan ID 4 |
| | | **vap5** string | | Virtual Access Point (VAP) for wlan ID 5 |
| | | **vap6** string | | Virtual Access Point (VAP) for wlan ID 6 |
| | | **vap7** string | | Virtual Access Point (VAP) for wlan ID 7 |
| | | **vap8** string | | Virtual Access Point (VAP) for wlan ID 8 |
| | | **vaps** string | | Manually selected list of Virtual Access Points (VAPs). |
| | | **wids-profile** string | | Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
| | | **zero-wait-dfs** string | **Choices:*** disable
* enable
| Enable/disable zero wait DFS on radio (default = enable). |
| | **snmp** string | **Choices:*** disable
* enable
| Enable/disable SNMP for the WTP, FortiAP, or AP (default = disable). |
| | **split-tunneling-acl** list / elements=string | | no description |
| | | **dest-ip** string | | Destination IP and mask for the split-tunneling subnet. |
| | | **id** integer | | ID. |
| | **split-tunneling-acl-local-ap-subnet** string | **Choices:*** disable
* enable
| Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL (default = disable). |
| | **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, default = 0). |
| | **tun-mtu-uplink** integer | | Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). |
| | **wan-port-mode** string | **Choices:*** wan-lan
* wan-only
| Enable/disable using a WAN port as a LAN port. |
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 WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fmgr_wtpprofile:
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]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap-country: <value in [AL, DZ, AR, ...]>
ble-profile: <value of string>
comment: <value of string>
control-message-offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
- spectral-analysis
deny-mac-list:
-
id: <value of integer>
mac: <value of string>
dtls-in-kernel: <value in [disable, enable]>
dtls-policy:
- clear-text
- dtls-enabled
- ipsec-vpn
energy-efficient-ethernet: <value in [disable, enable]>
ext-info-enable: <value in [disable, enable]>
handoff-roaming: <value in [disable, enable]>
handoff-rssi: <value of integer>
handoff-sta-thresh: <value of integer>
ip-fragment-preventing:
- tcp-mss-adjust
- icmp-unreachable
led-schedules: <value of string>
led-state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login-passwd: <value of string>
login-passwd-change: <value in [no, yes, default]>
max-clients: <value of integer>
name: <value of string>
poe-mode: <value in [auto, 8023af, 8023at, ...]>
split-tunneling-acl:
-
dest-ip: <value of string>
id: <value of integer>
split-tunneling-acl-local-ap-subnet: <value in [disable, enable]>
split-tunneling-acl-path: <value in [tunnel, local]>
tun-mtu-downlink: <value of integer>
tun-mtu-uplink: <value of integer>
wan-port-mode: <value in [wan-lan, wan-only]>
snmp: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
apcfg-profile: <value of string>
frequency-handoff: <value in [disable, enable]>
lan:
port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-esl-ssid: <value of string>
port-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-ssid: <value of string>
port1-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1-ssid: <value of string>
port2-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2-ssid: <value of string>
port3-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3-ssid: <value of string>
port4-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4-ssid: <value of string>
port5-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5-ssid: <value of string>
port6-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6-ssid: <value of string>
port7-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7-ssid: <value of string>
port8-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8-ssid: <value of string>
lbs:
aeroscout: <value in [disable, enable]>
aeroscout-ap-mac: <value in [bssid, board-mac]>
aeroscout-mmu-report: <value in [disable, enable]>
aeroscout-mu: <value in [disable, enable]>
aeroscout-mu-factor: <value of integer>
aeroscout-mu-timeout: <value of integer>
aeroscout-server-ip: <value of string>
aeroscout-server-port: <value of integer>
ekahau-blink-mode: <value in [disable, enable]>
ekahau-tag: <value of string>
erc-server-ip: <value of string>
erc-server-port: <value of integer>
fortipresence: <value in [disable, enable, enable2, ...]>
fortipresence-ble: <value in [disable, enable]>
fortipresence-frequency: <value of integer>
fortipresence-port: <value of integer>
fortipresence-project: <value of string>
fortipresence-rogue: <value in [disable, enable]>
fortipresence-secret: <value of string>
fortipresence-server: <value of string>
fortipresence-unassoc: <value in [disable, enable]>
station-locate: <value in [disable, enable]>
platform:
ddscan: <value in [disable, enable]>
mode: <value in [dual-5G, single-5G]>
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
_local_platform_str: <value of string>
radio-1:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
auto-power-target: <value of string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
bss-color: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <value of integer>
frag-threshold: <value of integer>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
vaps: <value of string>
wids-profile: <value of string>
zero-wait-dfs: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-username: <value of string>
radio-2:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
auto-power-target: <value of string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
bss-color: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <value of integer>
frag-threshold: <value of integer>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
vaps: <value of string>
wids-profile: <value of string>
zero-wait-dfs: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-username: <value of string>
radio-3:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
auto-power-target: <value of string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
bss-color: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <value of integer>
frag-threshold: <value of integer>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
vaps: <value of string>
wids-profile: <value of string>
zero-wait-dfs: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-username: <value of string>
radio-4:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
auto-power-target: <value of string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
bss-color: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <value of integer>
frag-threshold: <value of integer>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [ap, monitor, sniffer, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
vaps: <value of string>
wids-profile: <value of string>
zero-wait-dfs: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-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_emailfilter_options – Configure AntiSpam options. fortinet.fortimanager.fmgr\_emailfilter\_options – Configure AntiSpam 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_emailfilter_options`.
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\_options** dictionary | | the top level parameters set |
| | **dns-timeout** integer | | DNS query time out (1 - 30 sec). |
| **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 options.
fmgr_emailfilter_options:
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>
emailfilter_options:
dns-timeout: <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_firewall_gtp_ievalidation – IE validation. fortinet.fortimanager.fmgr\_firewall\_gtp\_ievalidation – IE validation.
========================================================================
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_ievalidation`.
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\_ievalidation** dictionary | | the top level parameters set |
| | **apn-restriction** string | **Choices:*** disable
* enable
| Validate APN restriction. |
| | **charging-gateway-addr** string | **Choices:*** disable
* enable
| Validate charging gateway address. |
| | **charging-ID** string | **Choices:*** disable
* enable
| Validate charging ID. |
| | **end-user-addr** string | **Choices:*** disable
* enable
| Validate end user address. |
| | **gsn-addr** string | **Choices:*** disable
* enable
| Validate GSN address. |
| | **imei** string | **Choices:*** disable
* enable
| Validate IMEI(SV). |
| | **imsi** string | **Choices:*** disable
* enable
| Validate IMSI. |
| | **mm-context** string | **Choices:*** disable
* enable
| Validate MM context. |
| | **ms-tzone** string | **Choices:*** disable
* enable
| Validate MS time zone. |
| | **ms-validated** string | **Choices:*** disable
* enable
| Validate MS validated. |
| | **msisdn** string | **Choices:*** disable
* enable
| Validate MSISDN. |
| | **nsapi** string | **Choices:*** disable
* enable
| Validate NSAPI. |
| | **pdp-context** string | **Choices:*** disable
* enable
| Validate PDP context. |
| | **qos-profile** string | **Choices:*** disable
* enable
| Validate Quality of Service(QoS) profile. |
| | **rai** string | **Choices:*** disable
* enable
| Validate RAI. |
| | **rat-type** string | **Choices:*** disable
* enable
| Validate RAT type. |
| | **reordering-required** string | **Choices:*** disable
* enable
| Validate re-ordering required. |
| | **selection-mode** string | **Choices:*** disable
* enable
| Validate selection mode. |
| | **uli** string | **Choices:*** disable
* enable
| Validate user location information. |
| **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 validation.
fmgr_firewall_gtp_ievalidation:
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>
firewall_gtp_ievalidation:
apn-restriction: <value in [disable, enable]>
charging-ID: <value in [disable, enable]>
charging-gateway-addr: <value in [disable, enable]>
end-user-addr: <value in [disable, enable]>
gsn-addr: <value in [disable, enable]>
imei: <value in [disable, enable]>
imsi: <value in [disable, enable]>
mm-context: <value in [disable, enable]>
ms-tzone: <value in [disable, enable]>
ms-validated: <value in [disable, enable]>
msisdn: <value in [disable, enable]>
nsapi: <value in [disable, enable]>
pdp-context: <value in [disable, enable]>
qos-profile: <value in [disable, enable]>
rai: <value in [disable, enable]>
rat-type: <value in [disable, enable]>
reordering-required: <value in [disable, enable]>
selection-mode: <value in [disable, enable]>
uli: <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_user_radius – Configure RADIUS server entries. fortinet.fortimanager.fmgr\_user\_radius – Configure RADIUS server 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_user_radius`.
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\_radius** dictionary | | the top level parameters set |
| | **accounting-server** list / elements=string | | no description |
| | | **id** integer | | ID (0 - 4294967295). |
| | | **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. |
| | | **port** integer | | RADIUS accounting port number. |
| | | **secret** string | | no description |
| | | **server** string | | {<name\_str|ip\_str>} Server CN domain name or IP. |
| | | **source-ip** string | | Source IP address for communications to the RADIUS server. |
| | | **status** string | **Choices:*** disable
* enable
| Status. |
| | **acct-all-servers** string | **Choices:*** disable
* enable
| Enable/disable sending of accounting messages to all configured servers (default = disable). |
| | **acct-interim-interval** integer | | Time in seconds between each accounting interim update message. |
| | **all-usergroup** string | **Choices:*** disable
* enable
| Enable/disable automatically including this RADIUS server in all user groups. |
| | **auth-type** string | **Choices:*** pap
* chap
* ms\_chap
* ms\_chap\_v2
* auto
| Authentication methods/protocols permitted for this RADIUS server. |
| | **class** string | | no description |
| | **dynamic\_mapping** list / elements=string | | no description |
| | | **\_scope** list / elements=string | | no description |
| | | | **name** string | | no description |
| | | | **vdom** string | | no description |
| | | **accounting-server** list / elements=string | | no description |
| | | | **id** integer | | no description |
| | | | **interface** string | | no description |
| | | | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | | | **port** integer | | no description |
| | | | **secret** string | | no description |
| | | | **server** string | | no description |
| | | | **source-ip** string | | no description |
| | | | **status** string | **Choices:*** disable
* enable
| no description |
| | | **acct-all-servers** string | **Choices:*** disable
* enable
| no description |
| | | **acct-interim-interval** integer | | no description |
| | | **all-usergroup** string | **Choices:*** disable
* enable
| no description |
| | | **auth-type** string | **Choices:*** pap
* chap
* ms\_chap
* ms\_chap\_v2
* auto
| no description |
| | | **class** string | | no description |
| | | **dp-carrier-endpoint-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
| no description |
| | | **dp-carrier-endpoint-block-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
| no description |
| | | **dp-context-timeout** integer | | no description |
| | | **dp-flush-ip-session** string | **Choices:*** disable
* enable
| no description |
| | | **dp-hold-time** integer | | no description |
| | | **dp-http-header** string | | no description |
| | | **dp-http-header-fallback** string | **Choices:*** ip-header-address
* default-profile
| no description |
| | | **dp-http-header-status** string | **Choices:*** disable
* enable
| no description |
| | | **dp-http-header-suppress** string | **Choices:*** disable
* enable
| no description |
| | | **dp-log-dyn\_flags** list / elements=string | **Choices:*** none
* protocol-error
* profile-missing
* context-missing
* accounting-stop-missed
* accounting-event
* radiusd-other
* endpoint-block
| no description |
| | | **dp-log-period** integer | | no description |
| | | **dp-mem-percent** integer | | no description |
| | | **dp-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
| no description |
| | | **dp-profile-attribute-key** string | | no description |
| | | **dp-radius-response** string | **Choices:*** disable
* enable
| no description |
| | | **dp-radius-server-port** integer | | no description |
| | | **dp-secret** string | | no description |
| | | **dp-validate-request-secret** string | **Choices:*** disable
* enable
| no description |
| | | **dynamic-profile** string | **Choices:*** disable
* enable
| no description |
| | | **endpoint-translation** string | **Choices:*** disable
* enable
| no description |
| | | **ep-carrier-endpoint-convert-hex** string | **Choices:*** disable
* enable
| no description |
| | | **ep-carrier-endpoint-header** string | | no description |
| | | **ep-carrier-endpoint-header-suppress** string | **Choices:*** disable
* enable
| no description |
| | | **ep-carrier-endpoint-prefix** string | **Choices:*** disable
* enable
| no description |
| | | **ep-carrier-endpoint-prefix-range-max** integer | | no description |
| | | **ep-carrier-endpoint-prefix-range-min** integer | | no description |
| | | **ep-carrier-endpoint-prefix-string** string | | no description |
| | | **ep-carrier-endpoint-source** string | **Choices:*** http-header
* cookie
| no description |
| | | **ep-ip-header** string | | no description |
| | | **ep-ip-header-suppress** string | **Choices:*** disable
* enable
| no description |
| | | **ep-missing-header-fallback** string | **Choices:*** session-ip
* policy-profile
| no description |
| | | **ep-profile-query-type** string | **Choices:*** session-ip
* extract-ip
* extract-carrier-endpoint
| no description |
| | | **group-override-attr-type** string | **Choices:*** filter-Id
* class
| no description |
| | | **h3c-compatibility** string | **Choices:*** disable
* enable
| no description |
| | | **interface** string | | no description |
| | | **interface-select-method** string | **Choices:*** auto
* sdwan
* specify
| no description |
| | | **nas-ip** string | | no description |
| | | **password-encoding** string | **Choices:*** ISO-8859-1
* auto
| no description |
| | | **password-renewal** string | **Choices:*** disable
* enable
| no description |
| | | **radius-coa** string | **Choices:*** disable
* enable
| no description |
| | | **radius-port** integer | | no description |
| | | **rsso** string | **Choices:*** disable
* enable
| no description |
| | | **rsso-context-timeout** integer | | no description |
| | | **rsso-endpoint-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
* 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
| no description |
| | | **rsso-endpoint-block-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
* 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
| no description |
| | | **rsso-ep-one-ip-only** string | **Choices:*** disable
* enable
| no description |
| | | **rsso-flush-ip-session** string | **Choices:*** disable
* enable
| no description |
| | | **rsso-log-flags** list / elements=string | **Choices:*** none
* protocol-error
* profile-missing
* context-missing
* accounting-stop-missed
* accounting-event
* radiusd-other
* endpoint-block
| no description |
| | | **rsso-log-period** integer | | no description |
| | | **rsso-radius-response** string | **Choices:*** disable
* enable
| no description |
| | | **rsso-radius-server-port** integer | | no description |
| | | **rsso-secret** string | | no description |
| | | **rsso-validate-request-secret** string | **Choices:*** disable
* enable
| no description |
| | | **secondary-secret** string | | no description |
| | | **secondary-server** string | | no description |
| | | **secret** string | | no description |
| | | **server** string | | no description |
| | | **source-ip** string | | no description |
| | | **sso-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
* 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
| no description |
| | | **sso-attribute-key** string | | no description |
| | | **sso-attribute-value-override** string | **Choices:*** disable
* enable
| no description |
| | | **switch-controller-acct-fast-framedip-detect** integer | | no description |
| | | **switch-controller-service-type** list / elements=string | **Choices:*** login
* framed
* callback-login
* callback-framed
* outbound
* administrative
* nas-prompt
* authenticate-only
* callback-nas-prompt
* call-check
* callback-administrative
| no description |
| | | **tertiary-secret** string | | no description |
| | | **tertiary-server** string | | no description |
| | | **timeout** integer | | no description |
| | | **use-group-for-profile** string | **Choices:*** disable
* enable
| no description |
| | | **use-management-vdom** string | **Choices:*** disable
* enable
| no description |
| | | **username-case-sensitive** string | **Choices:*** disable
* enable
| no description |
| | **group-override-attr-type** string | **Choices:*** filter-Id
* class
| RADIUS attribute type to override user group information. |
| | **h3c-compatibility** string | **Choices:*** disable
* enable
| Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication. |
| | **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. |
| | **name** string | | RADIUS server entry name. |
| | **nas-ip** string | | IP address used to communicate with the RADIUS server and used as NAS-IP-Address and Called-Station-ID attributes. |
| | **password-encoding** string | **Choices:*** ISO-8859-1
* auto
| Password encoding. |
| | **password-renewal** string | **Choices:*** disable
* enable
| Enable/disable password renewal. |
| | **radius-coa** string | **Choices:*** disable
* enable
| Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is a... |
| | **radius-port** integer | | RADIUS service port number. |
| | **rsso** string | **Choices:*** disable
* enable
| Enable/disable RADIUS based single sign on feature. |
| | **rsso-context-timeout** integer | | Time in seconds before the logged out user is removed from the "user context list" of logged on users. |
| | **rsso-endpoint-attribute** string | **Choices:*** User-Name
* 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
* 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
| RADIUS attributes used to extract the user end point identifer from the RADIUS Start record. |
| | **rsso-endpoint-block-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
* 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
| RADIUS attributes used to block a user. |
| | **rsso-ep-one-ip-only** string | **Choices:*** disable
* enable
| Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages. |
| | **rsso-flush-ip-session** string | **Choices:*** disable
* enable
| Enable/disable flushing user IP sessions on RADIUS accounting Stop messages. |
| | **rsso-log-flags** list / elements=string | **Choices:*** none
* protocol-error
* profile-missing
* context-missing
* accounting-stop-missed
* accounting-event
* radiusd-other
* endpoint-block
| no description |
| | **rsso-log-period** integer | | Time interval in seconds that group event log messages will be generated for dynamic profile events. |
| | **rsso-radius-response** string | **Choices:*** disable
* enable
| Enable/disable sending RADIUS response packets after receiving Start and Stop records. |
| | **rsso-radius-server-port** integer | | UDP port to listen on for RADIUS Start and Stop records. |
| | **rsso-secret** string | | no description |
| | **rsso-validate-request-secret** string | **Choices:*** disable
* enable
| Enable/disable validating the RADIUS request shared secret in the Start or End record. |
| | **secondary-secret** string | | no description |
| | **secondary-server** string | | {<name\_str|ip\_str>} secondary RADIUS CN domain name or IP. |
| | **secret** string | | no description |
| | **server** string | | Primary RADIUS server CN domain name or IP address. |
| | **source-ip** string | | Source IP address for communications to the RADIUS server. |
| | **sso-attribute** string | **Choices:*** User-Name
* 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
* 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
| RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record. |
| | **sso-attribute-key** string | | Key prefix for SSO group value in the SSO attribute. |
| | **sso-attribute-value-override** string | **Choices:*** disable
* enable
| Enable/disable override old attribute value with new value for the same endpoint. |
| | **switch-controller-acct-fast-framedip-detect** integer | | Switch controller accounting message Framed-IP detection from DHCP snooping (seconds, default=2). |
| | **switch-controller-service-type** list / elements=string | **Choices:*** login
* framed
* callback-login
* callback-framed
* outbound
* administrative
* nas-prompt
* authenticate-only
* callback-nas-prompt
* call-check
* callback-administrative
| no description |
| | **tertiary-secret** string | | no description |
| | **tertiary-server** string | | {<name\_str|ip\_str>} tertiary RADIUS CN domain name or IP. |
| | **timeout** integer | | Time in seconds between re-sending authentication requests. |
| | **use-management-vdom** string | **Choices:*** disable
* enable
| Enable/disable using management VDOM to send requests. |
| | **username-case-sensitive** string | **Choices:*** disable
* enable
| Enable/disable case sensitive user 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: Configure RADIUS server entries.
fmgr_user_radius:
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_radius:
accounting-server:
-
id: <value of integer>
port: <value of integer>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
status: <value in [disable, enable]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
acct-all-servers: <value in [disable, enable]>
acct-interim-interval: <value of integer>
all-usergroup: <value in [disable, enable]>
auth-type: <value in [pap, chap, ms_chap, ...]>
class: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
acct-all-servers: <value in [disable, enable]>
acct-interim-interval: <value of integer>
all-usergroup: <value in [disable, enable]>
auth-type: <value in [pap, chap, ms_chap, ...]>
class: <value of string>
dp-carrier-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-carrier-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-context-timeout: <value of integer>
dp-flush-ip-session: <value in [disable, enable]>
dp-hold-time: <value of integer>
dp-http-header: <value of string>
dp-http-header-fallback: <value in [ip-header-address, default-profile]>
dp-http-header-status: <value in [disable, enable]>
dp-http-header-suppress: <value in [disable, enable]>
dp-log-dyn_flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
dp-log-period: <value of integer>
dp-mem-percent: <value of integer>
dp-profile-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-profile-attribute-key: <value of string>
dp-radius-response: <value in [disable, enable]>
dp-radius-server-port: <value of integer>
dp-secret: <value of string>
dp-validate-request-secret: <value in [disable, enable]>
dynamic-profile: <value in [disable, enable]>
endpoint-translation: <value in [disable, enable]>
ep-carrier-endpoint-convert-hex: <value in [disable, enable]>
ep-carrier-endpoint-header: <value of string>
ep-carrier-endpoint-header-suppress: <value in [disable, enable]>
ep-carrier-endpoint-prefix: <value in [disable, enable]>
ep-carrier-endpoint-prefix-range-max: <value of integer>
ep-carrier-endpoint-prefix-range-min: <value of integer>
ep-carrier-endpoint-prefix-string: <value of string>
ep-carrier-endpoint-source: <value in [http-header, cookie]>
ep-ip-header: <value of string>
ep-ip-header-suppress: <value in [disable, enable]>
ep-missing-header-fallback: <value in [session-ip, policy-profile]>
ep-profile-query-type: <value in [session-ip, extract-ip, extract-carrier-endpoint]>
h3c-compatibility: <value in [disable, enable]>
nas-ip: <value of string>
password-encoding: <value in [ISO-8859-1, auto]>
password-renewal: <value in [disable, enable]>
radius-coa: <value in [disable, enable]>
radius-port: <value of integer>
rsso: <value in [disable, enable]>
rsso-context-timeout: <value of integer>
rsso-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-ep-one-ip-only: <value in [disable, enable]>
rsso-flush-ip-session: <value in [disable, enable]>
rsso-log-flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
rsso-log-period: <value of integer>
rsso-radius-response: <value in [disable, enable]>
rsso-radius-server-port: <value of integer>
rsso-secret: <value of string>
rsso-validate-request-secret: <value in [disable, enable]>
secondary-secret: <value of string>
secondary-server: <value of string>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
sso-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
sso-attribute-key: <value of string>
sso-attribute-value-override: <value in [disable, enable]>
tertiary-secret: <value of string>
tertiary-server: <value of string>
timeout: <value of integer>
use-group-for-profile: <value in [disable, enable]>
use-management-vdom: <value in [disable, enable]>
username-case-sensitive: <value in [disable, enable]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
group-override-attr-type: <value in [filter-Id, class]>
switch-controller-acct-fast-framedip-detect: <value of integer>
accounting-server:
-
id: <value of integer>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
port: <value of integer>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
status: <value in [disable, enable]>
switch-controller-service-type:
- login
- framed
- callback-login
- callback-framed
- outbound
- administrative
- nas-prompt
- authenticate-only
- callback-nas-prompt
- call-check
- callback-administrative
h3c-compatibility: <value in [disable, enable]>
name: <value of string>
nas-ip: <value of string>
password-encoding: <value in [ISO-8859-1, auto]>
password-renewal: <value in [disable, enable]>
radius-coa: <value in [disable, enable]>
radius-port: <value of integer>
rsso: <value in [disable, enable]>
rsso-context-timeout: <value of integer>
rsso-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-ep-one-ip-only: <value in [disable, enable]>
rsso-flush-ip-session: <value in [disable, enable]>
rsso-log-flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
rsso-log-period: <value of integer>
rsso-radius-response: <value in [disable, enable]>
rsso-radius-server-port: <value of integer>
rsso-secret: <value of string>
rsso-validate-request-secret: <value in [disable, enable]>
secondary-secret: <value of string>
secondary-server: <value of string>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
sso-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
sso-attribute-key: <value of string>
sso-attribute-value-override: <value in [disable, enable]>
tertiary-secret: <value of string>
tertiary-server: <value of string>
timeout: <value of integer>
use-management-vdom: <value in [disable, enable]>
username-case-sensitive: <value in [disable, enable]>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
group-override-attr-type: <value in [filter-Id, class]>
switch-controller-acct-fast-framedip-detect: <value of integer>
switch-controller-service-type:
- login
- framed
- callback-login
- callback-framed
- outbound
- administrative
- nas-prompt
- authenticate-only
- callback-nas-prompt
- call-check
- callback-administrative
```
Return Values
-------------
Common return 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_fdssetting_serveroverride_servlist – Override server. fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_serveroverride\_servlist – Override 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_fmupdate_fdssetting_serveroverride_servlist`.
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\_serveroverride\_servlist** dictionary | | the top level parameters set |
| | **id** integer | **Default:**0 | Override server ID (1 - 10). |
| | **ip** string | **Default:**"0.0.0.0" | IPv4 address of the override server. |
| | **ip6** string | **Default:**"::" | IPv6 address of the override server. |
| | **port** integer | **Default:**443 | Port number to use when contacting FortiGuard (1 - 65535, default = 443). |
| | **service-type** list / elements=string | **Choices:*** fds
* fct
| 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: Override server.
fmgr_fmupdate_fdssetting_serveroverride_servlist:
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]>
fmupdate_fdssetting_serveroverride_servlist:
id: <value of integer>
ip: <value of string>
ip6: <value of string>
port: <value of integer>
service-type:
- fds
- fct
```
Return Values
-------------
Common return 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_realservers – Select the SSL real servers that this Access Proxy will distribute traffic to. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_realservers – Select the SSL real servers that this Access Proxy will distribute traffic to.
===============================================================================================================================================
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_realservers`.
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\_realservers** dictionary | | the top level parameters set |
| | **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 sent. |
| | **weight** integer | | Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
| **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: Select the SSL real servers that this Access Proxy will distribute traffic to.
fmgr_firewall_accessproxy_realservers:
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_realservers:
id: <value of integer>
ip: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
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_firewall_wildcardfqdn_group – Config global Wildcard FQDN address groups. fortinet.fortimanager.fmgr\_firewall\_wildcardfqdn\_group – Config global Wildcard FQDN 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_wildcardfqdn_group`.
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\_wildcardfqdn\_group** dictionary | | the top level parameters set |
| | **color** integer | | GUI icon color. |
| | **comment** string | | Comment. |
| | **member** string | | Address group members. |
| | **name** string | | Address group name. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **visibility** string | **Choices:*** disable
* enable
| Enable/disable address visibility. |
| **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 global Wildcard FQDN address groups.
fmgr_firewall_wildcardfqdn_group:
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_wildcardfqdn_group:
color: <value of integer>
comment: <value of string>
member: <value of string>
name: <value of string>
uuid: <value of string>
visibility: <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_pkg_firewall_policy6 – Configure IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy6 – Configure IPv6 policies.
=============================================================================
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_policy6`.
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\_policy6** dictionary | | the top level parameters set |
| | **action** string | **Choices:*** deny
* accept
* ipsec
* ssl-vpn
| Policy action (allow/deny/ipsec). |
| | **anti-replay** string | **Choices:*** disable
* enable
| Enable/disable anti-replay check. |
| | **app-category** string | | Application category ID list. |
| | **app-group** string | | Application group names. |
| | **application** integer | | no description |
| | **application-list** string | | Name of an existing Application list. |
| | **auto-asic-offload** string | **Choices:*** disable
* enable
| Enable/disable policy traffic ASIC offloading. |
| | **av-profile** string | | Name of an existing Antivirus profile. |
| | **cifs-profile** string | | Name of an existing CIFS profile. |
| | **comments** string | | Comment. |
| | **custom-log-fields** string | | Log field index numbers to append custom log fields to log messages for this policy. |
| | **decrypted-traffic-mirror** string | | Decrypted traffic mirror. |
| | **devices** string | | Names of devices or device groups that can be matched by the policy. |
| | **diffserv-forward** string | **Choices:*** disable
* enable
| Enable to change packets DiffServ values to the specified diffservcode-forward value. |
| | **diffserv-reverse** string | **Choices:*** disable
* enable
| Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. |
| | **diffservcode-forward** string | | Change packets DiffServ to this value. |
| | **diffservcode-rev** string | | Change packets reverse (reply) DiffServ to this value. |
| | **dlp-sensor** string | | Name of an existing DLP sensor. |
| | **dnsfilter-profile** string | | Name of an existing DNS filter profile. |
| | **dscp-match** string | **Choices:*** disable
* enable
| Enable DSCP check. |
| | **dscp-negate** string | **Choices:*** disable
* enable
| Enable negated DSCP match. |
| | **dscp-value** string | | DSCP value. |
| | **dsri** string | **Choices:*** disable
* enable
| Enable DSRI to ignore HTTP server responses. |
| | **dstaddr** string | | Destination address and address group names. |
| | **dstaddr-negate** string | **Choices:*** disable
* enable
| When enabled dstaddr specifies what the destination address must NOT be. |
| | **dstintf** string | | Outgoing (egress) interface. |
| | **emailfilter-profile** string | | Name of an existing email filter profile. |
| | **firewall-session-dirty** string | **Choices:*** check-all
* check-new
| How to handle sessions if the configuration of this firewall policy changes. |
| | **fixedport** string | **Choices:*** disable
* enable
| Enable to prevent source NAT from changing a sessions source port. |
| | **fsso-groups** string | | Names of FSSO groups. |
| | **global-label** string | | Label for the policy that appears when the GUI is in Global View mode. |
| | **groups** string | | Names of user groups that can authenticate with this policy. |
| | **http-policy-redirect** string | **Choices:*** disable
* enable
| Redirect HTTP(S) traffic to matching transparent web proxy policy. |
| | **icap-profile** string | | Name of an existing ICAP profile. |
| | **inbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. |
| | **inspection-mode** string | **Choices:*** proxy
* flow
| Policy inspection mode (Flow/proxy). Default is Flow mode. |
| | **ippool** string | **Choices:*** disable
* enable
| Enable to use IP Pools for source NAT. |
| | **ips-sensor** string | | Name of an existing IPS sensor. |
| | **label** string | | Label for the policy that appears when the GUI is in Section View mode. |
| | **logtraffic** string | **Choices:*** disable
* enable
* all
* utm
| Enable or disable logging. Log all sessions or security profile sessions. |
| | **logtraffic-start** string | **Choices:*** disable
* enable
| Record logs when a session starts and ends. |
| | **mms-profile** string | | Name of an existing MMS profile. |
| | **name** string | | Policy name. |
| | **nat** string | **Choices:*** disable
* enable
| Enable/disable source NAT. |
| | **natinbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: apply destination NAT to inbound traffic. |
| | **natoutbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: apply source NAT to outbound traffic. |
| | **np-accelation** string | **Choices:*** disable
* enable
| Enable/disable UTM Network Processor acceleration. |
| | **np-acceleration** string | **Choices:*** disable
* enable
| Enable/disable UTM Network Processor acceleration. |
| | **outbound** string | **Choices:*** disable
* enable
| Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. |
| | **per-ip-shaper** string | | Per-IP traffic shaper. |
| | **policyid** integer | | Policy ID. |
| | **poolname** string | | IP Pool names. |
| | **profile-group** string | | Name of profile group. |
| | **profile-protocol-options** string | | Name of an existing Protocol options profile. |
| | **profile-type** string | **Choices:*** single
* group
| Determine whether the firewall policy allows security profile groups or single profiles only. |
| | **replacemsg-override-group** string | | Override the default replacement message group for this policy. |
| | **rsso** string | **Choices:*** disable
* enable
| Enable/disable RADIUS single sign-on (RSSO). |
| | **schedule** string | | Schedule name. |
| | **send-deny-packet** string | **Choices:*** disable
* enable
| Enable/disable return of deny-packet. |
| | **service** string | | Service and service group names. |
| | **service-negate** string | **Choices:*** disable
* enable
| When enabled service specifies what the service must NOT be. |
| | **session-ttl** integer | | Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. |
| | **spamfilter-profile** string | | Name of an existing Spam filter profile. |
| | **srcaddr** string | | Source address and address group names. |
| | **srcaddr-negate** string | **Choices:*** disable
* enable
| When enabled srcaddr specifies what the source address must NOT be. |
| | **srcintf** string | | Incoming (ingress) interface. |
| | **ssh-filter-profile** string | | Name of an existing SSH filter profile. |
| | **ssh-policy-redirect** string | **Choices:*** disable
* enable
| Redirect SSH traffic to matching transparent proxy policy. |
| | **ssl-mirror** string | **Choices:*** disable
* enable
| Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). |
| | **ssl-mirror-intf** string | | SSL mirror interface name. |
| | **ssl-ssh-profile** string | | Name of an existing SSL SSH profile. |
| | **status** string | **Choices:*** disable
* enable
| Enable or disable this policy. |
| | **tags** string | | Names of object-tags applied to this policy. |
| | **tcp-mss-receiver** integer | | Receiver TCP maximum segment size (MSS). |
| | **tcp-mss-sender** integer | | Sender TCP maximum segment size (MSS). |
| | **tcp-session-without-syn** string | **Choices:*** all
* data-only
* disable
| Enable/disable creation of TCP session without SYN flag. |
| | **timeout-send-rst** string | **Choices:*** disable
* enable
| Enable/disable sending RST packets when TCP sessions expire. |
| | **tos** string | | ToS (Type of Service) value used for comparison. |
| | **tos-mask** string | | Non-zero bit positions are used for comparison while zero bit positions are ignored. |
| | **tos-negate** string | **Choices:*** disable
* enable
| Enable negated TOS match. |
| | **traffic-shaper** string | | Reverse traffic shaper. |
| | **traffic-shaper-reverse** string | | Reverse traffic shaper. |
| | **url-category** string | | URL category ID list. |
| | **users** string | | Names of individual users that can authenticate with this policy. |
| | **utm-status** string | **Choices:*** disable
* enable
| Enable AV/web/ips protection profile. |
| | **uuid** string | | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
| | **vlan-cos-fwd** integer | | VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest |
| | **vlan-cos-rev** integer | | VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest |
| | **vlan-filter** string | | Set VLAN filters. |
| | **voip-profile** string | | Name of an existing VoIP profile. |
| | **vpntunnel** string | | Policy-based IPsec VPN: name of the IPsec VPN Phase 1. |
| | **waf-profile** string | | Name of an existing Web application firewall profile. |
| | **webcache** string | **Choices:*** disable
* enable
| 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. |
| | **webproxy-forward-server** string | | Web proxy forward server name. |
| | **webproxy-profile** string | | Webproxy profile 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 IPv6 policies.
fmgr_pkg_firewall_policy6:
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>
state: <value in [present, absent]>
pkg_firewall_policy6:
action: <value in [deny, accept, ipsec, ...]>
app-category: <value of string>
application: <value of integer>
application-list: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
comments: <value of string>
custom-log-fields: <value of string>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
dlp-sensor: <value of string>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstintf: <value of string>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
global-label: <value of string>
groups: <value of string>
icap-profile: <value of string>
inbound: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natoutbound: <value in [disable, enable]>
np-accelation: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
replacemsg-override-group: <value of string>
rsso: <value in [disable, enable]>
schedule: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcintf: <value of string>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
voip-profile: <value of string>
vpntunnel: <value of string>
webfilter-profile: <value of string>
anti-replay: <value in [disable, enable]>
app-group: <value of string>
cifs-profile: <value of string>
dnsfilter-profile: <value of string>
emailfilter-profile: <value of string>
http-policy-redirect: <value in [disable, enable]>
inspection-mode: <value in [proxy, flow]>
np-acceleration: <value in [disable, enable]>
ssh-filter-profile: <value of string>
ssh-policy-redirect: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
tos-negate: <value in [disable, enable]>
vlan-filter: <value of string>
waf-profile: <value of string>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, enable]>
webproxy-forward-server: <value of string>
webproxy-profile: <value of string>
fsso-groups: <value of string>
decrypted-traffic-mirror: <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 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.