Datasets:

vikp
/

clean_notebooks

Dataset card Data Studio Files Files and versions Community

Split (1)

train · 1.01M rows

code stringlengths 2.5k 150k	kind stringclasses 1 value
ansible fortinet.fortimanager.fmgr_user_local – Configure local users. fortinet.fortimanager.fmgr\_user\_local – Configure local 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_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 \| \| 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\_local dictionary \| \| the top level parameters set \| \| \| auth-concurrent-override string \| Choices:* disable * enable \| Enable/disable overriding the policy-auth-concurrent under config system global. \| \| \| auth-concurrent-value integer \| \| Maximum number of concurrent logins permitted from the same user. \| \| \| authtimeout integer \| \| Time in minutes before the authentication timeout for a user is reached. \| \| \| email-to string \| \| Two-factor recipients email address. \| \| \| fortitoken string \| \| Two-factor recipients FortiToken serial number. \| \| \| id integer \| \| User ID. \| \| \| ldap-server string \| \| Name of LDAP server with which the user must authenticate. \| \| \| name string \| \| User name. \| \| \| passwd string \| \| no description \| \| \| passwd-policy string \| \| Password policy to apply to this user, as defined in config user password-policy. \| \| \| ppk-identity string \| \| IKEv2 Postquantum Preshared Key Identity. \| \| \| ppk-secret string \| \| no description \| \| \| radius-server string \| \| Name of RADIUS server with which the user must authenticate. \| \| \| sms-custom-server string \| \| Two-factor recipients SMS server. \| \| \| sms-phone string \| \| Two-factor recipients mobile phone number. \| \| \| sms-server string \| Choices:* fortiguard * custom \| Send SMS through FortiGuard or other external server. \| \| \| status string \| Choices:* disable * enable \| Enable/disable allowing the local user to authenticate with the FortiGate unit. \| \| \| tacacs+-server string \| \| Name of TACACS+ server with which the user must authenticate. \| \| \| two-factor string \| Choices:* disable * fortitoken * email * sms * fortitoken-cloud \| Enable/disable two-factor authentication. \| \| \| two-factor-authentication string \| Choices:* fortitoken * email * sms \| Authentication method by FortiToken Cloud. \| \| \| two-factor-notification string \| Choices:* email * sms \| Notification method for user activation by FortiToken Cloud. \| \| \| type string \| Choices:* password * radius * tacacs+ * ldap \| Authentication method. \| \| \| username-case-insensitivity string \| Choices:* disable * enable \| Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti... \| \| \| username-case-sensitivity string \| Choices:* disable * enable \| Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti... \| \| \| workstation string \| \| Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 local users. fmgr_user_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]> user_local: auth-concurrent-override: <value in [disable, enable]> auth-concurrent-value: <value of integer> authtimeout: <value of integer> email-to: <value of string> fortitoken: <value of string> id: <value of integer> ldap-server: <value of string> name: <value of string> passwd: <value of string> passwd-policy: <value of string> ppk-identity: <value of string> ppk-secret: <value of string> radius-server: <value of string> sms-custom-server: <value of string> sms-phone: <value of string> sms-server: <value in [fortiguard, custom]> status: <value in [disable, enable]> tacacs+-server: <value of string> two-factor: <value in [disable, fortitoken, email, ...]> type: <value in [password, radius, tacacs+, ...]> workstation: <value of string> two-factor-authentication: <value in [fortitoken, email, sms]> two-factor-notification: <value in [email, sms]> username-case-sensitivity: <value in [disable, enable]> username-case-insensitivity: <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_admin_tacacs – TACACS+ server entry configuration. fortinet.fortimanager.fmgr\_system\_admin\_tacacs – TACACS+ 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_system_admin_tacacs`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_tacacs dictionary \| \| the top level parameters set \| \| \| authen-type string \| Choices:* auto ← * ascii * pap * chap * mschap \| Authentication type. auto - Use PAP, MSCHAP, and CHAP (in that order). ascii - ASCII. pap - PAP. chap - CHAP. mschap - MSCHAP. \| \| \| authorization string \| Choices:* disable ← * enable \| Enable/disable TACACS+ authorization. disable - Disable TACACS+ authorization. enable - Enable TACACS+ authorization (service = fortigate). \| \| \| key string \| \| no description \| \| \| name string \| \| TACACS+ server entry name. \| \| \| port integer \| Default:49 \| Port number of TACACS+ server. \| \| \| secondary-key string \| \| no description \| \| \| secondary-server string \| \| {<name\_str\|ip\_str>} secondary server domain name or IP. \| \| \| server string \| \| {<name\_str\|ip\_str>} server domain name or IP. \| \| \| tertiary-key string \| \| no description \| \| \| tertiary-server string \| \| {<name\_str\|ip\_str>} tertiary server domain name or 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: TACACS+ server entry configuration. fmgr_system_admin_tacacs: bypass_validation: 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_tacacs: authen-type: <value in [auto, ascii, pap, ...]> authorization: <value in [disable, enable]> key: <value of string> name: <value of string> port: <value of integer> secondary-key: <value of string> secondary-server: <value of string> server: <value of string> tertiary-key: <value of string> tertiary-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_system_certificate_crl – Certificate Revocation List. fortinet.fortimanager.fmgr\_system\_certificate\_crl – Certificate Revocation 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_system_certificate_crl`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_crl dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment of this Certificate Revocation List. \| \| \| crl string \| \| no description \| \| \| http-url string \| \| HTTP server URL for CRL auto-update \| \| \| name string \| \| no description \| \| \| update-interval integer \| Default:1440 \| CRL auto-update interval (in minutes) \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Certificate Revocation List. fmgr_system_certificate_crl: bypass_validation: 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_crl: comment: <value of string> crl: <value of string> name: <value of string> http-url: <value of string> update-interval: <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 – no description fortinet.fortimanager.fmgr\_fsp\_vlan – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| \_dhcp-status string \| Choices:* disable * enable \| no description \| \| \| auth string \| Choices:* radius * usergroup \| no description \| \| \| color integer \| \| no description \| \| \| comments 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. \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_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... \| \| \| \| \| 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 \| \| \| interface dictionary \| \| no description \| \| \| \| ac-name string \| \| PPPoE server name. \| \| \| \| aggregate string \| \| no description \| \| \| \| algorithm string \| Choices:* L2 * L3 * L4 \| Frame distribution algorithm. \| \| \| \| alias string \| \| Alias will be displayed with the interface name to make it easier to distinguish. \| \| \| \| allowaccess list / elements=string \| Choices:* 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 \| Enable/disable automatic registration of unknown FortiAP devices. \| \| \| \| arpforward string \| Choices:* disable * enable \| Enable/disable ARP forwarding. \| \| \| \| atm-protocol string \| Choices:* none * ipoa \| ATM protocol. \| \| \| \| auth-type string \| Choices:* auto * pap * chap * mschapv1 * mschapv2 \| PPP authentication type to use. \| \| \| \| auto-auth-extension-device string \| Choices:* disable * enable \| Enable/disable automatic authorization of dedicated Fortinet extension device on this interface. \| \| \| \| bandwidth-measure-time integer \| \| Bandwidth measure time \| \| \| \| bfd string \| Choices:* global * enable * disable \| Bidirectional Forwarding Detection (BFD) settings. \| \| \| \| bfd-desired-min-tx integer \| \| BFD desired minimal transmit interval. \| \| \| \| bfd-detect-mult integer \| \| BFD detection multiplier. \| \| \| \| bfd-required-min-rx integer \| \| BFD required minimal receive interval. \| \| \| \| broadcast-forticlient-discovery string \| Choices:* disable * enable \| no description \| \| \| \| broadcast-forward string \| Choices:* disable * enable \| Enable/disable broadcast forwarding. \| \| \| \| captive-portal integer \| \| Enable/disable captive portal. \| \| \| \| cli-conn-status integer \| \| no description \| \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| \| 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 \| Configure interface for single purpose. \| \| \| \| defaultgw string \| Choices:* disable * enable \| Enable to get the gateway IP from the DHCP or PPPoE server. \| \| \| \| description string \| \| Description. \| \| \| \| detected-peer-mtu integer \| \| no description \| \| \| \| detectprotocol list / elements=string \| Choices:* ping * tcp-echo * udp-echo \| no description \| \| \| \| detectserver string \| \| Gateways ping server for this IP. \| \| \| \| device-access-list string \| \| no description \| \| \| \| device-identification string \| Choices:* disable * enable \| Enable/disable passively gathering of device identity information about the devices on the network connected to this i... \| \| \| \| 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 \| Enable/disable passive gathering of user identity information about users on this interface. \| \| \| \| devindex integer \| \| no description \| \| \| \| dhcp-client-identifier string \| \| DHCP client identifier. \| \| \| \| dhcp-relay-agent-option string \| Choices:* disable * enable \| Enable/disable DHCP relay agent option. \| \| \| \| dhcp-relay-interface string \| \| Specify outgoing interface to reach server. \| \| \| \| dhcp-relay-interface-select-method string \| Choices:* auto * sdwan * specify \| Specify how to select outgoing interface to reach server. \| \| \| \| 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 \| Enable/disable allowing this interface to act as a DHCP relay. \| \| \| \| dhcp-relay-type string \| Choices:* regular * ipsec \| DHCP relay type (regular or IPsec). \| \| \| \| dhcp-renew-time integer \| \| DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server. \| \| \| \| disc-retry-timeout integer \| \| Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout. \| \| \| \| disconnect-threshold integer \| \| Time in milliseconds to wait before sending a notification that this interface is down or disconnected. \| \| \| \| distance integer \| \| Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route. \| \| \| \| dns-query string \| Choices:* disable * recursive * non-recursive \| no description \| \| \| \| dns-server-override string \| Choices:* disable * enable \| Enable/disable use DNS acquired by DHCP or PPPoE. \| \| \| \| drop-fragment string \| Choices:* disable * enable \| Enable/disable drop fragment packets. \| \| \| \| drop-overlapped-fragment string \| Choices:* disable * enable \| Enable/disable drop overlapped fragment packets. \| \| \| \| egress-cos string \| Choices:* disable * cos0 * cos1 * cos2 * cos3 * cos4 * cos5 * cos6 * cos7 \| Override outgoing CoS in user VLAN tag. \| \| \| \| egress-shaping-profile string \| \| Outgoing traffic shaping profile. \| \| \| \| eip string \| \| no description \| \| \| \| endpoint-compliance string \| Choices:* disable * enable \| no description \| \| \| \| estimated-downstream-bandwidth integer \| \| Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization. \| \| \| \| estimated-upstream-bandwidth integer \| \| Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization. \| \| \| \| explicit-ftp-proxy string \| Choices:* disable * enable \| Enable/disable the explicit FTP proxy on this interface. \| \| \| \| explicit-web-proxy string \| Choices:* disable * enable \| Enable/disable the explicit web proxy on this interface. \| \| \| \| external string \| Choices:* disable * enable \| Enable/disable identifying the interface as an external interface (which usually means its connected to the Internet). \| \| \| \| fail-action-on-extender string \| Choices:* soft-restart * hard-restart * reboot \| Action on extender when interface fail . \| \| \| \| fail-alert-interfaces string \| \| Names of the FortiGate interfaces to which the link failure alert is sent. \| \| \| \| fail-alert-method string \| Choices:* link-failed-signal * link-down \| Select link-failed-signal or link-down method to alert about a failed link. \| \| \| \| fail-detect string \| Choices:* disable * enable \| Enable/disable fail detection features for this interface. \| \| \| \| 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 \| Enable FortiLink to dedicate this interface to manage other Fortinet devices. \| \| \| \| fortilink-backup-link integer \| \| no description \| \| \| \| fortilink-neighbor-detect string \| Choices:* lldp * fortilink \| Protocol for FortiGate neighbor discovery. \| \| \| \| fortilink-split-interface string \| Choices:* disable * enable \| Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy. \| \| \| \| fortilink-stacking string \| Choices:* disable * enable \| Enable/disable FortiLink switch-stacking on this interface. \| \| \| \| forward-domain integer \| \| Transparent mode forward domain. \| \| \| \| forward-error-correction string \| Choices:* disable * enable * rs-fec * base-r-fec * fec-cl91 * fec-cl74 \| Enable/disable forward error correction (FEC Clause 91). \| \| \| \| 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 \| \| Gateway address \| \| \| \| gi-gk string \| Choices:* disable * enable \| Enable/disable Gi Gatekeeper. \| \| \| \| gwaddr string \| \| Gateway address \| \| \| \| gwdetect string \| Choices:* disable * enable \| Enable/disable detect gateway alive for first. \| \| \| \| ha-priority integer \| \| HA election priority for the PING server. \| \| \| \| icmp-accept-redirect string \| Choices:* disable * enable \| Enable/disable ICMP accept redirect. \| \| \| \| icmp-redirect string \| Choices:* disable * enable \| no description \| \| \| \| icmp-send-redirect string \| Choices:* disable * enable \| Enable/disable sending of ICMP redirects. \| \| \| \| ident-accept string \| Choices:* disable * enable \| Enable/disable authentication for this interface. \| \| \| \| idle-timeout integer \| \| PPPoE auto disconnect after idle timeout seconds, 0 means no timeout. \| \| \| \| 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 \| \| Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited. \| \| \| \| ingress-cos string \| Choices:* disable * cos0 * cos1 * cos2 * cos3 * cos4 * cos5 * cos6 * cos7 \| Override incoming CoS in user VLAN tag on VLAN interface or assign a priority VLAN tag on physical interface. \| \| \| \| ingress-shaping-profile string \| \| Incoming traffic shaping profile. \| \| \| \| ingress-spillover-threshold integer \| \| Ingress Spillover threshold (0 - 16776000 kbps), 0 means unlimited. \| \| \| \| internal integer \| \| Implicitly created. \| \| \| \| ip string \| \| Interface IPv4 address and subnet mask, syntax: X.X.X.X/24. \| \| \| \| ip-managed-by-fortiipam string \| Choices:* disable * enable \| Enable/disable automatic IP address assignment of this interface by FortiIPAM. \| \| \| \| ipmac string \| Choices:* disable * enable \| Enable/disable IP/MAC binding. \| \| \| \| ips-sniffer-mode string \| Choices:* disable * enable \| Enable/disable the use of this interface as a one-armed sniffer. \| \| \| \| ipunnumbered string \| \| Unnumbered IP used for PPPoE interfaces for which no unique local address is provided. \| \| \| \| ipv6 dictionary \| \| 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. \| \| \| \| l2forward string \| Choices:* disable * enable \| Enable/disable l2 forwarding. \| \| \| \| l2tp-client string \| Choices:* disable * enable \| Enable/disable this interface as a Layer 2 Tunnelling Protocol (L2TP) client. \| \| \| \| lacp-ha-slave string \| Choices:* disable * enable \| LACP HA slave. \| \| \| \| lacp-mode string \| Choices:* static * passive * active \| LACP mode. \| \| \| \| lacp-speed string \| Choices:* slow * fast \| How often the interface sends LACP messages. \| \| \| \| lcp-echo-interval integer \| \| Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. \| \| \| \| lcp-max-echo-fails integer \| \| Maximum missed LCP echo messages before disconnect. \| \| \| \| link-up-delay integer \| \| Number of milliseconds to wait before considering a link is up. \| \| \| \| listen-forticlient-connection string \| Choices:* disable * enable \| no description \| \| \| \| lldp-network-policy string \| \| LLDP-MED network policy profile. \| \| \| \| lldp-reception string \| Choices:* disable * enable * vdom \| Enable/disable Link Layer Discovery Protocol (LLDP) reception. \| \| \| \| lldp-transmission string \| Choices:* enable * disable * vdom \| Enable/disable Link Layer Discovery Protocol (LLDP) transmission. \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| macaddr string \| \| Change the interfaces MAC address. \| \| \| \| managed-subnetwork-size string \| Choices:* 256 * 512 * 1024 * 2048 * 4096 * 8192 * 16384 * 32768 * 65536 \| Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate units DHCP server settings. \| \| \| \| management-ip string \| \| High Availability in-band management IP address of this interface. \| \| \| \| max-egress-burst-rate integer \| \| no description \| \| \| \| max-egress-rate integer \| \| no description \| \| \| \| measured-downstream-bandwidth integer \| \| Measured downstream bandwidth (kbps). \| \| \| \| measured-upstream-bandwidth integer \| \| Measured upstream bandwidth (kbps). \| \| \| \| 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 \| Select SFP media interface type \| \| \| \| member string \| \| Physical interfaces that belong to the aggregate or redundant interface. \| \| \| \| min-links integer \| \| Minimum number of aggregated ports that must be up. \| \| \| \| min-links-down string \| Choices:* operational * administrative \| Action to take when less than the configured minimum number of links are active. \| \| \| \| mode string \| Choices:* static * dhcp * pppoe * pppoa * ipoa * eoa \| Addressing mode (static, DHCP, PPPoE). \| \| \| \| monitor-bandwidth string \| Choices:* disable * enable \| Enable monitoring bandwidth on this interface. \| \| \| \| mtu integer \| \| MTU value for this interface. \| \| \| \| mtu-override string \| Choices:* disable * enable \| Enable to set a custom MTU for this interface. \| \| \| \| mux-type string \| Choices:* llc-encaps * vc-encaps \| Multiplexer type \| \| \| \| name string \| \| Name. \| \| \| \| ndiscforward string \| Choices:* disable * enable \| Enable/disable NDISC forwarding. \| \| \| \| netbios-forward string \| Choices:* disable * enable \| Enable/disable NETBIOS forwarding. \| \| \| \| netflow-sampler string \| Choices:* disable * tx * rx * both \| Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both). \| \| \| \| 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 \| \| Bandwidth limit for outgoing traffic (0 - 16776000 kbps), 0 means unlimited. \| \| \| \| padt-retry-timeout integer \| \| PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time. \| \| \| \| password string \| \| no description \| \| \| \| peer-interface string \| \| no description \| \| \| \| phy-mode string \| Choices:* auto * adsl * vdsl \| DSL physical mode. \| \| \| \| ping-serv-status integer \| \| no description \| \| \| \| poe string \| Choices:* disable * enable \| Enable/disable PoE status. \| \| \| \| polling-interval integer \| \| sFlow polling interval (1 - 255 sec). \| \| \| \| pppoe-unnumbered-negotiate string \| Choices:* disable * enable \| Enable/disable PPPoE unnumbered negotiation. \| \| \| \| pptp-auth-type string \| Choices:* auto * pap * chap * mschapv1 * mschapv2 \| PPTP authentication type. \| \| \| \| pptp-client string \| Choices:* disable * enable \| Enable/disable PPTP client. \| \| \| \| pptp-password string \| \| no description \| \| \| \| pptp-server-ip string \| \| PPTP server IP address. \| \| \| \| pptp-timeout integer \| \| Idle timer in minutes (0 for disabled). \| \| \| \| pptp-user string \| \| PPTP user name. \| \| \| \| preserve-session-route string \| Choices:* disable * enable \| Enable/disable preservation of session route when dirty. \| \| \| \| priority integer \| \| Priority of learned routes. \| \| \| \| priority-override string \| Choices:* disable * enable \| Enable/disable fail back to higher priority port once recovered. \| \| \| \| proxy-captive-portal string \| Choices:* disable * enable \| Enable/disable proxy captive portal on this interface. \| \| \| \| redundant-interface string \| \| no description \| \| \| \| remote-ip string \| \| Remote IP address of tunnel. \| \| \| \| replacemsg-override-group string \| \| Replacement message override group. \| \| \| \| retransmission string \| Choices:* disable * enable \| Enable/disable DSL retransmission. \| \| \| \| ring-rx integer \| \| RX ring size. \| \| \| \| ring-tx integer \| \| TX ring size. \| \| \| \| role string \| Choices:* lan * wan * dmz * undefined \| Interface role. \| \| \| \| sample-direction string \| Choices:* rx * tx * both \| Data that NetFlow collects (rx, tx, or both). \| \| \| \| sample-rate integer \| \| sFlow sample rate (10 - 99999). \| \| \| \| scan-botnet-connections string \| Choices:* disable * block * monitor \| no description \| \| \| \| secondary-IP string \| Choices:* disable * enable \| Enable/disable adding a secondary IP to this interface. \| \| \| \| 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 \| \| \| \| security-8021x-dynamic-vlan-id integer \| \| VLAN ID for virtual switch. \| \| \| \| security-8021x-master string \| \| 802.1X master virtual-switch. \| \| \| \| security-8021x-mode string \| Choices:* default * dynamic-vlan * fallback * slave \| 802.1X mode. \| \| \| \| security-exempt-list string \| \| Name of security-exempt-list. \| \| \| \| security-external-logout string \| \| URL of external authentication logout server. \| \| \| \| security-external-web string \| \| URL of external authentication web server. \| \| \| \| security-groups string \| \| User groups that can authenticate with the captive portal. \| \| \| \| security-mac-auth-bypass string \| Choices:* disable * enable * mac-auth-only \| Enable/disable MAC authentication bypass. \| \| \| \| security-mode string \| Choices:* none * captive-portal * 802.1X \| Turn on captive portal authentication for this interface. \| \| \| \| security-redirect-url string \| \| URL redirection after disclaimer/authentication. \| \| \| \| service-name string \| \| PPPoE service name. \| \| \| \| sflow-sampler string \| Choices:* disable * enable \| Enable/disable sFlow on this interface. \| \| \| \| speed string \| Choices:* auto * 10full * 10half * 100full * 100half * 1000full * 1000half * 10000full * 1000auto * 10000auto * 40000full * 100Gfull * 25000full * 40000auto * 25000auto * 100Gauto \| Interface speed. The default setting and the options available depend on the interface hardware. \| \| \| \| spillover-threshold integer \| \| Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited. \| \| \| \| src-check string \| Choices:* disable * enable \| Enable/disable source IP check. \| \| \| \| status string \| Choices:* down * up \| Bring the interface up or shut the interface down. \| \| \| \| stp string \| Choices:* disable * enable \| Enable/disable STP. \| \| \| \| stp-ha-secondary string \| Choices:* disable * enable * priority-adjust \| Control STP behaviour on HA secondary. \| \| \| \| stp-ha-slave string \| Choices:* disable * enable * priority-adjust \| Control STP behaviour on HA slave. \| \| \| \| stpforward string \| Choices:* disable * enable \| Enable/disable STP forwarding. \| \| \| \| stpforward-mode string \| Choices:* rpl-all-ext-id * rpl-bridge-ext-id * rpl-nothing \| Configure STP forwarding mode. \| \| \| \| strip-priority-vlan-tag string \| Choices:* disable * enable \| no description \| \| \| \| subst string \| Choices:* disable * enable \| Enable to always send packets from this interface to a destination MAC address. \| \| \| \| substitute-dst-mac string \| \| Destination MAC address that all packets are sent to from this interface. \| \| \| \| swc-first-create integer \| \| Initial create for switch-controller VLANs. \| \| \| \| swc-vlan integer \| \| no description \| \| \| \| switch string \| \| no description \| \| \| \| switch-controller-access-vlan string \| Choices:* disable * enable \| Block FortiSwitch port-to-port traffic. \| \| \| \| switch-controller-arp-inspection string \| Choices:* disable * enable \| Enable/disable FortiSwitch ARP inspection. \| \| \| \| switch-controller-auth string \| Choices:* radius * usergroup \| no description \| \| \| \| switch-controller-dhcp-snooping string \| Choices:* disable * enable \| Switch controller DHCP snooping. \| \| \| \| switch-controller-dhcp-snooping-option82 string \| Choices:* disable * enable \| Switch controller DHCP snooping option82. \| \| \| \| switch-controller-dhcp-snooping-verify-mac string \| Choices:* disable * enable \| Switch controller DHCP snooping verify MAC. \| \| \| \| 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 \| Interfaces purpose when assigning traffic (read only). \| \| \| \| switch-controller-igmp-snooping string \| Choices:* disable * enable \| Switch controller IGMP snooping. \| \| \| \| switch-controller-igmp-snooping-fast-leave string \| Choices:* disable * enable \| Switch controller IGMP snooping fast-leave. \| \| \| \| switch-controller-igmp-snooping-proxy string \| Choices:* disable * enable \| Switch controller IGMP snooping proxy. \| \| \| \| switch-controller-iot-scanning string \| Choices:* disable * enable \| Enable/disable managed FortiSwitch IoT scanning. \| \| \| \| switch-controller-learning-limit integer \| \| Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default). \| \| \| \| switch-controller-mgmt-vlan integer \| \| VLAN to use for FortiLink management purposes. \| \| \| \| switch-controller-nac string \| \| Integrated NAC settings for managed FortiSwitch. \| \| \| \| switch-controller-radius-server string \| \| no description \| \| \| \| switch-controller-rspan-mode string \| Choices:* disable * enable \| Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface. \| \| \| \| switch-controller-source-ip string \| Choices:* outbound * fixed \| Source IP address used in FortiLink over L3 connections. \| \| \| \| switch-controller-traffic-policy string \| \| Switch controller traffic policy for the VLAN. \| \| \| \| tc-mode string \| Choices:* ptm * atm \| DSL transfer mode. \| \| \| \| tcp-mss integer \| \| TCP maximum segment size. 0 means do not change segment size. \| \| \| \| trunk string \| Choices:* disable * enable \| Enable/disable VLAN trunk. \| \| \| \| trust-ip-1 string \| \| Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). \| \| \| \| trust-ip-2 string \| \| Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). \| \| \| \| trust-ip-3 string \| \| Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). \| \| \| \| trust-ip6-1 string \| \| Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). \| \| \| \| trust-ip6-2 string \| \| Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). \| \| \| \| trust-ip6-3 string \| \| Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). \| \| \| \| 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 \| Interface type. \| \| \| \| username string \| \| Username of the PPPoE account, provided by your ISP. \| \| \| \| vci integer \| \| Virtual Channel ID \| \| \| \| vectoring string \| Choices:* disable * enable \| Enable/disable DSL vectoring. \| \| \| \| vindex integer \| \| no description \| \| \| \| vlan-protocol string \| Choices:* 8021q * 8021ad \| Ethernet protocol of VLAN. \| \| \| \| vlanforward string \| Choices:* disable * enable \| Enable/disable traffic forwarding between VLANs on this interface. \| \| \| \| vlanid integer \| \| VLAN ID (1 - 4094). \| \| \| \| vpi integer \| \| Virtual Path ID \| \| \| \| vrf integer \| \| Virtual Routing Forwarding ID. \| \| \| \| vrrp list / elements=string \| \| no description \| \| \| \| \| accept-mode string \| Choices:* disable * enable \| Enable/disable accept mode. \| \| \| \| \| adv-interval integer \| \| Advertisement interval (1 - 255 seconds). \| \| \| \| \| ignore-default-route string \| Choices:* disable * enable \| Enable/disable ignoring of default route when checking destination. \| \| \| \| \| 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 this VRRP configuration. \| \| \| \| \| version string \| Choices:* 2 * 3 \| VRRP version. \| \| \| \| \| vrdst string \| \| no description \| \| \| \| \| vrdst-priority integer \| \| Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). \| \| \| \| \| vrgrp integer \| \| VRRP group ID (1 - 65535). \| \| \| \| \| vrid integer \| \| Virtual router identifier (1 - 255). \| \| \| \| \| vrip string \| \| IP address of the virtual router. \| \| \| \| vrrp-virtual-mac string \| Choices:* disable * enable \| Enable/disable use of virtual MAC for VRRP. \| \| \| \| wccp string \| Choices:* disable * enable \| Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers. \| \| \| \| weight integer \| \| Default weight for static routes (if route has no weight configured). \| \| \| \| wifi-5g-threshold string \| \| Minimal signal strength to be considered as a good 5G AP. \| \| \| \| wifi-acl string \| Choices:* deny * allow \| Access control for MAC addresses in the MAC list. \| \| \| \| wifi-ap-band string \| Choices:* any * 5g-preferred * 5g-only \| How to select the AP to connect. \| \| \| \| wifi-auth string \| Choices:* PSK * RADIUS * radius * usergroup \| WiFi authentication. \| \| \| \| wifi-auto-connect string \| Choices:* disable * enable \| Enable/disable WiFi network auto connect. \| \| \| \| wifi-auto-save string \| Choices:* disable * enable \| Enable/disable WiFi network automatic save. \| \| \| \| wifi-broadcast-ssid string \| Choices:* disable * enable \| Enable/disable SSID broadcast in the beacon. \| \| \| \| wifi-encrypt string \| Choices:* TKIP * AES \| Data encryption. \| \| \| \| wifi-fragment-threshold integer \| \| WiFi fragment threshold (800 - 2346). \| \| \| \| wifi-key string \| \| no description \| \| \| \| wifi-keyindex integer \| \| WEP key index (1 - 4). \| \| \| \| wifi-mac-filter string \| Choices:* disable * enable \| Enable/disable MAC filter status. \| \| \| \| wifi-passphrase string \| \| no description \| \| \| \| wifi-radius-server string \| \| WiFi RADIUS server for WPA. \| \| \| \| wifi-rts-threshold integer \| \| WiFi RTS threshold (256 - 2346). \| \| \| \| 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 \| Wireless access security of SSID. \| \| \| \| wifi-ssid string \| \| IEEE 802.11 Service Set Identifier. \| \| \| \| wifi-usergroup string \| \| WiFi user group for WPA. \| \| \| \| wins-ip string \| \| WINS server IP. \| \| \| name string \| \| no description \| \| \| portal-message-override-group string \| \| no description \| \| \| radius-server string \| \| no description \| \| \| security string \| Choices:* open * captive-portal * 8021x \| no description \| \| \| selected-usergroups string \| \| no description \| \| \| usergroup string \| \| no description \| \| \| vdom string \| \| 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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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: bypass_validation: False workspace_locking_adom: <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]> fsp_vlan: _dhcp-status: <value in [disable, enable]> auth: <value in [radius, usergroup]> color: <value of integer> comments: <value of string> dynamic_mapping: - _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> name: <value of string> portal-message-override-group: <value of string> radius-server: <value of string> security: <value in [open, captive-portal, 8021x]> selected-usergroups: <value of string> usergroup: <value of string> vdom: <value of string> vlanid: <value of integer> 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: 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]> bandwidth-measure-time: <value of integer> 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-interface: <value of string> dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]> 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> eip: <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-neighbor-detect: <value in [lldp, fortilink]> 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-shaping-profile: <value of string> ingress-spillover-threshold: <value of integer> internal: <value of integer> ip: <value of string> ip-managed-by-fortiipam: <value in [disable, enable]> 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]> 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]> 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> managed-subnetwork-size: <value in [256, 512, 1024, ...]> management-ip: <value of string> max-egress-burst-rate: <value of integer> max-egress-rate: <value of integer> measured-downstream-bandwidth: <value of integer> measured-upstream-bandwidth: <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, ...]> monitor-bandwidth: <value in [disable, enable]> 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, ...]> np-qos-profile: <value of integer> 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]> ring-rx: <value of integer> ring-tx: <value of integer> 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> swc-first-create: <value of integer> swc-vlan: <value of integer> 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-feature: <value in [none, default-vlan, quarantine, ...]> switch-controller-igmp-snooping: <value in [disable, enable]> switch-controller-igmp-snooping-fast-leave: <value in [disable, enable]> switch-controller-igmp-snooping-proxy: <value in [disable, enable]> switch-controller-iot-scanning: <value in [disable, enable]> switch-controller-learning-limit: <value of integer> switch-controller-mgmt-vlan: <value of integer> switch-controller-nac: <value of string> switch-controller-radius-server: <value of string> switch-controller-rspan-mode: <value in [disable, enable]> switch-controller-source-ip: <value in [outbound, fixed]> 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> vlan-protocol: <value in [8021q, 8021ad]> 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> 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_filefilter_profile – Configure file-filter profiles. fortinet.fortimanager.fmgr\_filefilter\_profile – Configure file-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_filefilter_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 \| \| filefilter\_profile dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| extended-log string \| Choices:* disable * enable \| Enable/disable file-filter extended logging. \| \| \| feature-set string \| Choices:* proxy * flow \| Flow/proxy feature set. \| \| \| log string \| Choices:* disable * enable \| Enable/disable file-filter logging. \| \| \| name string \| \| Profile name. \| \| \| replacemsg-group string \| \| Replacement message group \| \| \| rules list / elements=string \| \| no description \| \| \| \| 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 \| \| \| scan-archive-contents string \| Choices:* disable * enable \| Enable/disable archive contents scan. (Not for CIFS) \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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-filter profiles. fmgr_filefilter_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]> filefilter_profile: comment: <value of string> extended-log: <value in [disable, enable]> feature-set: <value in [proxy, flow]> log: <value in [disable, enable]> name: <value of string> replacemsg-group: <value of string> 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 scan-archive-contents: <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_sslsshprofile – Configure SSL/SSH protocol options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile – Configure SSL/SSH 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_sslsshprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| allowlist string \| Choices:* disable * enable \| Enable/disable exempting servers by FortiGuard allowlist. \| \| \| block-blacklisted-certificates string \| Choices:* disable * enable \| Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist. \| \| \| block-blocklisted-certificates string \| Choices:* disable * enable \| Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist. \| \| \| caname string \| \| CA certificate used by SSL Inspection. \| \| \| comment string \| \| Optional comments. \| \| \| dot dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| proxy-after-tcp-handshake string \| Choices:* 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:* enable * strict * disable \| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. \| \| \| \| status string \| Choices:* disable * deep-inspection \| Configure protocol inspection status. \| \| \| \| unsupported-ssl-cipher string \| Choices:* block * allow \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* block * allow \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| ftps dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| 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-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| https dictionary \| \| no description \| \| \| \| 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-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. \| \| \| \| 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-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| imaps dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| 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-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| mapi-over-https string \| Choices:* disable * enable \| Enable/disable inspection of MAPI over HTTPS. \| \| \| name string \| \| Name. \| \| \| pop3s dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| 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-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| rpc-over-https string \| Choices:* disable * enable \| Enable/disable inspection of RPC over HTTPS. \| \| \| server-cert string \| \| Certificate used by SSL Inspection to replace server certificate. \| \| \| server-cert-mode string \| Choices:* re-sign * replace \| Re-sign or replace the servers certificate. \| \| \| smtps dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| 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-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| ssh dictionary \| \| no description \| \| \| \| inspect-all string \| Choices:* disable * deep-inspection \| Level of SSL inspection. \| \| \| \| 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). \| \| \| \| ssh-algorithm string \| Choices:* compatible * high-encryption \| Relative strength of encryption algorithms accepted during negotiation. \| \| \| \| ssh-tun-policy-check string \| Choices:* disable * enable \| Enable/disable SSH tunnel policy check. \| \| \| \| status string \| Choices:* disable * deep-inspection \| Configure protocol inspection status. \| \| \| \| unsupported-version string \| Choices:* block * bypass \| Action based on SSH version being unsupported. \| \| \| ssl dictionary \| \| no description \| \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| \| inspect-all string \| Choices:* disable * certificate-inspection * deep-inspection \| Level of SSL inspection. \| \| \| \| 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. \| \| \| \| unsupported-ssl-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| \| ssl-anomalies-log string \| Choices:* disable * enable \| Enable/disable logging SSL anomalies. \| \| \| ssl-exempt list / elements=string \| \| no description \| \| \| \| address string \| \| IPv4 address object. \| \| \| \| address6 string \| \| IPv6 address object. \| \| \| \| fortiguard-category string \| \| FortiGuard category ID. \| \| \| \| id integer \| \| ID number. \| \| \| \| regex string \| \| Exempt servers by regular expression. \| \| \| \| type string \| Choices:* fortiguard-category * address * address6 * wildcard-fqdn * regex \| Type of address object (IPv4 or IPv6) or FortiGuard category. \| \| \| \| wildcard-fqdn string \| \| Exempt servers by wildcard FQDN. \| \| \| ssl-exemptions-log string \| Choices:* disable * enable \| Enable/disable logging SSL exemptions. \| \| \| ssl-negotiation-log string \| Choices:* disable * enable \| Enable/disable logging SSL negotiation. \| \| \| ssl-server list / elements=string \| \| no description \| \| \| \| ftps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the FTPS handshake. \| \| \| \| ftps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the FTPS handshake. \| \| \| \| https-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the HTTPS handshake. \| \| \| \| https-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the HTTPS handshake. \| \| \| \| id integer \| \| SSL server ID. \| \| \| \| imaps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the IMAPS handshake. \| \| \| \| imaps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the IMAPS handshake. \| \| \| \| ip string \| \| IPv4 address of the SSL server. \| \| \| \| pop3s-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the POP3S handshake. \| \| \| \| pop3s-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the POP3S handshake. \| \| \| \| smtps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the SMTPS handshake. \| \| \| \| smtps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the SMTPS handshake. \| \| \| \| ssl-other-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during an SSL protocol handshake. \| \| \| \| ssl-other-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during an SSL protocol handshake. \| \| \| supported-alpn string \| Choices:* none * http1-1 * http2 * all \| Configure ALPN option. \| \| \| untrusted-caname string \| \| Untrusted CA certificate used by SSL Inspection. \| \| \| use-ssl-server string \| Choices:* disable * enable \| Enable/disable the use of SSL server table for SSL offloading. \| \| \| whitelist string \| Choices:* disable * enable \| Enable/disable exempting servers by FortiGuard whitelist. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 SSL/SSH protocol options. fmgr_firewall_sslsshprofile: bypass_validation: False workspace_locking_adom: <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_sslsshprofile: caname: <value of string> comment: <value of string> mapi-over-https: <value in [disable, enable]> name: <value of string> rpc-over-https: <value in [disable, enable]> server-cert: <value of string> server-cert-mode: <value in [re-sign, replace]> ssl-anomalies-log: <value in [disable, enable]> ssl-exempt: - address: <value of string> address6: <value of string> fortiguard-category: <value of string> id: <value of integer> regex: <value of string> type: <value in [fortiguard-category, address, address6, ...]> wildcard-fqdn: <value of string> ssl-exemptions-log: <value in [disable, enable]> ssl-server: - ftps-client-cert-request: <value in [bypass, inspect, block]> https-client-cert-request: <value in [bypass, inspect, block]> id: <value of integer> imaps-client-cert-request: <value in [bypass, inspect, block]> ip: <value of string> pop3s-client-cert-request: <value in [bypass, inspect, block]> smtps-client-cert-request: <value in [bypass, inspect, block]> ssl-other-client-cert-request: <value in [bypass, inspect, block]> ftps-client-certificate: <value in [bypass, inspect, block]> https-client-certificate: <value in [bypass, inspect, block]> imaps-client-certificate: <value in [bypass, inspect, block]> pop3s-client-certificate: <value in [bypass, inspect, block]> smtps-client-certificate: <value in [bypass, inspect, block]> ssl-other-client-certificate: <value in [bypass, inspect, block]> untrusted-caname: <value of string> use-ssl-server: <value in [disable, enable]> whitelist: <value in [disable, enable]> block-blacklisted-certificates: <value in [disable, enable]> ssl-negotiation-log: <value in [disable, enable]> ftps: 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]> ports: <value of integer> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> https: 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]> ports: <value of integer> proxy-after-tcp-handshake: <value in [disable, enable]> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> status: <value in [disable, certificate-inspection, deep-inspection]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> cert-probe-failure: <value in [block, allow]> imaps: 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]> ports: <value of integer> proxy-after-tcp-handshake: <value in [disable, enable]> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> pop3s: 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]> ports: <value of integer> proxy-after-tcp-handshake: <value in [disable, enable]> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> smtps: 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]> ports: <value of integer> proxy-after-tcp-handshake: <value in [disable, enable]> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> ssh: inspect-all: <value in [disable, deep-inspection]> ports: <value of integer> proxy-after-tcp-handshake: <value in [disable, enable]> ssh-algorithm: <value in [compatible, high-encryption]> ssh-tun-policy-check: <value in [disable, enable]> status: <value in [disable, deep-inspection]> unsupported-version: <value in [block, bypass]> ssl: 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]> inspect-all: <value in [disable, certificate-inspection, deep-inspection]> revoked-server-cert: <value in [allow, block, ignore]> sni-server-cert-check: <value in [disable, enable, strict]> unsupported-ssl-cipher: <value in [allow, block]> unsupported-ssl-negotiation: <value in [allow, block]> untrusted-server-cert: <value in [allow, block, ignore]> allowlist: <value in [disable, enable]> block-blocklisted-certificates: <value in [disable, enable]> dot: 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]> sni-server-cert-check: <value in [enable, strict, disable]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [block, allow]> unsupported-ssl-negotiation: <value in [block, allow]> untrusted-server-cert: <value in [allow, block, ignore]> supported-alpn: <value in [none, http1-1, http2, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_h2qposuprovider_servicedescription – OSU service name. fortinet.fortimanager.fmgr\_hotspot20\_h2qposuprovider\_servicedescription – OSU service 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_servicedescription`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_servicedescription dictionary \| \| the top level parameters set \| \| \| 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: OSU service name. fmgr_hotspot20_h2qposuprovider_servicedescription: bypass_validation: False workspace_locking_adom: <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_servicedescription: 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_switchcontroller_qos_dot1pmap – Configure FortiSwitch QoS 802. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_dot1pmap – Configure FortiSwitch QoS 802. ============================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dot1pmap`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_dot1pmap dictionary \| \| the top level parameters set \| \| \| description string \| \| Description of the 802.1p name. \| \| \| egress-pri-tagging string \| Choices:* disable * enable \| Enable/disable egress priority-tag frame. \| \| \| name string \| \| Dot1p map name. \| \| \| priority-0 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-1 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-2 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-3 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-4 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-5 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-6 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| \| priority-7 string \| Choices:* queue-0 * queue-1 * queue-2 * queue-3 * queue-4 * queue-5 * queue-6 * queue-7 \| COS queue mapped to dot1p priority number. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 802. fmgr_switchcontroller_qos_dot1pmap: bypass_validation: False workspace_locking_adom: <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_dot1pmap: description: <value of string> name: <value of string> priority-0: <value in [queue-0, queue-1, queue-2, ...]> priority-1: <value in [queue-0, queue-1, queue-2, ...]> priority-2: <value in [queue-0, queue-1, queue-2, ...]> priority-3: <value in [queue-0, queue-1, queue-2, ...]> priority-4: <value in [queue-0, queue-1, queue-2, ...]> priority-5: <value in [queue-0, queue-1, queue-2, ...]> priority-6: <value in [queue-0, queue-1, queue-2, ...]> priority-7: <value in [queue-0, queue-1, queue-2, ...]> egress-pri-tagging: <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_signature – WAF signatures. fortinet.fortimanager.fmgr\_waf\_profile\_signature – WAF signatures. ===================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 signatures. fmgr_waf_profile_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> profile: <your own value> waf_profile_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) ansible fortinet.fortimanager.fmgr_firewall_mmsprofile_notifmsisdn – Notification for MSISDNs. fortinet.fortimanager.fmgr\_firewall\_mmsprofile\_notifmsisdn – Notification for MSISDNs. ========================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_notifmsisdn`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_notifmsisdn dictionary \| \| the top level parameters set \| \| \| msisdn string \| \| Recipient MSISDN. \| \| \| threshold list / elements=string \| Choices:* flood-thresh-1 * flood-thresh-2 * flood-thresh-3 * dupe-thresh-1 * dupe-thresh-2 * dupe-thresh-3 \| no description \| \| 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: Notification for MSISDNs. fmgr_firewall_mmsprofile_notifmsisdn: bypass_validation: False workspace_locking_adom: <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> state: <value in [present, absent]> firewall_mmsprofile_notifmsisdn: msisdn: <value of string> threshold: - flood-thresh-1 - flood-thresh-2 - flood-thresh-3 - dupe-thresh-1 - dupe-thresh-2 - dupe-thresh-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)	programming_docs
ansible fortinet.fortimanager.fmgr_bleprofile – Configure Bluetooth Low Energy profile. fortinet.fortimanager.fmgr\_bleprofile – Configure Bluetooth Low Energy 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_bleprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bleprofile dictionary \| \| the top level parameters set \| \| \| advertising list / elements=string \| Choices:* ibeacon * eddystone-uid * eddystone-url \| no description \| \| \| beacon-interval integer \| \| Beacon interval (default = 100 msec). \| \| \| ble-scanning string \| Choices:* disable * enable \| Enable/disable Bluetooth Low Energy (BLE) scanning. \| \| \| comment string \| \| Comment. \| \| \| eddystone-instance string \| \| Eddystone instance ID. \| \| \| eddystone-namespace string \| \| Eddystone namespace ID. \| \| \| eddystone-url string \| \| Eddystone URL. \| \| \| eddystone-url-encode-hex string \| \| Eddystone encoded URL hexadecimal string \| \| \| ibeacon-uuid string \| \| Universally Unique Identifier (UUID; automatically assigned but can be manually reset). \| \| \| major-id integer \| \| Major ID. \| \| \| minor-id integer \| \| Minor ID. \| \| \| name string \| \| Bluetooth Low Energy profile name. \| \| \| txpower string \| Choices:* 0 * 1 * 2 * 3 * 4 * 5 * 6 * 7 * 8 * 9 * 10 * 11 * 12 \| Transmit power level (default = 0). \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 Bluetooth Low Energy profile. fmgr_bleprofile: bypass_validation: False workspace_locking_adom: <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]> bleprofile: advertising: - ibeacon - eddystone-uid - eddystone-url beacon-interval: <value of integer> ble-scanning: <value in [disable, enable]> comment: <value of string> eddystone-instance: <value of string> eddystone-namespace: <value of string> eddystone-url: <value of string> eddystone-url-encode-hex: <value of string> ibeacon-uuid: <value of string> major-id: <value of integer> minor-id: <value of integer> name: <value of string> txpower: <value in [0, 1, 2, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_clone – Clone an object in FortiManager. fortinet.fortimanager.fmgr\_clone – Clone an object in 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_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 \| \| clone dictionary \| \| the top level parameters set \| \| 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. * Normally, running one module can fail when a 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: clone an vip object using fmgr_clone module. fmgr_clone: clone: selector: 'firewall_vip' self: adom: 'root' vip: 'ansible-test-vip_first' target: name: 'ansible-test-vip_fourth' ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_dnat6 – no description fortinet.fortimanager.fmgr\_pkg\_central\_dnat6 – 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_dnat6`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_dnat6 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_dnat6: bypass_validation: False workspace_locking_adom: <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_dnat6: 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_workflow_review – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_review – 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_review`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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_review: bypass_validation: False workspace_locking_adom: <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_dlp_sensor – Configure DLP sensors. fortinet.fortimanager.fmgr\_dlp\_sensor – Configure DLP sensors. ================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| dlp-log string \| Choices:* disable * enable \| Enable/disable DLP logging. \| \| \| extended-log string \| Choices:* disable * enable \| Enable/disable extended logging for data leak prevention. \| \| \| feature-set string \| Choices:* proxy * flow \| Flow/proxy feature set. \| \| \| filter list / elements=string \| \| no description \| \| \| \| 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). \| \| \| flow-based string \| Choices:* disable * enable \| Enable/disable flow-based DLP. \| \| \| full-archive-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 \| \| \| nac-quar-log string \| Choices:* disable * enable \| Enable/disable NAC quarantine logging. \| \| \| name string \| \| Name of the DLP sensor. \| \| \| options string \| Choices:* strict-file \| Configure DLP options. \| \| \| replacemsg-group string \| \| Replacement message group used by this DLP sensor. \| \| \| summary-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 \| \| 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 DLP sensors. fmgr_dlp_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]> dlp_sensor: comment: <value of string> dlp-log: <value in [disable, enable]> extended-log: <value in [disable, enable]> 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> flow-based: <value in [disable, enable]> full-archive-proto: - imap - smtp - pop3 - ftp - nntp - mm1 - mm3 - mm4 - mm7 - mapi - aim - icq - msn - yahoo - http-get - http-post - ssh - cifs nac-quar-log: <value in [disable, enable]> name: <value of string> options: <value in [strict-file]> replacemsg-group: <value of string> summary-proto: - imap - smtp - pop3 - ftp - nntp - mm1 - mm3 - mm4 - mm7 - mapi - aim - icq - msn - yahoo - http-get - http-post - ssh - cifs feature-set: <value in [proxy, flow]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_apn – Configure APN for GTP. fortinet.fortimanager.fmgr\_gtp\_apn – Configure APN 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_apn`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| gtp\_apn dictionary \| \| the top level parameters set \| \| \| apn string \| \| APN value. \| \| \| name string \| \| APN 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 for GTP. fmgr_gtp_apn: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> gtp_apn: apn: <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 – Configure Email Filter profiles. fortinet.fortimanager.fmgr\_emailfilter\_profile – Configure Email 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_emailfilter_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 \| \| emailfilter\_profile dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| external string \| Choices:* disable * enable \| Enable/disable external Email inspection. \| \| \| feature-set string \| Choices:* proxy * flow \| Flow/proxy feature set. \| \| \| gmail dictionary \| \| no description \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| \| imap dictionary \| \| no description \| \| \| \| action string \| Choices:* pass * tag \| Action for spam email. \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| 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 \| \| \| mapi dictionary \| \| no description \| \| \| \| action string \| Choices:* pass * discard \| Action for spam email. \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| \| msn-hotmail dictionary \| \| no description \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| \| name string \| \| Profile name. \| \| \| options list / elements=string \| Choices:* bannedword * spambwl * spamfsip * spamfssubmit * spamfschksum * spamfsurl * spamhelodns * spamraddrdns * spamrbl * spamhdrcheck * spamfsphish * spambal \| no description \| \| \| other-webmails dictionary \| \| no description \| \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| \| pop3 dictionary \| \| no description \| \| \| \| action string \| Choices:* pass * tag \| Action for spam email. \| \| \| \| log string \| Choices:* disable * enable \| no description \| \| \| \| 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 \| \| \| replacemsg-group string \| \| Replacement message group. \| \| \| smtp dictionary \| \| no description \| \| \| \| 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 \| no description \| \| \| \| 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 \| \| \| spam-bal-table string \| \| Anti-spam block/allow list table ID. \| \| \| 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. \| \| 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 Email Filter profiles. fmgr_emailfilter_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]> emailfilter_profile: comment: <value of string> external: <value in [disable, enable]> name: <value of string> options: - bannedword - spambwl - spamfsip - spamfssubmit - spamfschksum - spamfsurl - spamhelodns - spamraddrdns - spamrbl - spamhdrcheck - spamfsphish - spambal 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> feature-set: <value in [proxy, flow]> gmail: log: <value in [disable, enable]> log-all: <value in [disable, enable]> imap: action: <value in [pass, tag]> log: <value in [disable, enable]> log-all: <value in [disable, enable]> tag-msg: <value of string> tag-type: - subject - header - spaminfo mapi: action: <value in [pass, discard]> log: <value in [disable, enable]> log-all: <value in [disable, enable]> msn-hotmail: log: <value in [disable, enable]> log-all: <value in [disable, enable]> other-webmails: log-all: <value in [disable, enable]> pop3: action: <value in [pass, tag]> log: <value in [disable, enable]> log-all: <value in [disable, enable]> tag-msg: <value of string> tag-type: - subject - header - spaminfo smtp: action: <value in [pass, tag, discard]> hdrip: <value in [disable, enable]> local-override: <value in [disable, enable]> log: <value in [disable, enable]> log-all: <value in [disable, enable]> tag-msg: <value of string> tag-type: - subject - header - spaminfo spam-bal-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) ansible fortinet.fortimanager.fmgr_system_autodelete_dlpfilesautodeletion – Automatic deletion policy for DLP archives. fortinet.fortimanager.fmgr\_system\_autodelete\_dlpfilesautodeletion – Automatic deletion policy for DLP archives. ================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dlpfilesautodeletion`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_dlpfilesautodeletion 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 DLP archives. fmgr_system_autodelete_dlpfilesautodeletion: bypass_validation: 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_dlpfilesautodeletion: 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)	programming_docs
ansible fortinet.fortimanager.fmgr_user_devicegroup_tagging – Config object tagging. fortinet.fortimanager.fmgr\_user\_devicegroup\_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_user_devicegroup_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 \| \| device-group string / required \| \| the parameter (device-group) 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\_devicegroup\_tagging dictionary \| \| the top level parameters set \| \| \| category string \| \| Tag category. \| \| \| name string \| \| Tagging entry name. \| \| \| 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: Config object tagging. fmgr_user_devicegroup_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> device-group: <your own value> state: <value in [present, absent]> user_devicegroup_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_securityconsole_preview_result – Retrieve the result of previous install/preview command. fortinet.fortimanager.fmgr\_securityconsole\_preview\_result – Retrieve the result of previous install/preview command. ======================================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_preview_result`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_preview\_result dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM name. \| \| \| device 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: Retrieve the result of previous install/preview command. fmgr_securityconsole_preview_result: bypass_validation: 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_preview_result: adom: <value of string> device: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_dvmdb_workflow_reject – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_reject – 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_reject`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dvmdb\_workflow\_reject dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| session\_id string / required \| \| the parameter (session\_id) in requested url \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: no description fmgr_dvmdb_workflow_reject: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> session_id: <your own value> dvmdb_workflow_reject: desc: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_options – DHCP options. fortinet.fortimanager.fmgr\_fsp\_vlan\_dhcpserver\_options – DHCP 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_fsp_vlan_dhcpserver_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 \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| fsp\_vlan\_dhcpserver\_options dictionary \| \| the top level parameters set \| \| \| code integer \| \| no description \| \| \| id integer \| \| no description \| \| \| ip string \| \| no description \| \| \| type string \| Choices:* hex * string * ip * fqdn \| 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 \| \| 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: DHCP options. fmgr_fsp_vlan_dhcpserver_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> vlan: <your own value> state: <value in [present, absent]> fsp_vlan_dhcpserver_options: code: <value of integer> id: <value of integer> ip: <value of string> type: <value in [hex, string, ip, ...]> 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_system_replacemsggroup_ec – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_ec – 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_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 \| \| 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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)	programming_docs
ansible fortinet.fortimanager.fmgr_devprof_log_syslogd_setting – Global settings for remote syslog server. fortinet.fortimanager.fmgr\_devprof\_log\_syslogd\_setting – Global 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_devprof_log_syslogd_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\_syslogd\_setting dictionary \| \| the top level parameters set \| \| \| certificate string \| \| Certificate used to communicate with Syslog server. \| \| \| enc-algorithm string \| Choices:* high * low * disable * high-medium \| Enable/disable reliable syslogging with TLS encryption. \| \| \| facility string \| Choices:* kernel * user * mail * daemon * auth * syslog * lpr * news * uucp * cron * authpriv * ftp * ntp * audit * alert * clock * local0 * local1 * local2 * local3 * local4 * local5 * local6 * local7 \| Remote syslog facility. \| \| \| 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. \| \| \| max-log-rate integer \| \| Syslog maximum log rate in MBps (0 = unlimited). \| \| \| mode string \| Choices:* udp * legacy-reliable * reliable \| Remote syslog logging over UDP/Reliable TCP. \| \| \| port integer \| \| Server listen port. \| \| \| priority string \| Choices:* low * default \| Set log transmission priority. \| \| \| server string \| \| Address of remote syslog server. \| \| \| 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 remote syslog logging. \| \| 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 settings for remote syslog server. fmgr_devprof_log_syslogd_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_syslogd_setting: certificate: <value of string> enc-algorithm: <value in [high, low, disable, ...]> facility: <value in [kernel, user, mail, ...]> mode: <value in [udp, legacy-reliable, reliable]> port: <value of integer> server: <value of string> ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]> status: <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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_virtualwanlink_members – no description fortinet.fortimanager.fmgr\_dynamic\_virtualwanlink\_members – 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_members`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dynamic\_virtualwanlink\_members dictionary \| \| the top level parameters set \| \| \| comment string \| \| no description \| \| \| cost integer \| \| no description \| \| \| detect-failtime integer \| \| no description \| \| \| detect-http-get string \| \| no description \| \| \| detect-http-match string \| \| no description \| \| \| detect-http-port integer \| \| no description \| \| \| detect-interval integer \| \| no description \| \| \| detect-protocol string \| Choices:* ping * tcp-echo * udp-echo * http \| no description \| \| \| detect-recoverytime integer \| \| no description \| \| \| detect-server string \| \| no description \| \| \| detect-timeout integer \| \| no description \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_scope list / elements=string \| \| no description \| \| \| \| \| name string \| \| no description \| \| \| \| \| vdom string \| \| no description \| \| \| \| comment string \| \| no description \| \| \| \| cost integer \| \| no description \| \| \| \| detect-failtime integer \| \| no description \| \| \| \| detect-http-get string \| \| no description \| \| \| \| detect-http-match string \| \| no description \| \| \| \| detect-http-port integer \| \| no description \| \| \| \| detect-interval integer \| \| no description \| \| \| \| detect-protocol string \| Choices:* ping * tcp-echo * udp-echo * http \| no description \| \| \| \| detect-recoverytime integer \| \| no description \| \| \| \| detect-server string \| \| no description \| \| \| \| detect-timeout integer \| \| no description \| \| \| \| gateway string \| \| no description \| \| \| \| gateway6 string \| \| no description \| \| \| \| ingress-spillover-threshold integer \| \| no description \| \| \| \| interface string \| \| no description \| \| \| \| priority integer \| \| no description \| \| \| \| source string \| \| no description \| \| \| \| source6 string \| \| no description \| \| \| \| spillover-threshold integer \| \| no description \| \| \| \| status string \| Choices:* disable * enable \| no description \| \| \| \| volume-ratio integer \| \| no description \| \| \| \| weight integer \| \| no description \| \| \| gateway string \| \| no description \| \| \| gateway6 string \| \| no description \| \| \| ingress-spillover-threshold integer \| \| no description \| \| \| interface string \| \| no description \| \| \| name string \| \| no description \| \| \| priority integer \| \| no description \| \| \| source string \| \| no description \| \| \| source6 string \| \| no description \| \| \| spillover-threshold integer \| \| no description \| \| \| status string \| Choices:* disable * enable \| no description \| \| \| volume-ratio integer \| \| no description \| \| \| weight 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: no description fmgr_dynamic_virtualwanlink_members: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> dynamic_virtualwanlink_members: comment: <value of string> cost: <value of integer> detect-failtime: <value of integer> detect-http-get: <value of string> detect-http-match: <value of string> detect-http-port: <value of integer> detect-interval: <value of integer> detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]> detect-recoverytime: <value of integer> detect-server: <value of string> detect-timeout: <value of integer> dynamic_mapping: - _scope: - name: <value of string> vdom: <value of string> comment: <value of string> cost: <value of integer> detect-failtime: <value of integer> detect-http-get: <value of string> detect-http-match: <value of string> detect-http-port: <value of integer> detect-interval: <value of integer> detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]> detect-recoverytime: <value of integer> detect-server: <value of string> detect-timeout: <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> 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> gateway: <value of string> gateway6: <value of string> ingress-spillover-threshold: <value of integer> interface: <value of string> name: <value of string> priority: <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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_snmpuser – Configuration method to edit Simple Network Management Protocol fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_snmpuser – Configuration method to edit Simple Network Management Protocol ======================================================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpuser`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_snmpuser dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configuration method to edit Simple Network Management Protocol fmgr_switchcontroller_managedswitch_snmpuser: bypass_validation: False workspace_locking_adom: <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_snmpuser: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_vipgrp46 – Configure IPv4 to IPv6 virtual IP groups. fortinet.fortimanager.fmgr\_firewall\_vipgrp46 – Configure IPv4 to 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_vipgrp46`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_vipgrp46 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 \| \| VIP46 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 to IPv6 virtual IP groups. fmgr_firewall_vipgrp46: bypass_validation: False workspace_locking_adom: <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_vipgrp46: 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_user_krbkeytab – Configure Kerberos keytab entries. fortinet.fortimanager.fmgr\_user\_krbkeytab – Configure Kerberos keytab 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_krbkeytab`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_krbkeytab dictionary \| \| the top level parameters set \| \| \| keytab string \| \| base64 coded keytab file containing a pre-shared key. \| \| \| ldap-server string \| \| LDAP server name. \| \| \| name string \| \| Kerberos keytab entry name. \| \| \| pac-data string \| Choices:* disable * enable \| Enable/disable parsing PAC data in the ticket. \| \| \| password string \| \| no description \| \| \| principal string \| \| Kerberos service principal, e.g. HTTP/[email protected]. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 Kerberos keytab entries. fmgr_user_krbkeytab: bypass_validation: False workspace_locking_adom: <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_krbkeytab: keytab: <value of string> ldap-server: <value of string> name: <value of string> pac-data: <value in [disable, enable]> principal: <value of string> password: <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_localinpolicy6 – Configure user defined IPv6 local-in policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_localinpolicy6 – Configure user defined IPv6 local-in 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_localinpolicy6`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_localinpolicy6 dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* deny * accept \| Action performed on traffic matching the policy (default = deny). \| \| \| comments string \| \| Comment. \| \| \| dstaddr string \| \| Destination address object from available options. \| \| \| dstaddr-negate string \| Choices:* disable * enable \| When enabled dstaddr specifies what the destination address must NOT be. \| \| \| intf string \| \| Incoming interface name from available options. \| \| \| policyid integer \| \| User defined local in policy ID. \| \| \| schedule string \| \| Schedule object from available options. \| \| \| service string \| \| Service object from available options. Separate names with a space. \| \| \| service-negate string \| Choices:* disable * enable \| When enabled service specifies what the service must NOT be. \| \| \| srcaddr string \| \| Source address object from available options. \| \| \| srcaddr-negate string \| Choices:* disable * enable \| When enabled srcaddr specifies what the source address must NOT be. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this local-in 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 user defined IPv6 local-in policies. fmgr_pkg_firewall_localinpolicy6: bypass_validation: False workspace_locking_adom: <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_localinpolicy6: action: <value in [deny, accept]> dstaddr: <value of string> intf: <value of string> policyid: <value of integer> schedule: <value of string> service: <value of string> srcaddr: <value of string> status: <value in [disable, enable]> comments: <value of string> uuid: <value of string> dstaddr-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_system_sdnconnector_route – Configure GCP route. fortinet.fortimanager.fmgr\_system\_sdnconnector\_route – Configure GCP 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_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 \| \| 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\_route dictionary \| \| the top level parameters set \| \| \| name string \| \| Route 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 GCP route. fmgr_system_sdnconnector_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> state: <value in [present, absent]> system_sdnconnector_route: 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_dynamic_multicast_interface_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_multicast\_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_multicast_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\_multicast\_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_multicast_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_multicast_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_waf_profile_constraint_headerlength – HTTP header length in request. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_headerlength – HTTP header length in request. =================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_headerlength`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_headerlength dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 length in request. fmgr_waf_profile_constraint_headerlength: bypass_validation: False workspace_locking_adom: <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_headerlength: 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_emailfilter_profile_mapi – MAPI. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_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. \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| 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: MAPI. fmgr_emailfilter_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> emailfilter_profile_mapi: action: <value in [pass, discard]> log: <value in [disable, enable]> 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_system_admin_ldap – LDAP server entry configuration. fortinet.fortimanager.fmgr\_system\_admin\_ldap – LDAP 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_system_admin_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ldap dictionary \| \| the top level parameters set \| \| \| adom list / elements=string \| \| no description \| \| \| \| adom-name string \| \| Admin domain names. \| \| \| adom-attr string \| \| Attribute used to retrieve adom \| \| \| attributes string \| Default:"member,uniquemember,memberuid" \| Attributes used for group searching. \| \| \| ca-cert string \| \| CA certificate name. \| \| \| cnid string \| Default:"cn" \| Common Name Identifier (default = CN). \| \| \| connect-timeout integer \| Default:500 \| LDAP connection timeout (msec). \| \| \| dn string \| \| Distinguished Name. \| \| \| filter string \| Default:"(objectclass=\)" \| Filter used for group searching. \| \| \| group* string \| \| Full base DN used for group searching. \| \| \| memberof-attr string \| \| Attribute used to retrieve memeberof. \| \| \| name string \| \| LDAP server entry name. \| \| \| password string \| \| no description \| \| \| port integer \| Default:389 \| Port number of LDAP server (default = 389). \| \| \| profile-attr string \| \| Attribute used to retrieve admin profile. \| \| \| secondary-server string \| \| {<name\_str\|ip\_str>} secondary LDAP server domain name or IP. \| \| \| secure string \| Choices:* disable ← * starttls * ldaps \| SSL connection. disable - No SSL. starttls - Use StartTLS. ldaps - Use LDAPS. \| \| \| server string \| \| {<name\_str\|ip\_str>} LDAP server domain name or IP. \| \| \| tertiary-server string \| \| {<name\_str\|ip\_str>} tertiary LDAP server domain name or IP. \| \| \| type string \| Choices:* simple ← * anonymous * regular \| Type of LDAP binding. simple - Simple password authentication without search. anonymous - Bind using anonymous user search. regular - Bind using username/password and then search. \| \| \| 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: LDAP server entry configuration. fmgr_system_admin_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, ...] state: <value in [present, absent]> system_admin_ldap: adom: - adom-name: <value of string> adom-attr: <value of string> attributes: <value of string> ca-cert: <value of string> cnid: <value of string> connect-timeout: <value of integer> dn: <value of string> filter: <value of string> group: <value of string> memberof-attr: <value of string> name: <value of string> password: <value of string> port: <value of integer> profile-attr: <value of string> secondary-server: <value of string> secure: <value in [disable, starttls, ldaps]> server: <value of string> tertiary-server: <value of string> type: <value in [simple, anonymous, regular]> 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_user_passwordpolicy – Configure user password policy. fortinet.fortimanager.fmgr\_user\_passwordpolicy – Configure user 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_user_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 \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_passwordpolicy dictionary \| \| the top level parameters set \| \| \| expire-days integer \| \| Time in days before the users password expires. \| \| \| expired-password-renewal string \| Choices:* disable * enable \| Enable/disable renewal of a password that already is expired. \| \| \| name string \| \| Password policy name. \| \| \| warn-days integer \| \| Time in days before a password expiration warning message is displayed to the user upon login. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 password policy. fmgr_user_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, ...] adom: <your own value> state: <value in [present, absent]> user_passwordpolicy: expire-days: <value of integer> name: <value of string> warn-days: <value of integer> expired-password-renewal: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf – FortiGuard Web Filter settings. fortinet.fortimanager.fmgr\_webfilter\_profile\_ftgdwf – FortiGuard Web Filter settings. ======================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| profile string / required \| \| the parameter (profile) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| webfilter\_profile\_ftgdwf dictionary \| \| the top level parameters set \| \| \| 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 \| Enable/disable rating images by URL. \| \| \| rate-javascript-urls string \| Choices:* disable * enable \| Enable/disable rating JavaScript by 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: FortiGuard Web Filter settings. fmgr_webfilter_profile_ftgdwf: bypass_validation: False workspace_locking_adom: <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_ftgdwf: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mms – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_mms – 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_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 \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_replacemsg\_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. \| \| 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_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> devprof: <your own value> devprof_system_replacemsg_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) ansible fortinet.fortimanager.fmgr_hotspot20_anqproamingconsortium – Configure roaming consortium. fortinet.fortimanager.fmgr\_hotspot20\_anqproamingconsortium – Configure roaming consortium. ============================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| name string \| \| Roaming consortium name. \| \| \| oi-list list / elements=string \| \| no description \| \| \| \| 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: Configure roaming consortium. fmgr_hotspot20_anqproamingconsortium: bypass_validation: False workspace_locking_adom: <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_anqproamingconsortium: name: <value of string> oi-list: - 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)	programming_docs
ansible fortinet.fortimanager.fmgr_waf_profile_addresslist – Black address list and white address list. fortinet.fortimanager.fmgr\_waf\_profile\_addresslist – Black address list and white 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_waf_profile_addresslist`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_addresslist dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Black address list and white address list. fmgr_waf_profile_addresslist: bypass_validation: False workspace_locking_adom: <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_addresslist: 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible Fortinet.Fortimanager Fortinet.Fortimanager ===================== Collection version 2.1.3 Plugin Index ------------ These are the plugins in the fortinet.fortimanager collection ### Httpapi Plugins * [fortimanager](fortimanager_httpapi#ansible-collections-fortinet-fortimanager-fortimanager-httpapi) – HttpApi Plugin for Fortinet FortiManager Appliance or VM. ### Modules * [fmgr\_adom\_options](fmgr_adom_options_module#ansible-collections-fortinet-fortimanager-fmgr-adom-options-module) – no description * [fmgr\_antivirus\_mmschecksum](fmgr_antivirus_mmschecksum_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-mmschecksum-module) – Configure MMS content checksum list. * [fmgr\_antivirus\_mmschecksum\_entries](fmgr_antivirus_mmschecksum_entries_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-mmschecksum-entries-module) – modify this MMS content checksum list * [fmgr\_antivirus\_notification](fmgr_antivirus_notification_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-notification-module) – Configure AntiVirus notification lists. * [fmgr\_antivirus\_notification\_entries](fmgr_antivirus_notification_entries_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-notification-entries-module) – modify this antivirus notification list * [fmgr\_antivirus\_profile](fmgr_antivirus_profile_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-module) – Configure AntiVirus profiles. * [fmgr\_antivirus\_profile\_cifs](fmgr_antivirus_profile_cifs_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-cifs-module) – Configure CIFS AntiVirus options. * [fmgr\_antivirus\_profile\_contentdisarm](fmgr_antivirus_profile_contentdisarm_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-contentdisarm-module) – AV Content Disarm and Reconstruction settings. * [fmgr\_antivirus\_profile\_ftp](fmgr_antivirus_profile_ftp_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-ftp-module) – Configure FTP AntiVirus options. * [fmgr\_antivirus\_profile\_http](fmgr_antivirus_profile_http_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-http-module) – Configure HTTP AntiVirus options. * [fmgr\_antivirus\_profile\_imap](fmgr_antivirus_profile_imap_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-imap-module) – Configure IMAP AntiVirus options. * [fmgr\_antivirus\_profile\_mapi](fmgr_antivirus_profile_mapi_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-mapi-module) – Configure MAPI AntiVirus options. * [fmgr\_antivirus\_profile\_nacquar](fmgr_antivirus_profile_nacquar_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-nacquar-module) – Configure AntiVirus quarantine settings. * [fmgr\_antivirus\_profile\_nntp](fmgr_antivirus_profile_nntp_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-nntp-module) – Configure NNTP AntiVirus options. * [fmgr\_antivirus\_profile\_outbreakprevention](fmgr_antivirus_profile_outbreakprevention_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-outbreakprevention-module) – Configure Virus Outbreak Prevention settings. * [fmgr\_antivirus\_profile\_pop3](fmgr_antivirus_profile_pop3_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-pop3-module) – Configure POP3 AntiVirus options. * [fmgr\_antivirus\_profile\_smb](fmgr_antivirus_profile_smb_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-smb-module) – Configure SMB AntiVirus options. * [fmgr\_antivirus\_profile\_smtp](fmgr_antivirus_profile_smtp_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-smtp-module) – Configure SMTP AntiVirus options. * [fmgr\_antivirus\_profile\_ssh](fmgr_antivirus_profile_ssh_module#ansible-collections-fortinet-fortimanager-fmgr-antivirus-profile-ssh-module) – Configure SFTP and SCP AntiVirus options. * [fmgr\_apcfgprofile](fmgr_apcfgprofile_module#ansible-collections-fortinet-fortimanager-fmgr-apcfgprofile-module) – Configure AP local configuration profiles. * [fmgr\_apcfgprofile\_commandlist](fmgr_apcfgprofile_commandlist_module#ansible-collections-fortinet-fortimanager-fmgr-apcfgprofile-commandlist-module) – AP local configuration command list. * [fmgr\_application\_categories](fmgr_application_categories_module#ansible-collections-fortinet-fortimanager-fmgr-application-categories-module) – no description * [fmgr\_application\_custom](fmgr_application_custom_module#ansible-collections-fortinet-fortimanager-fmgr-application-custom-module) – Configure custom application signatures. * [fmgr\_application\_group](fmgr_application_group_module#ansible-collections-fortinet-fortimanager-fmgr-application-group-module) – Configure firewall application groups. * [fmgr\_application\_list](fmgr_application_list_module#ansible-collections-fortinet-fortimanager-fmgr-application-list-module) – Configure application control lists. * [fmgr\_application\_list\_defaultnetworkservices](fmgr_application_list_defaultnetworkservices_module#ansible-collections-fortinet-fortimanager-fmgr-application-list-defaultnetworkservices-module) – Default network service entries. * [fmgr\_application\_list\_entries](fmgr_application_list_entries_module#ansible-collections-fortinet-fortimanager-fmgr-application-list-entries-module) – Application list entries. * [fmgr\_application\_list\_entries\_parameters](fmgr_application_list_entries_parameters_module#ansible-collections-fortinet-fortimanager-fmgr-application-list-entries-parameters-module) – Application parameters. * [fmgr\_application\_list\_entries\_parameters\_members](fmgr_application_list_entries_parameters_members_module#ansible-collections-fortinet-fortimanager-fmgr-application-list-entries-parameters-members-module) – Parameter tuple members. * [fmgr\_authentication\_scheme](fmgr_authentication_scheme_module#ansible-collections-fortinet-fortimanager-fmgr-authentication-scheme-module) – Configure Authentication Schemes. * [fmgr\_bleprofile](fmgr_bleprofile_module#ansible-collections-fortinet-fortimanager-fmgr-bleprofile-module) – Configure Bluetooth Low Energy profile. * [fmgr\_bonjourprofile](fmgr_bonjourprofile_module#ansible-collections-fortinet-fortimanager-fmgr-bonjourprofile-module) – Configure Bonjour profiles. * [fmgr\_bonjourprofile\_policylist](fmgr_bonjourprofile_policylist_module#ansible-collections-fortinet-fortimanager-fmgr-bonjourprofile-policylist-module) – Bonjour policy list. * [fmgr\_certificate\_template](fmgr_certificate_template_module#ansible-collections-fortinet-fortimanager-fmgr-certificate-template-module) – no description * [fmgr\_cifs\_domaincontroller](fmgr_cifs_domaincontroller_module#ansible-collections-fortinet-fortimanager-fmgr-cifs-domaincontroller-module) – Define known domain controller servers. * [fmgr\_cifs\_profile](fmgr_cifs_profile_module#ansible-collections-fortinet-fortimanager-fmgr-cifs-profile-module) – Configure CIFS profile. * [fmgr\_cifs\_profile\_filefilter](fmgr_cifs_profile_filefilter_module#ansible-collections-fortinet-fortimanager-fmgr-cifs-profile-filefilter-module) – File filter. * [fmgr\_cifs\_profile\_filefilter\_entries](fmgr_cifs_profile_filefilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-cifs-profile-filefilter-entries-module) – File filter entries. * [fmgr\_cifs\_profile\_serverkeytab](fmgr_cifs_profile_serverkeytab_module#ansible-collections-fortinet-fortimanager-fmgr-cifs-profile-serverkeytab-module) – Server keytab. * [fmgr\_clone](fmgr_clone_module#ansible-collections-fortinet-fortimanager-fmgr-clone-module) – Clone an object in FortiManager. * [fmgr\_credentialstore\_domaincontroller](fmgr_credentialstore_domaincontroller_module#ansible-collections-fortinet-fortimanager-fmgr-credentialstore-domaincontroller-module) – Define known domain controller servers. * [fmgr\_devprof\_device\_profile\_fortianalyzer](fmgr_devprof_device_profile_fortianalyzer_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-device-profile-fortianalyzer-module) – no description * [fmgr\_devprof\_device\_profile\_fortiguard](fmgr_devprof_device_profile_fortiguard_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-device-profile-fortiguard-module) – no description * [fmgr\_devprof\_import](fmgr_devprof_import_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-import-module) – no description * [fmgr\_devprof\_log\_fortianalyzer\_setting](fmgr_devprof_log_fortianalyzer_setting_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-log-fortianalyzer-setting-module) – Global FortiAnalyzer settings. * [fmgr\_devprof\_log\_fortianalyzercloud\_setting](fmgr_devprof_log_fortianalyzercloud_setting_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-log-fortianalyzercloud-setting-module) – Global FortiAnalyzer Cloud settings. * [fmgr\_devprof\_log\_syslogd\_filter](fmgr_devprof_log_syslogd_filter_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-log-syslogd-filter-module) – Filters for remote system server. * [fmgr\_devprof\_log\_syslogd\_setting](fmgr_devprof_log_syslogd_setting_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-log-syslogd-setting-module) – Global settings for remote syslog server. * [fmgr\_devprof\_system\_centralmanagement](fmgr_devprof_system_centralmanagement_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-centralmanagement-module) – Configure central management. * [fmgr\_devprof\_system\_centralmanagement\_serverlist](fmgr_devprof_system_centralmanagement_serverlist_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-centralmanagement-serverlist-module) – Additional severs that the FortiGate can use for updates * [fmgr\_devprof\_system\_dns](fmgr_devprof_system_dns_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-dns-module) – Configure DNS. * [fmgr\_devprof\_system\_emailserver](fmgr_devprof_system_emailserver_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-emailserver-module) – Configure the email server used by the FortiGate various things. * [fmgr\_devprof\_system\_global](fmgr_devprof_system_global_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-global-module) – Configure global attributes. * [fmgr\_devprof\_system\_ntp](fmgr_devprof_system_ntp_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-ntp-module) – Configure system NTP information. * [fmgr\_devprof\_system\_ntp\_ntpserver](fmgr_devprof_system_ntp_ntpserver_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-ntp-ntpserver-module) – Configure the FortiGate to connect to any available third-party NTP server. * [fmgr\_devprof\_system\_replacemsg\_admin](fmgr_devprof_system_replacemsg_admin_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-admin-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_alertmail](fmgr_devprof_system_replacemsg_alertmail_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-alertmail-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_auth](fmgr_devprof_system_replacemsg_auth_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-auth-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_devicedetectionportal](fmgr_devprof_system_replacemsg_devicedetectionportal_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-devicedetectionportal-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_ec](fmgr_devprof_system_replacemsg_ec_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-ec-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_fortiguardwf](fmgr_devprof_system_replacemsg_fortiguardwf_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-fortiguardwf-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_ftp](fmgr_devprof_system_replacemsg_ftp_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-ftp-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_http](fmgr_devprof_system_replacemsg_http_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-http-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_mail](fmgr_devprof_system_replacemsg_mail_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-mail-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_mms](fmgr_devprof_system_replacemsg_mms_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-mms-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_nacquar](fmgr_devprof_system_replacemsg_nacquar_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-nacquar-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_nntp](fmgr_devprof_system_replacemsg_nntp_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-nntp-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_spam](fmgr_devprof_system_replacemsg_spam_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-spam-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_sslvpn](fmgr_devprof_system_replacemsg_sslvpn_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-sslvpn-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_trafficquota](fmgr_devprof_system_replacemsg_trafficquota_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-trafficquota-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_utm](fmgr_devprof_system_replacemsg_utm_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-utm-module) – Replacement messages. * [fmgr\_devprof\_system\_replacemsg\_webproxy](fmgr_devprof_system_replacemsg_webproxy_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-replacemsg-webproxy-module) – Replacement messages. * [fmgr\_devprof\_system\_snmp\_community](fmgr_devprof_system_snmp_community_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-snmp-community-module) – SNMP community configuration. * [fmgr\_devprof\_system\_snmp\_community\_hosts](fmgr_devprof_system_snmp_community_hosts_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-snmp-community-hosts-module) – Configure IPv4 SNMP managers * [fmgr\_devprof\_system\_snmp\_community\_hosts6](fmgr_devprof_system_snmp_community_hosts6_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-snmp-community-hosts6-module) – Configure IPv6 SNMP managers. * [fmgr\_devprof\_system\_snmp\_sysinfo](fmgr_devprof_system_snmp_sysinfo_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-snmp-sysinfo-module) – SNMP system info configuration. * [fmgr\_devprof\_system\_snmp\_user](fmgr_devprof_system_snmp_user_module#ansible-collections-fortinet-fortimanager-fmgr-devprof-system-snmp-user-module) – SNMP user configuration. * [fmgr\_dlp\_filepattern](fmgr_dlp_filepattern_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-filepattern-module) – Configure file patterns used by DLP blocking. * [fmgr\_dlp\_filepattern\_entries](fmgr_dlp_filepattern_entries_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-filepattern-entries-module) – Configure file patterns used by DLP blocking. * [fmgr\_dlp\_fpsensitivity](fmgr_dlp_fpsensitivity_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-fpsensitivity-module) – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source. * [fmgr\_dlp\_sensitivity](fmgr_dlp_sensitivity_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-sensitivity-module) – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source. * [fmgr\_dlp\_sensor](fmgr_dlp_sensor_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-sensor-module) – Configure DLP sensors. * [fmgr\_dlp\_sensor\_filter](fmgr_dlp_sensor_filter_module#ansible-collections-fortinet-fortimanager-fmgr-dlp-sensor-filter-module) – Set up DLP filters for this sensor. * [fmgr\_dnsfilter\_domainfilter](fmgr_dnsfilter_domainfilter_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-domainfilter-module) – Configure DNS domain filters. * [fmgr\_dnsfilter\_domainfilter\_entries](fmgr_dnsfilter_domainfilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-domainfilter-entries-module) – DNS domain filter entries. * [fmgr\_dnsfilter\_profile](fmgr_dnsfilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-profile-module) – Configure DNS domain filter profiles. * [fmgr\_dnsfilter\_profile\_dnstranslation](fmgr_dnsfilter_profile_dnstranslation_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-profile-dnstranslation-module) – DNS translation settings. * [fmgr\_dnsfilter\_profile\_domainfilter](fmgr_dnsfilter_profile_domainfilter_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-profile-domainfilter-module) – Domain filter settings. * [fmgr\_dnsfilter\_profile\_ftgddns](fmgr_dnsfilter_profile_ftgddns_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-profile-ftgddns-module) – FortiGuard DNS Filter settings. * [fmgr\_dnsfilter\_profile\_ftgddns\_filters](fmgr_dnsfilter_profile_ftgddns_filters_module#ansible-collections-fortinet-fortimanager-fmgr-dnsfilter-profile-ftgddns-filters-module) – FortiGuard DNS domain filters. * [fmgr\_dvm\_cmd\_add\_device](fmgr_dvm_cmd_add_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-add-device-module) – Add a device to the Device Manager database. * [fmgr\_dvm\_cmd\_add\_devlist](fmgr_dvm_cmd_add_devlist_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-add-devlist-module) – Add multiple devices to the Device Manager database. * [fmgr\_dvm\_cmd\_changehaseq](fmgr_dvm_cmd_changehaseq_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-changehaseq-module) – Modify HA sequence to promote a slave to become the master of the cluster. * [fmgr\_dvm\_cmd\_del\_device](fmgr_dvm_cmd_del_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-del-device-module) – Delete a device. * [fmgr\_dvm\_cmd\_del\_devlist](fmgr_dvm_cmd_del_devlist_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-del-devlist-module) – Delete a list of devices. * [fmgr\_dvm\_cmd\_discover\_device](fmgr_dvm_cmd_discover_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-discover-device-module) – Probe a remote device and retrieve its device information and system status. * [fmgr\_dvm\_cmd\_import\_devlist](fmgr_dvm_cmd_import_devlist_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-import-devlist-module) – Import a list of ADOMs and devices. * [fmgr\_dvm\_cmd\_reload\_devlist](fmgr_dvm_cmd_reload_devlist_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-reload-devlist-module) – Retrieve a list of devices. * [fmgr\_dvm\_cmd\_update\_device](fmgr_dvm_cmd_update_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-update-device-module) – Refresh the FGFM connection and system information of a device. * [fmgr\_dvm\_cmd\_update\_devlist](fmgr_dvm_cmd_update_devlist_module#ansible-collections-fortinet-fortimanager-fmgr-dvm-cmd-update-devlist-module) – Refresh FGFM connection and system information for a list of devices. * [fmgr\_dvmdb\_adom](fmgr_dvmdb_adom_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-adom-module) – ADOM table, most attributes are read-only and can only be changed internally. * [fmgr\_dvmdb\_adom\_objectmember](fmgr_dvmdb_adom_objectmember_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-adom-objectmember-module) – ADOM table, most attributes are read-only and can only be changed internally. * [fmgr\_dvmdb\_device](fmgr_dvmdb_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-device-module) – Device table, most attributes are read-only and can only be changed internally. * [fmgr\_dvmdb\_device\_replace\_sn](fmgr_dvmdb_device_replace_sn_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-device-replace-sn-module) – Replace devices serial number with new value. * [fmgr\_dvmdb\_device\_vdom](fmgr_dvmdb_device_vdom_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-device-vdom-module) – Device VDOM table. * [fmgr\_dvmdb\_folder](fmgr_dvmdb_folder_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-folder-module) – no description * [fmgr\_dvmdb\_group](fmgr_dvmdb_group_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-group-module) – Device group table. * [fmgr\_dvmdb\_group\_objectmember](fmgr_dvmdb_group_objectmember_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-group-objectmember-module) – Device group table. * [fmgr\_dvmdb\_metafields\_adom](fmgr_dvmdb_metafields_adom_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-metafields-adom-module) – no description * [fmgr\_dvmdb\_metafields\_device](fmgr_dvmdb_metafields_device_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-metafields-device-module) – no description * [fmgr\_dvmdb\_metafields\_group](fmgr_dvmdb_metafields_group_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-metafields-group-module) – no description * [fmgr\_dvmdb\_revision](fmgr_dvmdb_revision_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-revision-module) – ADOM revision table. * [fmgr\_dvmdb\_script](fmgr_dvmdb_script_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-script-module) – Script table. * [fmgr\_dvmdb\_script\_execute](fmgr_dvmdb_script_execute_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-script-execute-module) – Run script. * [fmgr\_dvmdb\_script\_objectmember](fmgr_dvmdb_script_objectmember_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-script-objectmember-module) – Script table. * [fmgr\_dvmdb\_script\_scriptschedule](fmgr_dvmdb_script_scriptschedule_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-script-scriptschedule-module) – Script schedule table. * [fmgr\_dvmdb\_workflow\_approve](fmgr_dvmdb_workflow_approve_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-approve-module) – no description * [fmgr\_dvmdb\_workflow\_discard](fmgr_dvmdb_workflow_discard_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-discard-module) – no description * [fmgr\_dvmdb\_workflow\_drop](fmgr_dvmdb_workflow_drop_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-drop-module) – no description * [fmgr\_dvmdb\_workflow\_reject](fmgr_dvmdb_workflow_reject_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-reject-module) – no description * [fmgr\_dvmdb\_workflow\_repair](fmgr_dvmdb_workflow_repair_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-repair-module) – no description * [fmgr\_dvmdb\_workflow\_revert](fmgr_dvmdb_workflow_revert_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-revert-module) – no description * [fmgr\_dvmdb\_workflow\_review](fmgr_dvmdb_workflow_review_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-review-module) – no description * [fmgr\_dvmdb\_workflow\_save](fmgr_dvmdb_workflow_save_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-save-module) – no description * [fmgr\_dvmdb\_workflow\_start](fmgr_dvmdb_workflow_start_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-start-module) – Continue a workflow session. * [fmgr\_dvmdb\_workflow\_submit](fmgr_dvmdb_workflow_submit_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workflow-submit-module) – no description * [fmgr\_dvmdb\_workspace\_commit](fmgr_dvmdb_workspace_commit_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-commit-module) – Commit change * [fmgr\_dvmdb\_workspace\_commit\_dev](fmgr_dvmdb_workspace_commit_dev_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-commit-dev-module) – Commit change * [fmgr\_dvmdb\_workspace\_commit\_obj](fmgr_dvmdb_workspace_commit_obj_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-commit-obj-module) – Commit change * [fmgr\_dvmdb\_workspace\_commit\_pkg](fmgr_dvmdb_workspace_commit_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-commit-pkg-module) – Commit change * [fmgr\_dvmdb\_workspace\_lock](fmgr_dvmdb_workspace_lock_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-lock-module) – Lock an entire ADOM. * [fmgr\_dvmdb\_workspace\_lock\_dev](fmgr_dvmdb_workspace_lock_dev_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-lock-dev-module) – Lock a device. * [fmgr\_dvmdb\_workspace\_lock\_obj](fmgr_dvmdb_workspace_lock_obj_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-lock-obj-module) – Lock a specific object, where the url contains the full path to the object * [fmgr\_dvmdb\_workspace\_lock\_pkg](fmgr_dvmdb_workspace_lock_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-lock-pkg-module) – Lock a specific package, where the url includes both the folder * [fmgr\_dvmdb\_workspace\_unlock](fmgr_dvmdb_workspace_unlock_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-unlock-module) – Unlock an entire ADOM. * [fmgr\_dvmdb\_workspace\_unlock\_dev](fmgr_dvmdb_workspace_unlock_dev_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-unlock-dev-module) – Unlock a device. * [fmgr\_dvmdb\_workspace\_unlock\_obj](fmgr_dvmdb_workspace_unlock_obj_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-unlock-obj-module) – Unlock a specific object, where the url contains the full path to the object * [fmgr\_dvmdb\_workspace\_unlock\_pkg](fmgr_dvmdb_workspace_unlock_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-dvmdb-workspace-unlock-pkg-module) – Unlock a specific package, where the url includes both the folder * [fmgr\_dynamic\_address](fmgr_dynamic_address_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-address-module) – no description * [fmgr\_dynamic\_address\_dynamicaddrmapping](fmgr_dynamic_address_dynamicaddrmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-address-dynamicaddrmapping-module) – no description * [fmgr\_dynamic\_certificate\_local](fmgr_dynamic_certificate_local_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-certificate-local-module) – no description * [fmgr\_dynamic\_certificate\_local\_dynamicmapping](fmgr_dynamic_certificate_local_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-certificate-local-dynamicmapping-module) – no description * [fmgr\_dynamic\_input\_interface](fmgr_dynamic_input_interface_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-input-interface-module) – no description * [fmgr\_dynamic\_input\_interface\_dynamicmapping](fmgr_dynamic_input_interface_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-input-interface-dynamicmapping-module) – no description * [fmgr\_dynamic\_interface](fmgr_dynamic_interface_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-interface-module) – no description * [fmgr\_dynamic\_interface\_dynamicmapping](fmgr_dynamic_interface_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-interface-dynamicmapping-module) – no description * [fmgr\_dynamic\_interface\_platformmapping](fmgr_dynamic_interface_platformmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-interface-platformmapping-module) – no description * [fmgr\_dynamic\_ippool](fmgr_dynamic_ippool_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-ippool-module) – no description * [fmgr\_dynamic\_multicast\_interface](fmgr_dynamic_multicast_interface_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-multicast-interface-module) – no description * [fmgr\_dynamic\_multicast\_interface\_dynamicmapping](fmgr_dynamic_multicast_interface_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-multicast-interface-dynamicmapping-module) – no description * [fmgr\_dynamic\_vip](fmgr_dynamic_vip_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-vip-module) – no description * [fmgr\_dynamic\_virtualwanlink\_members](fmgr_dynamic_virtualwanlink_members_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-members-module) – no description * [fmgr\_dynamic\_virtualwanlink\_members\_dynamicmapping](fmgr_dynamic_virtualwanlink_members_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-members-dynamicmapping-module) – no description * [fmgr\_dynamic\_virtualwanlink\_neighbor](fmgr_dynamic_virtualwanlink_neighbor_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-neighbor-module) – no description * [fmgr\_dynamic\_virtualwanlink\_neighbor\_dynamicmapping](fmgr_dynamic_virtualwanlink_neighbor_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-neighbor-dynamicmapping-module) – no description * [fmgr\_dynamic\_virtualwanlink\_server](fmgr_dynamic_virtualwanlink_server_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-server-module) – no description * [fmgr\_dynamic\_virtualwanlink\_server\_dynamicmapping](fmgr_dynamic_virtualwanlink_server_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-virtualwanlink-server-dynamicmapping-module) – no description * [fmgr\_dynamic\_vpntunnel](fmgr_dynamic_vpntunnel_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-vpntunnel-module) – no description * [fmgr\_dynamic\_vpntunnel\_dynamicmapping](fmgr_dynamic_vpntunnel_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-dynamic-vpntunnel-dynamicmapping-module) – no description * [fmgr\_emailfilter\_blockallowlist](fmgr_emailfilter_blockallowlist_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-blockallowlist-module) – Configure anti-spam block/allow list. * [fmgr\_emailfilter\_blockallowlist\_entries](fmgr_emailfilter_blockallowlist_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-blockallowlist-entries-module) – Anti-spam block/allow entries. * [fmgr\_emailfilter\_bwl](fmgr_emailfilter_bwl_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-bwl-module) – Configure anti-spam black/white list. * [fmgr\_emailfilter\_bwl\_entries](fmgr_emailfilter_bwl_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-bwl-entries-module) – Anti-spam black/white list entries. * [fmgr\_emailfilter\_bword](fmgr_emailfilter_bword_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-bword-module) – Configure AntiSpam banned word list. * [fmgr\_emailfilter\_bword\_entries](fmgr_emailfilter_bword_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-bword-entries-module) – Spam filter banned word. * [fmgr\_emailfilter\_dnsbl](fmgr_emailfilter_dnsbl_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-dnsbl-module) – Configure AntiSpam DNSBL/ORBL. * [fmgr\_emailfilter\_dnsbl\_entries](fmgr_emailfilter_dnsbl_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-dnsbl-entries-module) – Spam filter DNSBL and ORBL server. * [fmgr\_emailfilter\_fortishield](fmgr_emailfilter_fortishield_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-fortishield-module) – Configure FortiGuard - AntiSpam. * [fmgr\_emailfilter\_iptrust](fmgr_emailfilter_iptrust_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-iptrust-module) – Configure AntiSpam IP trust. * [fmgr\_emailfilter\_iptrust\_entries](fmgr_emailfilter_iptrust_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-iptrust-entries-module) – Spam filter trusted IP addresses. * [fmgr\_emailfilter\_mheader](fmgr_emailfilter_mheader_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-mheader-module) – Configure AntiSpam MIME header. * [fmgr\_emailfilter\_mheader\_entries](fmgr_emailfilter_mheader_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-mheader-entries-module) – Spam filter mime header content. * [fmgr\_emailfilter\_options](fmgr_emailfilter_options_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-options-module) – Configure AntiSpam options. * [fmgr\_emailfilter\_profile](fmgr_emailfilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-module) – Configure Email Filter profiles. * [fmgr\_emailfilter\_profile\_filefilter](fmgr_emailfilter_profile_filefilter_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-filefilter-module) – File filter. * [fmgr\_emailfilter\_profile\_filefilter\_entries](fmgr_emailfilter_profile_filefilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-filefilter-entries-module) – File filter entries. * [fmgr\_emailfilter\_profile\_gmail](fmgr_emailfilter_profile_gmail_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-gmail-module) – Gmail. * [fmgr\_emailfilter\_profile\_imap](fmgr_emailfilter_profile_imap_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-imap-module) – IMAP. * [fmgr\_emailfilter\_profile\_mapi](fmgr_emailfilter_profile_mapi_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-mapi-module) – MAPI. * [fmgr\_emailfilter\_profile\_msnhotmail](fmgr_emailfilter_profile_msnhotmail_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-msnhotmail-module) – MSN Hotmail. * [fmgr\_emailfilter\_profile\_otherwebmails](fmgr_emailfilter_profile_otherwebmails_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-otherwebmails-module) – Other supported webmails. * [fmgr\_emailfilter\_profile\_pop3](fmgr_emailfilter_profile_pop3_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-pop3-module) – POP3. * [fmgr\_emailfilter\_profile\_smtp](fmgr_emailfilter_profile_smtp_module#ansible-collections-fortinet-fortimanager-fmgr-emailfilter-profile-smtp-module) – SMTP. * [fmgr\_exec\_fgfm\_reclaimdevtunnel](fmgr_exec_fgfm_reclaimdevtunnel_module#ansible-collections-fortinet-fortimanager-fmgr-exec-fgfm-reclaimdevtunnel-module) – Reclaim management tunnel to device. * [fmgr\_extendercontroller\_dataplan](fmgr_extendercontroller_dataplan_module#ansible-collections-fortinet-fortimanager-fmgr-extendercontroller-dataplan-module) – FortiExtender dataplan configuration. * [fmgr\_extendercontroller\_simprofile](fmgr_extendercontroller_simprofile_module#ansible-collections-fortinet-fortimanager-fmgr-extendercontroller-simprofile-module) – no description * [fmgr\_extendercontroller\_simprofile\_autoswitchprofile](fmgr_extendercontroller_simprofile_autoswitchprofile_module#ansible-collections-fortinet-fortimanager-fmgr-extendercontroller-simprofile-autoswitchprofile-module) – no description * [fmgr\_extendercontroller\_template](fmgr_extendercontroller_template_module#ansible-collections-fortinet-fortimanager-fmgr-extendercontroller-template-module) – no description * [fmgr\_fact](fmgr_fact_module#ansible-collections-fortinet-fortimanager-fmgr-fact-module) – Gather fortimanager facts. * [fmgr\_filefilter\_profile](fmgr_filefilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-filefilter-profile-module) – Configure file-filter profiles. * [fmgr\_filefilter\_profile\_rules](fmgr_filefilter_profile_rules_module#ansible-collections-fortinet-fortimanager-fmgr-filefilter-profile-rules-module) – File filter rules. * [fmgr\_firewall\_accessproxy](fmgr_firewall_accessproxy_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-module) – Configure Access Proxy. * [fmgr\_firewall\_accessproxy\_apigateway](fmgr_firewall_accessproxy_apigateway_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-apigateway-module) – Set API Gateway. * [fmgr\_firewall\_accessproxy\_apigateway\_realservers](fmgr_firewall_accessproxy_apigateway_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-apigateway-realservers-module) – Select the real servers that this Access Proxy will distribute traffic to. * [fmgr\_firewall\_accessproxy\_apigateway\_sslciphersuites](fmgr_firewall_accessproxy_apigateway_sslciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-apigateway-sslciphersuites-module) – SSL/TLS cipher suites to offer to a server, ordered by priority. * [fmgr\_firewall\_accessproxy\_realservers](fmgr_firewall_accessproxy_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-realservers-module) – Select the SSL real servers that this Access Proxy will distribute traffic to. * [fmgr\_firewall\_accessproxy\_serverpubkeyauthsettings](fmgr_firewall_accessproxy_serverpubkeyauthsettings_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-serverpubkeyauthsettings-module) – Server SSH public key authentication settings. * [fmgr\_firewall\_accessproxy\_serverpubkeyauthsettings\_certextension](fmgr_firewall_accessproxy_serverpubkeyauthsettings_certextension_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-accessproxy-serverpubkeyauthsettings-certextension-module) – Configure certificate extension for user certificate. * [fmgr\_firewall\_address](fmgr_firewall_address_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address-module) – Configure IPv4 addresses. * [fmgr\_firewall\_address6](fmgr_firewall_address6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-module) – Configure IPv6 firewall addresses. * [fmgr\_firewall\_address6\_dynamicmapping](fmgr_firewall_address6_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-dynamicmapping-module) – Configure IPv6 firewall addresses. * [fmgr\_firewall\_address6\_dynamicmapping\_subnetsegment](fmgr_firewall_address6_dynamicmapping_subnetsegment_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-dynamicmapping-subnetsegment-module) – IPv6 subnet segments. * [fmgr\_firewall\_address6\_list](fmgr_firewall_address6_list_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-list-module) – IP address list. * [fmgr\_firewall\_address6\_subnetsegment](fmgr_firewall_address6_subnetsegment_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-subnetsegment-module) – IPv6 subnet segments. * [fmgr\_firewall\_address6\_tagging](fmgr_firewall_address6_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6-tagging-module) – Config object tagging * [fmgr\_firewall\_address6template](fmgr_firewall_address6template_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6template-module) – Configure IPv6 address templates. * [fmgr\_firewall\_address6template\_subnetsegment](fmgr_firewall_address6template_subnetsegment_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6template-subnetsegment-module) – IPv6 subnet segments. * [fmgr\_firewall\_address6template\_subnetsegment\_values](fmgr_firewall_address6template_subnetsegment_values_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address6template-subnetsegment-values-module) – Subnet segment values. * [fmgr\_firewall\_address\_dynamicmapping](fmgr_firewall_address_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address-dynamicmapping-module) – Configure IPv4 addresses. * [fmgr\_firewall\_address\_list](fmgr_firewall_address_list_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address-list-module) – IP address list. * [fmgr\_firewall\_address\_tagging](fmgr_firewall_address_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-address-tagging-module) – Config object tagging. * [fmgr\_firewall\_addrgrp](fmgr_firewall_addrgrp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp-module) – Configure IPv4 address groups. * [fmgr\_firewall\_addrgrp6](fmgr_firewall_addrgrp6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp6-module) – Configure IPv6 address groups. * [fmgr\_firewall\_addrgrp6\_dynamicmapping](fmgr_firewall_addrgrp6_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp6-dynamicmapping-module) – Configure IPv6 address groups. * [fmgr\_firewall\_addrgrp6\_tagging](fmgr_firewall_addrgrp6_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp6-tagging-module) – Config object tagging. * [fmgr\_firewall\_addrgrp\_dynamicmapping](fmgr_firewall_addrgrp_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp-dynamicmapping-module) – Configure IPv4 address groups. * [fmgr\_firewall\_addrgrp\_tagging](fmgr_firewall_addrgrp_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-addrgrp-tagging-module) – Config object tagging. * [fmgr\_firewall\_carrierendpointbwl](fmgr_firewall_carrierendpointbwl_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-carrierendpointbwl-module) – Carrier end point black/white list tables. * [fmgr\_firewall\_carrierendpointbwl\_entries](fmgr_firewall_carrierendpointbwl_entries_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-carrierendpointbwl-entries-module) – Carrier end point black/white list. * [fmgr\_firewall\_decryptedtrafficmirror](fmgr_firewall_decryptedtrafficmirror_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-decryptedtrafficmirror-module) – Configure decrypted traffic mirror. * [fmgr\_firewall\_gtp](fmgr_firewall_gtp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-module) – Configure GTP. * [fmgr\_firewall\_gtp\_apn](fmgr_firewall_gtp_apn_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-apn-module) – APN. * [fmgr\_firewall\_gtp\_ieremovepolicy](fmgr_firewall_gtp_ieremovepolicy_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-ieremovepolicy-module) – IE remove policy. * [fmgr\_firewall\_gtp\_ievalidation](fmgr_firewall_gtp_ievalidation_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-ievalidation-module) – IE validation. * [fmgr\_firewall\_gtp\_imsi](fmgr_firewall_gtp_imsi_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-imsi-module) – IMSI. * [fmgr\_firewall\_gtp\_ippolicy](fmgr_firewall_gtp_ippolicy_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-ippolicy-module) – IP policy. * [fmgr\_firewall\_gtp\_messageratelimit](fmgr_firewall_gtp_messageratelimit_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-messageratelimit-module) – Message rate limiting. * [fmgr\_firewall\_gtp\_messageratelimitv0](fmgr_firewall_gtp_messageratelimitv0_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-messageratelimitv0-module) – Message rate limiting for GTP version 0. * [fmgr\_firewall\_gtp\_messageratelimitv1](fmgr_firewall_gtp_messageratelimitv1_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-messageratelimitv1-module) – Message rate limiting for GTP version 1. * [fmgr\_firewall\_gtp\_messageratelimitv2](fmgr_firewall_gtp_messageratelimitv2_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-messageratelimitv2-module) – Message rate limiting for GTP version 2. * [fmgr\_firewall\_gtp\_noippolicy](fmgr_firewall_gtp_noippolicy_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-noippolicy-module) – No IP policy. * [fmgr\_firewall\_gtp\_perapnshaper](fmgr_firewall_gtp_perapnshaper_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-perapnshaper-module) – Per APN shaper. * [fmgr\_firewall\_gtp\_policy](fmgr_firewall_gtp_policy_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-policy-module) – Policy. * [fmgr\_firewall\_gtp\_policyv2](fmgr_firewall_gtp_policyv2_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-gtp-policyv2-module) – Apply allow or deny action to each GTPv2-c packet. * [fmgr\_firewall\_identitybasedroute](fmgr_firewall_identitybasedroute_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-identitybasedroute-module) – Configure identity based routing. * [fmgr\_firewall\_identitybasedroute\_rule](fmgr_firewall_identitybasedroute_rule_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-identitybasedroute-rule-module) – Rule. * [fmgr\_firewall\_internetservice](fmgr_firewall_internetservice_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservice-module) – Show Internet Service application. * [fmgr\_firewall\_internetservice\_entry](fmgr_firewall_internetservice_entry_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservice-entry-module) – Entries in the Internet Service database. * [fmgr\_firewall\_internetserviceaddition](fmgr_firewall_internetserviceaddition_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetserviceaddition-module) – Configure Internet Services Addition. * [fmgr\_firewall\_internetserviceaddition\_entry](fmgr_firewall_internetserviceaddition_entry_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetserviceaddition-entry-module) – Entries added to the Internet Service addition database. * [fmgr\_firewall\_internetserviceaddition\_entry\_portrange](fmgr_firewall_internetserviceaddition_entry_portrange_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetserviceaddition-entry-portrange-module) – Port ranges in the custom entry. * [fmgr\_firewall\_internetservicecustom](fmgr_firewall_internetservicecustom_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustom-module) – Configure custom Internet Services. * [fmgr\_firewall\_internetservicecustom\_disableentry](fmgr_firewall_internetservicecustom_disableentry_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustom-disableentry-module) – Disable entries in the Internet Service database. * [fmgr\_firewall\_internetservicecustom\_disableentry\_iprange](fmgr_firewall_internetservicecustom_disableentry_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustom-disableentry-iprange-module) – IP ranges in the disable entry. * [fmgr\_firewall\_internetservicecustom\_entry](fmgr_firewall_internetservicecustom_entry_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustom-entry-module) – Entries added to the Internet Service database and custom database. * [fmgr\_firewall\_internetservicecustom\_entry\_portrange](fmgr_firewall_internetservicecustom_entry_portrange_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustom-entry-portrange-module) – Port ranges in the custom entry. * [fmgr\_firewall\_internetservicecustomgroup](fmgr_firewall_internetservicecustomgroup_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicecustomgroup-module) – Configure custom Internet Service group. * [fmgr\_firewall\_internetservicegroup](fmgr_firewall_internetservicegroup_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicegroup-module) – Configure group of Internet Service. * [fmgr\_firewall\_internetservicename](fmgr_firewall_internetservicename_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-internetservicename-module) – Define internet service names. * [fmgr\_firewall\_ippool](fmgr_firewall_ippool_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ippool-module) – Configure IPv4 IP pools. * [fmgr\_firewall\_ippool6](fmgr_firewall_ippool6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ippool6-module) – Configure IPv6 IP pools. * [fmgr\_firewall\_ippool6\_dynamicmapping](fmgr_firewall_ippool6_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ippool6-dynamicmapping-module) – Configure IPv6 IP pools. * [fmgr\_firewall\_ippool\_dynamicmapping](fmgr_firewall_ippool_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ippool-dynamicmapping-module) – Configure IPv4 IP pools. * [fmgr\_firewall\_ldbmonitor](fmgr_firewall_ldbmonitor_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ldbmonitor-module) – Configure server load balancing health monitors. * [fmgr\_firewall\_mmsprofile](fmgr_firewall_mmsprofile_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-module) – Configure MMS profiles. * [fmgr\_firewall\_mmsprofile\_dupe](fmgr_firewall_mmsprofile_dupe_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-dupe-module) – Duplicate configuration. * [fmgr\_firewall\_mmsprofile\_flood](fmgr_firewall_mmsprofile_flood_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-flood-module) – Flood configuration. * [fmgr\_firewall\_mmsprofile\_notification](fmgr_firewall_mmsprofile_notification_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-notification-module) – Notification configuration. * [fmgr\_firewall\_mmsprofile\_notifmsisdn](fmgr_firewall_mmsprofile_notifmsisdn_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-notifmsisdn-module) – Notification for MSISDNs. * [fmgr\_firewall\_mmsprofile\_outbreakprevention](fmgr_firewall_mmsprofile_outbreakprevention_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-mmsprofile-outbreakprevention-module) – Configure Virus Outbreak Prevention settings. * [fmgr\_firewall\_multicastaddress](fmgr_firewall_multicastaddress_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-multicastaddress-module) – Configure multicast addresses. * [fmgr\_firewall\_multicastaddress6](fmgr_firewall_multicastaddress6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-multicastaddress6-module) – Configure IPv6 multicast address. * [fmgr\_firewall\_multicastaddress6\_tagging](fmgr_firewall_multicastaddress6_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-multicastaddress6-tagging-module) – Config object tagging. * [fmgr\_firewall\_multicastaddress\_tagging](fmgr_firewall_multicastaddress_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-multicastaddress-tagging-module) – Config object tagging. * [fmgr\_firewall\_profilegroup](fmgr_firewall_profilegroup_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profilegroup-module) – Configure profile groups. * [fmgr\_firewall\_profileprotocoloptions](fmgr_firewall_profileprotocoloptions_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-module) – Configure protocol options. * [fmgr\_firewall\_profileprotocoloptions\_cifs](fmgr_firewall_profileprotocoloptions_cifs_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-cifs-module) – Configure CIFS protocol options. * [fmgr\_firewall\_profileprotocoloptions\_cifs\_filefilter](fmgr_firewall_profileprotocoloptions_cifs_filefilter_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-cifs-filefilter-module) – File filter. * [fmgr\_firewall\_profileprotocoloptions\_cifs\_filefilter\_entries](fmgr_firewall_profileprotocoloptions_cifs_filefilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-cifs-filefilter-entries-module) – File filter entries. * [fmgr\_firewall\_profileprotocoloptions\_cifs\_serverkeytab](fmgr_firewall_profileprotocoloptions_cifs_serverkeytab_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-cifs-serverkeytab-module) – Server keytab. * [fmgr\_firewall\_profileprotocoloptions\_dns](fmgr_firewall_profileprotocoloptions_dns_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-dns-module) – Configure DNS protocol options. * [fmgr\_firewall\_profileprotocoloptions\_ftp](fmgr_firewall_profileprotocoloptions_ftp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-ftp-module) – Configure FTP protocol options. * [fmgr\_firewall\_profileprotocoloptions\_http](fmgr_firewall_profileprotocoloptions_http_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-http-module) – Configure HTTP protocol options. * [fmgr\_firewall\_profileprotocoloptions\_imap](fmgr_firewall_profileprotocoloptions_imap_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-imap-module) – Configure IMAP protocol options. * [fmgr\_firewall\_profileprotocoloptions\_mailsignature](fmgr_firewall_profileprotocoloptions_mailsignature_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-mailsignature-module) – Configure Mail signature. * [fmgr\_firewall\_profileprotocoloptions\_mapi](fmgr_firewall_profileprotocoloptions_mapi_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-mapi-module) – Configure MAPI protocol options. * [fmgr\_firewall\_profileprotocoloptions\_nntp](fmgr_firewall_profileprotocoloptions_nntp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-nntp-module) – Configure NNTP protocol options. * [fmgr\_firewall\_profileprotocoloptions\_pop3](fmgr_firewall_profileprotocoloptions_pop3_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-pop3-module) – Configure POP3 protocol options. * [fmgr\_firewall\_profileprotocoloptions\_smtp](fmgr_firewall_profileprotocoloptions_smtp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-smtp-module) – Configure SMTP protocol options. * [fmgr\_firewall\_profileprotocoloptions\_ssh](fmgr_firewall_profileprotocoloptions_ssh_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-profileprotocoloptions-ssh-module) – Configure SFTP and SCP protocol options. * [fmgr\_firewall\_proxyaddress](fmgr_firewall_proxyaddress_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-proxyaddress-module) – Web proxy address configuration. * [fmgr\_firewall\_proxyaddress\_headergroup](fmgr_firewall_proxyaddress_headergroup_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-proxyaddress-headergroup-module) – HTTP header group. * [fmgr\_firewall\_proxyaddress\_tagging](fmgr_firewall_proxyaddress_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-proxyaddress-tagging-module) – Config object tagging. * [fmgr\_firewall\_proxyaddrgrp](fmgr_firewall_proxyaddrgrp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-proxyaddrgrp-module) – Web proxy address group configuration. * [fmgr\_firewall\_proxyaddrgrp\_tagging](fmgr_firewall_proxyaddrgrp_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-proxyaddrgrp-tagging-module) – Config object tagging. * [fmgr\_firewall\_schedule\_group](fmgr_firewall_schedule_group_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-schedule-group-module) – Schedule group configuration. * [fmgr\_firewall\_schedule\_onetime](fmgr_firewall_schedule_onetime_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-schedule-onetime-module) – Onetime schedule configuration. * [fmgr\_firewall\_schedule\_recurring](fmgr_firewall_schedule_recurring_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-schedule-recurring-module) – Recurring schedule configuration. * [fmgr\_firewall\_service\_category](fmgr_firewall_service_category_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-service-category-module) – Configure service categories. * [fmgr\_firewall\_service\_custom](fmgr_firewall_service_custom_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-service-custom-module) – Configure custom services. * [fmgr\_firewall\_service\_group](fmgr_firewall_service_group_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-service-group-module) – Configure service groups. * [fmgr\_firewall\_shaper\_peripshaper](fmgr_firewall_shaper_peripshaper_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-shaper-peripshaper-module) – Configure per-IP traffic shaper. * [fmgr\_firewall\_shaper\_trafficshaper](fmgr_firewall_shaper_trafficshaper_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-shaper-trafficshaper-module) – Configure shared traffic shaper. * [fmgr\_firewall\_shapingprofile](fmgr_firewall_shapingprofile_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-shapingprofile-module) – Configure shaping profiles. * [fmgr\_firewall\_shapingprofile\_shapingentries](fmgr_firewall_shapingprofile_shapingentries_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-shapingprofile-shapingentries-module) – Define shaping entries of this shaping profile. * [fmgr\_firewall\_ssh\_localca](fmgr_firewall_ssh_localca_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-ssh-localca-module) – SSH proxy local CA. * [fmgr\_firewall\_sslsshprofile](fmgr_firewall_sslsshprofile_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-module) – Configure SSL/SSH protocol options. * [fmgr\_firewall\_sslsshprofile\_dot](fmgr_firewall_sslsshprofile_dot_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-dot-module) – Configure DNS over TLS options. * [fmgr\_firewall\_sslsshprofile\_ftps](fmgr_firewall_sslsshprofile_ftps_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-ftps-module) – Configure FTPS options. * [fmgr\_firewall\_sslsshprofile\_https](fmgr_firewall_sslsshprofile_https_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-https-module) – Configure HTTPS options. * [fmgr\_firewall\_sslsshprofile\_imaps](fmgr_firewall_sslsshprofile_imaps_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-imaps-module) – Configure IMAPS options. * [fmgr\_firewall\_sslsshprofile\_pop3s](fmgr_firewall_sslsshprofile_pop3s_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-pop3s-module) – Configure POP3S options. * [fmgr\_firewall\_sslsshprofile\_smtps](fmgr_firewall_sslsshprofile_smtps_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-smtps-module) – Configure SMTPS options. * [fmgr\_firewall\_sslsshprofile\_ssh](fmgr_firewall_sslsshprofile_ssh_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-ssh-module) – Configure SSH options. * [fmgr\_firewall\_sslsshprofile\_ssl](fmgr_firewall_sslsshprofile_ssl_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-ssl-module) – Configure SSL options. * [fmgr\_firewall\_sslsshprofile\_sslexempt](fmgr_firewall_sslsshprofile_sslexempt_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-sslexempt-module) – Servers to exempt from SSL inspection. * [fmgr\_firewall\_sslsshprofile\_sslserver](fmgr_firewall_sslsshprofile_sslserver_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-sslsshprofile-sslserver-module) – SSL servers. * [fmgr\_firewall\_trafficclass](fmgr_firewall_trafficclass_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-trafficclass-module) – Configure names for shaping classes. * [fmgr\_firewall\_vip](fmgr_firewall_vip_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-module) – Configure virtual IP for IPv4. * [fmgr\_firewall\_vip46](fmgr_firewall_vip46_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip46-module) – Configure IPv4 to IPv6 virtual IPs. * [fmgr\_firewall\_vip46\_dynamicmapping](fmgr_firewall_vip46_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip46-dynamicmapping-module) – Configure IPv4 to IPv6 virtual IPs. * [fmgr\_firewall\_vip46\_realservers](fmgr_firewall_vip46_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip46-realservers-module) – Real servers. * [fmgr\_firewall\_vip6](fmgr_firewall_vip6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip6-module) – Configure virtual IP for IPv6. * [fmgr\_firewall\_vip64](fmgr_firewall_vip64_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip64-module) – Configure IPv6 to IPv4 virtual IPs. * [fmgr\_firewall\_vip64\_dynamicmapping](fmgr_firewall_vip64_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip64-dynamicmapping-module) – Configure IPv6 to IPv4 virtual IPs. * [fmgr\_firewall\_vip64\_realservers](fmgr_firewall_vip64_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip64-realservers-module) – Real servers. * [fmgr\_firewall\_vip6\_dynamicmapping](fmgr_firewall_vip6_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip6-dynamicmapping-module) – Configure virtual IP for IPv6. * [fmgr\_firewall\_vip6\_realservers](fmgr_firewall_vip6_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip6-realservers-module) – Select the real servers that this server load balancing VIP will distribute traffic to. * [fmgr\_firewall\_vip6\_sslciphersuites](fmgr_firewall_vip6_sslciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip6-sslciphersuites-module) – SSL/TLS cipher suites acceptable from a client, ordered by priority. * [fmgr\_firewall\_vip6\_sslserverciphersuites](fmgr_firewall_vip6_sslserverciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip6-sslserverciphersuites-module) – SSL/TLS cipher suites to offer to a server, ordered by priority. * [fmgr\_firewall\_vip\_dynamicmapping](fmgr_firewall_vip_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-dynamicmapping-module) – Configure virtual IP for IPv4. * [fmgr\_firewall\_vip\_dynamicmapping\_realservers](fmgr_firewall_vip_dynamicmapping_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-dynamicmapping-realservers-module) – Select the real servers that this server load balancing VIP will distribute traffic to. * [fmgr\_firewall\_vip\_dynamicmapping\_sslciphersuites](fmgr_firewall_vip_dynamicmapping_sslciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-dynamicmapping-sslciphersuites-module) – SSL/TLS cipher suites acceptable from a client, ordered by priority. * [fmgr\_firewall\_vip\_realservers](fmgr_firewall_vip_realservers_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-realservers-module) – Select the real servers that this server load balancing VIP will distribute traffic to. * [fmgr\_firewall\_vip\_sslciphersuites](fmgr_firewall_vip_sslciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-sslciphersuites-module) – SSL/TLS cipher suites acceptable from a client, ordered by priority. * [fmgr\_firewall\_vip\_sslserverciphersuites](fmgr_firewall_vip_sslserverciphersuites_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vip-sslserverciphersuites-module) – SSL/TLS cipher suites to offer to a server, ordered by priority. * [fmgr\_firewall\_vipgrp](fmgr_firewall_vipgrp_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vipgrp-module) – Configure IPv4 virtual IP groups. * [fmgr\_firewall\_vipgrp46](fmgr_firewall_vipgrp46_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vipgrp46-module) – Configure IPv4 to IPv6 virtual IP groups. * [fmgr\_firewall\_vipgrp6](fmgr_firewall_vipgrp6_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vipgrp6-module) – Configure IPv6 virtual IP groups. * [fmgr\_firewall\_vipgrp64](fmgr_firewall_vipgrp64_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vipgrp64-module) – Configure IPv6 to IPv4 virtual IP groups. * [fmgr\_firewall\_vipgrp\_dynamicmapping](fmgr_firewall_vipgrp_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-vipgrp-dynamicmapping-module) – Configure IPv4 virtual IP groups. * [fmgr\_firewall\_wildcardfqdn\_custom](fmgr_firewall_wildcardfqdn_custom_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-wildcardfqdn-custom-module) – Config global/VDOM Wildcard FQDN address. * [fmgr\_firewall\_wildcardfqdn\_group](fmgr_firewall_wildcardfqdn_group_module#ansible-collections-fortinet-fortimanager-fmgr-firewall-wildcardfqdn-group-module) – Config global Wildcard FQDN address groups. * [fmgr\_fmupdate\_analyzer\_virusreport](fmgr_fmupdate_analyzer_virusreport_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-analyzer-virusreport-module) – Send virus detection notification to FortiGuard. * [fmgr\_fmupdate\_avips\_advancedlog](fmgr_fmupdate_avips_advancedlog_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-avips-advancedlog-module) – Enable/disable logging of FortiGuard antivirus and IPS update packages received by FortiManagers built-in FortiGuard. * [fmgr\_fmupdate\_avips\_webproxy](fmgr_fmupdate_avips_webproxy_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-avips-webproxy-module) – Configure the web proxy for use with FortiGuard antivirus and IPS updates. * [fmgr\_fmupdate\_customurllist](fmgr_fmupdate_customurllist_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-customurllist-module) – Configure the URL database for rating and filtering. * [fmgr\_fmupdate\_diskquota](fmgr_fmupdate_diskquota_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-diskquota-module) – Configure disk space available for use by the Upgrade Manager. * [fmgr\_fmupdate\_fctservices](fmgr_fmupdate_fctservices_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fctservices-module) – Configure FortiGuard to provide services to FortiClient installations. * [fmgr\_fmupdate\_fdssetting](fmgr_fmupdate_fdssetting_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-module) – Configure FortiGuard settings. * [fmgr\_fmupdate\_fdssetting\_pushoverride](fmgr_fmupdate_fdssetting_pushoverride_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-pushoverride-module) – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for… * [fmgr\_fmupdate\_fdssetting\_pushoverridetoclient](fmgr_fmupdate_fdssetting_pushoverridetoclient_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-pushoverridetoclient-module) – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for… * [fmgr\_fmupdate\_fdssetting\_pushoverridetoclient\_announceip](fmgr_fmupdate_fdssetting_pushoverridetoclient_announceip_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-pushoverridetoclient-announceip-module) – Announce IP addresses for the device. * [fmgr\_fmupdate\_fdssetting\_serveroverride](fmgr_fmupdate_fdssetting_serveroverride_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-serveroverride-module) – Server override configure. * [fmgr\_fmupdate\_fdssetting\_serveroverride\_servlist](fmgr_fmupdate_fdssetting_serveroverride_servlist_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-serveroverride-servlist-module) – Override server. * [fmgr\_fmupdate\_fdssetting\_updateschedule](fmgr_fmupdate_fdssetting_updateschedule_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fdssetting-updateschedule-module) – Configure the schedule when built-in FortiGuard retrieves antivirus and IPS updates. * [fmgr\_fmupdate\_fwmsetting](fmgr_fmupdate_fwmsetting_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-fwmsetting-module) – Configure firmware management settings. * [fmgr\_fmupdate\_multilayer](fmgr_fmupdate_multilayer_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-multilayer-module) – Configure multilayer mode. * [fmgr\_fmupdate\_publicnetwork](fmgr_fmupdate_publicnetwork_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-publicnetwork-module) – Enable/disable access to the public FortiGuard. * [fmgr\_fmupdate\_serveraccesspriorities](fmgr_fmupdate_serveraccesspriorities_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-serveraccesspriorities-module) – Configure priorities for FortiGate units accessing antivirus updates and web filtering services. * [fmgr\_fmupdate\_serveraccesspriorities\_privateserver](fmgr_fmupdate_serveraccesspriorities_privateserver_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-serveraccesspriorities-privateserver-module) – Configure multiple FortiManager units and private servers. * [fmgr\_fmupdate\_serveroverridestatus](fmgr_fmupdate_serveroverridestatus_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-serveroverridestatus-module) – Configure strict/loose server override. * [fmgr\_fmupdate\_service](fmgr_fmupdate_service_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-service-module) – Enable/disable services provided by the built-in FortiGuard. * [fmgr\_fmupdate\_webspam\_fgdsetting](fmgr_fmupdate_webspam_fgdsetting_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-webspam-fgdsetting-module) – Configure the FortiGuard run parameters. * [fmgr\_fmupdate\_webspam\_fgdsetting\_serveroverride](fmgr_fmupdate_webspam_fgdsetting_serveroverride_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-webspam-fgdsetting-serveroverride-module) – Server override configure. * [fmgr\_fmupdate\_webspam\_fgdsetting\_serveroverride\_servlist](fmgr_fmupdate_webspam_fgdsetting_serveroverride_servlist_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-webspam-fgdsetting-serveroverride-servlist-module) – Override server. * [fmgr\_fmupdate\_webspam\_webproxy](fmgr_fmupdate_webspam_webproxy_module#ansible-collections-fortinet-fortimanager-fmgr-fmupdate-webspam-webproxy-module) – Configure the web proxy for use with FortiGuard antivirus and IPS updates. * [fmgr\_fsp\_vlan](fmgr_fsp_vlan_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-module) – no description * [fmgr\_fsp\_vlan\_dhcpserver](fmgr_fsp_vlan_dhcpserver_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dhcpserver-module) – Configure DHCP servers. * [fmgr\_fsp\_vlan\_dhcpserver\_excluderange](fmgr_fsp_vlan_dhcpserver_excluderange_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dhcpserver-excluderange-module) – Exclude one or more ranges of IP addresses from being assigned to clients. * [fmgr\_fsp\_vlan\_dhcpserver\_iprange](fmgr_fsp_vlan_dhcpserver_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dhcpserver-iprange-module) – DHCP IP range configuration. * [fmgr\_fsp\_vlan\_dhcpserver\_options](fmgr_fsp_vlan_dhcpserver_options_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dhcpserver-options-module) – DHCP options. * [fmgr\_fsp\_vlan\_dhcpserver\_reservedaddress](fmgr_fsp_vlan_dhcpserver_reservedaddress_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dhcpserver-reservedaddress-module) – Options for the DHCP server to assign IP settings to specific MAC addresses. * [fmgr\_fsp\_vlan\_dynamicmapping](fmgr_fsp_vlan_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-module) – no description * [fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver](fmgr_fsp_vlan_dynamicmapping_dhcpserver_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-dhcpserver-module) – Configure DHCP servers. * [fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_excluderange](fmgr_fsp_vlan_dynamicmapping_dhcpserver_excluderange_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-dhcpserver-excluderange-module) – Exclude one or more ranges of IP addresses from being assigned to clients. * [fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_iprange](fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-dhcpserver-iprange-module) – DHCP IP range configuration. * [fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_options](fmgr_fsp_vlan_dynamicmapping_dhcpserver_options_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-dhcpserver-options-module) – DHCP options. * [fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_reservedaddress](fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-dhcpserver-reservedaddress-module) – Options for the DHCP server to assign IP settings to specific MAC addresses. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface](fmgr_fsp_vlan_dynamicmapping_interface_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-module) – no description * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6](fmgr_fsp_vlan_dynamicmapping_interface_ipv6_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-ipv6-module) – IPv6 of interface. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_ip6delegatedprefixlist](fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6delegatedprefixlist_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-ipv6-ip6delegatedprefixlist-module) – Advertised IPv6 delegated prefix list. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_ip6extraaddr](fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6extraaddr_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-ipv6-ip6extraaddr-module) – Extra IPv6 address prefixes of interface. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_ip6prefixlist](fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6prefixlist_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-ipv6-ip6prefixlist-module) – Advertised prefix list. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_vrrp6](fmgr_fsp_vlan_dynamicmapping_interface_ipv6_vrrp6_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-ipv6-vrrp6-module) – IPv6 VRRP configuration. * [fmgr\_fsp\_vlan\_dynamicmapping\_interface\_secondaryip](fmgr_fsp_vlan_dynamicmapping_interface_secondaryip_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-dynamicmapping-interface-secondaryip-module) – Second IP address of interface. * [fmgr\_fsp\_vlan\_interface](fmgr_fsp_vlan_interface_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-module) – Configure interfaces. * [fmgr\_fsp\_vlan\_interface\_ipv6](fmgr_fsp_vlan_interface_ipv6_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-ipv6-module) – IPv6 of interface. * [fmgr\_fsp\_vlan\_interface\_ipv6\_ip6delegatedprefixlist](fmgr_fsp_vlan_interface_ipv6_ip6delegatedprefixlist_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-ipv6-ip6delegatedprefixlist-module) – Advertised IPv6 delegated prefix list. * [fmgr\_fsp\_vlan\_interface\_ipv6\_ip6extraaddr](fmgr_fsp_vlan_interface_ipv6_ip6extraaddr_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-ipv6-ip6extraaddr-module) – Extra IPv6 address prefixes of interface. * [fmgr\_fsp\_vlan\_interface\_ipv6\_ip6prefixlist](fmgr_fsp_vlan_interface_ipv6_ip6prefixlist_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-ipv6-ip6prefixlist-module) – Advertised prefix list. * [fmgr\_fsp\_vlan\_interface\_ipv6\_vrrp6](fmgr_fsp_vlan_interface_ipv6_vrrp6_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-ipv6-vrrp6-module) – IPv6 VRRP configuration. * [fmgr\_fsp\_vlan\_interface\_secondaryip](fmgr_fsp_vlan_interface_secondaryip_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-secondaryip-module) – Second IP address of interface. * [fmgr\_fsp\_vlan\_interface\_vrrp](fmgr_fsp_vlan_interface_vrrp_module#ansible-collections-fortinet-fortimanager-fmgr-fsp-vlan-interface-vrrp-module) – VRRP configuration. * [fmgr\_generic](fmgr_generic_module#ansible-collections-fortinet-fortimanager-fmgr-generic-module) – Build and send generic FortiManager API request. * [fmgr\_gtp\_apn](fmgr_gtp_apn_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-apn-module) – Configure APN for GTP. * [fmgr\_gtp\_apngrp](fmgr_gtp_apngrp_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-apngrp-module) – Configure APN groups for GTP. * [fmgr\_gtp\_iewhitelist](fmgr_gtp_iewhitelist_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-iewhitelist-module) – IE white list. * [fmgr\_gtp\_iewhitelist\_entries](fmgr_gtp_iewhitelist_entries_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-iewhitelist-entries-module) – Entries of white list * [fmgr\_gtp\_messagefilterv0v1](fmgr_gtp_messagefilterv0v1_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-messagefilterv0v1-module) – Message filter for GTPv0/v1 messages. * [fmgr\_gtp\_messagefilterv2](fmgr_gtp_messagefilterv2_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-messagefilterv2-module) – Message filter for GTPv2 messages. * [fmgr\_gtp\_tunnellimit](fmgr_gtp_tunnellimit_module#ansible-collections-fortinet-fortimanager-fmgr-gtp-tunnellimit-module) – GTP tunnel limiter. * [fmgr\_hotspot20\_anqp3gppcellular](fmgr_hotspot20_anqp3gppcellular_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqp3gppcellular-module) – Configure 3GPP public land mobile network * [fmgr\_hotspot20\_anqp3gppcellular\_mccmnclist](fmgr_hotspot20_anqp3gppcellular_mccmnclist_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqp3gppcellular-mccmnclist-module) – Mobile Country Code and Mobile Network Code configuration. * [fmgr\_hotspot20\_anqpipaddresstype](fmgr_hotspot20_anqpipaddresstype_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpipaddresstype-module) – Configure IP address type availability. * [fmgr\_hotspot20\_anqpnairealm](fmgr_hotspot20_anqpnairealm_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpnairealm-module) – Configure network access identifier * [fmgr\_hotspot20\_anqpnairealm\_nailist](fmgr_hotspot20_anqpnairealm_nailist_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpnairealm-nailist-module) – NAI list. * [fmgr\_hotspot20\_anqpnairealm\_nailist\_eapmethod](fmgr_hotspot20_anqpnairealm_nailist_eapmethod_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpnairealm-nailist-eapmethod-module) – EAP Methods. * [fmgr\_hotspot20\_anqpnairealm\_nailist\_eapmethod\_authparam](fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpnairealm-nailist-eapmethod-authparam-module) – EAP auth param. * [fmgr\_hotspot20\_anqpnetworkauthtype](fmgr_hotspot20_anqpnetworkauthtype_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpnetworkauthtype-module) – Configure network authentication type. * [fmgr\_hotspot20\_anqproamingconsortium](fmgr_hotspot20_anqproamingconsortium_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqproamingconsortium-module) – Configure roaming consortium. * [fmgr\_hotspot20\_anqproamingconsortium\_oilist](fmgr_hotspot20_anqproamingconsortium_oilist_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqproamingconsortium-oilist-module) – Organization identifier list. * [fmgr\_hotspot20\_anqpvenuename](fmgr_hotspot20_anqpvenuename_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpvenuename-module) – Configure venue name duple. * [fmgr\_hotspot20\_anqpvenuename\_valuelist](fmgr_hotspot20_anqpvenuename_valuelist_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-anqpvenuename-valuelist-module) – Name list. * [fmgr\_hotspot20\_h2qpconncapability](fmgr_hotspot20_h2qpconncapability_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qpconncapability-module) – Configure connection capability. * [fmgr\_hotspot20\_h2qpoperatorname](fmgr_hotspot20_h2qpoperatorname_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qpoperatorname-module) – Configure operator friendly name. * [fmgr\_hotspot20\_h2qpoperatorname\_valuelist](fmgr_hotspot20_h2qpoperatorname_valuelist_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qpoperatorname-valuelist-module) – Name list. * [fmgr\_hotspot20\_h2qposuprovider](fmgr_hotspot20_h2qposuprovider_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qposuprovider-module) – Configure online sign up * [fmgr\_hotspot20\_h2qposuprovider\_friendlyname](fmgr_hotspot20_h2qposuprovider_friendlyname_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qposuprovider-friendlyname-module) – OSU provider friendly name. * [fmgr\_hotspot20\_h2qposuprovider\_servicedescription](fmgr_hotspot20_h2qposuprovider_servicedescription_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qposuprovider-servicedescription-module) – OSU service name. * [fmgr\_hotspot20\_h2qpwanmetric](fmgr_hotspot20_h2qpwanmetric_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-h2qpwanmetric-module) – Configure WAN metrics. * [fmgr\_hotspot20\_hsprofile](fmgr_hotspot20_hsprofile_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-hsprofile-module) – Configure hotspot profile. * [fmgr\_hotspot20\_qosmap](fmgr_hotspot20_qosmap_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-qosmap-module) – Configure QoS map set. * [fmgr\_hotspot20\_qosmap\_dscpexcept](fmgr_hotspot20_qosmap_dscpexcept_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-qosmap-dscpexcept-module) – Differentiated Services Code Point * [fmgr\_hotspot20\_qosmap\_dscprange](fmgr_hotspot20_qosmap_dscprange_module#ansible-collections-fortinet-fortimanager-fmgr-hotspot20-qosmap-dscprange-module) – Differentiated Services Code Point * [fmgr\_icap\_profile](fmgr_icap_profile_module#ansible-collections-fortinet-fortimanager-fmgr-icap-profile-module) – Configure ICAP profiles. * [fmgr\_icap\_profile\_icapheaders](fmgr_icap_profile_icapheaders_module#ansible-collections-fortinet-fortimanager-fmgr-icap-profile-icapheaders-module) – Configure ICAP forwarded request headers. * [fmgr\_icap\_profile\_respmodforwardrules](fmgr_icap_profile_respmodforwardrules_module#ansible-collections-fortinet-fortimanager-fmgr-icap-profile-respmodforwardrules-module) – ICAP response mode forward rules. * [fmgr\_icap\_profile\_respmodforwardrules\_headergroup](fmgr_icap_profile_respmodforwardrules_headergroup_module#ansible-collections-fortinet-fortimanager-fmgr-icap-profile-respmodforwardrules-headergroup-module) – HTTP header group. * [fmgr\_icap\_server](fmgr_icap_server_module#ansible-collections-fortinet-fortimanager-fmgr-icap-server-module) – Configure ICAP servers. * [fmgr\_ips\_custom](fmgr_ips_custom_module#ansible-collections-fortinet-fortimanager-fmgr-ips-custom-module) – Configure IPS custom signature. * [fmgr\_ips\_sensor](fmgr_ips_sensor_module#ansible-collections-fortinet-fortimanager-fmgr-ips-sensor-module) – Configure IPS sensor. * [fmgr\_ips\_sensor\_entries](fmgr_ips_sensor_entries_module#ansible-collections-fortinet-fortimanager-fmgr-ips-sensor-entries-module) – IPS sensor filter. * [fmgr\_ips\_sensor\_entries\_exemptip](fmgr_ips_sensor_entries_exemptip_module#ansible-collections-fortinet-fortimanager-fmgr-ips-sensor-entries-exemptip-module) – Traffic from selected source or destination IP addresses is exempt from this signature. * [fmgr\_log\_customfield](fmgr_log_customfield_module#ansible-collections-fortinet-fortimanager-fmgr-log-customfield-module) – Configure custom log fields. * [fmgr\_metafields\_system\_admin\_user](fmgr_metafields_system_admin_user_module#ansible-collections-fortinet-fortimanager-fmgr-metafields-system-admin-user-module) – no description * [fmgr\_move](fmgr_move_module#ansible-collections-fortinet-fortimanager-fmgr-move-module) – Move fortimanager defined Object. * [fmgr\_mpskprofile](fmgr_mpskprofile_module#ansible-collections-fortinet-fortimanager-fmgr-mpskprofile-module) – Configure MPSK profile. * [fmgr\_mpskprofile\_mpskgroup](fmgr_mpskprofile_mpskgroup_module#ansible-collections-fortinet-fortimanager-fmgr-mpskprofile-mpskgroup-module) – List of multiple PSK groups. * [fmgr\_mpskprofile\_mpskgroup\_mpskkey](fmgr_mpskprofile_mpskgroup_mpskkey_module#ansible-collections-fortinet-fortimanager-fmgr-mpskprofile-mpskgroup-mpskkey-module) – List of multiple PSK entries. * [fmgr\_pkg\_authentication\_rule](fmgr_pkg_authentication_rule_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-authentication-rule-module) – Configure Authentication Rules. * [fmgr\_pkg\_authentication\_setting](fmgr_pkg_authentication_setting_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-authentication-setting-module) – Configure authentication setting. * [fmgr\_pkg\_central\_dnat](fmgr_pkg_central_dnat_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-central-dnat-module) – no description * [fmgr\_pkg\_central\_dnat6](fmgr_pkg_central_dnat6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-central-dnat6-module) – no description * [fmgr\_pkg\_firewall\_centralsnatmap](fmgr_pkg_firewall_centralsnatmap_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-centralsnatmap-module) – Configure central SNAT policies. * [fmgr\_pkg\_firewall\_consolidated\_policy](fmgr_pkg_firewall_consolidated_policy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-consolidated-policy-module) – Configure consolidated IPv4/IPv6 policies. * [fmgr\_pkg\_firewall\_consolidated\_policy\_sectionvalue](fmgr_pkg_firewall_consolidated_policy_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-consolidated-policy-sectionvalue-module) – Configure consolidated IPv4/IPv6 policies. * [fmgr\_pkg\_firewall\_dospolicy](fmgr_pkg_firewall_dospolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-dospolicy-module) – Configure IPv4 DoS policies. * [fmgr\_pkg\_firewall\_dospolicy6](fmgr_pkg_firewall_dospolicy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-dospolicy6-module) – Configure IPv6 DoS policies. * [fmgr\_pkg\_firewall\_dospolicy6\_anomaly](fmgr_pkg_firewall_dospolicy6_anomaly_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-dospolicy6-anomaly-module) – Anomaly name. * [fmgr\_pkg\_firewall\_dospolicy\_anomaly](fmgr_pkg_firewall_dospolicy_anomaly_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-dospolicy-anomaly-module) – Anomaly name. * [fmgr\_pkg\_firewall\_interfacepolicy](fmgr_pkg_firewall_interfacepolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-interfacepolicy-module) – Configure IPv4 interface policies. * [fmgr\_pkg\_firewall\_interfacepolicy6](fmgr_pkg_firewall_interfacepolicy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-interfacepolicy6-module) – Configure IPv6 interface policies. * [fmgr\_pkg\_firewall\_interfacepolicy6\_sectionvalue](fmgr_pkg_firewall_interfacepolicy6_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-interfacepolicy6-sectionvalue-module) – Configure IPv6 interface policies. * [fmgr\_pkg\_firewall\_interfacepolicy\_sectionvalue](fmgr_pkg_firewall_interfacepolicy_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-interfacepolicy-sectionvalue-module) – Configure IPv4 interface policies. * [fmgr\_pkg\_firewall\_localinpolicy](fmgr_pkg_firewall_localinpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-localinpolicy-module) – Configure user defined IPv4 local-in policies. * [fmgr\_pkg\_firewall\_localinpolicy6](fmgr_pkg_firewall_localinpolicy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-localinpolicy6-module) – Configure user defined IPv6 local-in policies. * [fmgr\_pkg\_firewall\_multicastpolicy](fmgr_pkg_firewall_multicastpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-multicastpolicy-module) – Configure multicast NAT policies. * [fmgr\_pkg\_firewall\_multicastpolicy6](fmgr_pkg_firewall_multicastpolicy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-multicastpolicy6-module) – Configure IPv6 multicast NAT policies. * [fmgr\_pkg\_firewall\_policy](fmgr_pkg_firewall_policy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy-module) – Configure IPv4 policies. * [fmgr\_pkg\_firewall\_policy46](fmgr_pkg_firewall_policy46_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy46-module) – Configure IPv4 to IPv6 policies. * [fmgr\_pkg\_firewall\_policy6](fmgr_pkg_firewall_policy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy6-module) – Configure IPv6 policies. * [fmgr\_pkg\_firewall\_policy64](fmgr_pkg_firewall_policy64_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy64-module) – Configure IPv6 to IPv4 policies. * [fmgr\_pkg\_firewall\_policy6\_sectionvalue](fmgr_pkg_firewall_policy6_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy6-sectionvalue-module) – Configure IPv6 policies. * [fmgr\_pkg\_firewall\_policy\_sectionvalue](fmgr_pkg_firewall_policy_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy-sectionvalue-module) – Configure IPv4 policies. * [fmgr\_pkg\_firewall\_policy\_vpndstnode](fmgr_pkg_firewall_policy_vpndstnode_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy-vpndstnode-module) – no description * [fmgr\_pkg\_firewall\_policy\_vpnsrcnode](fmgr_pkg_firewall_policy_vpnsrcnode_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-policy-vpnsrcnode-module) – no description * [fmgr\_pkg\_firewall\_proxypolicy](fmgr_pkg_firewall_proxypolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-proxypolicy-module) – Configure proxy policies. * [fmgr\_pkg\_firewall\_proxypolicy\_sectionvalue](fmgr_pkg_firewall_proxypolicy_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-proxypolicy-sectionvalue-module) – Configure proxy policies. * [fmgr\_pkg\_firewall\_securitypolicy](fmgr_pkg_firewall_securitypolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-securitypolicy-module) – Configure NGFW IPv4/IPv6 application policies. * [fmgr\_pkg\_firewall\_securitypolicy\_sectionvalue](fmgr_pkg_firewall_securitypolicy_sectionvalue_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-securitypolicy-sectionvalue-module) – Configure NGFW IPv4/IPv6 application policies. * [fmgr\_pkg\_firewall\_shapingpolicy](fmgr_pkg_firewall_shapingpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-firewall-shapingpolicy-module) – Configure shaping policies. * [fmgr\_pkg\_footer\_policy](fmgr_pkg_footer_policy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-footer-policy-module) – Configure IPv4/IPv6 policies. * [fmgr\_pkg\_footer\_policy6](fmgr_pkg_footer_policy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-footer-policy6-module) – Configure IPv6 policies. * [fmgr\_pkg\_footer\_shapingpolicy](fmgr_pkg_footer_shapingpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-footer-shapingpolicy-module) – Configure shaping policies. * [fmgr\_pkg\_header\_policy](fmgr_pkg_header_policy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-header-policy-module) – Configure IPv4/IPv6 policies. * [fmgr\_pkg\_header\_policy6](fmgr_pkg_header_policy6_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-header-policy6-module) – Configure IPv6 policies. * [fmgr\_pkg\_header\_shapingpolicy](fmgr_pkg_header_shapingpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-pkg-header-shapingpolicy-module) – Configure shaping policies. * [fmgr\_pm\_config\_metafields\_firewall\_address](fmgr_pm_config_metafields_firewall_address_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-address-module) – no description * [fmgr\_pm\_config\_metafields\_firewall\_addrgrp](fmgr_pm_config_metafields_firewall_addrgrp_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-addrgrp-module) – no description * [fmgr\_pm\_config\_metafields\_firewall\_centralsnatmap](fmgr_pm_config_metafields_firewall_centralsnatmap_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-centralsnatmap-module) – no description * [fmgr\_pm\_config\_metafields\_firewall\_policy](fmgr_pm_config_metafields_firewall_policy_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-policy-module) – no description * [fmgr\_pm\_config\_metafields\_firewall\_service\_custom](fmgr_pm_config_metafields_firewall_service_custom_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-service-custom-module) – no description * [fmgr\_pm\_config\_metafields\_firewall\_service\_group](fmgr_pm_config_metafields_firewall_service_group_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-metafields-firewall-service-group-module) – no description * [fmgr\_pm\_config\_reset\_database](fmgr_pm_config_reset_database_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-reset-database-module) – Reset Global ADOM to a specific version. * [fmgr\_pm\_config\_upgrade](fmgr_pm_config_upgrade_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-upgrade-module) – Upgrade an ADOM to the next version. * [fmgr\_pm\_config\_workspace\_commit](fmgr_pm_config_workspace_commit_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-workspace-commit-module) – Commit changes to an ADOM. * [fmgr\_pm\_config\_workspace\_lock](fmgr_pm_config_workspace_lock_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-workspace-lock-module) – Lock an ADOM in workspace mode. * [fmgr\_pm\_config\_workspace\_unlock](fmgr_pm_config_workspace_unlock_module#ansible-collections-fortinet-fortimanager-fmgr-pm-config-workspace-unlock-module) – Unlock an ADOM. * [fmgr\_pm\_devprof\_adom](fmgr_pm_devprof_adom_module#ansible-collections-fortinet-fortimanager-fmgr-pm-devprof-adom-module) – no description * [fmgr\_pm\_devprof\_pkg](fmgr_pm_devprof_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-pm-devprof-pkg-module) – no description * [fmgr\_pm\_pkg](fmgr_pm_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-pm-pkg-module) – no description * [fmgr\_pm\_pkg\_adom](fmgr_pm_pkg_adom_module#ansible-collections-fortinet-fortimanager-fmgr-pm-pkg-adom-module) – no description * [fmgr\_pm\_pkg\_global](fmgr_pm_pkg_global_module#ansible-collections-fortinet-fortimanager-fmgr-pm-pkg-global-module) – no description * [fmgr\_pm\_wanprof\_adom](fmgr_pm_wanprof_adom_module#ansible-collections-fortinet-fortimanager-fmgr-pm-wanprof-adom-module) – no description * [fmgr\_pm\_wanprof\_pkg](fmgr_pm_wanprof_pkg_module#ansible-collections-fortinet-fortimanager-fmgr-pm-wanprof-pkg-module) – no description * [fmgr\_qosprofile](fmgr_qosprofile_module#ansible-collections-fortinet-fortimanager-fmgr-qosprofile-module) – Configure WiFi quality of service * [fmgr\_region](fmgr_region_module#ansible-collections-fortinet-fortimanager-fmgr-region-module) – Configure FortiAP regions * [fmgr\_securityconsole\_abort](fmgr_securityconsole_abort_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-abort-module) – Abort and cancel a security console task. * [fmgr\_securityconsole\_assign\_package](fmgr_securityconsole_assign_package_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-assign-package-module) – Assign or unassign global policy package to ADOM packages. * [fmgr\_securityconsole\_import\_dev\_objs](fmgr_securityconsole_import_dev_objs_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-import-dev-objs-module) – Import objects from device to ADOM, or from ADOM to Global. * [fmgr\_securityconsole\_install\_device](fmgr_securityconsole_install_device_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-install-device-module) – no description * [fmgr\_securityconsole\_install\_package](fmgr_securityconsole_install_package_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-install-package-module) – Copy and install a policy package to devices. * [fmgr\_securityconsole\_install\_preview](fmgr_securityconsole_install_preview_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-install-preview-module) – Generate install preview for a device. * [fmgr\_securityconsole\_package\_cancel\_install](fmgr_securityconsole_package_cancel_install_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-package-cancel-install-module) – Cancel policy install and clear preview cache. * [fmgr\_securityconsole\_package\_clone](fmgr_securityconsole_package_clone_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-package-clone-module) – Clone a policy package within the same ADOM. * [fmgr\_securityconsole\_package\_commit](fmgr_securityconsole_package_commit_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-package-commit-module) – Install policies to device from preview cache. * [fmgr\_securityconsole\_package\_move](fmgr_securityconsole_package_move_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-package-move-module) – Move and/or rename a policy package within the same ADOM. * [fmgr\_securityconsole\_pblock\_clone](fmgr_securityconsole_pblock_clone_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-pblock-clone-module) – no description * [fmgr\_securityconsole\_preview\_result](fmgr_securityconsole_preview_result_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-preview-result-module) – Retrieve the result of previous install/preview command. * [fmgr\_securityconsole\_reinstall\_package](fmgr_securityconsole_reinstall_package_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-reinstall-package-module) – Re-install a policy package that had been previously installed. * [fmgr\_securityconsole\_sign\_certificate\_template](fmgr_securityconsole_sign_certificate_template_module#ansible-collections-fortinet-fortimanager-fmgr-securityconsole-sign-certificate-template-module) – Generate and sign certificate on the target device. * [fmgr\_spamfilter\_bwl](fmgr_spamfilter_bwl_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-bwl-module) – Configure anti-spam black/white list. * [fmgr\_spamfilter\_bwl\_entries](fmgr_spamfilter_bwl_entries_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-bwl-entries-module) – Anti-spam black/white list entries. * [fmgr\_spamfilter\_bword](fmgr_spamfilter_bword_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-bword-module) – Configure AntiSpam banned word list. * [fmgr\_spamfilter\_bword\_entries](fmgr_spamfilter_bword_entries_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-bword-entries-module) – Spam filter banned word. * [fmgr\_spamfilter\_dnsbl](fmgr_spamfilter_dnsbl_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-dnsbl-module) – Configure AntiSpam DNSBL/ORBL. * [fmgr\_spamfilter\_dnsbl\_entries](fmgr_spamfilter_dnsbl_entries_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-dnsbl-entries-module) – Spam filter DNSBL and ORBL server. * [fmgr\_spamfilter\_iptrust](fmgr_spamfilter_iptrust_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-iptrust-module) – Configure AntiSpam IP trust. * [fmgr\_spamfilter\_iptrust\_entries](fmgr_spamfilter_iptrust_entries_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-iptrust-entries-module) – Spam filter trusted IP addresses. * [fmgr\_spamfilter\_mheader](fmgr_spamfilter_mheader_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-mheader-module) – Configure AntiSpam MIME header. * [fmgr\_spamfilter\_mheader\_entries](fmgr_spamfilter_mheader_entries_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-mheader-entries-module) – Spam filter mime header content. * [fmgr\_spamfilter\_profile](fmgr_spamfilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-module) – Configure AntiSpam profiles. * [fmgr\_spamfilter\_profile\_gmail](fmgr_spamfilter_profile_gmail_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-gmail-module) – Gmail. * [fmgr\_spamfilter\_profile\_imap](fmgr_spamfilter_profile_imap_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-imap-module) – IMAP. * [fmgr\_spamfilter\_profile\_mapi](fmgr_spamfilter_profile_mapi_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-mapi-module) – MAPI. * [fmgr\_spamfilter\_profile\_msnhotmail](fmgr_spamfilter_profile_msnhotmail_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-msnhotmail-module) – MSN Hotmail. * [fmgr\_spamfilter\_profile\_pop3](fmgr_spamfilter_profile_pop3_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-pop3-module) – POP3. * [fmgr\_spamfilter\_profile\_smtp](fmgr_spamfilter_profile_smtp_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-smtp-module) – SMTP. * [fmgr\_spamfilter\_profile\_yahoomail](fmgr_spamfilter_profile_yahoomail_module#ansible-collections-fortinet-fortimanager-fmgr-spamfilter-profile-yahoomail-module) – Yahoo! Mail. * [fmgr\_sshfilter\_profile](fmgr_sshfilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-sshfilter-profile-module) – SSH filter profile. * [fmgr\_sshfilter\_profile\_filefilter](fmgr_sshfilter_profile_filefilter_module#ansible-collections-fortinet-fortimanager-fmgr-sshfilter-profile-filefilter-module) – File filter. * [fmgr\_sshfilter\_profile\_filefilter\_entries](fmgr_sshfilter_profile_filefilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-sshfilter-profile-filefilter-entries-module) – File filter entries. * [fmgr\_sshfilter\_profile\_shellcommands](fmgr_sshfilter_profile_shellcommands_module#ansible-collections-fortinet-fortimanager-fmgr-sshfilter-profile-shellcommands-module) – SSH command filter. * [fmgr\_switchcontroller\_customcommand](fmgr_switchcontroller_customcommand_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-customcommand-module) – Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices. * [fmgr\_switchcontroller\_lldpprofile](fmgr_switchcontroller_lldpprofile_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-lldpprofile-module) – Configure FortiSwitch LLDP profiles. * [fmgr\_switchcontroller\_lldpprofile\_customtlvs](fmgr_switchcontroller_lldpprofile_customtlvs_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-lldpprofile-customtlvs-module) – Configuration method to edit custom TLV entries. * [fmgr\_switchcontroller\_lldpprofile\_medlocationservice](fmgr_switchcontroller_lldpprofile_medlocationservice_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-lldpprofile-medlocationservice-module) – Configuration method to edit Media Endpoint Discovery * [fmgr\_switchcontroller\_lldpprofile\_mednetworkpolicy](fmgr_switchcontroller_lldpprofile_mednetworkpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-lldpprofile-mednetworkpolicy-module) – Configuration method to edit Media Endpoint Discovery * [fmgr\_switchcontroller\_managedswitch](fmgr_switchcontroller_managedswitch_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-module) – Configure FortiSwitch devices that are managed by this FortiGate. * [fmgr\_switchcontroller\_managedswitch\_8021xsettings](fmgr_switchcontroller_managedswitch_8021xsettings_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-8021xsettings-module) – Configuration method to edit FortiSwitch 802. * [fmgr\_switchcontroller\_managedswitch\_customcommand](fmgr_switchcontroller_managedswitch_customcommand_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-customcommand-module) – Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller… * [fmgr\_switchcontroller\_managedswitch\_igmpsnooping](fmgr_switchcontroller_managedswitch_igmpsnooping_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-igmpsnooping-module) – Configure FortiSwitch IGMP snooping global settings. * [fmgr\_switchcontroller\_managedswitch\_ipsourceguard](fmgr_switchcontroller_managedswitch_ipsourceguard_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-ipsourceguard-module) – IP source guard. * [fmgr\_switchcontroller\_managedswitch\_ipsourceguard\_bindingentry](fmgr_switchcontroller_managedswitch_ipsourceguard_bindingentry_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-ipsourceguard-bindingentry-module) – IP and MAC address configuration. * [fmgr\_switchcontroller\_managedswitch\_mirror](fmgr_switchcontroller_managedswitch_mirror_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-mirror-module) – Configuration method to edit FortiSwitch packet mirror. * [fmgr\_switchcontroller\_managedswitch\_ports](fmgr_switchcontroller_managedswitch_ports_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-ports-module) – Managed-switch port list. * [fmgr\_switchcontroller\_managedswitch\_remotelog](fmgr_switchcontroller_managedswitch_remotelog_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-remotelog-module) – Configure logging by FortiSwitch device to a remote syslog server. * [fmgr\_switchcontroller\_managedswitch\_snmpcommunity](fmgr_switchcontroller_managedswitch_snmpcommunity_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-snmpcommunity-module) – Configuration method to edit Simple Network Management Protocol * [fmgr\_switchcontroller\_managedswitch\_snmpcommunity\_hosts](fmgr_switchcontroller_managedswitch_snmpcommunity_hosts_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-snmpcommunity-hosts-module) – Configure IPv4 SNMP managers * [fmgr\_switchcontroller\_managedswitch\_snmpsysinfo](fmgr_switchcontroller_managedswitch_snmpsysinfo_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-snmpsysinfo-module) – Configuration method to edit Simple Network Management Protocol * [fmgr\_switchcontroller\_managedswitch\_snmptrapthreshold](fmgr_switchcontroller_managedswitch_snmptrapthreshold_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-snmptrapthreshold-module) – Configuration method to edit Simple Network Management Protocol * [fmgr\_switchcontroller\_managedswitch\_snmpuser](fmgr_switchcontroller_managedswitch_snmpuser_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-snmpuser-module) – Configuration method to edit Simple Network Management Protocol * [fmgr\_switchcontroller\_managedswitch\_stormcontrol](fmgr_switchcontroller_managedswitch_stormcontrol_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-stormcontrol-module) – Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption. * [fmgr\_switchcontroller\_managedswitch\_stpsettings](fmgr_switchcontroller_managedswitch_stpsettings_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-stpsettings-module) – Configuration method to edit Spanning Tree Protocol * [fmgr\_switchcontroller\_managedswitch\_switchlog](fmgr_switchcontroller_managedswitch_switchlog_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-switchlog-module) – Configuration method to edit FortiSwitch logging settings * [fmgr\_switchcontroller\_managedswitch\_switchstpsettings](fmgr_switchcontroller_managedswitch_switchstpsettings_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-managedswitch-switchstpsettings-module) – Configure spanning tree protocol * [fmgr\_switchcontroller\_qos\_dot1pmap](fmgr_switchcontroller_qos_dot1pmap_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-dot1pmap-module) – Configure FortiSwitch QoS 802. * [fmgr\_switchcontroller\_qos\_ipdscpmap](fmgr_switchcontroller_qos_ipdscpmap_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-ipdscpmap-module) – Configure FortiSwitch QoS IP precedence/DSCP. * [fmgr\_switchcontroller\_qos\_ipdscpmap\_map](fmgr_switchcontroller_qos_ipdscpmap_map_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-ipdscpmap-map-module) – Maps between IP-DSCP value to COS queue. * [fmgr\_switchcontroller\_qos\_qospolicy](fmgr_switchcontroller_qos_qospolicy_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-qospolicy-module) – Configure FortiSwitch QoS policy. * [fmgr\_switchcontroller\_qos\_queuepolicy](fmgr_switchcontroller_qos_queuepolicy_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-queuepolicy-module) – Configure FortiSwitch QoS egress queue policy. * [fmgr\_switchcontroller\_qos\_queuepolicy\_cosqueue](fmgr_switchcontroller_qos_queuepolicy_cosqueue_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-qos-queuepolicy-cosqueue-module) – COS queue configuration. * [fmgr\_switchcontroller\_securitypolicy\_8021x](fmgr_switchcontroller_securitypolicy_8021x_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-securitypolicy-8021x-module) – Configure 802. * [fmgr\_switchcontroller\_securitypolicy\_captiveportal](fmgr_switchcontroller_securitypolicy_captiveportal_module#ansible-collections-fortinet-fortimanager-fmgr-switchcontroller-securitypolicy-captiveportal-module) – Names of VLANs that use captive portal authentication. * [fmgr\_sys\_api\_sdnconnector](fmgr_sys_api_sdnconnector_module#ansible-collections-fortinet-fortimanager-fmgr-sys-api-sdnconnector-module) – Query SDN connector data. * [fmgr\_sys\_generate\_wsdl](fmgr_sys_generate_wsdl_module#ansible-collections-fortinet-fortimanager-fmgr-sys-generate-wsdl-module) – Generate WSDL for specific module and objects. * [fmgr\_sys\_login\_challenge](fmgr_sys_login_challenge_module#ansible-collections-fortinet-fortimanager-fmgr-sys-login-challenge-module) – Answer a log in challenge question, used following a login/user or login/challenge command. * [fmgr\_sys\_login\_user](fmgr_sys_login_user_module#ansible-collections-fortinet-fortimanager-fmgr-sys-login-user-module) – Log into the device with user name and password. * [fmgr\_sys\_logout](fmgr_sys_logout_module#ansible-collections-fortinet-fortimanager-fmgr-sys-logout-module) – Log out a session. * [fmgr\_sys\_proxy\_json](fmgr_sys_proxy_json_module#ansible-collections-fortinet-fortimanager-fmgr-sys-proxy-json-module) – Send and receive JSON request to/from managed devices. * [fmgr\_sys\_reboot](fmgr_sys_reboot_module#ansible-collections-fortinet-fortimanager-fmgr-sys-reboot-module) – Restart FortiManager. * [fmgr\_system\_admin\_group](fmgr_system_admin_group_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-group-module) – User group. * [fmgr\_system\_admin\_group\_member](fmgr_system_admin_group_member_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-group-member-module) – Group members. * [fmgr\_system\_admin\_ldap](fmgr_system_admin_ldap_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-ldap-module) – LDAP server entry configuration. * [fmgr\_system\_admin\_ldap\_adom](fmgr_system_admin_ldap_adom_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-ldap-adom-module) – Admin domain. * [fmgr\_system\_admin\_profile](fmgr_system_admin_profile_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-profile-module) – Admin profile. * [fmgr\_system\_admin\_profile\_datamaskcustomfields](fmgr_system_admin_profile_datamaskcustomfields_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-profile-datamaskcustomfields-module) – Customized datamask fields. * [fmgr\_system\_admin\_radius](fmgr_system_admin_radius_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-radius-module) – Configure radius. * [fmgr\_system\_admin\_setting](fmgr_system_admin_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-setting-module) – Admin setting. * [fmgr\_system\_admin\_tacacs](fmgr_system_admin_tacacs_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-tacacs-module) – TACACS+ server entry configuration. * [fmgr\_system\_admin\_user](fmgr_system_admin_user_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-module) – Admin user. * [fmgr\_system\_admin\_user\_adom](fmgr_system_admin_user_adom_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-adom-module) – Admin domain. * [fmgr\_system\_admin\_user\_adomexclude](fmgr_system_admin_user_adomexclude_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-adomexclude-module) – Excluding admin domain. * [fmgr\_system\_admin\_user\_appfilter](fmgr_system_admin_user_appfilter_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-appfilter-module) – App filter. * [fmgr\_system\_admin\_user\_dashboard](fmgr_system_admin_user_dashboard_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-dashboard-module) – Custom dashboard widgets. * [fmgr\_system\_admin\_user\_dashboardtabs](fmgr_system_admin_user_dashboardtabs_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-dashboardtabs-module) – Custom dashboard. * [fmgr\_system\_admin\_user\_ipsfilter](fmgr_system_admin_user_ipsfilter_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-ipsfilter-module) – IPS filter. * [fmgr\_system\_admin\_user\_metadata](fmgr_system_admin_user_metadata_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-metadata-module) – Configure meta data. * [fmgr\_system\_admin\_user\_policypackage](fmgr_system_admin_user_policypackage_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-policypackage-module) – Policy package access. * [fmgr\_system\_admin\_user\_restrictdevvdom](fmgr_system_admin_user_restrictdevvdom_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-restrictdevvdom-module) – Restricted to these devices/VDOMs. * [fmgr\_system\_admin\_user\_webfilter](fmgr_system_admin_user_webfilter_module#ansible-collections-fortinet-fortimanager-fmgr-system-admin-user-webfilter-module) – Web filter. * [fmgr\_system\_alertconsole](fmgr_system_alertconsole_module#ansible-collections-fortinet-fortimanager-fmgr-system-alertconsole-module) – Alert console. * [fmgr\_system\_alertemail](fmgr_system_alertemail_module#ansible-collections-fortinet-fortimanager-fmgr-system-alertemail-module) – Configure alertemail. * [fmgr\_system\_alertevent](fmgr_system_alertevent_module#ansible-collections-fortinet-fortimanager-fmgr-system-alertevent-module) – Alert events. * [fmgr\_system\_alertevent\_alertdestination](fmgr_system_alertevent_alertdestination_module#ansible-collections-fortinet-fortimanager-fmgr-system-alertevent-alertdestination-module) – Alert destination. * [fmgr\_system\_autodelete](fmgr_system_autodelete_module#ansible-collections-fortinet-fortimanager-fmgr-system-autodelete-module) – Automatic deletion policy for logs, reports, archived, and quarantined files. * [fmgr\_system\_autodelete\_dlpfilesautodeletion](fmgr_system_autodelete_dlpfilesautodeletion_module#ansible-collections-fortinet-fortimanager-fmgr-system-autodelete-dlpfilesautodeletion-module) – Automatic deletion policy for DLP archives. * [fmgr\_system\_autodelete\_logautodeletion](fmgr_system_autodelete_logautodeletion_module#ansible-collections-fortinet-fortimanager-fmgr-system-autodelete-logautodeletion-module) – Automatic deletion policy for device logs. * [fmgr\_system\_autodelete\_quarantinefilesautodeletion](fmgr_system_autodelete_quarantinefilesautodeletion_module#ansible-collections-fortinet-fortimanager-fmgr-system-autodelete-quarantinefilesautodeletion-module) – Automatic deletion policy for quarantined files. * [fmgr\_system\_autodelete\_reportautodeletion](fmgr_system_autodelete_reportautodeletion_module#ansible-collections-fortinet-fortimanager-fmgr-system-autodelete-reportautodeletion-module) – Automatic deletion policy for reports. * [fmgr\_system\_backup\_allsettings](fmgr_system_backup_allsettings_module#ansible-collections-fortinet-fortimanager-fmgr-system-backup-allsettings-module) – Scheduled backup settings. * [fmgr\_system\_certificate\_ca](fmgr_system_certificate_ca_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-ca-module) – CA certificate. * [fmgr\_system\_certificate\_crl](fmgr_system_certificate_crl_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-crl-module) – Certificate Revocation List. * [fmgr\_system\_certificate\_local](fmgr_system_certificate_local_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-local-module) – Local keys and certificates. * [fmgr\_system\_certificate\_oftp](fmgr_system_certificate_oftp_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-oftp-module) – OFTP certificates and keys. * [fmgr\_system\_certificate\_remote](fmgr_system_certificate_remote_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-remote-module) – Remote certificate. * [fmgr\_system\_certificate\_ssh](fmgr_system_certificate_ssh_module#ansible-collections-fortinet-fortimanager-fmgr-system-certificate-ssh-module) – SSH certificates and keys. * [fmgr\_system\_connector](fmgr_system_connector_module#ansible-collections-fortinet-fortimanager-fmgr-system-connector-module) – Configure connector. * [fmgr\_system\_customlanguage](fmgr_system_customlanguage_module#ansible-collections-fortinet-fortimanager-fmgr-system-customlanguage-module) – Configure custom languages. * [fmgr\_system\_dhcp\_server](fmgr_system_dhcp_server_module#ansible-collections-fortinet-fortimanager-fmgr-system-dhcp-server-module) – Configure DHCP servers. * [fmgr\_system\_dhcp\_server\_excluderange](fmgr_system_dhcp_server_excluderange_module#ansible-collections-fortinet-fortimanager-fmgr-system-dhcp-server-excluderange-module) – Exclude one or more ranges of IP addresses from being assigned to clients. * [fmgr\_system\_dhcp\_server\_iprange](fmgr_system_dhcp_server_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-system-dhcp-server-iprange-module) – DHCP IP range configuration. * [fmgr\_system\_dhcp\_server\_options](fmgr_system_dhcp_server_options_module#ansible-collections-fortinet-fortimanager-fmgr-system-dhcp-server-options-module) – DHCP options. * [fmgr\_system\_dhcp\_server\_reservedaddress](fmgr_system_dhcp_server_reservedaddress_module#ansible-collections-fortinet-fortimanager-fmgr-system-dhcp-server-reservedaddress-module) – Options for the DHCP server to assign IP settings to specific MAC addresses. * [fmgr\_system\_dm](fmgr_system_dm_module#ansible-collections-fortinet-fortimanager-fmgr-system-dm-module) – Configure dm. * [fmgr\_system\_dns](fmgr_system_dns_module#ansible-collections-fortinet-fortimanager-fmgr-system-dns-module) – DNS configuration. * [fmgr\_system\_docker](fmgr_system_docker_module#ansible-collections-fortinet-fortimanager-fmgr-system-docker-module) – Docker host. * [fmgr\_system\_externalresource](fmgr_system_externalresource_module#ansible-collections-fortinet-fortimanager-fmgr-system-externalresource-module) – Configure external resource. * [fmgr\_system\_fips](fmgr_system_fips_module#ansible-collections-fortinet-fortimanager-fmgr-system-fips-module) – Settings for FIPS-CC mode. * [fmgr\_system\_fortiguard](fmgr_system_fortiguard_module#ansible-collections-fortinet-fortimanager-fmgr-system-fortiguard-module) – Configure FortiGuard services. * [fmgr\_system\_fortiview\_autocache](fmgr_system_fortiview_autocache_module#ansible-collections-fortinet-fortimanager-fmgr-system-fortiview-autocache-module) – FortiView auto-cache settings. * [fmgr\_system\_fortiview\_setting](fmgr_system_fortiview_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-fortiview-setting-module) – FortiView settings. * [fmgr\_system\_geoipcountry](fmgr_system_geoipcountry_module#ansible-collections-fortinet-fortimanager-fmgr-system-geoipcountry-module) – no description * [fmgr\_system\_geoipoverride](fmgr_system_geoipoverride_module#ansible-collections-fortinet-fortimanager-fmgr-system-geoipoverride-module) – Configure geographical location mapping for IP address * [fmgr\_system\_geoipoverride\_ip6range](fmgr_system_geoipoverride_ip6range_module#ansible-collections-fortinet-fortimanager-fmgr-system-geoipoverride-ip6range-module) – Table of IPv6 ranges assigned to country. * [fmgr\_system\_geoipoverride\_iprange](fmgr_system_geoipoverride_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-system-geoipoverride-iprange-module) – Table of IP ranges assigned to country. * [fmgr\_system\_global](fmgr_system_global_module#ansible-collections-fortinet-fortimanager-fmgr-system-global-module) – Global range attributes. * [fmgr\_system\_guiact](fmgr_system_guiact_module#ansible-collections-fortinet-fortimanager-fmgr-system-guiact-module) – System settings through GUI. * [fmgr\_system\_ha](fmgr_system_ha_module#ansible-collections-fortinet-fortimanager-fmgr-system-ha-module) – HA configuration. * [fmgr\_system\_ha\_peer](fmgr_system_ha_peer_module#ansible-collections-fortinet-fortimanager-fmgr-system-ha-peer-module) – Peer. * [fmgr\_system\_interface](fmgr_system_interface_module#ansible-collections-fortinet-fortimanager-fmgr-system-interface-module) – Interface configuration. * [fmgr\_system\_interface\_ipv6](fmgr_system_interface_ipv6_module#ansible-collections-fortinet-fortimanager-fmgr-system-interface-ipv6-module) – IPv6 of interface. * [fmgr\_system\_locallog\_disk\_filter](fmgr_system_locallog_disk_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-disk-filter-module) – Filter for disk logging. * [fmgr\_system\_locallog\_disk\_setting](fmgr_system_locallog_disk_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-disk-setting-module) – Settings for local disk logging. * [fmgr\_system\_locallog\_fortianalyzer2\_filter](fmgr_system_locallog_fortianalyzer2_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer2-filter-module) – Filter for FortiAnalyzer2 logging. * [fmgr\_system\_locallog\_fortianalyzer2\_setting](fmgr_system_locallog_fortianalyzer2_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer2-setting-module) – Settings for locallog to fortianalyzer. * [fmgr\_system\_locallog\_fortianalyzer3\_filter](fmgr_system_locallog_fortianalyzer3_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer3-filter-module) – Filter for FortiAnalyzer3 logging. * [fmgr\_system\_locallog\_fortianalyzer3\_setting](fmgr_system_locallog_fortianalyzer3_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer3-setting-module) – Settings for locallog to fortianalyzer. * [fmgr\_system\_locallog\_fortianalyzer\_filter](fmgr_system_locallog_fortianalyzer_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer-filter-module) – Filter for FortiAnalyzer logging. * [fmgr\_system\_locallog\_fortianalyzer\_setting](fmgr_system_locallog_fortianalyzer_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-fortianalyzer-setting-module) – Settings for locallog to fortianalyzer. * [fmgr\_system\_locallog\_memory\_filter](fmgr_system_locallog_memory_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-memory-filter-module) – Filter for memory logging. * [fmgr\_system\_locallog\_memory\_setting](fmgr_system_locallog_memory_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-memory-setting-module) – Settings for memory buffer. * [fmgr\_system\_locallog\_setting](fmgr_system_locallog_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-setting-module) – Settings for locallog logging. * [fmgr\_system\_locallog\_syslogd2\_filter](fmgr_system_locallog_syslogd2_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd2-filter-module) – Filter for syslog logging. * [fmgr\_system\_locallog\_syslogd2\_setting](fmgr_system_locallog_syslogd2_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd2-setting-module) – Settings for remote syslog server. * [fmgr\_system\_locallog\_syslogd3\_filter](fmgr_system_locallog_syslogd3_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd3-filter-module) – Filter for syslog logging. * [fmgr\_system\_locallog\_syslogd3\_setting](fmgr_system_locallog_syslogd3_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd3-setting-module) – Settings for remote syslog server. * [fmgr\_system\_locallog\_syslogd\_filter](fmgr_system_locallog_syslogd_filter_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd-filter-module) – Filter for syslog logging. * [fmgr\_system\_locallog\_syslogd\_setting](fmgr_system_locallog_syslogd_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-locallog-syslogd-setting-module) – Settings for remote syslog server. * [fmgr\_system\_log\_alert](fmgr_system_log_alert_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-alert-module) – Log based alert settings. * [fmgr\_system\_log\_devicedisable](fmgr_system_log_devicedisable_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-devicedisable-module) – Disable client device logging. * [fmgr\_system\_log\_interfacestats](fmgr_system_log_interfacestats_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-interfacestats-module) – Interface statistics settings. * [fmgr\_system\_log\_ioc](fmgr_system_log_ioc_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-ioc-module) – IoC settings. * [fmgr\_system\_log\_maildomain](fmgr_system_log_maildomain_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-maildomain-module) – FortiMail domain setting. * [fmgr\_system\_log\_ratelimit](fmgr_system_log_ratelimit_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-ratelimit-module) – Logging rate limit. * [fmgr\_system\_log\_ratelimit\_device](fmgr_system_log_ratelimit_device_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-ratelimit-device-module) – Device log rate limit. * [fmgr\_system\_log\_settings](fmgr_system_log_settings_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-settings-module) – Log settings. * [fmgr\_system\_log\_settings\_rollinganalyzer](fmgr_system_log_settings_rollinganalyzer_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-settings-rollinganalyzer-module) – Log rolling policy for Network Analyzer logs. * [fmgr\_system\_log\_settings\_rollinglocal](fmgr_system_log_settings_rollinglocal_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-settings-rollinglocal-module) – Log rolling policy for local logs. * [fmgr\_system\_log\_settings\_rollingregular](fmgr_system_log_settings_rollingregular_module#ansible-collections-fortinet-fortimanager-fmgr-system-log-settings-rollingregular-module) – Log rolling policy for device logs. * [fmgr\_system\_logfetch\_clientprofile](fmgr_system_logfetch_clientprofile_module#ansible-collections-fortinet-fortimanager-fmgr-system-logfetch-clientprofile-module) – Log-fetch client profile settings. * [fmgr\_system\_logfetch\_clientprofile\_devicefilter](fmgr_system_logfetch_clientprofile_devicefilter_module#ansible-collections-fortinet-fortimanager-fmgr-system-logfetch-clientprofile-devicefilter-module) – List of device filter. * [fmgr\_system\_logfetch\_clientprofile\_logfilter](fmgr_system_logfetch_clientprofile_logfilter_module#ansible-collections-fortinet-fortimanager-fmgr-system-logfetch-clientprofile-logfilter-module) – Log content filters. * [fmgr\_system\_logfetch\_serversettings](fmgr_system_logfetch_serversettings_module#ansible-collections-fortinet-fortimanager-fmgr-system-logfetch-serversettings-module) – Log-fetch server settings. * [fmgr\_system\_mail](fmgr_system_mail_module#ansible-collections-fortinet-fortimanager-fmgr-system-mail-module) – Alert emails. * [fmgr\_system\_mcpolicydisabledadoms](fmgr_system_mcpolicydisabledadoms_module#ansible-collections-fortinet-fortimanager-fmgr-system-mcpolicydisabledadoms-module) – Multicast policy disabled adoms. * [fmgr\_system\_meta](fmgr_system_meta_module#ansible-collections-fortinet-fortimanager-fmgr-system-meta-module) – no description * [fmgr\_system\_meta\_sysmetafields](fmgr_system_meta_sysmetafields_module#ansible-collections-fortinet-fortimanager-fmgr-system-meta-sysmetafields-module) – no description * [fmgr\_system\_metadata\_admins](fmgr_system_metadata_admins_module#ansible-collections-fortinet-fortimanager-fmgr-system-metadata-admins-module) – Configure admins. * [fmgr\_system\_ntp](fmgr_system_ntp_module#ansible-collections-fortinet-fortimanager-fmgr-system-ntp-module) – NTP settings. * [fmgr\_system\_ntp\_ntpserver](fmgr_system_ntp_ntpserver_module#ansible-collections-fortinet-fortimanager-fmgr-system-ntp-ntpserver-module) – NTP server. * [fmgr\_system\_objecttagging](fmgr_system_objecttagging_module#ansible-collections-fortinet-fortimanager-fmgr-system-objecttagging-module) – Configure object tagging. * [fmgr\_system\_passwordpolicy](fmgr_system_passwordpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-system-passwordpolicy-module) – Password policy. * [fmgr\_system\_replacemsggroup](fmgr_system_replacemsggroup_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-module) – Configure replacement message groups. * [fmgr\_system\_replacemsggroup\_admin](fmgr_system_replacemsggroup_admin_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-admin-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_alertmail](fmgr_system_replacemsggroup_alertmail_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-alertmail-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_auth](fmgr_system_replacemsggroup_auth_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-auth-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_automation](fmgr_system_replacemsggroup_automation_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-automation-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_custommessage](fmgr_system_replacemsggroup_custommessage_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-custommessage-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_devicedetectionportal](fmgr_system_replacemsggroup_devicedetectionportal_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-devicedetectionportal-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_ec](fmgr_system_replacemsggroup_ec_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-ec-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_fortiguardwf](fmgr_system_replacemsggroup_fortiguardwf_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-fortiguardwf-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_ftp](fmgr_system_replacemsggroup_ftp_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-ftp-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_http](fmgr_system_replacemsggroup_http_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-http-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_icap](fmgr_system_replacemsggroup_icap_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-icap-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mail](fmgr_system_replacemsggroup_mail_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mail-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mm1](fmgr_system_replacemsggroup_mm1_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mm1-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mm3](fmgr_system_replacemsggroup_mm3_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mm3-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mm4](fmgr_system_replacemsggroup_mm4_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mm4-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mm7](fmgr_system_replacemsggroup_mm7_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mm7-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_mms](fmgr_system_replacemsggroup_mms_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-mms-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_nacquar](fmgr_system_replacemsggroup_nacquar_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-nacquar-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_nntp](fmgr_system_replacemsggroup_nntp_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-nntp-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_spam](fmgr_system_replacemsggroup_spam_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-spam-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_sslvpn](fmgr_system_replacemsggroup_sslvpn_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-sslvpn-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_trafficquota](fmgr_system_replacemsggroup_trafficquota_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-trafficquota-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_utm](fmgr_system_replacemsggroup_utm_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-utm-module) – Replacement message table entries. * [fmgr\_system\_replacemsggroup\_webproxy](fmgr_system_replacemsggroup_webproxy_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsggroup-webproxy-module) – Replacement message table entries. * [fmgr\_system\_replacemsgimage](fmgr_system_replacemsgimage_module#ansible-collections-fortinet-fortimanager-fmgr-system-replacemsgimage-module) – Configure replacement message images. * [fmgr\_system\_report\_autocache](fmgr_system_report_autocache_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-autocache-module) – Report auto-cache settings. * [fmgr\_system\_report\_estbrowsetime](fmgr_system_report_estbrowsetime_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-estbrowsetime-module) – Report estimated browse time settings * [fmgr\_system\_report\_group](fmgr_system_report_group_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-group-module) – Report group. * [fmgr\_system\_report\_group\_chartalternative](fmgr_system_report_group_chartalternative_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-group-chartalternative-module) – Chart alternatives. * [fmgr\_system\_report\_group\_groupby](fmgr_system_report_group_groupby_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-group-groupby-module) – Group-by variables. * [fmgr\_system\_report\_setting](fmgr_system_report_setting_module#ansible-collections-fortinet-fortimanager-fmgr-system-report-setting-module) – Report settings. * [fmgr\_system\_route](fmgr_system_route_module#ansible-collections-fortinet-fortimanager-fmgr-system-route-module) – Routing table configuration. * [fmgr\_system\_route6](fmgr_system_route6_module#ansible-collections-fortinet-fortimanager-fmgr-system-route6-module) – Routing table configuration. * [fmgr\_system\_saml](fmgr_system_saml_module#ansible-collections-fortinet-fortimanager-fmgr-system-saml-module) – Global settings for SAML authentication. * [fmgr\_system\_saml\_fabricidp](fmgr_system_saml_fabricidp_module#ansible-collections-fortinet-fortimanager-fmgr-system-saml-fabricidp-module) – Authorized identity providers. * [fmgr\_system\_sdnconnector](fmgr_system_sdnconnector_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-module) – Configure connection to SDN Connector. * [fmgr\_system\_sdnconnector\_externalip](fmgr_system_sdnconnector_externalip_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-externalip-module) – Configure GCP external IP. * [fmgr\_system\_sdnconnector\_nic](fmgr_system_sdnconnector_nic_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-nic-module) – Configure Azure network interface. * [fmgr\_system\_sdnconnector\_nic\_ip](fmgr_system_sdnconnector_nic_ip_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-nic-ip-module) – Configure IP configuration. * [fmgr\_system\_sdnconnector\_route](fmgr_system_sdnconnector_route_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-route-module) – Configure GCP route. * [fmgr\_system\_sdnconnector\_routetable](fmgr_system_sdnconnector_routetable_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-routetable-module) – Configure Azure route table. * [fmgr\_system\_sdnconnector\_routetable\_route](fmgr_system_sdnconnector_routetable_route_module#ansible-collections-fortinet-fortimanager-fmgr-system-sdnconnector-routetable-route-module) – Configure Azure route. * [fmgr\_system\_smsserver](fmgr_system_smsserver_module#ansible-collections-fortinet-fortimanager-fmgr-system-smsserver-module) – Configure SMS server for sending SMS messages to support user authentication. * [fmgr\_system\_sniffer](fmgr_system_sniffer_module#ansible-collections-fortinet-fortimanager-fmgr-system-sniffer-module) – Interface sniffer. * [fmgr\_system\_snmp\_community](fmgr_system_snmp_community_module#ansible-collections-fortinet-fortimanager-fmgr-system-snmp-community-module) – SNMP community configuration. * [fmgr\_system\_snmp\_community\_hosts](fmgr_system_snmp_community_hosts_module#ansible-collections-fortinet-fortimanager-fmgr-system-snmp-community-hosts-module) – Allow hosts configuration. * [fmgr\_system\_snmp\_community\_hosts6](fmgr_system_snmp_community_hosts6_module#ansible-collections-fortinet-fortimanager-fmgr-system-snmp-community-hosts6-module) – Allow hosts configuration for IPv6. * [fmgr\_system\_snmp\_sysinfo](fmgr_system_snmp_sysinfo_module#ansible-collections-fortinet-fortimanager-fmgr-system-snmp-sysinfo-module) – SNMP configuration. * [fmgr\_system\_snmp\_user](fmgr_system_snmp_user_module#ansible-collections-fortinet-fortimanager-fmgr-system-snmp-user-module) – SNMP user configuration. * [fmgr\_system\_socfabric](fmgr_system_socfabric_module#ansible-collections-fortinet-fortimanager-fmgr-system-socfabric-module) – SOC Fabric. * [fmgr\_system\_sql](fmgr_system_sql_module#ansible-collections-fortinet-fortimanager-fmgr-system-sql-module) – SQL settings. * [fmgr\_system\_sql\_customindex](fmgr_system_sql_customindex_module#ansible-collections-fortinet-fortimanager-fmgr-system-sql-customindex-module) – List of SQL index fields. * [fmgr\_system\_sql\_customskipidx](fmgr_system_sql_customskipidx_module#ansible-collections-fortinet-fortimanager-fmgr-system-sql-customskipidx-module) – List of aditional SQL skip index fields. * [fmgr\_system\_sql\_tsindexfield](fmgr_system_sql_tsindexfield_module#ansible-collections-fortinet-fortimanager-fmgr-system-sql-tsindexfield-module) – List of SQL text search index fields. * [fmgr\_system\_syslog](fmgr_system_syslog_module#ansible-collections-fortinet-fortimanager-fmgr-system-syslog-module) – Syslog servers. * [fmgr\_system\_virtualwirepair](fmgr_system_virtualwirepair_module#ansible-collections-fortinet-fortimanager-fmgr-system-virtualwirepair-module) – Configure virtual wire pairs. * [fmgr\_system\_workflow\_approvalmatrix](fmgr_system_workflow_approvalmatrix_module#ansible-collections-fortinet-fortimanager-fmgr-system-workflow-approvalmatrix-module) – workflow approval matrix. * [fmgr\_system\_workflow\_approvalmatrix\_approver](fmgr_system_workflow_approvalmatrix_approver_module#ansible-collections-fortinet-fortimanager-fmgr-system-workflow-approvalmatrix-approver-module) – Approver. * [fmgr\_template](fmgr_template_module#ansible-collections-fortinet-fortimanager-fmgr-template-module) – no description * [fmgr\_templategroup](fmgr_templategroup_module#ansible-collections-fortinet-fortimanager-fmgr-templategroup-module) – no description * [fmgr\_user\_adgrp](fmgr_user_adgrp_module#ansible-collections-fortinet-fortimanager-fmgr-user-adgrp-module) – Configure FSSO groups. * [fmgr\_user\_clearpass](fmgr_user_clearpass_module#ansible-collections-fortinet-fortimanager-fmgr-user-clearpass-module) – no description * [fmgr\_user\_device](fmgr_user_device_module#ansible-collections-fortinet-fortimanager-fmgr-user-device-module) – Configure devices. * [fmgr\_user\_device\_dynamicmapping](fmgr_user_device_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-device-dynamicmapping-module) – no description * [fmgr\_user\_device\_tagging](fmgr_user_device_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-user-device-tagging-module) – Config object tagging. * [fmgr\_user\_devicecategory](fmgr_user_devicecategory_module#ansible-collections-fortinet-fortimanager-fmgr-user-devicecategory-module) – Configure device categories. * [fmgr\_user\_devicegroup](fmgr_user_devicegroup_module#ansible-collections-fortinet-fortimanager-fmgr-user-devicegroup-module) – Configure device groups. * [fmgr\_user\_devicegroup\_dynamicmapping](fmgr_user_devicegroup_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-devicegroup-dynamicmapping-module) – no description * [fmgr\_user\_devicegroup\_tagging](fmgr_user_devicegroup_tagging_module#ansible-collections-fortinet-fortimanager-fmgr-user-devicegroup-tagging-module) – Config object tagging. * [fmgr\_user\_domaincontroller](fmgr_user_domaincontroller_module#ansible-collections-fortinet-fortimanager-fmgr-user-domaincontroller-module) – Configure domain controller entries. * [fmgr\_user\_domaincontroller\_extraserver](fmgr_user_domaincontroller_extraserver_module#ansible-collections-fortinet-fortimanager-fmgr-user-domaincontroller-extraserver-module) – extra servers. * [fmgr\_user\_exchange](fmgr_user_exchange_module#ansible-collections-fortinet-fortimanager-fmgr-user-exchange-module) – Configure MS Exchange server entries. * [fmgr\_user\_fortitoken](fmgr_user_fortitoken_module#ansible-collections-fortinet-fortimanager-fmgr-user-fortitoken-module) – Configure FortiToken. * [fmgr\_user\_fsso](fmgr_user_fsso_module#ansible-collections-fortinet-fortimanager-fmgr-user-fsso-module) – Configure Fortinet Single Sign On * [fmgr\_user\_fsso\_dynamicmapping](fmgr_user_fsso_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-fsso-dynamicmapping-module) – Configure Fortinet Single Sign On * [fmgr\_user\_fssopolling](fmgr_user_fssopolling_module#ansible-collections-fortinet-fortimanager-fmgr-user-fssopolling-module) – Configure FSSO active directory servers for polling mode. * [fmgr\_user\_fssopolling\_adgrp](fmgr_user_fssopolling_adgrp_module#ansible-collections-fortinet-fortimanager-fmgr-user-fssopolling-adgrp-module) – LDAP Group Info. * [fmgr\_user\_group](fmgr_user_group_module#ansible-collections-fortinet-fortimanager-fmgr-user-group-module) – Configure user groups. * [fmgr\_user\_group\_guest](fmgr_user_group_guest_module#ansible-collections-fortinet-fortimanager-fmgr-user-group-guest-module) – Guest User. * [fmgr\_user\_group\_match](fmgr_user_group_match_module#ansible-collections-fortinet-fortimanager-fmgr-user-group-match-module) – Group matches. * [fmgr\_user\_krbkeytab](fmgr_user_krbkeytab_module#ansible-collections-fortinet-fortimanager-fmgr-user-krbkeytab-module) – Configure Kerberos keytab entries. * [fmgr\_user\_ldap](fmgr_user_ldap_module#ansible-collections-fortinet-fortimanager-fmgr-user-ldap-module) – Configure LDAP server entries. * [fmgr\_user\_ldap\_dynamicmapping](fmgr_user_ldap_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-ldap-dynamicmapping-module) – Configure LDAP server entries. * [fmgr\_user\_local](fmgr_user_local_module#ansible-collections-fortinet-fortimanager-fmgr-user-local-module) – Configure local users. * [fmgr\_user\_nsx](fmgr_user_nsx_module#ansible-collections-fortinet-fortimanager-fmgr-user-nsx-module) – no description * [fmgr\_user\_passwordpolicy](fmgr_user_passwordpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-user-passwordpolicy-module) – Configure user password policy. * [fmgr\_user\_peer](fmgr_user_peer_module#ansible-collections-fortinet-fortimanager-fmgr-user-peer-module) – Configure peer users. * [fmgr\_user\_peergrp](fmgr_user_peergrp_module#ansible-collections-fortinet-fortimanager-fmgr-user-peergrp-module) – Configure peer groups. * [fmgr\_user\_pop3](fmgr_user_pop3_module#ansible-collections-fortinet-fortimanager-fmgr-user-pop3-module) – POP3 server entry configuration. * [fmgr\_user\_pxgrid](fmgr_user_pxgrid_module#ansible-collections-fortinet-fortimanager-fmgr-user-pxgrid-module) – no description * [fmgr\_user\_radius](fmgr_user_radius_module#ansible-collections-fortinet-fortimanager-fmgr-user-radius-module) – Configure RADIUS server entries. * [fmgr\_user\_radius\_accountingserver](fmgr_user_radius_accountingserver_module#ansible-collections-fortinet-fortimanager-fmgr-user-radius-accountingserver-module) – Additional accounting servers. * [fmgr\_user\_radius\_dynamicmapping](fmgr_user_radius_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-radius-dynamicmapping-module) – Configure RADIUS server entries. * [fmgr\_user\_radius\_dynamicmapping\_accountingserver](fmgr_user_radius_dynamicmapping_accountingserver_module#ansible-collections-fortinet-fortimanager-fmgr-user-radius-dynamicmapping-accountingserver-module) – Additional accounting servers. * [fmgr\_user\_saml](fmgr_user_saml_module#ansible-collections-fortinet-fortimanager-fmgr-user-saml-module) – SAML server entry configuration. * [fmgr\_user\_securityexemptlist](fmgr_user_securityexemptlist_module#ansible-collections-fortinet-fortimanager-fmgr-user-securityexemptlist-module) – Configure security exemption list. * [fmgr\_user\_securityexemptlist\_rule](fmgr_user_securityexemptlist_rule_module#ansible-collections-fortinet-fortimanager-fmgr-user-securityexemptlist-rule-module) – Configure rules for exempting users from captive portal authentication. * [fmgr\_user\_tacacs](fmgr_user_tacacs_module#ansible-collections-fortinet-fortimanager-fmgr-user-tacacs-module) – Configure TACACS+ server entries. * [fmgr\_user\_tacacs\_dynamicmapping](fmgr_user_tacacs_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-user-tacacs-dynamicmapping-module) – Configure TACACS+ server entries. * [fmgr\_user\_vcenter](fmgr_user_vcenter_module#ansible-collections-fortinet-fortimanager-fmgr-user-vcenter-module) – no description * [fmgr\_user\_vcenter\_rule](fmgr_user_vcenter_rule_module#ansible-collections-fortinet-fortimanager-fmgr-user-vcenter-rule-module) – no description * [fmgr\_utmprofile](fmgr_utmprofile_module#ansible-collections-fortinet-fortimanager-fmgr-utmprofile-module) – Configure UTM * [fmgr\_vap](fmgr_vap_module#ansible-collections-fortinet-fortimanager-fmgr-vap-module) – Configure Virtual Access Points * [fmgr\_vap\_dynamicmapping](fmgr_vap_dynamicmapping_module#ansible-collections-fortinet-fortimanager-fmgr-vap-dynamicmapping-module) – Configure Virtual Access Points * [fmgr\_vap\_macfilterlist](fmgr_vap_macfilterlist_module#ansible-collections-fortinet-fortimanager-fmgr-vap-macfilterlist-module) – Create a list of MAC addresses for MAC address filtering. * [fmgr\_vap\_mpskkey](fmgr_vap_mpskkey_module#ansible-collections-fortinet-fortimanager-fmgr-vap-mpskkey-module) – Pre-shared keys that can be used to connect to this virtual access point. * [fmgr\_vap\_portalmessageoverrides](fmgr_vap_portalmessageoverrides_module#ansible-collections-fortinet-fortimanager-fmgr-vap-portalmessageoverrides-module) – Individual message overrides. * [fmgr\_vap\_vlanpool](fmgr_vap_vlanpool_module#ansible-collections-fortinet-fortimanager-fmgr-vap-vlanpool-module) – VLAN pool. * [fmgr\_vapgroup](fmgr_vapgroup_module#ansible-collections-fortinet-fortimanager-fmgr-vapgroup-module) – Configure virtual Access Point * [fmgr\_videofilter\_profile](fmgr_videofilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-videofilter-profile-module) – Configure VideoFilter profile. * [fmgr\_videofilter\_profile\_fortiguardcategory](fmgr_videofilter_profile_fortiguardcategory_module#ansible-collections-fortinet-fortimanager-fmgr-videofilter-profile-fortiguardcategory-module) – Configure FortiGuard categories. * [fmgr\_videofilter\_profile\_fortiguardcategory\_filters](fmgr_videofilter_profile_fortiguardcategory_filters_module#ansible-collections-fortinet-fortimanager-fmgr-videofilter-profile-fortiguardcategory-filters-module) – Configure VideoFilter FortiGuard category. * [fmgr\_videofilter\_youtubechannelfilter](fmgr_videofilter_youtubechannelfilter_module#ansible-collections-fortinet-fortimanager-fmgr-videofilter-youtubechannelfilter-module) – Configure YouTube channel filter. * [fmgr\_videofilter\_youtubechannelfilter\_entries](fmgr_videofilter_youtubechannelfilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-videofilter-youtubechannelfilter-entries-module) – YouTube filter entries. * [fmgr\_voip\_profile](fmgr_voip_profile_module#ansible-collections-fortinet-fortimanager-fmgr-voip-profile-module) – Configure VoIP profiles. * [fmgr\_voip\_profile\_sccp](fmgr_voip_profile_sccp_module#ansible-collections-fortinet-fortimanager-fmgr-voip-profile-sccp-module) – SCCP. * [fmgr\_voip\_profile\_sip](fmgr_voip_profile_sip_module#ansible-collections-fortinet-fortimanager-fmgr-voip-profile-sip-module) – SIP. * [fmgr\_vpn\_certificate\_ca](fmgr_vpn_certificate_ca_module#ansible-collections-fortinet-fortimanager-fmgr-vpn-certificate-ca-module) – CA certificate. * [fmgr\_vpn\_certificate\_ocspserver](fmgr_vpn_certificate_ocspserver_module#ansible-collections-fortinet-fortimanager-fmgr-vpn-certificate-ocspserver-module) – OCSP server configuration. * [fmgr\_vpn\_certificate\_remote](fmgr_vpn_certificate_remote_module#ansible-collections-fortinet-fortimanager-fmgr-vpn-certificate-remote-module) – Remote certificate as a PEM file. * [fmgr\_vpn\_ssl\_settings](fmgr_vpn_ssl_settings_module#ansible-collections-fortinet-fortimanager-fmgr-vpn-ssl-settings-module) – Configure SSL VPN. * [fmgr\_vpn\_ssl\_settings\_authenticationrule](fmgr_vpn_ssl_settings_authenticationrule_module#ansible-collections-fortinet-fortimanager-fmgr-vpn-ssl-settings-authenticationrule-module) – Authentication rule for SSL VPN. * [fmgr\_vpnmgr\_node](fmgr_vpnmgr_node_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-node-module) – VPN node for VPN Manager. * [fmgr\_vpnmgr\_node\_iprange](fmgr_vpnmgr_node_iprange_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-node-iprange-module) – no description * [fmgr\_vpnmgr\_node\_ipv4excluderange](fmgr_vpnmgr_node_ipv4excluderange_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-node-ipv4excluderange-module) – no description * [fmgr\_vpnmgr\_node\_protectedsubnet](fmgr_vpnmgr_node_protectedsubnet_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-node-protectedsubnet-module) – no description * [fmgr\_vpnmgr\_node\_summaryaddr](fmgr_vpnmgr_node_summaryaddr_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-node-summaryaddr-module) – no description * [fmgr\_vpnmgr\_vpntable](fmgr_vpnmgr_vpntable_module#ansible-collections-fortinet-fortimanager-fmgr-vpnmgr-vpntable-module) – no description * [fmgr\_vpnsslweb\_hostchecksoftware](fmgr_vpnsslweb_hostchecksoftware_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-hostchecksoftware-module) – SSL-VPN host check software. * [fmgr\_vpnsslweb\_hostchecksoftware\_checkitemlist](fmgr_vpnsslweb_hostchecksoftware_checkitemlist_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-hostchecksoftware-checkitemlist-module) – Check item list. * [fmgr\_vpnsslweb\_portal](fmgr_vpnsslweb_portal_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-module) – Portal. * [fmgr\_vpnsslweb\_portal\_bookmarkgroup](fmgr_vpnsslweb_portal_bookmarkgroup_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-bookmarkgroup-module) – Portal bookmark group. * [fmgr\_vpnsslweb\_portal\_bookmarkgroup\_bookmarks](fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-bookmarkgroup-bookmarks-module) – Bookmark table. * [fmgr\_vpnsslweb\_portal\_bookmarkgroup\_bookmarks\_formdata](fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_formdata_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-bookmarkgroup-bookmarks-formdata-module) – Form data. * [fmgr\_vpnsslweb\_portal\_macaddrcheckrule](fmgr_vpnsslweb_portal_macaddrcheckrule_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-macaddrcheckrule-module) – Client MAC address check rule. * [fmgr\_vpnsslweb\_portal\_oschecklist](fmgr_vpnsslweb_portal_oschecklist_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-oschecklist-module) – SSL VPN OS checks. * [fmgr\_vpnsslweb\_portal\_splitdns](fmgr_vpnsslweb_portal_splitdns_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-portal-splitdns-module) – Split DNS for SSL VPN. * [fmgr\_vpnsslweb\_realm](fmgr_vpnsslweb_realm_module#ansible-collections-fortinet-fortimanager-fmgr-vpnsslweb-realm-module) – Realm. * [fmgr\_waf\_mainclass](fmgr_waf_mainclass_module#ansible-collections-fortinet-fortimanager-fmgr-waf-mainclass-module) – Hidden table for datasource. * [fmgr\_waf\_profile](fmgr_waf_profile_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-module) – Web application firewall configuration. * [fmgr\_waf\_profile\_addresslist](fmgr_waf_profile_addresslist_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-addresslist-module) – Black address list and white address list. * [fmgr\_waf\_profile\_constraint](fmgr_waf_profile_constraint_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-module) – WAF HTTP protocol restrictions. * [fmgr\_waf\_profile\_constraint\_contentlength](fmgr_waf_profile_constraint_contentlength_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-contentlength-module) – HTTP content length in request. * [fmgr\_waf\_profile\_constraint\_exception](fmgr_waf_profile_constraint_exception_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-exception-module) – HTTP constraint exception. * [fmgr\_waf\_profile\_constraint\_headerlength](fmgr_waf_profile_constraint_headerlength_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-headerlength-module) – HTTP header length in request. * [fmgr\_waf\_profile\_constraint\_hostname](fmgr_waf_profile_constraint_hostname_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-hostname-module) – Enable/disable hostname check. * [fmgr\_waf\_profile\_constraint\_linelength](fmgr_waf_profile_constraint_linelength_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-linelength-module) – HTTP line length in request. * [fmgr\_waf\_profile\_constraint\_malformed](fmgr_waf_profile_constraint_malformed_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-malformed-module) – Enable/disable malformed HTTP request check. * [fmgr\_waf\_profile\_constraint\_maxcookie](fmgr_waf_profile_constraint_maxcookie_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-maxcookie-module) – Maximum number of cookies in HTTP request. * [fmgr\_waf\_profile\_constraint\_maxheaderline](fmgr_waf_profile_constraint_maxheaderline_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-maxheaderline-module) – Maximum number of HTTP header line. * [fmgr\_waf\_profile\_constraint\_maxrangesegment](fmgr_waf_profile_constraint_maxrangesegment_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-maxrangesegment-module) – Maximum number of range segments in HTTP range line. * [fmgr\_waf\_profile\_constraint\_maxurlparam](fmgr_waf_profile_constraint_maxurlparam_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-maxurlparam-module) – Maximum number of parameters in URL. * [fmgr\_waf\_profile\_constraint\_method](fmgr_waf_profile_constraint_method_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-method-module) – Enable/disable HTTP method check. * [fmgr\_waf\_profile\_constraint\_paramlength](fmgr_waf_profile_constraint_paramlength_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-paramlength-module) – Maximum length of parameter in URL, HTTP POST request or HTTP body. * [fmgr\_waf\_profile\_constraint\_urlparamlength](fmgr_waf_profile_constraint_urlparamlength_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-urlparamlength-module) – Maximum length of parameter in URL. * [fmgr\_waf\_profile\_constraint\_version](fmgr_waf_profile_constraint_version_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-constraint-version-module) – Enable/disable HTTP version check. * [fmgr\_waf\_profile\_method](fmgr_waf_profile_method_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-method-module) – Method restriction. * [fmgr\_waf\_profile\_method\_methodpolicy](fmgr_waf_profile_method_methodpolicy_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-method-methodpolicy-module) – HTTP method policy. * [fmgr\_waf\_profile\_signature](fmgr_waf_profile_signature_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-signature-module) – WAF signatures. * [fmgr\_waf\_profile\_signature\_customsignature](fmgr_waf_profile_signature_customsignature_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-signature-customsignature-module) – Custom signature. * [fmgr\_waf\_profile\_signature\_mainclass](fmgr_waf_profile_signature_mainclass_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-signature-mainclass-module) – Main signature class. * [fmgr\_waf\_profile\_urlaccess](fmgr_waf_profile_urlaccess_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-urlaccess-module) – URL access list * [fmgr\_waf\_profile\_urlaccess\_accesspattern](fmgr_waf_profile_urlaccess_accesspattern_module#ansible-collections-fortinet-fortimanager-fmgr-waf-profile-urlaccess-accesspattern-module) – URL access pattern. * [fmgr\_waf\_signature](fmgr_waf_signature_module#ansible-collections-fortinet-fortimanager-fmgr-waf-signature-module) – Hidden table for datasource. * [fmgr\_waf\_subclass](fmgr_waf_subclass_module#ansible-collections-fortinet-fortimanager-fmgr-waf-subclass-module) – Hidden table for datasource. * [fmgr\_wagprofile](fmgr_wagprofile_module#ansible-collections-fortinet-fortimanager-fmgr-wagprofile-module) – Configure wireless access gateway * [fmgr\_wanopt\_authgroup](fmgr_wanopt_authgroup_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-authgroup-module) – Configure WAN optimization authentication groups. * [fmgr\_wanopt\_peer](fmgr_wanopt_peer_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-peer-module) – Configure WAN optimization peers. * [fmgr\_wanopt\_profile](fmgr_wanopt_profile_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-module) – Configure WAN optimization profiles. * [fmgr\_wanopt\_profile\_cifs](fmgr_wanopt_profile_cifs_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-cifs-module) – Enable/disable CIFS * [fmgr\_wanopt\_profile\_ftp](fmgr_wanopt_profile_ftp_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-ftp-module) – Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features. * [fmgr\_wanopt\_profile\_http](fmgr_wanopt_profile_http_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-http-module) – Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features. * [fmgr\_wanopt\_profile\_mapi](fmgr_wanopt_profile_mapi_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-mapi-module) – Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features. * [fmgr\_wanopt\_profile\_tcp](fmgr_wanopt_profile_tcp_module#ansible-collections-fortinet-fortimanager-fmgr-wanopt-profile-tcp-module) – Enable/disable TCP WAN Optimization and configure TCP WAN Optimization features. * [fmgr\_wanprof\_system\_sdwan](fmgr_wanprof_system_sdwan_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-module) – Configure redundant internet connections using SD-WAN * [fmgr\_wanprof\_system\_sdwan\_duplication](fmgr_wanprof_system_sdwan_duplication_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-duplication-module) – Create SD-WAN duplication rule. * [fmgr\_wanprof\_system\_sdwan\_healthcheck](fmgr_wanprof_system_sdwan_healthcheck_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-healthcheck-module) – SD-WAN status checking or health checking. * [fmgr\_wanprof\_system\_sdwan\_healthcheck\_sla](fmgr_wanprof_system_sdwan_healthcheck_sla_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-healthcheck-sla-module) – Service level agreement * [fmgr\_wanprof\_system\_sdwan\_members](fmgr_wanprof_system_sdwan_members_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-members-module) – FortiGate interfaces added to the SD-WAN. * [fmgr\_wanprof\_system\_sdwan\_neighbor](fmgr_wanprof_system_sdwan_neighbor_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-neighbor-module) – Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status. * [fmgr\_wanprof\_system\_sdwan\_service](fmgr_wanprof_system_sdwan_service_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-service-module) – Create SD-WAN rules * [fmgr\_wanprof\_system\_sdwan\_service\_sla](fmgr_wanprof_system_sdwan_service_sla_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-service-sla-module) – Service level agreement * [fmgr\_wanprof\_system\_sdwan\_zone](fmgr_wanprof_system_sdwan_zone_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-sdwan-zone-module) – Configure SD-WAN zones. * [fmgr\_wanprof\_system\_virtualwanlink](fmgr_wanprof_system_virtualwanlink_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-module) – Configure redundant internet connections using SD-WAN * [fmgr\_wanprof\_system\_virtualwanlink\_healthcheck](fmgr_wanprof_system_virtualwanlink_healthcheck_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-healthcheck-module) – SD-WAN status checking or health checking. * [fmgr\_wanprof\_system\_virtualwanlink\_healthcheck\_sla](fmgr_wanprof_system_virtualwanlink_healthcheck_sla_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-healthcheck-sla-module) – Service level agreement * [fmgr\_wanprof\_system\_virtualwanlink\_members](fmgr_wanprof_system_virtualwanlink_members_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-members-module) – Physical FortiGate interfaces added to the virtual-wan-link. * [fmgr\_wanprof\_system\_virtualwanlink\_neighbor](fmgr_wanprof_system_virtualwanlink_neighbor_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-neighbor-module) – SD-WAN neighbor table. * [fmgr\_wanprof\_system\_virtualwanlink\_service](fmgr_wanprof_system_virtualwanlink_service_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-service-module) – Create SD-WAN rules or priority rules * [fmgr\_wanprof\_system\_virtualwanlink\_service\_sla](fmgr_wanprof_system_virtualwanlink_service_sla_module#ansible-collections-fortinet-fortimanager-fmgr-wanprof-system-virtualwanlink-service-sla-module) – Service level agreement * [fmgr\_webfilter\_categories](fmgr_webfilter_categories_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-categories-module) – no description * [fmgr\_webfilter\_content](fmgr_webfilter_content_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-content-module) – Configure Web filter banned word table. * [fmgr\_webfilter\_content\_entries](fmgr_webfilter_content_entries_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-content-entries-module) – Configure banned word entries. * [fmgr\_webfilter\_contentheader](fmgr_webfilter_contentheader_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-contentheader-module) – Configure content types used by Web filter. * [fmgr\_webfilter\_contentheader\_entries](fmgr_webfilter_contentheader_entries_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-contentheader-entries-module) – Configure content types used by web filter. * [fmgr\_webfilter\_ftgdlocalcat](fmgr_webfilter_ftgdlocalcat_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-ftgdlocalcat-module) – Configure FortiGuard Web Filter local categories. * [fmgr\_webfilter\_ftgdlocalrating](fmgr_webfilter_ftgdlocalrating_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-ftgdlocalrating-module) – Configure local FortiGuard Web Filter local ratings. * [fmgr\_webfilter\_profile](fmgr_webfilter_profile_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-module) – Configure Web filter profiles. * [fmgr\_webfilter\_profile\_antiphish](fmgr_webfilter_profile_antiphish_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-antiphish-module) – AntiPhishing profile. * [fmgr\_webfilter\_profile\_antiphish\_custompatterns](fmgr_webfilter_profile_antiphish_custompatterns_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-antiphish-custompatterns-module) – Custom username and password regex patterns. * [fmgr\_webfilter\_profile\_antiphish\_inspectionentries](fmgr_webfilter_profile_antiphish_inspectionentries_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-antiphish-inspectionentries-module) – AntiPhishing entries. * [fmgr\_webfilter\_profile\_filefilter](fmgr_webfilter_profile_filefilter_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-filefilter-module) – File filter. * [fmgr\_webfilter\_profile\_filefilter\_entries](fmgr_webfilter_profile_filefilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-filefilter-entries-module) – File filter entries. * [fmgr\_webfilter\_profile\_ftgdwf](fmgr_webfilter_profile_ftgdwf_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-ftgdwf-module) – FortiGuard Web Filter settings. * [fmgr\_webfilter\_profile\_ftgdwf\_filters](fmgr_webfilter_profile_ftgdwf_filters_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-ftgdwf-filters-module) – FortiGuard filters. * [fmgr\_webfilter\_profile\_ftgdwf\_quota](fmgr_webfilter_profile_ftgdwf_quota_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-ftgdwf-quota-module) – FortiGuard traffic quota settings. * [fmgr\_webfilter\_profile\_override](fmgr_webfilter_profile_override_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-override-module) – Web Filter override settings. * [fmgr\_webfilter\_profile\_urlextraction](fmgr_webfilter_profile_urlextraction_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-urlextraction-module) – Configure URL Extraction * [fmgr\_webfilter\_profile\_web](fmgr_webfilter_profile_web_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-web-module) – Web content filtering settings. * [fmgr\_webfilter\_profile\_youtubechannelfilter](fmgr_webfilter_profile_youtubechannelfilter_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-profile-youtubechannelfilter-module) – YouTube channel filter. * [fmgr\_webfilter\_urlfilter](fmgr_webfilter_urlfilter_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-urlfilter-module) – Configure URL filter lists. * [fmgr\_webfilter\_urlfilter\_entries](fmgr_webfilter_urlfilter_entries_module#ansible-collections-fortinet-fortimanager-fmgr-webfilter-urlfilter-entries-module) – URL filter entries. * [fmgr\_webproxy\_forwardserver](fmgr_webproxy_forwardserver_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-forwardserver-module) – Configure forward-server addresses. * [fmgr\_webproxy\_forwardservergroup](fmgr_webproxy_forwardservergroup_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-forwardservergroup-module) – Configure a forward server group consisting or multiple forward servers. * [fmgr\_webproxy\_forwardservergroup\_serverlist](fmgr_webproxy_forwardservergroup_serverlist_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-forwardservergroup-serverlist-module) – Add web forward servers to a list to form a server group. * [fmgr\_webproxy\_profile](fmgr_webproxy_profile_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-profile-module) – Configure web proxy profiles. * [fmgr\_webproxy\_profile\_headers](fmgr_webproxy_profile_headers_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-profile-headers-module) – Configure HTTP forwarded requests headers. * [fmgr\_webproxy\_wisp](fmgr_webproxy_wisp_module#ansible-collections-fortinet-fortimanager-fmgr-webproxy-wisp-module) – Configure Wireless Internet service provider * [fmgr\_widsprofile](fmgr_widsprofile_module#ansible-collections-fortinet-fortimanager-fmgr-widsprofile-module) – Configure wireless intrusion detection system * [fmgr\_wtpprofile](fmgr_wtpprofile_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-module) – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. * [fmgr\_wtpprofile\_denymaclist](fmgr_wtpprofile_denymaclist_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-denymaclist-module) – List of MAC addresses that are denied access to this WTP, FortiAP, or AP. * [fmgr\_wtpprofile\_lan](fmgr_wtpprofile_lan_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-lan-module) – WTP LAN port mapping. * [fmgr\_wtpprofile\_lbs](fmgr_wtpprofile_lbs_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-lbs-module) – Set various location based service * [fmgr\_wtpprofile\_platform](fmgr_wtpprofile_platform_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-platform-module) – WTP, FortiAP, or AP platform. * [fmgr\_wtpprofile\_radio1](fmgr_wtpprofile_radio1_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-radio1-module) – Configuration options for radio 1. * [fmgr\_wtpprofile\_radio2](fmgr_wtpprofile_radio2_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-radio2-module) – Configuration options for radio 2. * [fmgr\_wtpprofile\_radio3](fmgr_wtpprofile_radio3_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-radio3-module) – Configuration options for radio 3. * [fmgr\_wtpprofile\_radio4](fmgr_wtpprofile_radio4_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-radio4-module) – Configuration options for radio 4. * [fmgr\_wtpprofile\_splittunnelingacl](fmgr_wtpprofile_splittunnelingacl_module#ansible-collections-fortinet-fortimanager-fmgr-wtpprofile-splittunnelingacl-module) – Split tunneling ACL filter list. See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible fortinet.fortimanager.fmgr_waf_profile_constraint_linelength – HTTP line length in request. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_linelength – HTTP line length in request. =============================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_linelength`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_linelength dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 line length in request. fmgr_waf_profile_constraint_linelength: bypass_validation: False workspace_locking_adom: <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_linelength: 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_webfilter_urlfilter – Configure URL filter lists. fortinet.fortimanager.fmgr\_webfilter\_urlfilter – Configure URL filter 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_webfilter_urlfilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_urlfilter dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* exempt * block * allow * monitor * pass \| Action to take for URL filter matches. \| \| \| \| antiphish-action string \| Choices:* block * log \| Action to take for AntiPhishing matches. \| \| \| \| dns-address-family string \| Choices:* ipv4 * ipv6 * both \| Resolve IPv4 address, IPv6 address, or both from DNS server. \| \| \| \| exempt list / elements=string \| Choices:* av * web-content * activex-java-cookie * dlp * fortiguard * all * filepattern * pass * range-block * antiphish \| no description \| \| \| \| id integer \| \| Id. \| \| \| \| referrer-host string \| \| Referrer host name. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable this URL filter. \| \| \| \| type string \| Choices:* simple * regex * wildcard \| Filter type (simple, regex, or wildcard). \| \| \| \| url string \| \| URL to be filtered. \| \| \| \| web-proxy-profile string \| \| Web proxy profile. \| \| \| id integer \| \| ID. \| \| \| ip-addr-block string \| Choices:* disable * enable \| Enable/disable blocking URLs when the hostname appears as an IP address. \| \| \| name string \| \| Name of URL filter list. \| \| \| one-arm-ips-urlfilter string \| Choices:* disable * enable \| Enable/disable DNS resolver for one-arm IPS URL filter operation. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 filter lists. fmgr_webfilter_urlfilter: bypass_validation: False workspace_locking_adom: <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_urlfilter: comment: <value of string> entries: - action: <value in [exempt, block, allow, ...]> dns-address-family: <value in [ipv4, ipv6, both]> exempt: - av - web-content - activex-java-cookie - dlp - fortiguard - all - filepattern - pass - range-block - antiphish id: <value of integer> referrer-host: <value of string> status: <value in [disable, enable]> type: <value in [simple, regex, wildcard]> url: <value of string> web-proxy-profile: <value of string> antiphish-action: <value in [block, log]> id: <value of integer> ip-addr-block: <value in [disable, enable]> name: <value of string> one-arm-ips-urlfilter: <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_fortiguardwf – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_fortiguardwf – 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_fortiguardwf`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_fortiguardwf 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_fortiguardwf: bypass_validation: False workspace_locking_adom: <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_fortiguardwf: buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_emailfilter_profile_msnhotmail – MSN Hotmail. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_profile\_msnhotmail dictionary \| \| the top level parameters set \| \| \| log string \| Choices:* disable * enable \| Enable/disable logging. \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| 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: MSN Hotmail. fmgr_emailfilter_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> emailfilter_profile_msnhotmail: log: <value in [disable, enable]> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_firewall_identitybasedroute_rule – Rule. fortinet.fortimanager.fmgr\_firewall\_identitybasedroute\_rule – 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_firewall_identitybasedroute_rule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_identitybasedroute\_rule dictionary \| \| the top level parameters set \| \| \| device string \| \| Outgoing interface for the rule. \| \| \| gateway string \| \| IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0). \| \| \| groups string \| \| Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space. \| \| \| id integer \| \| Rule ID. \| \| identity-based-route string / required \| \| the parameter (identity-based-route) 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: Rule. fmgr_firewall_identitybasedroute_rule: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> identity-based-route: <your own value> state: <value in [present, absent]> firewall_identitybasedroute_rule: device: <value of string> gateway: <value of string> groups: <value of string> id: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_antivirus_profile_smtp – Configure SMTP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_smtp – Configure SMTP 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_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 \| \| antivirus\_profile\_smtp 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 SMTP AntiVirus options. fmgr_antivirus_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> antivirus_profile_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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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 – Configure virtual IP for IPv6. fortinet.fortimanager.fmgr\_firewall\_vip6 – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| arp-reply string \| Choices:* disable * enable \| Enable to respond to ARP requests for this virtual IP address. Enabled by default. \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| comment string \| \| Comment. \| \| \| 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 \| \| \| \| 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 \| \| \| extip string \| \| IP address or address range on the external interface that you want to map to an address or address range on the destination n... \| \| \| extport string \| \| Incoming port number range that you want to map to a port number range on the destination network. \| \| \| http-cookie-age integer \| \| Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit. \| \| \| http-cookie-domain string \| \| Domain that HTTP cookie persistence should apply to. \| \| \| http-cookie-domain-from-host string \| Choices:* disable * enable \| Enable/disable use of HTTP cookie domain from host field in HTTP. \| \| \| http-cookie-generation integer \| \| Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. \| \| \| http-cookie-path string \| \| Limit HTTP cookie persistence to the specified path. \| \| \| http-cookie-share string \| Choices:* disable * same-ip \| Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disa... \| \| \| http-ip-header string \| Choices:* disable * enable \| For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. \| \| \| http-ip-header-name string \| \| For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-F... \| \| \| http-multiplex string \| Choices:* disable * enable \| Enable/disable HTTP multiplexing. \| \| \| http-redirect string \| Choices:* disable * enable \| Enable/disable redirection of HTTP to HTTPS \| \| \| https-cookie-secure string \| Choices:* disable * enable \| Enable/disable verification that inserted HTTPS cookies are secure. \| \| \| id integer \| \| Custom defined ID. \| \| \| ldb-method string \| Choices:* static * round-robin * weighted * least-session * least-rtt * first-alive * http-host \| Method used to distribute sessions to real servers. \| \| \| mappedip string \| \| Mapped IP address range in the format startIP-endIP. \| \| \| mappedport string \| \| Port number range on the destination network to which the external port number range is mapped. \| \| \| max-embryonic-connections integer \| \| Maximum number of incomplete connections. \| \| \| monitor string \| \| Name of the health check monitor to use when polling to determine a virtual servers connectivity status. \| \| \| name string \| \| Virtual ip6 name. \| \| \| nat-source-vip string \| Choices:* disable * enable \| Enable to perform SNAT on traffic from mappedip to the extip for all egress interfaces. \| \| \| outlook-web-access string \| Choices:* disable * enable \| Enable to add the Front-End-Https header for Microsoft Outlook Web Access. \| \| \| persistence string \| Choices:* none * http-cookie * ssl-session-id \| Configure how to make sure that clients connect to the same server every time they make a request that is part of the same ses... \| \| \| portforward string \| Choices:* disable * enable \| Enable port forwarding. \| \| \| protocol string \| Choices:* tcp * udp * sctp \| Protocol to use when forwarding packets. \| \| \| realservers list / elements=string \| \| no description \| \| \| \| client-ip string \| \| Only clients in this IP range can connect to this real server. \| \| \| \| healthcheck string \| Choices:* disable * enable * vip \| Enable to check the responsiveness of the real server before forwarding traffic. \| \| \| \| holddown-interval integer \| \| Time in seconds that the health check monitor continues to monitor an unresponsive server that should be active. \| \| \| \| http-host string \| \| HTTP server domain name in HTTP header. \| \| \| \| id integer \| \| Real server ID. \| \| \| \| ip string \| \| IPv6 address of the real server. \| \| \| \| max-connections integer \| \| Max number of active connections that can directed to the real server. When reached, sessions are sent to other real s... \| \| \| \| 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. \| \| \| \| status string \| Choices:* active * standby * disable \| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is ... \| \| \| \| weight integer \| \| Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connect... \| \| \| server-type string \| Choices:* http * https * ssl * tcp * udp * ip * imaps * pop3s * smtps \| Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). \| \| \| src-filter string \| \| no description \| \| \| ssl-algorithm string \| Choices:* high * low * medium * custom \| Permitted encryption algorithms for SSL sessions according to encryption strength. \| \| \| ssl-certificate string \| \| The name of the SSL certificate to use for SSL acceleration. \| \| \| ssl-cipher-suites list / elements=string \| \| no description \| \| \| \| cipher string \| Choices:* TLS-RSA-WITH-RC4-128-MD5 * TLS-RSA-WITH-RC4-128-SHA * TLS-RSA-WITH-DES-CBC-SHA * TLS-RSA-WITH-3DES-EDE-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA * TLS-RSA-WITH-AES-256-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA256 * TLS-RSA-WITH-AES-256-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-RSA-WITH-SEED-CBC-SHA * TLS-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-RSA-WITH-DES-CBC-SHA * TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA * TLS-DHE-RSA-WITH-AES-256-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-DHE-RSA-WITH-AES-256-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-RSA-WITH-SEED-CBC-SHA * TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-RC4-128-SHA * TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA * TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-DHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-AES-128-CBC-SHA * TLS-DHE-DSS-WITH-AES-256-CBC-SHA * TLS-DHE-DSS-WITH-AES-128-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-128-GCM-SHA256 * TLS-DHE-DSS-WITH-AES-256-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384 * TLS-RSA-WITH-AES-128-GCM-SHA256 * TLS-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-DSS-WITH-SEED-CBC-SHA * TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA * TLS-DHE-DSS-WITH-DES-CBC-SHA * TLS-AES-128-GCM-SHA256 * TLS-AES-256-GCM-SHA384 * TLS-CHACHA20-POLY1305-SHA256 \| Cipher suite name. \| \| \| \| priority integer \| \| SSL/TLS cipher suites priority. \| \| \| \| versions list / elements=string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| \| ssl-client-fallback string \| Choices:* disable * enable \| Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). \| \| \| ssl-client-rekey-count integer \| \| Maximum length of data in MB before triggering a client rekey (0 = disable). \| \| \| ssl-client-renegotiation string \| Choices:* deny * allow * secure \| Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. \| \| \| ssl-client-session-state-max integer \| \| Maximum number of client to FortiGate SSL session states to keep. \| \| \| ssl-client-session-state-timeout integer \| \| Number of minutes to keep client to FortiGate SSL session state. \| \| \| ssl-client-session-state-type string \| Choices:* disable * time * count * both \| How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. \| \| \| ssl-dh-bits string \| Choices:* 768 * 1024 * 1536 * 2048 * 3072 * 4096 \| Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. \| \| \| ssl-hpkp string \| Choices:* disable * enable * report-only \| Enable/disable including HPKP header in response. \| \| \| ssl-hpkp-age integer \| \| Number of minutes the web browser should keep HPKP. \| \| \| ssl-hpkp-backup string \| \| Certificate to generate backup HPKP pin from. \| \| \| ssl-hpkp-include-subdomains string \| Choices:* disable * enable \| Indicate that HPKP header applies to all subdomains. \| \| \| ssl-hpkp-primary string \| \| Certificate to generate primary HPKP pin from. \| \| \| ssl-hpkp-report-uri string \| \| URL to report HPKP violations to. \| \| \| ssl-hsts string \| Choices:* disable * enable \| Enable/disable including HSTS header in response. \| \| \| ssl-hsts-age integer \| \| Number of seconds the client should honour the HSTS setting. \| \| \| ssl-hsts-include-subdomains string \| Choices:* disable * enable \| Indicate that HSTS header applies to all subdomains. \| \| \| ssl-http-location-conversion string \| Choices:* disable * enable \| Enable to replace HTTP with HTTPS in the replys Location HTTP header field. \| \| \| ssl-http-match-host string \| Choices:* disable * enable \| Enable/disable HTTP host matching for location conversion. \| \| \| ssl-max-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| Highest SSL/TLS version acceptable from a client. \| \| \| ssl-min-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| Lowest SSL/TLS version acceptable from a client. \| \| \| ssl-mode string \| Choices:* half * full \| Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to... \| \| \| ssl-pfs string \| Choices:* require * deny * allow \| Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. \| \| \| ssl-send-empty-frags string \| Choices:* disable * enable \| Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibi... \| \| \| ssl-server-algorithm string \| Choices:* high * low * medium * custom * client \| Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. \| \| \| ssl-server-cipher-suites list / elements=string \| \| no description \| \| \| \| cipher string \| Choices:* TLS-RSA-WITH-RC4-128-MD5 * TLS-RSA-WITH-RC4-128-SHA * TLS-RSA-WITH-DES-CBC-SHA * TLS-RSA-WITH-3DES-EDE-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA * TLS-RSA-WITH-AES-256-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA256 * TLS-RSA-WITH-AES-256-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-RSA-WITH-SEED-CBC-SHA * TLS-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-RSA-WITH-DES-CBC-SHA * TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA * TLS-DHE-RSA-WITH-AES-256-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-DHE-RSA-WITH-AES-256-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-RSA-WITH-SEED-CBC-SHA * TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-RC4-128-SHA * TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA * TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-DHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-AES-128-CBC-SHA * TLS-DHE-DSS-WITH-AES-256-CBC-SHA * TLS-DHE-DSS-WITH-AES-128-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-128-GCM-SHA256 * TLS-DHE-DSS-WITH-AES-256-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384 * TLS-RSA-WITH-AES-128-GCM-SHA256 * TLS-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-DSS-WITH-SEED-CBC-SHA * TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA * TLS-DHE-DSS-WITH-DES-CBC-SHA * TLS-AES-128-GCM-SHA256 * TLS-AES-256-GCM-SHA384 * TLS-CHACHA20-POLY1305-SHA256 \| Cipher suite name. \| \| \| \| priority integer \| \| SSL/TLS cipher suites priority. \| \| \| \| versions list / elements=string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| \| ssl-server-max-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * client * tls-1.3 \| Highest SSL/TLS version acceptable from a server. Use the client setting by default. \| \| \| ssl-server-min-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * client * tls-1.3 \| Lowest SSL/TLS version acceptable from a server. Use the client setting by default. \| \| \| ssl-server-session-state-max integer \| \| Maximum number of FortiGate to Server SSL session states to keep. \| \| \| ssl-server-session-state-timeout integer \| \| Number of minutes to keep FortiGate to Server SSL session state. \| \| \| ssl-server-session-state-type string \| Choices:* disable * time * count * both \| How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. \| \| \| type string \| Choices:* static-nat * server-load-balance \| Configure a static NAT VIP. \| \| \| uuid string \| \| Universally Unique Identifier (UUID; automatically assigned but can be manually reset). \| \| \| weblogic-server string \| Choices:* disable * enable \| Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. \| \| \| websphere-server string \| Choices:* disable * enable \| Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure virtual IP for IPv6. fmgr_firewall_vip6: bypass_validation: False workspace_locking_adom: <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_vip6: 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> 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]> 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> name: <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]> realservers: - client-ip: <value of string> healthcheck: <value in [disable, enable, vip]> holddown-interval: <value of integer> http-host: <value of string> 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, https, ssl, ...]> src-filter: <value of string> ssl-algorithm: <value in [high, low, medium, ...]> ssl-certificate: <value of string> ssl-cipher-suites: - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> priority: <value of integer> versions: - ssl-3.0 - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 ssl-client-fallback: <value in [disable, enable]> ssl-client-renegotiation: <value in [deny, allow, secure]> ssl-client-session-state-max: <value of integer> ssl-client-session-state-timeout: <value of integer> ssl-client-session-state-type: <value in [disable, time, count, ...]> ssl-dh-bits: <value in [768, 1024, 1536, ...]> ssl-hpkp: <value in [disable, enable, report-only]> ssl-hpkp-age: <value of integer> ssl-hpkp-backup: <value of string> ssl-hpkp-include-subdomains: <value in [disable, enable]> ssl-hpkp-primary: <value of string> ssl-hpkp-report-uri: <value of string> ssl-hsts: <value in [disable, enable]> ssl-hsts-age: <value of integer> ssl-hsts-include-subdomains: <value in [disable, enable]> ssl-http-location-conversion: <value in [disable, enable]> ssl-http-match-host: <value in [disable, enable]> ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-mode: <value in [half, full]> ssl-pfs: <value in [require, deny, allow]> ssl-send-empty-frags: <value in [disable, enable]> ssl-server-algorithm: <value in [high, low, medium, ...]> ssl-server-cipher-suites: - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> priority: <value of integer> versions: - ssl-3.0 - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-server-session-state-max: <value of integer> ssl-server-session-state-timeout: <value of integer> ssl-server-session-state-type: <value in [disable, time, count, ...]> type: <value in [static-nat, 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)	programming_docs
ansible fortinet.fortimanager.fmgr_dvmdb_workspace_commit_pkg – Commit change fortinet.fortimanager.fmgr\_dvmdb\_workspace\_commit\_pkg – 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_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: Commit change fmgr_dvmdb_workspace_commit_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_devprof_system_ntp_ntpserver – Configure the FortiGate to connect to any available third-party NTP server. fortinet.fortimanager.fmgr\_devprof\_system\_ntp\_ntpserver – Configure the FortiGate to connect to any available third-party NTP server. ========================================================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_ntp\_ntpserver dictionary \| \| the top level parameters set \| \| \| authentication string \| Choices:* disable * enable \| Enable/disable MD5 authentication. \| \| \| id integer \| \| NTP server ID. \| \| \| interface string \| \| Specify outgoing interface to reach server. \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| Specify how to select outgoing interface to reach server. \| \| \| key string \| \| no description \| \| \| key-id integer \| \| Key ID for authentication. \| \| \| ntpv3 string \| Choices:* disable * enable \| Enable to use NTPv3 instead of NTPv4. \| \| \| server string \| \| IP address or hostname of the NTP Server. \| \| 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 the FortiGate to connect to any available third-party NTP server. fmgr_devprof_system_ntp_ntpserver: bypass_validation: False workspace_locking_adom: <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_ntp_ntpserver: authentication: <value in [disable, enable]> id: <value of integer> key: <value of string> key-id: <value of integer> ntpv3: <value in [disable, enable]> server: <value of string> interface: <value of string> interface-select-method: <value in [auto, sdwan, specify]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mheader – Configure AntiSpam MIME header. fortinet.fortimanager.fmgr\_spamfilter\_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_spamfilter_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 \| \| 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\_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. \| \| 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_spamfilter_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]> spamfilter_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_switchcontroller_lldpprofile_medlocationservice – Configuration method to edit Media Endpoint Discovery fortinet.fortimanager.fmgr\_switchcontroller\_lldpprofile\_medlocationservice – 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_medlocationservice`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_medlocationservice dictionary \| \| the top level parameters set \| \| \| name string \| \| Location service type name. \| \| \| status string \| Choices:* disable * enable \| Enable or disable this TLV. \| \| \| sys-location-id string \| \| Location service 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: Configuration method to edit Media Endpoint Discovery fmgr_switchcontroller_lldpprofile_medlocationservice: bypass_validation: False workspace_locking_adom: <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_medlocationservice: name: <value of string> status: <value in [disable, enable]> sys-location-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_webfilter_urlfilter_entries – URL filter entries. fortinet.fortimanager.fmgr\_webfilter\_urlfilter\_entries – URL 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_webfilter_urlfilter_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 \| \| urlfilter string / required \| \| the parameter (urlfilter) in requested url \| \| webfilter\_urlfilter\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* exempt * block * allow * monitor * pass \| Action to take for URL filter matches. \| \| \| antiphish-action string \| Choices:* block * log \| Action to take for AntiPhishing matches. \| \| \| dns-address-family string \| Choices:* ipv4 * ipv6 * both \| Resolve IPv4 address, IPv6 address, or both from DNS server. \| \| \| exempt list / elements=string \| Choices:* av * web-content * activex-java-cookie * dlp * fortiguard * all * filepattern * pass * range-block * antiphish \| no description \| \| \| id integer \| \| Id. \| \| \| referrer-host string \| \| Referrer host name. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this URL filter. \| \| \| type string \| Choices:* simple * regex * wildcard \| Filter type (simple, regex, or wildcard). \| \| \| url string \| \| URL to be filtered. \| \| \| web-proxy-profile string \| \| Web proxy profile. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 filter entries. fmgr_webfilter_urlfilter_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> urlfilter: <your own value> state: <value in [present, absent]> webfilter_urlfilter_entries: action: <value in [exempt, block, allow, ...]> dns-address-family: <value in [ipv4, ipv6, both]> exempt: - av - web-content - activex-java-cookie - dlp - fortiguard - all - filepattern - pass - range-block - antiphish id: <value of integer> referrer-host: <value of string> status: <value in [disable, enable]> type: <value in [simple, regex, wildcard]> url: <value of string> web-proxy-profile: <value of string> antiphish-action: <value in [block, log]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_adom – no description fortinet.fortimanager.fmgr\_dvmdb\_metafields\_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_dvmdb_metafields_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\_metafields\_adom 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_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, ...] dvmdb_metafields_adom: 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_user_securityexemptlist_rule – Configure rules for exempting users from captive portal authentication. fortinet.fortimanager.fmgr\_user\_securityexemptlist\_rule – Configure rules for exempting users from captive portal 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_user_securityexemptlist_rule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| security-exempt-list string / required \| \| the parameter (security-exempt-list) in requested url \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| user\_securityexemptlist\_rule dictionary \| \| the top level parameters set \| \| \| devices string \| \| Devices or device groups. \| \| \| dstaddr string \| \| Destination addresses or address groups. \| \| \| id integer \| \| ID. \| \| \| service string \| \| Destination services. \| \| \| srcaddr string \| \| Source addresses or address groups. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure rules for exempting users from captive portal authentication. fmgr_user_securityexemptlist_rule: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> security-exempt-list: <your own value> state: <value in [present, absent]> user_securityexemptlist_rule: devices: <value of string> dstaddr: <value of string> id: <value of integer> service: <value of string> srcaddr: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_neighbor – SD-WAN neighbor table. fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink\_neighbor – SD-WAN neighbor 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_wanprof_system_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 \| \| 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\_neighbor dictionary \| \| the top level parameters set \| \| \| health-check string \| \| SD-WAN health-check name. \| \| \| ip string \| \| IP 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: SD-WAN neighbor table. fmgr_wanprof_system_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> wanprof: <your own value> state: <value in [present, absent]> wanprof_system_virtualwanlink_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)	programming_docs
ansible fortinet.fortimanager.fmgr_system_admin_profile – Admin profile. fortinet.fortimanager.fmgr\_system\_admin\_profile – Admin 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_system_admin_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_profile dictionary \| \| the top level parameters set \| \| \| adom-lock string \| Choices:* none ← * read * read-write \| ADOM locking none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| adom-policy-packages string \| Choices:* none ← * read * read-write \| ADOM policy packages. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| adom-switch string \| Choices:* none ← * read * read-write \| Administrator domain. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| allow-to-install string \| Choices:* disable * enable ← \| Enable/disable the restricted user to install objects to the devices. disable - Disable setting. enable - Enable setting. \| \| \| app-filter string \| Choices:* disable ← * enable \| App filter. disable - Disable setting. enable - Enable setting. \| \| \| assignment string \| Choices:* none ← * read * read-write \| Assignment permission. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| change-password string \| Choices:* disable ← * enable \| Enable/disable restricted user to change self password. disable - Disable setting. enable - Enable setting. \| \| \| config-retrieve string \| Choices:* none ← * read * read-write \| Configuration retrieve. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| config-revert string \| Choices:* none ← * read * read-write \| Revert Configuration from Revision History none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| consistency-check string \| Choices:* none ← * read * read-write \| Consistency check. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| datamask string \| Choices:* disable ← * enable \| Enable/disable data masking. disable - Disable data masking. enable - Enable data masking. \| \| \| datamask-custom-fields list / elements=string \| \| no description \| \| \| \| field-category list / elements=string \| Choices:* log * fortiview * alert * ueba * all \| no description \| \| \| \| field-name string \| \| Field name. \| \| \| \| field-status string \| Choices:* disable * enable ← \| Field status. disable - Disable field. enable - Enable field. \| \| \| \| field-type string \| Choices:* string ← * ip * mac * email * unknown \| Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. \| \| \| datamask-custom-priority string \| Choices:* disable ← * enable \| Prioritize custom fields. disable - Disable custom field search priority. enable - Enable custom field search priority. \| \| \| datamask-fields list / elements=string \| Choices:* user * srcip * srcname * srcmac * dstip * dstname * email * message * domain \| no description \| \| \| datamask-key string \| \| no description \| \| \| datamask-unmasked-time integer \| Default:0 \| Time in days without data masking. \| \| \| deploy-management string \| Choices:* none ← * read * read-write \| Install to devices. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| description string \| \| Description. \| \| \| device-ap string \| Choices:* none ← * read * read-write \| Manage AP. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-config string \| Choices:* none ← * read * read-write \| Manage device configurations. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-forticlient string \| Choices:* none ← * read * read-write \| Manage FortiClient. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-fortiswitch string \| Choices:* none ← * read * read-write \| Manage FortiSwitch. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-manager string \| Choices:* none ← * read * read-write \| Device manager. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-op string \| Choices:* none ← * read * read-write \| Device add/delete/edit. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-policy-package-lock string \| Choices:* none ← * read * read-write \| Device/Policy Package locking none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-profile string \| Choices:* none ← * read * read-write \| Device profile permission. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-revision-deletion string \| Choices:* none ← * read * read-write \| Delete device revision. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| device-wan-link-load-balance string \| Choices:* none ← * read * read-write \| Manage WAN link load balance. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| event-management string \| Choices:* none ← * read * read-write \| Event management. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| extension-access string \| Choices:* none ← * read * read-write \| Manage extension access. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| fabric-viewer string \| Choices:* none ← * read * read-write \| Fabric viewer. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| fgd-center-advanced string \| Choices:* none ← * read * read-write \| FortiGuard Center Advanced. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| fgd-center-fmw-mgmt string \| Choices:* none ← * read * read-write \| FortiGuard Center Firmware Management. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| fgd-center-licensing string \| Choices:* none ← * read * read-write \| FortiGuard Center Licensing. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| fgd\_center string \| Choices:* none ← * read * read-write \| FortiGuard Center. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| global-policy-packages string \| Choices:* none ← * read * read-write \| Global policy packages. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| import-policy-packages string \| Choices:* none ← * read * read-write \| Import Policy Package. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| intf-mapping string \| Choices:* none ← * read * read-write \| Interface Mapping none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| ips-filter string \| Choices:* disable ← * enable \| IPS filter. disable - Disable setting. enable - Enable setting. \| \| \| log-viewer string \| Choices:* none ← * read * read-write \| Log viewer. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| policy-objects string \| Choices:* none ← * read * read-write \| Policy objects permission. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| profileid string \| \| Profile ID. \| \| \| read-passwd string \| Choices:* none ← * read * read-write \| View password in clear text. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| realtime-monitor string \| Choices:* none ← * read * read-write \| Realtime monitor. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| report-viewer string \| Choices:* none ← * read * read-write \| Report viewer. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| run-report string \| Choices:* none ← * read * read-write \| Run reports. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| scope string \| Choices:* global ← * adom \| Scope. global - Global scope. adom - ADOM scope. \| \| \| script-access string \| Choices:* none ← * read * read-write \| Script access. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| set-install-targets string \| Choices:* none ← * read * read-write \| Edit installation targets. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| super-user-profile string \| Choices:* disable ← * enable \| Enable/disable super user profile disable - Disable super user profile enable - Enable super user profile \| \| \| system-setting string \| Choices:* none ← * read * read-write \| System setting. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| term-access string \| Choices:* none ← * read * read-write \| Terminal access. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| triage-events string \| Choices:* none ← * read * read-write \| Triage events. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| type string \| Choices:* system ← * restricted \| profile type. system - System admin. restricted - Restricted admin. \| \| \| update-incidents string \| Choices:* none ← * read * read-write \| Create/update incidents. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| vpn-manager string \| Choices:* none ← * read * read-write \| VPN manager. none - No permission. read - Read permission. read-write - Read-write permission. \| \| \| web-filter string \| Choices:* disable ← * enable \| Web filter. 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: Admin profile. fmgr_system_admin_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, ...] state: <value in [present, absent]> system_admin_profile: adom-lock: <value in [none, read, read-write]> adom-policy-packages: <value in [none, read, read-write]> adom-switch: <value in [none, read, read-write]> app-filter: <value in [disable, enable]> assignment: <value in [none, read, read-write]> change-password: <value in [disable, enable]> config-retrieve: <value in [none, read, read-write]> config-revert: <value in [none, read, read-write]> consistency-check: <value in [none, read, read-write]> datamask: <value in [disable, enable]> datamask-custom-fields: - field-category: - log - fortiview - alert - ueba - all field-name: <value of string> field-status: <value in [disable, enable]> field-type: <value in [string, ip, mac, ...]> datamask-custom-priority: <value in [disable, enable]> datamask-fields: - user - srcip - srcname - srcmac - dstip - dstname - email - message - domain datamask-key: <value of string> deploy-management: <value in [none, read, read-write]> description: <value of string> device-ap: <value in [none, read, read-write]> device-config: <value in [none, read, read-write]> device-forticlient: <value in [none, read, read-write]> device-fortiswitch: <value in [none, read, read-write]> device-manager: <value in [none, read, read-write]> device-op: <value in [none, read, read-write]> device-policy-package-lock: <value in [none, read, read-write]> device-profile: <value in [none, read, read-write]> device-revision-deletion: <value in [none, read, read-write]> device-wan-link-load-balance: <value in [none, read, read-write]> event-management: <value in [none, read, read-write]> fgd-center-advanced: <value in [none, read, read-write]> fgd-center-fmw-mgmt: <value in [none, read, read-write]> fgd-center-licensing: <value in [none, read, read-write]> fgd_center: <value in [none, read, read-write]> global-policy-packages: <value in [none, read, read-write]> import-policy-packages: <value in [none, read, read-write]> intf-mapping: <value in [none, read, read-write]> ips-filter: <value in [disable, enable]> log-viewer: <value in [none, read, read-write]> policy-objects: <value in [none, read, read-write]> profileid: <value of string> read-passwd: <value in [none, read, read-write]> realtime-monitor: <value in [none, read, read-write]> report-viewer: <value in [none, read, read-write]> scope: <value in [global, adom]> set-install-targets: <value in [none, read, read-write]> system-setting: <value in [none, read, read-write]> term-access: <value in [none, read, read-write]> type: <value in [system, restricted]> vpn-manager: <value in [none, read, read-write]> web-filter: <value in [disable, enable]> datamask-unmasked-time: <value of integer> super-user-profile: <value in [disable, enable]> allow-to-install: <value in [disable, enable]> extension-access: <value in [none, read, read-write]> fabric-viewer: <value in [none, read, read-write]> run-report: <value in [none, read, read-write]> script-access: <value in [none, read, read-write]> triage-events: <value in [none, read, read-write]> update-incidents: <value in [none, read, read-write]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_summaryaddr – no description fortinet.fortimanager.fmgr\_vpnmgr\_node\_summaryaddr – 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_summaryaddr`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_summaryaddr dictionary \| \| the top level parameters set \| \| \| addr string \| \| no description \| \| \| priority integer \| \| 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_summaryaddr: bypass_validation: False workspace_locking_adom: <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_summaryaddr: addr: <value of string> priority: <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)	programming_docs
ansible fortinet.fortimanager.fmgr_webfilter_ftgdlocalcat – Configure FortiGuard Web Filter local categories. fortinet.fortimanager.fmgr\_webfilter\_ftgdlocalcat – Configure FortiGuard Web Filter local 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_webfilter_ftgdlocalcat`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ftgdlocalcat dictionary \| \| the top level parameters set \| \| \| desc string \| \| Local category description. \| \| \| id integer \| \| Local category ID. \| \| \| status string \| Choices:* disable * enable \| Enable/disable the local category. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 Web Filter local categories. fmgr_webfilter_ftgdlocalcat: bypass_validation: False workspace_locking_adom: <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_ftgdlocalcat: desc: <value of string> id: <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_fsp_vlan_dynamicmapping_interface_ipv6_ip6prefixlist – Advertised prefix list. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_ip6prefixlist – Advertised 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_dynamicmapping_interface_ipv6_ip6prefixlist`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_ip6prefixlist dictionary \| \| the top level parameters set \| \| \| 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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 prefix list. fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6prefixlist: bypass_validation: False workspace_locking_adom: <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_ipv6_ip6prefixlist: 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_diskquota – Configure disk space available for use by the Upgrade Manager. fortinet.fortimanager.fmgr\_fmupdate\_diskquota – Configure disk space available for use by the Upgrade 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_fmupdate_diskquota`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_diskquota dictionary \| \| the top level parameters set \| \| \| value integer \| Default:51200 \| Configure the size of the Upgrade Manager disk quota, in megabytes. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 disk space available for use by the Upgrade Manager. fmgr_fmupdate_diskquota: bypass_validation: 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_diskquota: 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_devprof_system_replacemsg_nntp – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_nntp – 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_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 \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_replacemsg\_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. \| \| 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_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> devprof: <your own value> devprof_system_replacemsg_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_system_sdnconnector_externalip – Configure GCP external IP. fortinet.fortimanager.fmgr\_system\_sdnconnector\_externalip – Configure GCP external IP. ========================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_externalip`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_externalip dictionary \| \| the top level parameters set \| \| \| name string \| \| External IP 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 GCP external IP. fmgr_system_sdnconnector_externalip: bypass_validation: False workspace_locking_adom: <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_externalip: 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_replacemsggroup_http – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_http – 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_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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_cifs_profile_serverkeytab – Server keytab. fortinet.fortimanager.fmgr\_cifs\_profile\_serverkeytab – Server keytab. ======================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_cifs_profile_serverkeytab`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| cifs\_profile\_serverkeytab dictionary \| \| the top level parameters set \| \| \| keytab string \| \| Base64 encoded keytab file containing credential of the server. \| \| \| password string \| \| no description \| \| \| principal string \| \| Service principal. For example, "host/[email protected]". \| \| 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: Server keytab. fmgr_cifs_profile_serverkeytab: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> profile: <your own value> state: <value in [present, absent]> cifs_profile_serverkeytab: keytab: <value of string> principal: <value of string> password: <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_interfacepolicy6 – Configure IPv6 interface policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_interfacepolicy6 – Configure IPv6 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_interfacepolicy6`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_interfacepolicy6 dictionary \| \| the top level parameters set \| \| \| address-type string \| Choices:* ipv4 * ipv6 \| no description \| \| \| application-list string \| \| Application list name. \| \| \| application-list-status string \| Choices:* disable * enable \| Enable/disable application control. \| \| \| av-profile string \| \| Antivirus profile. \| \| \| av-profile-status string \| Choices:* disable * enable \| Enable/disable antivirus. \| \| \| comments string \| \| Comments. \| \| \| dlp-sensor string \| \| DLP sensor name. \| \| \| dlp-sensor-status string \| Choices:* disable * enable \| Enable/disable DLP. \| \| \| dsri string \| Choices:* disable * enable \| Enable/disable DSRI. \| \| \| dstaddr6 string \| \| IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range. \| \| \| emailfilter-profile string \| \| Email filter profile. \| \| \| emailfilter-profile-status string \| Choices:* disable * enable \| Enable/disable email filter. \| \| \| interface string \| \| Monitored interface name from available interfaces. \| \| \| ips-sensor string \| \| IPS sensor name. \| \| \| ips-sensor-status string \| Choices:* disable * enable \| Enable/disable IPS. \| \| \| label string \| \| Label. \| \| \| logtraffic string \| Choices:* disable * all * utm \| Logging type to be used in this policy (Options: all \| utm \| disable, Default: utm). \| \| \| policyid integer \| \| Policy ID. \| \| \| scan-botnet-connections string \| Choices:* disable * block * monitor \| Enable/disable scanning for connections to Botnet servers. \| \| \| service6 string \| \| Service name. \| \| \| spamfilter-profile string \| \| Antispam profile. \| \| \| spamfilter-profile-status string \| Choices:* disable * enable \| Enable/disable antispam. \| \| \| srcaddr6 string \| \| IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this policy. \| \| \| webfilter-profile string \| \| Web filter profile. \| \| \| webfilter-profile-status string \| Choices:* disable * enable \| Enable/disable web filtering. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 interface policies. fmgr_pkg_firewall_interfacepolicy6: bypass_validation: False workspace_locking_adom: <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_interfacepolicy6: address-type: <value in [ipv4, ipv6]> application-list: <value of string> application-list-status: <value in [disable, enable]> av-profile: <value of string> av-profile-status: <value in [disable, enable]> comments: <value of string> dlp-sensor: <value of string> dlp-sensor-status: <value in [disable, enable]> dsri: <value in [disable, enable]> dstaddr6: <value of string> interface: <value of string> ips-sensor: <value of string> ips-sensor-status: <value in [disable, enable]> label: <value of string> logtraffic: <value in [disable, all, utm]> policyid: <value of integer> scan-botnet-connections: <value in [disable, block, monitor]> service6: <value of string> spamfilter-profile: <value of string> spamfilter-profile-status: <value in [disable, enable]> srcaddr6: <value of string> status: <value in [disable, enable]> webfilter-profile: <value of string> webfilter-profile-status: <value in [disable, enable]> emailfilter-profile: <value of string> emailfilter-profile-status: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_nntp – Configure NNTP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_nntp – Configure NNTP 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_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 \| \| firewall\_profileprotocoloptions\_nntp 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 * no-content-summary * splice \| no description \| \| \| oversize-limit integer \| \| Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). \| \| \| ports integer \| \| no description \| \| \| proxy-after-tcp-handshake string \| Choices:* disable * enable \| Proxy traffic after the TCP 3-way handshake has been established (not before). \| \| \| scan-bzip2 string \| Choices:* disable * enable \| Enable/disable scanning of BZip2 compressed files. \| \| \| status string \| Choices:* disable * enable \| Enable/disable the active status of scanning for this protocol. \| \| \| uncompressed-nest-limit integer \| \| Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). \| \| \| uncompressed-oversize-limit integer \| \| Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). \| \| 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 NNTP protocol options. fmgr_firewall_profileprotocoloptions_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-protocol-options: <your own value> firewall_profileprotocoloptions_nntp: inspect-all: <value in [disable, enable]> options: - oversize - no-content-summary - splice oversize-limit: <value of integer> ports: <value of integer> scan-bzip2: <value in [disable, enable]> status: <value in [disable, enable]> uncompressed-nest-limit: <value of integer> uncompressed-oversize-limit: <value of integer> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_firewall_gtp_ippolicy – IP policy. fortinet.fortimanager.fmgr\_firewall\_gtp\_ippolicy – 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_ippolicy`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ippolicy dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* allow * deny \| Action. \| \| \| dstaddr string \| \| Destination address name. \| \| \| dstaddr6 string \| \| Destination IPv6 address name. \| \| \| id integer \| \| ID. \| \| \| srcaddr string \| \| Source address name. \| \| \| srcaddr6 string \| \| Source IPv6 address name. \| \| gtp string / required \| \| the parameter (gtp) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: IP policy. fmgr_firewall_gtp_ippolicy: bypass_validation: False workspace_locking_adom: <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_ippolicy: action: <value in [allow, deny]> dstaddr: <value of string> id: <value of integer> srcaddr: <value of string> dstaddr6: <value of string> srcaddr6: <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_add_device – Add a device to the Device Manager database. fortinet.fortimanager.fmgr\_dvm\_cmd\_add\_device – Add a device to the Device Manager 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_dvm_cmd_add_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\_add\_device dictionary \| \| the top level parameters set \| \| \| adom string \| \| Name or ID of the ADOM where the command is to be executed on. \| \| \| device dictionary \| \| no description \| \| \| \| adm\_pass string \| \| no description \| \| \| \| adm\_usr string \| \| <i>add real and promote device</i>. \| \| \| \| desc string \| \| <i>available for all operations</i>. \| \| \| \| device action string \| \| Specify add device operations, or leave blank to add real device: "add\_model" - add a model device. "promote\_unreg" - promote an unregistered device to be managed by FortiManager using information from database. \| \| \| \| faz.quota integer \| \| <i>available for all operations</i>. \| \| \| \| ip string \| \| <i>add real device only</i>. Add device will probe with this IP using the log in credential specified. \| \| \| \| meta fields dictionary \| \| no description \| \| \| \| mgmt\_mode string \| Choices:* unreg * fmg * faz * fmgfaz \| <i>add real and model device</i>. \| \| \| \| mr integer \| \| <i>add model device only</i>. \| \| \| \| name string \| \| <i>required for all operations</i>. Unique name for the device. \| \| \| \| os\_type string \| Choices:* unknown * fos * fsw * foc * fml * faz * fwb * fch * fct * log * fmg * fsa * fdd * fac * fpx * fna \| <i>add model device only</i>. \| \| \| \| os\_ver string \| Choices:* unknown * 0.0 * 1.0 * 2.0 * 3.0 * 4.0 * 5.0 * 6.0 \| os version \| \| \| \| patch integer \| \| <i>add model device only</i>. \| \| \| \| platform\_str string \| \| <i>add model device only</i>. Required for determine the platform for VM platforms. \| \| \| \| sn string \| \| <i>add model device only</i>. This attribute will be used to determine the device platform, except for VM platforms, w... \| \| \| flags list / elements=string \| Choices:* none * create\_task * nonblocking * log\_dev \| no description \| \| \| groups 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: Add a device to the Device Manager database. fmgr_dvm_cmd_add_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_add_device: adom: <value of string> device: adm_pass: <value of string> adm_usr: <value of string> desc: <value of string> device action: <value of string> faz.quota: <value of integer> ip: <value of string> meta fields: <value of dict> mgmt_mode: <value in [unreg, fmg, faz, ...]> mr: <value of integer> name: <value of string> os_type: <value in [unknown, fos, fsw, ...]> os_ver: <value in [unknown, 0.0, 1.0, ...]> patch: <value of integer> platform_str: <value of string> sn: <value of string> flags: - none - create_task - nonblocking - log_dev groups: - 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_fmupdate_fdssetting_pushoverridetoclient – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for… fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_pushoverridetoclient – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for… ================================================================================================================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_fmupdate_fdssetting_pushoverridetoclient`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_pushoverridetoclient dictionary \| \| the top level parameters set \| \| \| announce-ip list / elements=string \| \| no description \| \| \| \| id integer \| Default:0 \| ID of the announce IP address (1 - 10). \| \| \| \| ip string \| Default:"0.0.0.0" \| Announce IPv4 address. \| \| \| \| port integer \| Default:8890 \| Announce IP port (1 - 65535, default = 8890). \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable push updates (default = disable). disable - Disable setting. enable - Enable setting. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for... fmgr_fmupdate_fdssetting_pushoverridetoclient: bypass_validation: 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_pushoverridetoclient: announce-ip: - id: <value of integer> ip: <value of string> port: <value of integer> status: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_system_externalresource – Configure external resource. fortinet.fortimanager.fmgr\_system\_externalresource – Configure external resource. =================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_externalresource`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_externalresource dictionary \| \| the top level parameters set \| \| \| category integer \| \| User resource category. \| \| \| comments string \| \| Comment. \| \| \| 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 \| \| External resource name. \| \| \| password string \| \| no description \| \| \| refresh-rate integer \| \| Time interval to refresh external resource (1 - 43200 min, default = 5 min). \| \| \| resource string \| \| URI of external resource. \| \| \| source-ip string \| \| Source IPv4 address used to communicate with server. \| \| \| status string \| Choices:* disable * enable \| Enable/disable user resource. \| \| \| type string \| Choices:* category * address * domain * malware \| User resource type. \| \| \| user-agent string \| \| Override HTTP User-Agent header used when retrieving this external resource. \| \| \| username string \| \| HTTP basic authentication user name. \| \| \| uuid string \| \| Universally Unique Identifier (UUID; automatically assigned but can be manually reset). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 external resource. fmgr_system_externalresource: bypass_validation: False workspace_locking_adom: <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_externalresource: category: <value of integer> comments: <value of string> name: <value of string> refresh-rate: <value of integer> resource: <value of string> status: <value in [disable, enable]> type: <value in [category, address, domain, ...]> password: <value of string> source-ip: <value of string> username: <value of string> interface: <value of string> interface-select-method: <value in [auto, sdwan, specify]> user-agent: <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_dvmdb_workflow_approve – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_approve – 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_approve`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dvmdb\_workflow\_approve dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| session\_id string / required \| \| the parameter (session\_id) in requested url \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: no description fmgr_dvmdb_workflow_approve: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> session_id: <your own value> dvmdb_workflow_approve: desc: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6_sectionvalue – Configure IPv6 interface policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_interfacepolicy6\_sectionvalue – Configure IPv6 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_interfacepolicy6_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-policy6 string / required \| \| the parameter (interface-policy6) in requested url \| \| pkg string / required \| \| the parameter (pkg) in requested url \| \| pkg\_firewall\_interfacepolicy6\_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 IPv6 interface policies. fmgr_pkg_firewall_interfacepolicy6_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-policy6: <your own value> state: <value in [present, absent]> pkg_firewall_interfacepolicy6_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_system_locallog_syslogd_filter – Filter for syslog logging. fortinet.fortimanager.fmgr\_system\_locallog\_syslogd\_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_syslogd_filter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_syslogd\_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_syslogd_filter: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] system_locallog_syslogd_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_system_log_settings_rollinganalyzer – Log rolling policy for Network Analyzer logs. fortinet.fortimanager.fmgr\_system\_log\_settings\_rollinganalyzer – Log rolling policy for Network Analyzer logs. ================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_settings_rollinganalyzer`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_settings\_rollinganalyzer dictionary \| \| the top level parameters set \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| password string \| \| no description \| \| \| password2 string \| \| no description \| \| \| password3 string \| \| no description \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| username string \| \| Upload server login username. \| \| \| username2 string \| \| Upload server login username2. \| \| \| username3 string \| \| Upload server login username3. \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 rolling policy for Network Analyzer logs. fmgr_system_log_settings_rollinganalyzer: bypass_validation: 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_settings_rollinganalyzer: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <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_admin_user_dashboard – Custom dashboard widgets. fortinet.fortimanager.fmgr\_system\_admin\_user\_dashboard – Custom dashboard widgets. ====================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_dashboard`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_dashboard dictionary \| \| the top level parameters set \| \| \| column integer \| Default:0 \| Widgets column ID. \| \| \| diskio-content-type string \| Choices:* util ← * iops * blks \| Disk I/O Monitor widgets chart type. util - bandwidth utilization. iops - the number of I/O requests. blks - the amount of data of I/O requests. \| \| \| diskio-period string \| Choices:* 1hour ← * 8hour * 24hour \| Disk I/O Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. \| \| \| log-rate-period string \| Choices:* 2min * 1hour * 6hours \| Log receive monitor widgets data period. 2min - 2 minutes. 1hour - 1 hour. 6hours - 6 hours. \| \| \| log-rate-topn string \| Choices:* 1 * 2 * 3 * 4 * 5 ← \| Log receive monitor widgets number of top items to display. 1 - Top 1. 2 - Top 2. 3 - Top 3. 4 - Top 4. 5 - Top 5. \| \| \| log-rate-type string \| Choices:* log * device ← \| Log receive monitor widgets statistics breakdown options. log - Show log rates for each log type. device - Show log rates for each device. \| \| \| moduleid integer \| Default:0 \| Widget ID. \| \| \| name string \| \| Widget name. \| \| \| num-entries integer \| Default:10 \| Number of entries. \| \| \| refresh-interval integer \| Default:300 \| Widgets refresh interval. \| \| \| res-cpu-display string \| Choices:* average ← * each \| Widgets CPU display type. average - Average usage of CPU. each - Each usage of CPU. \| \| \| res-period string \| Choices:* 10min * hour * day \| Widgets data period. 10min - Last 10 minutes. hour - Last hour. day - Last day. \| \| \| res-view-type string \| Choices:* real-time * history \| Widgets data view type. real-time - Real-time view. history - History view. \| \| \| status string \| Choices:* close * open ← \| Widgets opened/closed state. close - Widget closed. open - Widget opened. \| \| \| tabid integer \| Default:0 \| ID of tab where widget is displayed. \| \| \| time-period string \| Choices:* 1hour ← * 8hour * 24hour \| Log Database Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. \| \| \| widget-type string \| Choices:* top-lograte * sysres * sysinfo * licinfo * jsconsole * sysop * alert * statistics * rpteng * raid * logrecv * devsummary * logdb-perf * logdb-lag * disk-io * log-rcvd-fwd \| Widget type. top-lograte - Log Receive Monitor. sysres - System resources. sysinfo - System Information. licinfo - License Information. jsconsole - CLI Console. sysop - Unit Operation. alert - Alert Message Console. statistics - Statistics. rpteng - Report Engine. raid - Disk Monitor. logrecv - Logs/Data Received. devsummary - Device Summary. logdb-perf - Log Database Performance Monitor. logdb-lag - Log Database Lag Time. disk-io - Disk I/O. log-rcvd-fwd - Log receive and forwarding Monitor. \| \| 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 widgets. fmgr_system_admin_user_dashboard: bypass_validation: 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_dashboard: column: <value of integer> diskio-content-type: <value in [util, iops, blks]> diskio-period: <value in [1hour, 8hour, 24hour]> log-rate-period: <value in [2min, 1hour, 6hours]> log-rate-topn: <value in [1, 2, 3, ...]> log-rate-type: <value in [log, device]> moduleid: <value of integer> name: <value of string> num-entries: <value of integer> refresh-interval: <value of integer> res-cpu-display: <value in [average, each]> res-period: <value in [10min, hour, day]> res-view-type: <value in [real-time, history]> status: <value in [close, open]> tabid: <value of integer> time-period: <value in [1hour, 8hour, 24hour]> widget-type: <value in [top-lograte, sysres, sysinfo, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_alertemail – Configure alertemail. fortinet.fortimanager.fmgr\_system\_alertemail – Configure alertemail. ====================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_alertemail`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_alertemail dictionary \| \| the top level parameters set \| \| \| authentication string \| Choices:* disable * enable ← \| Enable/disable authentication. disable - Disable setting. enable - Enable setting. \| \| \| fromaddress string \| \| SMTP from address. \| \| \| fromname string \| \| SMTP from user. \| \| \| smtppassword string \| \| no description \| \| \| smtpport integer \| Default:25 \| SMTP server port. \| \| \| smtpserver string \| \| SMTP server address. \| \| \| smtpuser string \| \| SMTP server user. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 alertemail. fmgr_system_alertemail: bypass_validation: 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_alertemail: authentication: <value in [disable, enable]> fromaddress: <value of string> fromname: <value of string> smtppassword: <value of string> smtpport: <value of integer> smtpserver: <value of string> smtpuser: <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_replacemsggroup – Configure replacement message groups. fortinet.fortimanager.fmgr\_system\_replacemsggroup – Configure replacement message 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_system_replacemsggroup`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_replacemsggroup dictionary \| \| the top level parameters set \| \| \| admin list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| alertmail list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| auth list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| automation list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| comment string \| \| Comment. \| \| \| custom-message list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| device-detection-portal list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| ec list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| fortiguard-wf list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| ftp list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| group-type string \| Choices:* default * utm * auth * ec * captive-portal \| Group type. \| \| \| http list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| icap list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| mail list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| mm1 list / elements=string \| \| no description \| \| \| \| add-smil string \| Choices:* disable * enable \| add message encapsulation \| \| \| \| charset string \| Choices:* us-ascii * utf-8 \| character encoding used for replacement message \| \| \| \| class string \| Choices:* personal * advertisement * information * automatic * not-included \| message class \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| from string \| \| from address \| \| \| \| from-sender string \| Choices:* disable * enable \| notification message sent from recipient \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| image string \| \| Message string. \| \| \| \| message string \| \| message text \| \| \| \| msg-type string \| \| Message type. \| \| \| \| priority string \| Choices:* low * normal * high * not-included \| message priority \| \| \| \| rsp-status string \| Choices:* ok * err-unspecified * err-srv-denied * err-msg-fmt-corrupt * err-snd-addr-unresolv * err-msg-not-found * err-net-prob * err-content-not-accept * err-unsupp-msg \| response status code \| \| \| \| rsp-text string \| \| response text \| \| \| \| sender-visibility string \| Choices:* hide * show * not-specified \| sender visibility \| \| \| \| smil-part string \| \| message encapsulation text \| \| \| \| subject string \| \| subject text string \| \| \| mm3 list / elements=string \| \| no description \| \| \| \| add-html string \| Choices:* disable * enable \| add message encapsulation \| \| \| \| charset string \| Choices:* us-ascii * utf-8 \| character encoding used for replacement message \| \| \| \| 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. \| \| \| \| html-part string \| \| message encapsulation text \| \| \| \| image string \| \| Message string. \| \| \| \| message string \| \| message text \| \| \| \| msg-type string \| \| Message type. \| \| \| \| priority string \| Choices:* low * normal * high * not-included \| message priority \| \| \| \| subject string \| \| subject text string \| \| \| mm4 list / elements=string \| \| no description \| \| \| \| 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 \| \| \| mm7 list / elements=string \| \| no description \| \| \| \| 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 \| \| \| mms list / elements=string \| \| no description \| \| \| \| 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. \| \| \| nac-quar list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| name string \| \| Group name. \| \| \| nntp list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| spam list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| sslvpn list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| traffic-quota list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| utm list / elements=string \| \| no description \| \| \| \| buffer string \| \| Message string. \| \| \| \| format string \| Choices:* none * text * html * wml \| Format flag. \| \| \| \| header string \| Choices:* none * http * 8bit \| Header flag. \| \| \| \| msg-type string \| \| Message type. \| \| \| webproxy list / elements=string \| \| no description \| \| \| \| 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: Configure replacement message groups. fmgr_system_replacemsggroup: bypass_validation: False workspace_locking_adom: <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_replacemsggroup: admin: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> alertmail: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> auth: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> comment: <value of string> custom-message: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> device-detection-portal: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> ec: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> fortiguard-wf: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> ftp: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> group-type: <value in [default, utm, auth, ...]> http: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> icap: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> mail: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> mm1: - add-smil: <value in [disable, enable]> charset: <value in [us-ascii, utf-8]> class: <value in [personal, advertisement, information, ...]> format: <value in [none, text, html, ...]> from: <value of string> from-sender: <value in [disable, enable]> header: <value in [none, http, 8bit]> image: <value of string> message: <value of string> msg-type: <value of string> priority: <value in [low, normal, high, ...]> rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]> rsp-text: <value of string> sender-visibility: <value in [hide, show, not-specified]> smil-part: <value of string> subject: <value of string> mm3: - add-html: <value in [disable, enable]> charset: <value in [us-ascii, utf-8]> format: <value in [none, text, html, ...]> from: <value of string> from-sender: <value in [disable, enable]> header: <value in [none, http, 8bit]> html-part: <value of string> image: <value of string> message: <value of string> msg-type: <value of string> priority: <value in [low, normal, high, ...]> subject: <value of string> 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> 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> 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> nac-quar: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> name: <value of string> nntp: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> spam: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> sslvpn: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> traffic-quota: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> utm: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> webproxy: - buffer: <value of string> format: <value in [none, text, html, ...]> header: <value in [none, http, 8bit]> msg-type: <value of string> 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_fsp_vlan_dynamicmapping_interface – no description fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_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_fsp_vlan_dynamicmapping_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\_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 dictionary \| \| the top level parameters set \| \| \| 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 \| 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 \| \| \| 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 \| \| \| 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_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> dynamic_mapping: <your own value> fsp_vlan_dynamicmapping_interface: ip: <value of string> vlanid: <value of integer> 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]> 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]> 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_anomaly – Anomaly name. fortinet.fortimanager.fmgr\_pkg\_firewall\_dospolicy\_anomaly – Anomaly 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_pkg_firewall_dospolicy_anomaly`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| DoS-policy string / required \| \| the parameter (DoS-policy) in requested url \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| pkg string / required \| \| the parameter (pkg) in requested url \| \| pkg\_firewall\_dospolicy\_anomaly dictionary \| \| the top level parameters set \| \| \| 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 = 5m). Requ... \| \| \| 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 has a d... \| \| \| threshold(default) 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: Anomaly name. fmgr_pkg_firewall_dospolicy_anomaly: bypass_validation: False workspace_locking_adom: <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> DoS-policy: <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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_tacacs_dynamicmapping – Configure TACACS+ server entries. fortinet.fortimanager.fmgr\_user\_tacacs\_dynamicmapping – Configure TACACS+ 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_tacacs_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| tacacs+ string / required \| \| the parameter (tacacs+) in requested url \| \| user\_tacacs\_dynamicmapping dictionary \| \| the top level parameters set \| \| \| \_scope list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| authen-type string \| Choices:* auto * ascii * pap * chap * mschap \| no description \| \| \| authorization string \| Choices:* disable * enable \| no description \| \| \| interface string \| \| no description \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| no description \| \| \| key string \| \| no description \| \| \| port integer \| \| no description \| \| \| secondary-key string \| \| no description \| \| \| secondary-server string \| \| no description \| \| \| server string \| \| no description \| \| \| source-ip string \| \| no description \| \| \| tertiary-key string \| \| no description \| \| \| tertiary-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 TACACS+ server entries. fmgr_user_tacacs_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> tacacs+: <your own value> state: <value in [present, absent]> user_tacacs_dynamicmapping: _scope: - name: <value of string> vdom: <value of string> authen-type: <value in [auto, ascii, pap, ...]> authorization: <value in [disable, enable]> key: <value of string> port: <value of integer> secondary-key: <value of string> secondary-server: <value of string> server: <value of string> source-ip: <value of string> tertiary-key: <value of string> tertiary-server: <value of string> 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_emailfilter_blockallowlist_entries – Anti-spam block/allow entries. fortinet.fortimanager.fmgr\_emailfilter\_blockallowlist\_entries – Anti-spam block/allow 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_blockallowlist_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 \| \| block-allow-list string / required \| \| the parameter (block-allow-list) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| emailfilter\_blockallowlist\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* spam * clear * reject \| Reject, mark as spam or good email. \| \| \| addr-type string \| Choices:* ipv4 * ipv6 \| IP address type. \| \| \| email-pattern string \| \| Email address pattern. \| \| \| id integer \| \| Entry ID. \| \| \| ip4-subnet string \| \| IPv4 network address/subnet mask bits. \| \| \| ip6-subnet string \| \| IPv6 network address/subnet mask bits. \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| type string \| Choices:* ip * email \| Entry type. \| \| 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: Anti-spam block/allow entries. fmgr_emailfilter_blockallowlist_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> block-allow-list: <your own value> state: <value in [present, absent]> emailfilter_blockallowlist_entries: action: <value in [spam, clear, reject]> addr-type: <value in [ipv4, ipv6]> email-pattern: <value of string> id: <value of integer> ip4-subnet: <value of string> ip6-subnet: <value of string> pattern-type: <value in [wildcard, regexp]> status: <value in [disable, enable]> type: <value in [ip, email]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mailsignature – Configure Mail signature. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_mailsignature – Configure Mail 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_firewall_profileprotocoloptions_mailsignature`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_mailsignature dictionary \| \| the top level parameters set \| \| \| signature string \| \| Email signature to be added to outgoing email (if the signature contains spaces, enclose with quotation marks). \| \| \| status string \| Choices:* disable * enable \| Enable/disable adding an email signature to SMTP email messages as they pass through the FortiGate. \| \| 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 Mail signature. fmgr_firewall_profileprotocoloptions_mailsignature: bypass_validation: False workspace_locking_adom: <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_mailsignature: signature: <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_icap_profile_respmodforwardrules – ICAP response mode forward rules. fortinet.fortimanager.fmgr\_icap\_profile\_respmodforwardrules – ICAP response mode forward 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_icap_profile_respmodforwardrules`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| 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. \| \| 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: ICAP response mode forward rules. fmgr_icap_profile_respmodforwardrules: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> profile: <your own value> state: <value in [present, absent]> icap_profile_respmodforwardrules: 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)	programming_docs
ansible fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam – EAP auth param. fortinet.fortimanager.fmgr\_hotspot20\_anqpnairealm\_nailist\_eapmethod\_authparam – EAP auth param. ==================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_eapmethod_authparam`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values 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 \| \| eap-method string / required \| \| the parameter (eap-method) in requested url \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| hotspot20\_anqpnairealm\_nailist\_eapmethod\_authparam dictionary \| \| the top level parameters set \| \| \| 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. \| \| nai-list string / required \| \| the parameter (nai-list) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: EAP auth param. fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam: bypass_validation: False workspace_locking_adom: <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> nai-list: <your own value> eap-method: <your own value> state: <value in [present, absent]> hotspot20_anqpnairealm_nailist_eapmethod_authparam: id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]> index: <value of integer> val: <value in [eap-identity, eap-md5, eap-tls, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_quarantinefilesautodeletion – Automatic deletion policy for quarantined files. fortinet.fortimanager.fmgr\_system\_autodelete\_quarantinefilesautodeletion – Automatic deletion policy for 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_quarantinefilesautodeletion`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_quarantinefilesautodeletion 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 quarantined files. fmgr_system_autodelete_quarantinefilesautodeletion: bypass_validation: 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_quarantinefilesautodeletion: 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_switchcontroller_managedswitch_snmpsysinfo – Configuration method to edit Simple Network Management Protocol fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_snmpsysinfo – Configuration method to edit Simple Network Management Protocol ========================================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpsysinfo`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_snmpsysinfo dictionary \| \| the top level parameters set \| \| \| contact-info string \| \| Contact information. \| \| \| description string \| \| System description. \| \| \| engine-id string \| \| Local SNMP engine ID string (max 24 char). \| \| \| location string \| \| System location. \| \| \| status string \| Choices:* disable * enable \| Enable/disable SNMP. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configuration method to edit Simple Network Management Protocol fmgr_switchcontroller_managedswitch_snmpsysinfo: bypass_validation: False workspace_locking_adom: <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> switchcontroller_managedswitch_snmpsysinfo: contact-info: <value of string> description: <value of string> engine-id: <value of string> location: <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_cifs_profile – Configure CIFS profile. fortinet.fortimanager.fmgr\_cifs\_profile – Configure CIFS 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_cifs_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 \| \| cifs\_profile dictionary \| \| the top level parameters set \| \| \| domain-controller string \| \| Domain for which to decrypt CIFS traffic. \| \| \| name string \| \| Profile name. \| \| \| server-credential-type string \| Choices:* none * credential-replication * credential-keytab \| CIFS server credential type. \| \| \| server-keytab list / elements=string \| \| no description \| \| \| \| keytab string \| \| Base64 encoded keytab file containing credential of the server. \| \| \| \| password string \| \| no description \| \| \| \| principal string \| \| Service principal. For example, "host/[email protected]". \| \| 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 CIFS profile. fmgr_cifs_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]> cifs_profile: domain-controller: <value of string> name: <value of string> server-credential-type: <value in [none, credential-replication, credential-keytab]> server-keytab: - keytab: <value of string> principal: <value of string> password: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu)	programming_docs
ansible fortinet.fortimanager.fmgr_fmupdate_fdssetting – Configure FortiGuard settings. fortinet.fortimanager.fmgr\_fmupdate\_fdssetting – Configure FortiGuard 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_fdssetting`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 dictionary \| \| the top level parameters set \| \| \| fds-clt-ssl-protocol string \| Choices:* sslv3 * tlsv1.0 * tlsv1.1 * tlsv1.2 ← * tlsv1.3 \| The SSL protocols version for connecting fds server (default = tlsv1.2). sslv3 - set SSLv3 as the client version. tlsv1.0 - set TLSv1.0 as the client version. tlsv1.1 - set TLSv1.1 as the client version. tlsv1.2 - set TLSv1.2 as the client version (default). \| \| \| fds-ssl-protocol string \| Choices:* sslv3 * tlsv1.0 * tlsv1.1 * tlsv1.2 ← * tlsv1.3 \| The SSL protocols version for receiving fgt connection (default = tlsv1.2). sslv3 - set SSLv3 as the lowest version. tlsv1.0 - set TLSv1.0 as the lowest version. tlsv1.1 - set TLSv1.1 as the lowest version. tlsv1.2 - set TLSv1.2 as the lowest version (default). \| \| \| fmtr-log string \| Choices:* emergency * alert * critical * error * warn * notice * info ← * debug * disable \| fmtr log level emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log \| \| \| fortiguard-anycast string \| Choices:* disable ← * enable \| Enable/disable use of FortiGuards anycast network disable - Disable setting. enable - Enable setting. \| \| \| fortiguard-anycast-source string \| Choices:* fortinet ← * aws \| Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. Default is Fortinet fortinet - Use Fortinets servers to provide FortiGuard services in FortiGuards anycast network. aws - Use Fortinets AWS servers to provide FortiGuard services in FortiGuards anycast network. \| \| \| linkd-log string \| Choices:* emergency * alert * critical * error * warn * notice * info ← * debug * disable \| The linkd log level (default = info). emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log \| \| \| max-av-ips-version integer \| Default:20 \| The maximum number of downloadable, full version AV/IPS packages (1 - 1000, default = 20). \| \| \| max-work integer \| Default:1 \| The maximum number of worker processing download requests (1 - 32, default = 1). \| \| \| push-override dictionary \| \| no description \| \| \| \| ip string \| Default:"0.0.0.0" \| External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. \| \| \| \| port integer \| Default:9443 \| Receiving port number on the NAT device (1 - 65535, default = 9443). \| \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable push updates for clients (default = disable). disable - Disable setting. enable - Enable setting. \| \| \| push-override-to-client dictionary \| \| no description \| \| \| \| announce-ip list / elements=string \| \| no description \| \| \| \| \| id integer \| Default:0 \| ID of the announce IP address (1 - 10). \| \| \| \| \| ip string \| Default:"0.0.0.0" \| Announce IPv4 address. \| \| \| \| \| port integer \| Default:8890 \| Announce IP port (1 - 65535, default = 8890). \| \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable push updates (default = disable). disable - Disable setting. enable - Enable setting. \| \| \| send\_report string \| Choices:* disable * enable ← \| send report/fssi to fds server. disable - Disable setting. enable - Enable setting. \| \| \| send\_setup string \| Choices:* disable ← * enable \| forward setup to fds server. disable - Disable setting. enable - Enable setting. \| \| \| server-override dictionary \| \| no description \| \| \| \| 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. \| \| \| system-support-fct list / elements=string \| Choices:* 4.x * 5.0 * 5.2 * 5.4 * 5.6 * 6.0 * 6.2 * 6.4 \| no description \| \| \| system-support-fgt list / elements=string \| Choices:* 5.4 * 5.6 * 6.0 * 6.2 * 6.4 * 7.0 \| no description \| \| \| system-support-fml list / elements=string \| Choices:* 4.x * 5.x * 6.x \| no description \| \| \| system-support-fsa list / elements=string \| Choices:* 1.x * 2.x * 3.x * 4.x \| no description \| \| \| system-support-fsw list / elements=string \| Choices:* 5.4 * 5.6 * 6.0 * 6.2 * 4.x * 5.0 * 5.2 * 6.4 \| no description \| \| \| umsvc-log string \| Choices:* emergency * alert * critical * error * warn * notice * info ← * debug * disable \| The um\_service log level (default = info). emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log \| \| \| unreg-dev-option string \| Choices:* ignore * svc-only * add-service ← \| set the option for unregister devices ignore - Ignore all unregistered devices. svc-only - Allow update requests without adding the device. add-service - Add unregistered devices and allow update request. \| \| \| update-schedule dictionary \| \| no description \| \| \| \| day string \| Choices:* Sunday * Monday ← * Tuesday * Wednesday * Thursday * Friday * Saturday \| Configure the day the update will occur, if the freqnecy is weekly (Sunday - Saturday, default = Monday). Sunday - Update every Sunday. Monday - Update every Monday. Tuesday - Update every Tuesday. Wednesday - Update every Wednesday. Thursday - Update every Thursday. Friday - Update every Friday. Saturday - Update every Saturday. \| \| \| \| frequency string \| Choices:* every ← * daily * weekly \| Configure update frequency: every - time interval, daily - once a day, weekly - once a week (default = every). every - Time interval. daily - Every day. weekly - Every week. \| \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable scheduled updates. disable - Disable setting. enable - Enable setting. \| \| \| \| time string \| \| no description \| \| \| User-Agent string \| Default:"Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)" \| Configure the user agent string. \| \| \| wanip-query-mode string \| Choices:* disable ← * ipify \| public ip query mode disable - Do not query public ip ipify - Get public IP through https://api.ipify.org \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 FortiGuard settings. fmgr_fmupdate_fdssetting: bypass_validation: 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: User-Agent: <value of string> fds-clt-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]> fds-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]> fmtr-log: <value in [emergency, alert, critical, ...]> linkd-log: <value in [emergency, alert, critical, ...]> max-av-ips-version: <value of integer> max-work: <value of integer> push-override: ip: <value of string> port: <value of integer> status: <value in [disable, enable]> push-override-to-client: announce-ip: - id: <value of integer> ip: <value of string> port: <value of integer> status: <value in [disable, enable]> send_report: <value in [disable, enable]> send_setup: <value in [disable, enable]> server-override: 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]> system-support-fct: - 4.x - 5.0 - 5.2 - 5.4 - 5.6 - 6.0 - 6.2 - 6.4 system-support-fgt: - 5.4 - 5.6 - 6.0 - 6.2 - 6.4 - 7.0 system-support-fml: - 4.x - 5.x - 6.x system-support-fsa: - 1.x - 2.x - 3.x - 4.x system-support-fsw: - 5.4 - 5.6 - 6.0 - 6.2 - 4.x - 5.0 - 5.2 - 6.4 umsvc-log: <value in [emergency, alert, critical, ...]> unreg-dev-option: <value in [ignore, svc-only, add-service]> update-schedule: day: <value in [Sunday, Monday, Tuesday, ...]> frequency: <value in [every, daily, weekly]> status: <value in [disable, enable]> time: <value of string> wanip-query-mode: <value in [disable, ipify]> fortiguard-anycast: <value in [disable, enable]> fortiguard-anycast-source: <value in [fortinet, aws]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_imap – IMAP. fortinet.fortimanager.fmgr\_emailfilter\_profile\_imap – IMAP. ============================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_profile_imap`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| emailfilter\_profile\_imap dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* pass * tag \| Action for spam email. \| \| \| log string \| Choices:* disable * enable \| Enable/disable logging. \| \| \| 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: IMAP. fmgr_emailfilter_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> emailfilter_profile_imap: action: <value in [pass, tag]> 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_pm_devprof_pkg – no description fortinet.fortimanager.fmgr\_pm\_devprof\_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_devprof_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\_devprof\_pkg dictionary \| \| the top level parameters set \| \| \| description string \| \| no description \| \| \| enabled options list / elements=string \| Choices:* none * dns * ntp * email * admin * snmp * repmsg * ftgd * log \| no description \| \| \| name string \| \| no description \| \| \| oid integer \| \| no description \| \| \| scope member list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| type string \| Choices:* devprof \| 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_devprof_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_devprof_pkg: description: <value of string> enabled options: - none - dns - ntp - email - admin - snmp - repmsg - ftgd - log name: <value of string> oid: <value of integer> scope member: - name: <value of string> vdom: <value of string> type: <value in [devprof]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_multicastpolicy – Configure multicast NAT policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_multicastpolicy – Configure 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_multicastpolicy`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_multicastpolicy 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. \| \| \| dnat string \| \| IPv4 DNAT address used for multicast destination addresses. \| \| \| dstaddr string \| \| Destination address objects. \| \| \| dstintf string \| \| Destination interface name. \| \| \| end-port integer \| \| Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1). \| \| \| 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). \| \| \| snat string \| Choices:* disable * enable \| Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). \| \| \| snat-ip string \| \| IPv4 address to be used as the source address for NATed traffic. \| \| \| srcaddr string \| \| Source address objects. \| \| \| srcintf string \| \| 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 multicast NAT policies. fmgr_pkg_firewall_multicastpolicy: bypass_validation: False workspace_locking_adom: <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_multicastpolicy: action: <value in [deny, accept]> auto-asic-offload: <value in [disable, enable]> dnat: <value of string> 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> snat: <value in [disable, enable]> snat-ip: <value of string> srcaddr: <value of string> srcintf: <value of string> start-port: <value of integer> status: <value in [disable, enable]> comments: <value of string> uuid: <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_secondaryip – Second IP address of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_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_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 \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| fsp\_vlan\_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_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> state: <value in [present, absent]> fsp_vlan_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_vpnsslweb_portal_oschecklist – SSL VPN OS checks. fortinet.fortimanager.fmgr\_vpnsslweb\_portal\_oschecklist – SSL VPN OS checks. =============================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_oschecklist`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_oschecklist dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* allow * check-up-to-date * deny \| OS check options. \| \| \| latest-patch-level string \| \| Latest OS patch level. \| \| \| name string \| \| Name. \| \| \| tolerance integer \| \| OS patch level tolerance. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 VPN OS checks. fmgr_vpnsslweb_portal_oschecklist: bypass_validation: False workspace_locking_adom: <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> vpnsslweb_portal_oschecklist: action: <value in [allow, check-up-to-date, deny]> latest-patch-level: <value of string> name: <value of string> tolerance: <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_videofilter_profile – Configure VideoFilter profile. fortinet.fortimanager.fmgr\_videofilter\_profile – Configure VideoFilter 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_videofilter_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 \| \| videofilter\_profile dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| dailymotion string \| Choices:* disable * enable \| Enable/disable Dailymotion video source. \| \| \| fortiguard-category dictionary \| \| no description \| \| \| \| 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. \| \| \| name string \| \| Name. \| \| \| vimeo string \| Choices:* disable * enable \| Enable/disable Vimeo video source. \| \| \| vimeo-restrict string \| \| Set Vimeo-restrict ("7" = dont show mature content, "134" = dont show unrated and mature content). A value of cookie "content\_... \| \| \| youtube string \| Choices:* disable * enable \| Enable/disable YouTube video source. \| \| \| youtube-channel-filter string \| \| Set YouTube channel filter. \| \| \| youtube-restrict string \| Choices:* strict * none * moderate \| Set YouTube-restrict 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 VideoFilter profile. fmgr_videofilter_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]> videofilter_profile: comment: <value of string> dailymotion: <value in [disable, enable]> fortiguard-category: filters: - action: <value in [block, bypass, monitor]> category-id: <value of integer> id: <value of integer> log: <value in [disable, enable]> name: <value of string> vimeo: <value in [disable, enable]> vimeo-restrict: <value of string> youtube: <value in [disable, enable]> youtube-channel-filter: <value of string> youtube-restrict: <value in [strict, none, moderate]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_alertevent – Alert events. fortinet.fortimanager.fmgr\_system\_alertevent – Alert events. ============================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_alertevent dictionary \| \| the top level parameters set \| \| \| alert-destination list / elements=string \| \| no description \| \| \| \| 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. \| \| \| enable-generic-text list / elements=string \| Choices:* enable * disable \| no description \| \| \| enable-severity-filter list / elements=string \| Choices:* enable * disable \| no description \| \| \| event-time-period string \| Choices:* 0.5 ← * 1 * 3 * 6 * 12 * 24 * 72 * 168 \| Time period (hours). 0.5 - 30 minutes. 1 - 1 hour. 3 - 3 hours. 6 - 6 hours. 12 - 12 hours. 24 - 1 day. 72 - 3 days. 168 - 1 week. \| \| \| generic-text string \| \| Text that must be contained in a log to trigger alert. \| \| \| name string \| \| Alert name. \| \| \| num-events string \| Choices:* 1 ← * 5 * 10 * 50 * 100 \| Minimum number of events required within time period. 1 - 1 event. 5 - 5 events. 10 - 10 events. 50 - 50 events. 100 - 100 events. \| \| \| severity-filter string \| Choices:* high ← * medium-high * medium * medium-low * low \| Required log severity to trigger alert. high - High level alert. medium-high - Medium-high level alert. medium - Medium level alert. medium-low - Medium-low level alert. low - Low level alert. \| \| \| severity-level-comp list / elements=string \| Choices:* >= * = * <= \| no description \| \| \| severity-level-logs list / elements=string \| Choices:* no-check * information * notify * warning * error * critical * alert * emergency \| 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: Alert events. fmgr_system_alertevent: bypass_validation: 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_alertevent: alert-destination: - 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]> enable-generic-text: - enable - disable enable-severity-filter: - enable - disable event-time-period: <value in [0.5, 1, 3, ...]> generic-text: <value of string> name: <value of string> num-events: <value in [1, 5, 10, ...]> severity-filter: <value in [high, medium-high, medium, ...]> severity-level-comp: - '>=' - '=' - '<=' severity-level-logs: - no-check - information - notify - warning - error - critical - alert - emergency ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_dynamicmapping – Configure IPv4 to IPv6 virtual IPs. fortinet.fortimanager.fmgr\_firewall\_vip46\_dynamicmapping – 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_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\_vip46\_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 \| \| \| 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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Configure IPv4 to IPv6 virtual IPs. fmgr_firewall_vip46_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> vip46: <your own value> state: <value in [present, absent]> firewall_vip46_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> 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_ippool6 – Configure IPv6 IP pools. fortinet.fortimanager.fmgr\_firewall\_ippool6 – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| comments string \| \| Comment. \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_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 \| \| \| endip string \| \| Final IPv6 address (inclusive) in the range for the address pool (format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx, Default: ::). \| \| \| name string \| \| IPv6 IP pool name. \| \| \| startip string \| \| First IPv6 address (inclusive) in the range for the address pool (format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx, Default: ::). \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: bypass_validation: False workspace_locking_adom: <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_ippool6: comments: <value of string> dynamic_mapping: - _scope: - name: <value of string> vdom: <value of string> comments: <value of string> endip: <value of string> startip: <value of string> endip: <value of string> name: <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_cifs_profile_filefilter_entries – File filter entries. fortinet.fortimanager.fmgr\_cifs\_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_cifs_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 \| \| cifs\_profile\_filefilter\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* block * log \| Action taken for matched file. \| \| \| comment string \| \| Comment. \| \| \| direction string \| Choices:* incoming * outgoing * any \| 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 \| \| 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_cifs_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]> cifs_profile_filefilter_entries: action: <value in [block, log]> comment: <value of string> direction: <value in [incoming, outgoing, any]> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_application_list_entries_parameters_members – Parameter tuple members. fortinet.fortimanager.fmgr\_application\_list\_entries\_parameters\_members – Parameter tuple 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_application_list_entries_parameters_members`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| application\_list\_entries\_parameters\_members dictionary \| \| the top level parameters set \| \| \| id integer \| \| Parameter. \| \| \| name string \| \| Parameter name. \| \| \| value string \| \| Parameter 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 \| \| entries string / required \| \| the parameter (entries) in requested url \| \| list string / required \| \| the parameter (list) in requested url \| \| parameters string / required \| \| the parameter (parameters) 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: Parameter tuple members. fmgr_application_list_entries_parameters_members: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> list: <your own value> entries: <your own value> parameters: <your own value> state: <value in [present, absent]> application_list_entries_parameters_members: id: <value of integer> 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) ansible fortinet.fortimanager.fmgr_system_alertconsole – Alert console. fortinet.fortimanager.fmgr\_system\_alertconsole – Alert console. ================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_alertconsole`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_alertconsole dictionary \| \| the top level parameters set \| \| \| period string \| Choices:* 1 * 2 * 3 * 4 * 5 * 6 * 7 ← \| Alert console keeps alerts for this period. 1 - 1 day. 2 - 2 days. 3 - 3 days. 4 - 4 days. 5 - 5 days. 6 - 6 days. 7 - 7 days. \| \| \| severity-level list / elements=string \| Choices:* debug * information * notify * warning * error * critical * alert * emergency \| 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: Alert console. fmgr_system_alertconsole: bypass_validation: 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_alertconsole: period: <value in [1, 2, 3, ...]> severity-level: - debug - information - notify - warning - error - critical - alert - emergency ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_emailfilter_iptrust_entries – Spam filter trusted IP addresses. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_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. \| \| 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 \| \| 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_emailfilter_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]> emailfilter_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_dvmdb_device_replace_sn – Replace devices serial number with new value. fortinet.fortimanager.fmgr\_dvmdb\_device\_replace\_sn – Replace devices serial number with new value. ====================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_replace_sn`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 \| \| dvmdb\_device\_replace\_sn dictionary \| \| the top level parameters set \| \| \| sn string \| \| New serial number. \| \| 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: Replace devices serial number with new value. fmgr_dvmdb_device_replace_sn: bypass_validation: False workspace_locking_adom: <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> dvmdb_device_replace_sn: 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_fmupdate_webspam_fgdsetting – Configure the FortiGuard run parameters. fortinet.fortimanager.fmgr\_fmupdate\_webspam\_fgdsetting – Configure the FortiGuard run parameters. ==================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 dictionary \| \| the top level parameters set \| \| \| as-cache integer \| Default:300 \| Antispam service maximum memory usage in megabytes (Maximum = Physical memory-1024, 0: no limit, default = 300). \| \| \| as-log string \| Choices:* disable * nospam ← * all \| Antispam log setting (default = nospam). disable - Disable spam log. nospam - Log non-spam events. all - Log all spam lookups. \| \| \| as-preload string \| Choices:* disable ← * enable \| Enable/disable preloading antispam database to memory (default = disable). disable - Disable antispam database preload. enable - Enable antispam database preload. \| \| \| av-cache integer \| Default:300 \| Antivirus service maximum memory usage, in megabytes (100 - 500, default = 300). \| \| \| av-log string \| Choices:* disable * novirus ← * all \| Antivirus log setting (default = novirus). disable - Disable virus log. novirus - Log non-virus events. all - Log all virus lookups. \| \| \| av-preload string \| Choices:* disable ← * enable \| Enable/disable preloading antivirus database to memory (default = disable). disable - Disable antivirus database preload. enable - Enable antivirus database preload. \| \| \| av2-cache integer \| Default:800 \| Antispam service maximum memory usage in megabytes (Maximum = Physical memory-1024, 0: no limit, default = 800). \| \| \| av2-log string \| Choices:* disable * noav2 ← * all \| Outbreak prevention log setting (default = noav2). disable - Disable av2 log. noav2 - Log non-av2 events. all - Log all av2 lookups. \| \| \| av2-preload string \| Choices:* disable ← * enable \| Enable/disable preloading outbreak prevention database to memory (default = disable). disable - Disable outbreak prevention database preload. enable - Enable outbreak prevention database preload. \| \| \| eventlog-query string \| Choices:* disable ← * enable \| Enable/disable record query to event-log besides fgd-log (default = disable). disable - Record query to event-log besides fgd-log. enable - Do not log to event-log. \| \| \| fgd-pull-interval integer \| Default:10 \| Fgd pull interval setting, in minutes (1 - 1440, default = 10). \| \| \| fq-cache integer \| Default:300 \| File query service maximum memory usage, in megabytes (100 - 500, default = 300). \| \| \| fq-log string \| Choices:* disable * nofilequery ← * all \| File query log setting (default = nofilequery). disable - Disable file query log. nofilequery - Log non-file query events. all - Log all file query events. \| \| \| fq-preload string \| Choices:* disable ← * enable \| Enable/disable preloading file query database to memory (default = disable). disable - Disable file query db preload. enable - Enable file query db preload. \| \| \| linkd-log string \| Choices:* emergency * alert * critical * error * warn * notice * info * debug ← * disable \| Linkd log setting (default = debug). emergency - The unit is unusable. alert - Immediate action is required critical - Functionality is affected. error - Functionality is probably affected. warn - Functionality might be affected. notice - Information about normal events. info - General information. debug - Debug information. disable - Linkd logging is disabled. \| \| \| max-client-worker integer \| Default:0 \| max worker for tcp client connection (0~16: 0 means use cpu number up to 4). \| \| \| max-log-quota integer \| Default:6144 \| Maximum log quota setting, in megabytes (100 - 20480, default = 6144). \| \| \| max-unrated-site integer \| Default:500 \| Maximum number of unrated site in memory, in kilobytes(10 - 5120, default = 500). \| \| \| restrict-as1-dbver string \| \| Restrict system update to indicated antispam(1) database version (character limit = 127). \| \| \| restrict-as2-dbver string \| \| Restrict system update to indicated antispam(2) database version (character limit = 127). \| \| \| restrict-as4-dbver string \| \| Restrict system update to indicated antispam(4) database version (character limit = 127). \| \| \| restrict-av-dbver string \| \| Restrict system update to indicated antivirus database version (character limit = 127). \| \| \| restrict-av2-dbver string \| \| Restrict system update to indicated outbreak prevention database version (character limit = 127). \| \| \| restrict-fq-dbver string \| \| Restrict system update to indicated file query database version (character limit = 127). \| \| \| restrict-wf-dbver string \| \| Restrict system update to indicated web filter database version (character limit = 127). \| \| \| server-override dictionary \| \| no description \| \| \| \| 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. \| \| \| stat-log-interval integer \| Default:60 \| Statistic log interval setting, in minutes (1 - 1440, default = 60). \| \| \| stat-sync-interval integer \| Default:60 \| Synchronization interval for statistic of unrated site in minutes (1 - 60, default = 60). \| \| \| update-interval integer \| Default:6 \| FortiGuard database update wait time if not enough delta files, in hours (2 - 24, default = 6). \| \| \| update-log string \| Choices:* disable * enable ← \| Enable/disable update log setting (default = enable). disable - Disable update log. enable - Enable update log. \| \| \| wf-cache integer \| Default:0 \| Web filter service maximum memory usage, in megabytes (maximum = Physical memory-1024, 0 = no limit, default = 600). \| \| \| wf-dn-cache-expire-time integer \| Default:30 \| Web filter DN cache expire time, in minutes (1 - 1440, 0 = never, default = 30). \| \| \| wf-dn-cache-max-number integer \| Default:10000 \| Maximum number of Web filter DN cache (0 = disable, default = 10000). \| \| \| wf-log string \| Choices:* disable * nourl ← * all \| Web filter log setting (default = nour1) disable - Disable URL log. nourl - Log non-URL events. all - Log all URL lookups. \| \| \| wf-preload string \| Choices:* disable * enable ← \| Enable/disable preloading the web filter database into memory (default = disable). disable - Disable web filter database preload. enable - Enable web filter database preload. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 FortiGuard run parameters. fmgr_fmupdate_webspam_fgdsetting: bypass_validation: 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: as-cache: <value of integer> as-log: <value in [disable, nospam, all]> as-preload: <value in [disable, enable]> av-cache: <value of integer> av-log: <value in [disable, novirus, all]> av-preload: <value in [disable, enable]> av2-cache: <value of integer> av2-log: <value in [disable, noav2, all]> av2-preload: <value in [disable, enable]> eventlog-query: <value in [disable, enable]> fgd-pull-interval: <value of integer> fq-cache: <value of integer> fq-log: <value in [disable, nofilequery, all]> fq-preload: <value in [disable, enable]> linkd-log: <value in [emergency, alert, critical, ...]> max-client-worker: <value of integer> max-log-quota: <value of integer> max-unrated-site: <value of integer> restrict-as1-dbver: <value of string> restrict-as2-dbver: <value of string> restrict-as4-dbver: <value of string> restrict-av-dbver: <value of string> restrict-av2-dbver: <value of string> restrict-fq-dbver: <value of string> restrict-wf-dbver: <value of string> server-override: 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]> stat-log-interval: <value of integer> stat-sync-interval: <value of integer> update-interval: <value of integer> update-log: <value in [disable, enable]> wf-cache: <value of integer> wf-dn-cache-expire-time: <value of integer> wf-dn-cache-max-number: <value of integer> wf-log: <value in [disable, nourl, all]> wf-preload: <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_pkg_authentication_rule – Configure Authentication Rules. fortinet.fortimanager.fmgr\_pkg\_authentication\_rule – Configure Authentication 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_pkg_authentication_rule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_rule dictionary \| \| the top level parameters set \| \| \| active-auth-method string \| \| Select an active authentication method. \| \| \| comments string \| \| Comment. \| \| \| dstaddr string \| \| Select an IPv4 destination address from available options. Required for web proxy authentication. \| \| \| dstaddr6 string \| \| Select an IPv6 destination address from available options. Required for web proxy authentication. \| \| \| ip-based string \| Choices:* disable * enable \| Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from ... \| \| \| name string \| \| Authentication rule name. \| \| \| protocol string \| Choices:* http * ftp * socks * ssh \| Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are ask... \| \| \| srcaddr string \| \| Select an IPv4 source address from available options. Required for web proxy authentication. \| \| \| srcaddr6 string \| \| Select an IPv6 source address. Required for web proxy authentication. \| \| \| srcintf string \| \| Incoming (ingress) interface. \| \| \| sso-auth-method string \| \| Select a single-sign on (SSO) authentication method. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this authentication rule. \| \| \| transaction-based string \| Choices:* disable * enable \| Enable/disable transaction based authentication (default = disable). \| \| \| web-auth-cookie string \| Choices:* disable * enable \| Enable/disable Web authentication cookies (default = disable). \| \| \| web-portal string \| Choices:* disable * enable \| Enable/disable web portal for proxy transparent policy (default = enable). \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 Rules. fmgr_pkg_authentication_rule: bypass_validation: False workspace_locking_adom: <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_authentication_rule: active-auth-method: <value of string> comments: <value of string> ip-based: <value in [disable, enable]> name: <value of string> protocol: <value in [http, ftp, socks, ...]> srcaddr: <value of string> srcaddr6: <value of string> sso-auth-method: <value of string> status: <value in [disable, enable]> transaction-based: <value in [disable, enable]> web-auth-cookie: <value in [disable, enable]> web-portal: <value in [disable, enable]> dstaddr: <value of string> dstaddr6: <value of string> srcintf: <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_fortianalyzer3_setting – Settings for locallog to fortianalyzer. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer3\_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_fortianalyzer3_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\_fortianalyzer3\_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_fortianalyzer3_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_fortianalyzer3_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_webfilter_profile_filefilter_entries – File filter entries. fortinet.fortimanager.fmgr\_webfilter\_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_webfilter_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 \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| webfilter\_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. \| \| \| 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:* http * ftp \| 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: File filter entries. fmgr_webfilter_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]> webfilter_profile_filefilter_entries: action: <value in [log, block]> comment: <value of string> direction: <value in [any, incoming, outgoing]> encryption: <value in [any, yes]> file-type: <value of string> filter: <value of string> password-protected: <value in [any, yes]> protocol: - http - ftp ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_generate_wsdl – Generate WSDL for specific module and objects. fortinet.fortimanager.fmgr\_sys\_generate\_wsdl – Generate WSDL for specific module and objects. ================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_generate_wsdl`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_generate\_wsdl dictionary \| \| the top level parameters set \| \| \| endpoint string \| \| no description \| \| \| target string \| \| URL to the module, ADOM, and 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: Generate WSDL for specific module and objects. fmgr_sys_generate_wsdl: bypass_validation: 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_generate_wsdl: endpoint: <value of string> target: <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_sys_login_challenge – Answer a log in challenge question, used following a login/user or login/challenge command. fortinet.fortimanager.fmgr\_sys\_login\_challenge – Answer a log in challenge question, used following a login/user or login/challenge command. =============================================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_login_challenge`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_login\_challenge dictionary \| \| the top level parameters set \| \| \| answer string \| \| Answer to the challenge question from previous request. \| \| \| session string \| \| Session ID returned from login/user or previous login/challenge 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: Answer a log in challenge question, used following a login/user or login/challenge command. fmgr_sys_login_challenge: bypass_validation: 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_login_challenge: answer: <value of string> session: <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_filefilter – File filter. fortinet.fortimanager.fmgr\_webfilter\_profile\_filefilter – File 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_filefilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_filefilter dictionary \| \| the top level parameters set \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* log * block \| Action taken for matched file. \| \| \| \| comment string \| \| Comment. \| \| \| \| direction string \| Choices:* any * incoming * outgoing \| Match files transmitted in the sessions originating or reply direction. \| \| \| \| 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:* http * ftp \| no description \| \| \| log string \| Choices:* disable * enable \| Enable/disable file filter logging. \| \| \| scan-archive-contents string \| Choices:* disable * enable \| Enable/disable file filter archive contents scan. \| \| \| status string \| Choices:* disable * enable \| Enable/disable file filter. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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. fmgr_webfilter_profile_filefilter: bypass_validation: False workspace_locking_adom: <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_filefilter: entries: - action: <value in [log, block]> comment: <value of string> direction: <value in [any, incoming, outgoing]> encryption: <value in [any, yes]> file-type: <value of string> filter: <value of string> password-protected: <value in [any, yes]> protocol: - http - ftp log: <value in [disable, enable]> scan-archive-contents: <value in [disable, enable]> 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_snmpcommunity_hosts – Configure IPv4 SNMP managers fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_snmpcommunity\_hosts – Configure IPv4 SNMP managers ================================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity_hosts`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| snmp-community string / required \| \| the parameter (snmp-community) in requested url \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| switchcontroller\_managedswitch\_snmpcommunity\_hosts dictionary \| \| the top level parameters set \| \| \| id integer \| \| Host entry ID. \| \| \| ip string \| \| IPv4 address of the SNMP manager (host). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 SNMP managers fmgr_switchcontroller_managedswitch_snmpcommunity_hosts: bypass_validation: False workspace_locking_adom: <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> snmp-community: <your own value> state: <value in [present, absent]> switchcontroller_managedswitch_snmpcommunity_hosts: id: <value of integer> 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_dvmdb_workflow_start – Continue a workflow session. fortinet.fortimanager.fmgr\_dvmdb\_workflow\_start – Continue a workflow session. ================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvmdb_workflow_start`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dvmdb\_workflow\_start dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| \| name string \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| session\_id string / required \| \| the parameter (session\_id) in requested url \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Continue a workflow session. fmgr_dvmdb_workflow_start: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> session_id: <your own value> dvmdb_workflow_start: desc: <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_dnsfilter_profile_ftgddns – FortiGuard DNS Filter settings. fortinet.fortimanager.fmgr\_dnsfilter\_profile\_ftgddns – FortiGuard DNS Filter settings. ========================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dnsfilter_profile_ftgddns`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_ftgddns dictionary \| \| the top level parameters set \| \| \| 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 \| \| 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: FortiGuard DNS Filter settings. fmgr_dnsfilter_profile_ftgddns: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> profile: <your own value> dnsfilter_profile_ftgddns: 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_firewall_sslsshprofile_sslserver – SSL servers. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_sslserver – SSL 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_sslsshprofile_sslserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sslserver dictionary \| \| the top level parameters set \| \| \| ftps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the FTPS handshake. \| \| \| ftps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the FTPS handshake. \| \| \| https-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the HTTPS handshake. \| \| \| https-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the HTTPS handshake. \| \| \| id integer \| \| SSL server ID. \| \| \| imaps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the IMAPS handshake. \| \| \| imaps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the IMAPS handshake. \| \| \| ip string \| \| IPv4 address of the SSL server. \| \| \| pop3s-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the POP3S handshake. \| \| \| pop3s-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the POP3S handshake. \| \| \| smtps-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during the SMTPS handshake. \| \| \| smtps-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during the SMTPS handshake. \| \| \| ssl-other-client-cert-request string \| Choices:* bypass * inspect * block \| Action based on client certificate request during an SSL protocol handshake. \| \| \| ssl-other-client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate during an SSL protocol handshake. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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: SSL servers. fmgr_firewall_sslsshprofile_sslserver: bypass_validation: False workspace_locking_adom: <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> state: <value in [present, absent]> firewall_sslsshprofile_sslserver: ftps-client-cert-request: <value in [bypass, inspect, block]> https-client-cert-request: <value in [bypass, inspect, block]> id: <value of integer> imaps-client-cert-request: <value in [bypass, inspect, block]> ip: <value of string> pop3s-client-cert-request: <value in [bypass, inspect, block]> smtps-client-cert-request: <value in [bypass, inspect, block]> ssl-other-client-cert-request: <value in [bypass, inspect, block]> ftps-client-certificate: <value in [bypass, inspect, block]> https-client-certificate: <value in [bypass, inspect, block]> imaps-client-certificate: <value in [bypass, inspect, block]> pop3s-client-certificate: <value in [bypass, inspect, block]> smtps-client-certificate: <value in [bypass, inspect, block]> ssl-other-client-certificate: <value in [bypass, inspect, 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_system_locallog_setting – Settings for locallog logging. fortinet.fortimanager.fmgr\_system\_locallog\_setting – Settings for locallog 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_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\_setting dictionary \| \| the top level parameters set \| \| \| log-interval-dev-no-logging integer \| Default:1440 \| Interval in minute for logging the event of no logs received from a device. \| \| \| log-interval-disk-full integer \| Default:5 \| Interval in minute for logging the event of disk full. \| \| \| log-interval-gbday-exceeded integer \| Default:1440 \| Interval in minute for logging the event of the GB/Day license exceeded. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 logging. fmgr_system_locallog_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_setting: log-interval-dev-no-logging: <value of integer> log-interval-disk-full: <value of integer> log-interval-gbday-exceeded: <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_admin_user_appfilter – App filter. fortinet.fortimanager.fmgr\_system\_admin\_user\_appfilter – App 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_admin_user_appfilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_appfilter dictionary \| \| the top level parameters set \| \| \| app-filter-name string \| \| App filter name. \| \| 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: App filter. fmgr_system_admin_user_appfilter: bypass_validation: 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_appfilter: app-filter-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_sdwan_healthcheck – SD-WAN status checking or health checking. fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_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_sdwan_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\_sdwan\_healthcheck dictionary \| \| the top level parameters set \| \| \| \_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, default ... \| \| \| 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, twamp: 80... \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_sdwan_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_sdwan_healthcheck: _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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_header_shapingpolicy – Configure shaping policies. fortinet.fortimanager.fmgr\_pkg\_header\_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_header_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\_header\_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_header_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_header_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_pm_devprof_adom – no description fortinet.fortimanager.fmgr\_pm\_devprof\_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_devprof_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\_devprof\_adom dictionary \| \| the top level parameters set \| \| \| description string \| \| no description \| \| \| enabled options list / elements=string \| Choices:* none * dns * ntp * email * admin * snmp * repmsg * ftgd * log \| no description \| \| \| name string \| \| no description \| \| \| oid integer \| \| no description \| \| \| scope member list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| type string \| Choices:* devprof \| 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_devprof_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_devprof_adom: description: <value of string> enabled options: - none - dns - ntp - email - admin - snmp - repmsg - ftgd - log name: <value of string> oid: <value of integer> scope member: - name: <value of string> vdom: <value of string> type: <value in [devprof]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_filters – FortiGuard filters. fortinet.fortimanager.fmgr\_webfilter\_profile\_ftgdwf\_filters – FortiGuard filters. ===================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_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 \| \| webfilter\_profile\_ftgdwf\_filters dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: FortiGuard filters. fmgr_webfilter_profile_ftgdwf_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]> webfilter_profile_ftgdwf_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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mm3 – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_mm3 – 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_mm3`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_mm3 dictionary \| \| the top level parameters set \| \| \| add-html string \| Choices:* disable * enable \| add message encapsulation \| \| \| charset string \| Choices:* us-ascii * utf-8 \| character encoding used for replacement message \| \| \| 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. \| \| \| html-part string \| \| message encapsulation text \| \| \| image string \| \| Message string. \| \| \| message string \| \| message text \| \| \| msg-type string \| \| Message type. \| \| \| priority string \| Choices:* low * normal * high * not-included \| message priority \| \| \| 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_mm3: bypass_validation: False workspace_locking_adom: <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_mm3: add-html: <value in [disable, enable]> charset: <value in [us-ascii, utf-8]> format: <value in [none, text, html, ...]> from: <value of string> from-sender: <value in [disable, enable]> header: <value in [none, http, 8bit]> html-part: <value of string> image: <value of string> message: <value of string> msg-type: <value of string> priority: <value in [low, normal, high, ...]> 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_firewall_vip_dynamicmapping_realservers – Select the real servers that this server load balancing VIP will distribute traffic to. fortinet.fortimanager.fmgr\_firewall\_vip\_dynamicmapping\_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_dynamicmapping_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 \| \| dynamic\_mapping string / required \| \| the parameter (dynamic\_mapping) in requested url \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_vip\_dynamicmapping\_realservers dictionary \| \| the top level parameters set \| \| \| address string \| \| no description \| \| \| client-ip string \| \| no description \| \| \| healthcheck string \| Choices:* disable * enable * vip \| no description \| \| \| holddown-interval integer \| \| no description \| \| \| http-host string \| \| no description \| \| \| id integer \| \| no description \| \| \| ip string \| \| no description \| \| \| max-connections integer \| \| no description \| \| \| monitor string \| \| no description \| \| \| port integer \| \| no description \| \| \| seq integer \| \| no description \| \| \| status string \| Choices:* active * standby * disable \| no description \| \| \| type string \| Choices:* ip * address \| no description \| \| \| weight integer \| \| no description \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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_dynamicmapping_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> dynamic_mapping: <your own value> state: <value in [present, absent]> firewall_vip_dynamicmapping_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_system_admin_user_webfilter – Web filter. fortinet.fortimanager.fmgr\_system\_admin\_user\_webfilter – Web 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_admin_user_webfilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_webfilter dictionary \| \| the top level parameters set \| \| \| web-filter-name string \| \| Web filter name. \| \| 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: Web filter. fmgr_system_admin_user_webfilter: bypass_validation: 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_webfilter: web-filter-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_mheader_entries – Spam filter mime header content. fortinet.fortimanager.fmgr\_spamfilter\_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_spamfilter_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 \| \| 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 \| \| spamfilter\_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. \| \| 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_spamfilter_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]> spamfilter_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) ansible fortinet.fortimanager.fmgr_mpskprofile_mpskgroup_mpskkey – List of multiple PSK entries. fortinet.fortimanager.fmgr\_mpskprofile\_mpskgroup\_mpskkey – List of multiple PSK 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_mpskprofile_mpskgroup_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 \| \| mpsk-group string / required \| \| the parameter (mpsk-group) in requested url \| \| mpsk-profile string / required \| \| the parameter (mpsk-profile) in requested url \| \| mpskprofile\_mpskgroup\_mpskkey dictionary \| \| the top level parameters set \| \| \| 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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 entries. fmgr_mpskprofile_mpskgroup_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> mpsk-profile: <your own value> mpsk-group: <your own value> state: <value in [present, absent]> mpskprofile_mpskgroup_mpskkey: 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_sql_customindex – List of SQL index fields. fortinet.fortimanager.fmgr\_system\_sql\_customindex – List of SQL index fields. ================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sql_customindex`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_sql\_customindex dictionary \| \| the top level parameters set \| \| \| case-sensitive string \| Choices:* disable ← * enable \| Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. \| \| \| device-type string \| Choices:* FortiGate ← * FortiManager * FortiClient * FortiMail * FortiWeb * FortiCache * FortiSandbox * FortiDDoS * FortiAuthenticator * FortiProxy \| Device type. FortiGate - Device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. FortiCache - Set device type to FortiCache FortiSandbox - Set device type to FortiSandbox FortiDDoS - Set device type to FortiDDoS FortiAuthenticator - Set device type to FortiAuthenticator FortiProxy - Set device type to FortiProxy \| \| \| id integer \| Default:0 \| Add or Edit log index fields. \| \| \| index-field string \| \| Log field name to be indexed. \| \| \| log-type string \| Choices:* none * app-ctrl * attack * content * dlp * emailfilter * event * generic * history * traffic ← * virus * voip * webfilter * netscan * fct-event * fct-traffic * fct-netscan * waf * gtp * dns * ssh * ssl * file-filter * asset * protocol * siem \| Log type. none - none app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 SQL index fields. fmgr_system_sql_customindex: bypass_validation: 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_sql_customindex: case-sensitive: <value in [disable, enable]> device-type: <value in [FortiGate, FortiManager, FortiClient, ...]> id: <value of integer> index-field: <value of string> log-type: <value in [none, app-ctrl, attack, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_ldbmonitor – Configure server load balancing health monitors. fortinet.fortimanager.fmgr\_firewall\_ldbmonitor – Configure server load balancing health monitors. =================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ldbmonitor`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ldbmonitor dictionary \| \| the top level parameters set \| \| \| dns-match-ip string \| \| Response IP expected from DNS server. \| \| \| dns-protocol string \| Choices:* udp * tcp \| Select the protocol used by the DNS health check monitor to check the health of the server (UDP \| TCP). \| \| \| dns-request-domain string \| \| Fully qualified domain name to resolve for the DNS probe. \| \| \| http-get string \| \| URL used to send a GET request to check the health of an HTTP server. \| \| \| http-match string \| \| String to match the value expected in response to an HTTP-GET request. \| \| \| http-max-redirects integer \| \| The maximum number of HTTP redirects to be allowed (0 - 5, default = 0). \| \| \| interval integer \| \| Time between health checks (5 - 65635 sec, default = 10). \| \| \| name string \| \| Monitor name. \| \| \| port integer \| \| Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65635, ... \| \| \| retry integer \| \| Number health check attempts before the server is considered down (1 - 255, default = 3). \| \| \| src-ip string \| \| Source IP for ldb-monitor. \| \| \| timeout integer \| \| Time to wait to receive response to a health check from a server. Reaching the timeout means the health check failed (1 - 255 ... \| \| \| type string \| Choices:* ping * tcp * http * passive-sip * https * dns \| Select the Monitor type used by the health check monitor to check the health of the server (PING \| TCP \| HTTP). \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 server load balancing health monitors. fmgr_firewall_ldbmonitor: bypass_validation: False workspace_locking_adom: <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_ldbmonitor: http-get: <value of string> http-match: <value of string> http-max-redirects: <value of integer> interval: <value of integer> name: <value of string> port: <value of integer> retry: <value of integer> timeout: <value of integer> type: <value in [ping, tcp, http, ...]> src-ip: <value of string> dns-match-ip: <value of string> dns-protocol: <value in [udp, tcp]> dns-request-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) ansible fortinet.fortimanager.fmgr_system_locallog_fortianalyzer2_setting – Settings for locallog to fortianalyzer. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer2\_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_fortianalyzer2_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\_fortianalyzer2\_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_fortianalyzer2_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_fortianalyzer2_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_system_log_alert – Log based alert settings. fortinet.fortimanager.fmgr\_system\_log\_alert – Log based alert settings. ========================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_log_alert`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_alert dictionary \| \| the top level parameters set \| \| \| max-alert-count integer \| Default:1000 \| Maximum number of alerts supported. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 based alert settings. fmgr_system_log_alert: bypass_validation: 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_alert: max-alert-count: <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_devicegroup_dynamicmapping – no description fortinet.fortimanager.fmgr\_user\_devicegroup\_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_devicegroup_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-group string / required \| \| the parameter (device-group) 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\_devicegroup\_dynamicmapping dictionary \| \| the top level parameters set \| \| \| \_if\_unmanaged integer \| \| no description \| \| \| \_scope list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| comment string \| \| no description \| \| \| member 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_devicegroup_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-group: <your own value> state: <value in [present, absent]> user_devicegroup_dynamicmapping: _if_unmanaged: <value of integer> _scope: - name: <value of string> vdom: <value of string> comment: <value of string> member: <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_log_customfield – Configure custom log fields. fortinet.fortimanager.fmgr\_log\_customfield – Configure custom log fields. =========================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_log_customfield`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| log\_customfield dictionary \| \| the top level parameters set \| \| \| id string \| \| field ID <string>. \| \| \| name string \| \| Field name (max: 15 characters). \| \| \| value string \| \| Field value (max: 15 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 custom log fields. fmgr_log_customfield: bypass_validation: False workspace_locking_adom: <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]> log_customfield: id: <value of string> 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) ansible fortinet.fortimanager.fmgr_vpnsslweb_realm – Realm. fortinet.fortimanager.fmgr\_vpnsslweb\_realm – Realm. ===================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_realm`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vpnsslweb\_realm dictionary \| \| the top level parameters set \| \| \| login-page string \| \| Replacement HTML for SSL-VPN login page. \| \| \| max-concurrent-user integer \| \| Maximum concurrent users (0 - 65535, 0 means unlimited). \| \| \| nas-ip string \| \| IP address used as a NAS-IP to communicate with the RADIUS server. \| \| \| radius-port integer \| \| RADIUS service port number (0 - 65535, 0 means user.radius.radius-port). \| \| \| radius-server string \| \| RADIUS server associated with realm. \| \| \| url-path string \| \| URL path to access SSL-VPN login page. \| \| \| virtual-host string \| \| Virtual host name for realm. \| \| \| virtual-host-only string \| Choices:* disable * enable \| Enable/disable enforcement of virtual host method for SSL-VPN client access. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Realm. fmgr_vpnsslweb_realm: bypass_validation: False workspace_locking_adom: <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]> vpnsslweb_realm: login-page: <value of string> max-concurrent-user: <value of integer> url-path: <value of string> virtual-host: <value of string> nas-ip: <value of string> radius-server: <value of string> radius-port: <value of integer> virtual-host-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_system_log_settings_rollingregular – Log rolling policy for device logs. fortinet.fortimanager.fmgr\_system\_log\_settings\_rollingregular – Log rolling policy for device logs. ======================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_settings_rollingregular`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_settings\_rollingregular dictionary \| \| the top level parameters set \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| password string \| \| no description \| \| \| password2 string \| \| no description \| \| \| password3 string \| \| no description \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| username string \| \| Upload server login username. \| \| \| username2 string \| \| Upload server login username2. \| \| \| username3 string \| \| Upload server login username3. \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 rolling policy for device logs. fmgr_system_log_settings_rollingregular: bypass_validation: 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_settings_rollingregular: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <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_virtualwirepair – Configure virtual wire pairs. fortinet.fortimanager.fmgr\_system\_virtualwirepair – Configure virtual wire pairs. =================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_virtualwirepair`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_virtualwirepair dictionary \| \| the top level parameters set \| \| \| member list / elements=string \| \| no description \| \| \| name string \| \| Virtual-wire-pair name. Must be a unique interface name. \| \| \| vlan-filter string \| \| Set VLAN filters. \| \| \| wildcard-vlan string \| Choices:* disable * enable \| Enable/disable wildcard VLAN. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 wire pairs. fmgr_system_virtualwirepair: bypass_validation: False workspace_locking_adom: <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_virtualwirepair: member: <value of list> name: <value of string> vlan-filter: <value of string> wildcard-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) ansible fortinet.fortimanager.fmgr_waf_profile_constraint_version – Enable/disable HTTP version check. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_version – Enable/disable HTTP version 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_version`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_version 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 version check. fmgr_waf_profile_constraint_version: bypass_validation: False workspace_locking_adom: <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_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_system_smsserver – Configure SMS server for sending SMS messages to support user authentication. fortinet.fortimanager.fmgr\_system\_smsserver – Configure SMS server for sending SMS messages to support user 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_smsserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_smsserver dictionary \| \| the top level parameters set \| \| \| mail-server string \| \| Email-to-SMS server domain name. \| \| \| name string \| \| Name of SMS 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 SMS server for sending SMS messages to support user authentication. fmgr_system_smsserver: bypass_validation: False workspace_locking_adom: <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_smsserver: mail-server: <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_hotspot20_anqpvenuename_valuelist – Name list. fortinet.fortimanager.fmgr\_hotspot20\_anqpvenuename\_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_anqpvenuename_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 \| \| anqp-venue-name string / required \| \| the parameter (anqp-venue-name) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_valuelist dictionary \| \| the top level parameters set \| \| \| 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: Name list. fmgr_hotspot20_anqpvenuename_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> anqp-venue-name: <your own value> state: <value in [present, absent]> hotspot20_anqpvenuename_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_user_domaincontroller – Configure domain controller entries. fortinet.fortimanager.fmgr\_user\_domaincontroller – Configure domain controller 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_domaincontroller`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_domaincontroller dictionary \| \| the top level parameters set \| \| \| ad-mode string \| Choices:* none * ds * lds \| Set Active Directory mode. \| \| \| adlds-dn string \| \| AD LDS distinguished name. \| \| \| adlds-ip-address string \| \| AD LDS IPv4 address. \| \| \| adlds-ip6 string \| \| AD LDS IPv6 address. \| \| \| adlds-port integer \| \| Port number of AD LDS service (default = 389). \| \| \| dns-srv-lookup string \| Choices:* disable * enable \| Enable/disable DNS service lookup. \| \| \| domain-name string \| \| Domain DNS name. \| \| \| extra-server list / elements=string \| \| no description \| \| \| \| id integer \| \| Server ID. \| \| \| \| ip-address string \| \| Domain controller IP address. \| \| \| \| port integer \| \| Port to be used for communication with the domain controller (default = 445). \| \| \| \| source-ip-address string \| \| FortiGate IPv4 address to be used for communication with the domain controller. \| \| \| \| source-port integer \| \| Source port to be used for communication with the domain controller. \| \| \| hostname string \| \| Hostname of the server to connect to. \| \| \| interface string \| \| Specify outgoing interface to reach server. \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| Specify how to select outgoing interface to reach server. \| \| \| ip-address string \| \| Domain controller IP address. \| \| \| ip6 string \| \| Domain controller IPv6 address. \| \| \| ldap-server string \| \| LDAP server name. \| \| \| name string \| \| Domain controller entry name. \| \| \| password string \| \| no description \| \| \| port integer \| \| Port to be used for communication with the domain controller (default = 445). \| \| \| replication-port integer \| \| Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discov... \| \| \| source-ip-address string \| \| FortiGate IPv4 address to be used for communication with the domain controller. \| \| \| source-ip6 string \| \| FortiGate IPv6 address to be used for communication with the domain controller. \| \| \| source-port integer \| \| Source port to be used for communication with the domain controller. \| \| \| username string \| \| User name to sign in with. Must have proper permissions for service. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 domain controller entries. fmgr_user_domaincontroller: bypass_validation: False workspace_locking_adom: <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_domaincontroller: domain-name: <value of string> extra-server: - id: <value of integer> ip-address: <value of string> port: <value of integer> source-ip-address: <value of string> source-port: <value of integer> ip-address: <value of string> ldap-server: <value of string> name: <value of string> port: <value of integer> ad-mode: <value in [none, ds, lds]> adlds-dn: <value of string> adlds-ip-address: <value of string> adlds-ip6: <value of string> adlds-port: <value of integer> dns-srv-lookup: <value in [disable, enable]> hostname: <value of string> interface: <value of string> interface-select-method: <value in [auto, sdwan, specify]> ip6: <value of string> password: <value of string> replication-port: <value of integer> source-ip-address: <value of string> source-ip6: <value of string> source-port: <value of integer> 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_system_snmp_community – SNMP community configuration. fortinet.fortimanager.fmgr\_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_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_community dictionary \| \| the top level parameters set \| \| \| events list / elements=string \| Choices:* disk\_low * ha\_switch * intf\_ip\_chg * sys\_reboot * cpu\_high * mem\_low * log-alert * log-rate * log-data-rate * lic-gbday * lic-dev-quota * cpu-high-exclude-nice \| no description \| \| \| hosts list / elements=string \| \| no description \| \| \| \| id integer \| Default:0 \| Host entry ID. \| \| \| \| interface string \| \| Allow interface name. \| \| \| \| ip string \| Default:"0.0.0.0 0.0.0.0" \| Allow host IP address. \| \| \| hosts6 list / elements=string \| \| no description \| \| \| \| id integer \| Default:0 \| Host entry ID. \| \| \| \| interface string \| \| Allow interface name. \| \| \| \| ip string \| Default:"::/0" \| Allow host IP address. \| \| \| id integer \| Default:0 \| Community ID. \| \| \| name string \| \| Community name. \| \| \| query\_v1\_port integer \| Default:161 \| SNMP v1 query port. \| \| \| query\_v1\_status string \| Choices:* disable * enable ← \| Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. \| \| \| query\_v2c\_port integer \| Default:161 \| SNMP v2c query port. \| \| \| query\_v2c\_status string \| Choices:* disable * enable ← \| Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable community. disable - Disable setting. enable - Enable setting. \| \| \| trap\_v1\_rport integer \| Default:162 \| SNMP v1 trap remote port. \| \| \| trap\_v1\_status string \| Choices:* disable * enable ← \| Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. \| \| \| trap\_v2c\_rport integer \| Default:162 \| SNMP v2c trap remote port. \| \| \| trap\_v2c\_status string \| Choices:* disable * enable ← \| Enable/disable SNMP v2c trap. 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: SNMP community configuration. fmgr_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, ...] state: <value in [present, absent]> system_snmp_community: events: - disk_low - ha_switch - intf_ip_chg - sys_reboot - cpu_high - mem_low - log-alert - log-rate - log-data-rate - lic-gbday - lic-dev-quota - cpu-high-exclude-nice hosts: - id: <value of integer> interface: <value of string> ip: <value of string> hosts6: - id: <value of integer> interface: <value of string> 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_rport: <value of integer> trap_v1_status: <value in [disable, enable]> trap_v2c_rport: <value of integer> trap_v2c_status: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_application_group – Configure firewall application groups. fortinet.fortimanager.fmgr\_application\_group – Configure firewall application 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_application_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 \| \| application\_group dictionary \| \| the top level parameters set \| \| \| application integer \| \| no description \| \| \| behavior string \| \| Application behavior filter. \| \| \| category integer \| \| no description \| \| \| comment string \| \| Comment \| \| \| name string \| \| Application group name. \| \| \| popularity list / elements=string \| Choices:* 1 * 2 * 3 * 4 * 5 \| no description \| \| \| protocols string \| \| Application protocol filter. \| \| \| risk integer \| \| no description \| \| \| technology string \| \| Application technology filter. \| \| \| type string \| Choices:* application * category * filter \| Application group type. \| \| \| vendor string \| \| Application vendor filter. \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 firewall application groups. fmgr_application_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]> application_group: application: <value of integer> category: <value of integer> comment: <value of string> name: <value of string> type: <value in [application, category, filter]> behavior: <value of string> popularity: - 1 - 2 - 3 - 4 - 5 protocols: <value of string> risk: <value of integer> technology: <value of string> vendor: <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_wisp – Configure Wireless Internet service provider fortinet.fortimanager.fmgr\_webproxy\_wisp – Configure Wireless Internet service provider ========================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_wisp`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_wisp dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| max-connections integer \| \| Maximum number of web proxy WISP connections (4 - 4096, default = 64). \| \| \| name string \| \| Server name. \| \| \| outgoing-ip string \| \| WISP outgoing IP address. \| \| \| server-ip string \| \| WISP server IP address. \| \| \| server-port integer \| \| WISP server port (1 - 65535, default = 15868). \| \| \| timeout integer \| \| Period of time before WISP requests time out (1 - 15 sec, default = 5). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 Internet service provider fmgr_webproxy_wisp: bypass_validation: False workspace_locking_adom: <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_wisp: comment: <value of string> max-connections: <value of integer> name: <value of string> outgoing-ip: <value of string> server-ip: <value of string> server-port: <value of integer> 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_switchcontroller_qos_ipdscpmap – Configure FortiSwitch QoS IP precedence/DSCP. fortinet.fortimanager.fmgr\_switchcontroller\_qos\_ipdscpmap – Configure FortiSwitch QoS IP precedence/DSCP. ============================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ipdscpmap dictionary \| \| the top level parameters set \| \| \| description string \| \| Description of the ip-dscp map name. \| \| \| map list / elements=string \| \| no description \| \| \| \| 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). \| \| \| name string \| \| Dscp map 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 QoS IP precedence/DSCP. fmgr_switchcontroller_qos_ipdscpmap: bypass_validation: False workspace_locking_adom: <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_ipdscpmap: description: <value of string> 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> 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_address6_dynamicmapping – Configure IPv6 firewall addresses. fortinet.fortimanager.fmgr\_firewall\_address6\_dynamicmapping – 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_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 \| \| --- \| --- \| --- \| \| 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\_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 \| \| \| 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 * nsx * dynamic * fqdn * template * mac * geography \| 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 firewall addresses. fmgr_firewall_address6_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> address6: <your own value> state: <value in [present, absent]> firewall_address6_dynamicmapping: _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, nsx, ...]> 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_healthcheck_sla – Service level agreement fortinet.fortimanager.fmgr\_wanprof\_system\_sdwan\_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_sdwan_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\_sdwan\_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_sdwan_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_sdwan_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_fsp_vlan_dhcpserver – Configure DHCP servers. fortinet.fortimanager.fmgr\_fsp\_vlan\_dhcpserver – 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_fsp_vlan_dhcpserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_dhcpserver dictionary \| \| the top level parameters set \| \| \| auto-configuration string \| Choices:* disable * enable \| no description \| \| \| auto-managed-status string \| Choices:* disable * enable \| no description \| \| \| conflicted-ip-timeout integer \| \| no description \| \| \| ddns-auth string \| Choices:* disable * tsig \| no description \| \| \| ddns-key string \| \| no description \| \| \| ddns-keyname string \| \| no description \| \| \| ddns-server-ip string \| \| no description \| \| \| ddns-ttl integer \| \| no description \| \| \| ddns-update string \| Choices:* disable * enable \| no description \| \| \| ddns-update-override string \| Choices:* disable * enable \| no description \| \| \| ddns-zone string \| \| no description \| \| \| default-gateway string \| \| no description \| \| \| dhcp-settings-from-fortiipam string \| Choices:* disable * enable \| no description \| \| \| dns-server1 string \| \| no description \| \| \| dns-server2 string \| \| no description \| \| \| dns-server3 string \| \| no description \| \| \| dns-server4 string \| \| no description \| \| \| dns-service string \| Choices:* default * specify * local \| no description \| \| \| domain string \| \| no description \| \| \| enable string \| Choices:* disable * enable \| no description \| \| \| exclude-range list / elements=string \| \| no description \| \| \| \| end-ip string \| \| no description \| \| \| \| id integer \| \| no description \| \| \| \| start-ip string \| \| no description \| \| \| filename string \| \| no description \| \| \| forticlient-on-net-status string \| Choices:* disable * enable \| no description \| \| \| id integer \| \| no description \| \| \| interface string \| \| no description \| \| \| ip-mode string \| Choices:* range * usrgrp \| 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 \| \| \| lease-time integer \| \| no description \| \| \| mac-acl-default-action string \| Choices:* assign * block \| no description \| \| \| netmask string \| \| no description \| \| \| next-server string \| \| no description \| \| \| ntp-server1 string \| \| no description \| \| \| ntp-server2 string \| \| no description \| \| \| ntp-server3 string \| \| no description \| \| \| ntp-service string \| Choices:* default * specify * local \| no description \| \| \| 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 \| \| no description \| \| \| \| id integer \| \| no description \| \| \| \| ip string \| \| no description \| \| \| \| type string \| Choices:* hex * string * ip * fqdn \| no description \| \| \| \| value string \| \| no description \| \| \| reserved-address list / elements=string \| \| no description \| \| \| \| 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 \| \| \| server-type string \| Choices:* regular * ipsec \| no description \| \| \| status string \| Choices:* disable * enable \| no description \| \| \| 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 \| no description \| \| \| timezone-option string \| Choices:* disable * default * specify \| no description \| \| \| vci-match string \| Choices:* disable * enable \| no description \| \| \| vci-string string \| \| no description \| \| \| wifi-ac-service string \| Choices:* specify * local \| no description \| \| \| wifi-ac1 string \| \| no description \| \| \| wifi-ac2 string \| \| no description \| \| \| wifi-ac3 string \| \| no description \| \| \| wins-server1 string \| \| no description \| \| \| wins-server2 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 DHCP servers. fmgr_fsp_vlan_dhcpserver: bypass_validation: False workspace_locking_adom: <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_dhcpserver: 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> 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> 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]> 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-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_system_snmp_community_hosts6 – Allow hosts configuration for IPv6. fortinet.fortimanager.fmgr\_system\_snmp\_community\_hosts6 – Allow hosts configuration 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_system_snmp_community_hosts6`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 \| \| community string / required \| \| the parameter (community) 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\_snmp\_community\_hosts6 dictionary \| \| the top level parameters set \| \| \| id integer \| Default:0 \| Host entry ID. \| \| \| interface string \| \| Allow interface name. \| \| \| ip string \| Default:"::/0" \| Allow host IP 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: Allow hosts configuration for IPv6. fmgr_system_snmp_community_hosts6: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] community: <your own value> state: <value in [present, absent]> system_snmp_community_hosts6: id: <value of integer> interface: <value of string> 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_connector – Configure connector. fortinet.fortimanager.fmgr\_system\_connector – Configure connector. ==================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_connector`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_connector dictionary \| \| the top level parameters set \| \| \| fsso-refresh-interval integer \| Default:180 \| FSSO refresh interval (60 - 1800 seconds). \| \| \| fsso-sess-timeout integer \| Default:300 \| FSSO session timeout (30 - 600 seconds). \| \| \| px-refresh-interval integer \| Default:300 \| pxGrid refresh interval (60 - 1800 seconds). \| \| \| px-svr-timeout integer \| Default:900 \| pxGrid server timeout (30 - 600 seconds). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 connector. fmgr_system_connector: bypass_validation: 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_connector: fsso-refresh-interval: <value of integer> fsso-sess-timeout: <value of integer> px-refresh-interval: <value of integer> px-svr-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_system_replacemsggroup_webproxy – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_webproxy – 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_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 \| \| 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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_switchcontroller_securitypolicy_captiveportal – Names of VLANs that use captive portal authentication. fortinet.fortimanager.fmgr\_switchcontroller\_securitypolicy\_captiveportal – Names of VLANs that use captive portal 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_switchcontroller_securitypolicy_captiveportal`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_securitypolicy\_captiveportal dictionary \| \| the top level parameters set \| \| \| name string \| \| Policy name. \| \| \| policy-type string \| Choices:* captive-portal \| Policy type. \| \| \| vlan string \| \| Names of VLANs that use captive portal 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: Names of VLANs that use captive portal authentication. fmgr_switchcontroller_securitypolicy_captiveportal: bypass_validation: False workspace_locking_adom: <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_securitypolicy_captiveportal: name: <value of string> policy-type: <value in [captive-portal]> 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_system_replacemsggroup_admin – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_admin – 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_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 \| \| 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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)	programming_docs
ansible fortinet.fortimanager.fmgr_spamfilter_profile_yahoomail – Yahoo! Mail. fortinet.fortimanager.fmgr\_spamfilter\_profile\_yahoomail – Yahoo! Mail. ========================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_yahoomail`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_yahoomail 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: Yahoo! Mail. fmgr_spamfilter_profile_yahoomail: bypass_validation: False workspace_locking_adom: <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_yahoomail: 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_footer_policy – Configure IPv4/IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_footer\_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_footer_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\_footer\_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_footer_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_footer_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_user_devicecategory – Configure device categories. fortinet.fortimanager.fmgr\_user\_devicecategory – Configure device 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_user_devicecategory`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_devicecategory dictionary \| \| the top level parameters set \| \| \| comment string \| \| no description \| \| \| desc string \| \| no description \| \| \| name string \| \| Device category 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 device categories. fmgr_user_devicecategory: bypass_validation: False workspace_locking_adom: <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_devicecategory: comment: <value of string> desc: <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_avips_advancedlog – Enable/disable logging of FortiGuard antivirus and IPS update packages received by FortiManagers built-in FortiGuard. fortinet.fortimanager.fmgr\_fmupdate\_avips\_advancedlog – Enable/disable logging of FortiGuard antivirus and IPS update packages received by FortiManagers 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_avips_advancedlog`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| fmupdate\_avips\_advancedlog dictionary \| \| the top level parameters set \| \| \| log-fortigate string \| Choices:* disable ← * enable \| Enable/disable logging of FortiGuard antivirus and IPS service updates of FortiGate devices (default = disable). disable - Disable setting. enable - Enable setting. \| \| \| log-server string \| Choices:* disable * enable ← \| Enable/disable logging of update packages received by the build-in FortiGuard server (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 logging of FortiGuard antivirus and IPS update packages received by FortiManagers built-in FortiGuard. fmgr_fmupdate_avips_advancedlog: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] fmupdate_avips_advancedlog: log-fortigate: <value in [disable, enable]> log-server: <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_guiact – System settings through GUI. fortinet.fortimanager.fmgr\_system\_guiact – System settings through GUI. ========================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_guiact`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_guiact dictionary \| \| the top level parameters set \| \| \| backup\_all string \| \| Backup all settings. \| \| \| backup\_conf string \| \| Backup config file. \| \| \| eventlog\_msg string \| \| Write event log. \| \| \| eventlog\_path string \| \| Event log path. \| \| \| reboot integer \| Default:0 \| Reboot system. \| \| \| reset2default integer \| Default:0 \| Reset to factory default. \| \| \| restore\_all string \| \| Restore all settings. \| \| \| restore\_conf string \| \| Restore config file. \| \| \| time string \| \| 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: System settings through GUI. fmgr_system_guiact: bypass_validation: 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_guiact: backup_all: <value of string> backup_conf: <value of string> eventlog_msg: <value of string> eventlog_path: <value of string> reboot: <value of integer> reset2default: <value of integer> restore_all: <value of string> restore_conf: <value of string> time: <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_ippool – Configure IPv4 IP pools. fortinet.fortimanager.fmgr\_firewall\_ippool – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| arp-intf string \| \| Select an interface from available options that will reply to ARP requests. (If blank, any is selected). \| \| \| arp-reply string \| Choices:* disable * enable \| Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). \| \| \| associated-interface string \| \| Associated interface name. \| \| \| block-size integer \| \| Number of addresses in a block (64 to 4096, default = 128). \| \| \| comments string \| \| Comment. \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_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 \| \| \| endip string \| \| Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0). \| \| \| endport integer \| \| Final port number (inclusive) in the range for the address pool (Default: 65533). \| \| \| name string \| \| IP pool name. \| \| \| num-blocks-per-user integer \| \| Number of addresses blocks that can be used by a user (1 to 128, default = 8). \| \| \| pba-timeout integer \| \| Port block allocation timeout (seconds). \| \| \| permit-any-host string \| Choices:* disable * enable \| Enable/disable full cone NAT. \| \| \| port-per-user integer \| \| Number of port for each user (32 to 60416, default = 0, auto). \| \| \| source-endip string \| \| Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0). \| \| \| source-startip string \| \| First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0). \| \| \| startip string \| \| First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0). \| \| \| 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 \| IP pool type (overload, one-to-one, fixed port range, or port block allocation). \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: bypass_validation: False workspace_locking_adom: <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_ippool: 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> dynamic_mapping: - _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> endip: <value of string> name: <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, ...]> 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_wtpprofile_radio4 – Configuration options for radio 4. fortinet.fortimanager.fmgr\_wtpprofile\_radio4 – Configuration options for radio 4. =================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_radio4`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_radio4 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:* 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 = 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 4. fmgr_wtpprofile_radio4: bypass_validation: False workspace_locking_adom: <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_radio4: 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, ...]> 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> 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 [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, ...]> vaps: <value of string> wids-profile: <value of string> 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_firewall_service_category – Configure service categories. fortinet.fortimanager.fmgr\_firewall\_service\_category – Configure service 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_firewall_service_category`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_category dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| global-object integer \| \| Global Object. \| \| \| name string \| \| Service category 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 service categories. fmgr_firewall_service_category: bypass_validation: False workspace_locking_adom: <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_category: comment: <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)	programming_docs
ansible fortinet.fortimanager.fmgr_wanopt_profile_cifs – Enable/disable CIFS fortinet.fortimanager.fmgr\_wanopt\_profile\_cifs – Enable/disable CIFS ======================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_cifs 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). \| \| \| 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 CIFS fmgr_wanopt_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> wanopt_profile_cifs: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_settings_rollinglocal – Log rolling policy for local logs. fortinet.fortimanager.fmgr\_system\_log\_settings\_rollinglocal – Log rolling policy for local logs. ==================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_settings_rollinglocal`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_settings\_rollinglocal dictionary \| \| the top level parameters set \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| password string \| \| no description \| \| \| password2 string \| \| no description \| \| \| password3 string \| \| no description \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| username string \| \| Upload server login username. \| \| \| username2 string \| \| Upload server login username2. \| \| \| username3 string \| \| Upload server login username3. \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 rolling policy for local logs. fmgr_system_log_settings_rollinglocal: bypass_validation: 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_settings_rollinglocal: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <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_spamfilter_profile_smtp – SMTP. fortinet.fortimanager.fmgr\_spamfilter\_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_spamfilter_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 \| \| 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\_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. \| \| \| 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: SMTP. fmgr_spamfilter_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> spamfilter_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 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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 – Configure DHCP servers. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver – 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_fsp_vlan_dynamicmapping_dhcpserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 dictionary \| \| the top level parameters set \| \| \| auto-configuration string \| Choices:* disable * enable \| no description \| \| \| auto-managed-status string \| Choices:* disable * enable \| no description \| \| \| conflicted-ip-timeout integer \| \| no description \| \| \| ddns-auth string \| Choices:* disable * tsig \| no description \| \| \| ddns-key string \| \| no description \| \| \| ddns-keyname string \| \| no description \| \| \| ddns-server-ip string \| \| no description \| \| \| ddns-ttl integer \| \| no description \| \| \| ddns-update string \| Choices:* disable * enable \| no description \| \| \| ddns-update-override string \| Choices:* disable * enable \| no description \| \| \| ddns-zone string \| \| no description \| \| \| default-gateway string \| \| no description \| \| \| dhcp-settings-from-fortiipam string \| Choices:* disable * enable \| no description \| \| \| dns-server1 string \| \| no description \| \| \| dns-server2 string \| \| no description \| \| \| dns-server3 string \| \| no description \| \| \| dns-server4 string \| \| no description \| \| \| dns-service string \| Choices:* default * specify * local \| no description \| \| \| domain string \| \| no description \| \| \| enable string \| Choices:* disable * enable \| no description \| \| \| exclude-range list / elements=string \| \| no description \| \| \| \| end-ip string \| \| no description \| \| \| \| id integer \| \| no description \| \| \| \| start-ip string \| \| no description \| \| \| filename string \| \| no description \| \| \| forticlient-on-net-status string \| Choices:* disable * enable \| no description \| \| \| id integer \| \| no description \| \| \| interface string \| \| no description \| \| \| ip-mode string \| Choices:* range * usrgrp \| 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 \| \| \| lease-time integer \| \| no description \| \| \| mac-acl-default-action string \| Choices:* assign * block \| no description \| \| \| netmask string \| \| no description \| \| \| next-server string \| \| no description \| \| \| ntp-server1 string \| \| no description \| \| \| ntp-server2 string \| \| no description \| \| \| ntp-server3 string \| \| no description \| \| \| ntp-service string \| Choices:* default * specify * local \| no description \| \| \| 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 \| \| no description \| \| \| \| id integer \| \| no description \| \| \| \| ip string \| \| no description \| \| \| \| type string \| Choices:* hex * string * ip * fqdn \| no description \| \| \| \| value string \| \| no description \| \| \| reserved-address list / elements=string \| \| no description \| \| \| \| 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 \| \| \| server-type string \| Choices:* regular * ipsec \| no description \| \| \| status string \| Choices:* disable * enable \| no description \| \| \| 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 \| no description \| \| \| timezone-option string \| Choices:* disable * default * specify \| no description \| \| \| vci-match string \| Choices:* disable * enable \| no description \| \| \| vci-string string \| \| no description \| \| \| wifi-ac-service string \| Choices:* specify * local \| no description \| \| \| wifi-ac1 string \| \| no description \| \| \| wifi-ac2 string \| \| no description \| \| \| wifi-ac3 string \| \| no description \| \| \| wins-server1 string \| \| no description \| \| \| wins-server2 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 DHCP servers. fmgr_fsp_vlan_dynamicmapping_dhcpserver: bypass_validation: False workspace_locking_adom: <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_dhcpserver: 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> 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> 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]> 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-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_dvmdb_workflow_revert – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_revert – 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_revert`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dvmdb\_workflow\_revert dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| \| fmgip string \| \| no description \| \| \| mail\_user string \| \| no description \| \| \| no\_diff integer \| \| no description \| \| \| no\_mail integer \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| session\_id string / required \| \| the parameter (session\_id) in requested url \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: no description fmgr_dvmdb_workflow_revert: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> session_id: <your own value> dvmdb_workflow_revert: desc: <value of string> fmgip: <value of string> mail_user: <value of string> no_diff: <value of integer> no_mail: <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 – Configure AntiSpam DNSBL/ORBL. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_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. \| \| 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 DNSBL/ORBL. fmgr_emailfilter_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]> emailfilter_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) ansible fortinet.fortimanager.fmgr_user_fortitoken – Configure FortiToken. fortinet.fortimanager.fmgr\_user\_fortitoken – Configure FortiToken. ==================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fortitoken`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_fortitoken dictionary \| \| the top level parameters set \| \| \| comments string \| \| Comment. \| \| \| license string \| \| Mobile token license. \| \| \| os-ver string \| \| Device Mobile Version. \| \| \| reg-id string \| \| Device Reg ID. \| \| \| serial-number string \| \| Serial number. \| \| \| status string \| Choices:* lock * active \| 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 FortiToken. fmgr_user_fortitoken: bypass_validation: False workspace_locking_adom: <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_fortitoken: comments: <value of string> license: <value of string> os-ver: <value of string> reg-id: <value of string> serial-number: <value of string> status: <value in [lock, active]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_ip6extraaddr – Extra IPv6 address prefixes of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_interface\_ipv6\_ip6extraaddr – Extra IPv6 address prefixes 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_ip6extraaddr`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ip6extraaddr dictionary \| \| the top level parameters set \| \| \| prefix 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: Extra IPv6 address prefixes of interface. fmgr_fsp_vlan_interface_ipv6_ip6extraaddr: bypass_validation: False workspace_locking_adom: <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_ip6extraaddr: prefix: <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_ntp_ntpserver – NTP server. fortinet.fortimanager.fmgr\_system\_ntp\_ntpserver – NTP 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_ntp_ntpserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_ntp\_ntpserver dictionary \| \| the top level parameters set \| \| \| authentication string \| Choices:* disable ← * enable \| Enable/disable MD5 authentication. disable - Disable setting. enable - Enable setting. \| \| \| id integer \| Default:0 \| Time server ID. \| \| \| key string \| \| no description \| \| \| key-id integer \| Default:0 \| Key ID for authentication. \| \| \| ntpv3 string \| Choices:* disable ← * enable \| Enable/disable NTPv3. disable - Disable setting. enable - Enable setting. \| \| \| server string \| \| IP address/hostname of NTP 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: NTP server. fmgr_system_ntp_ntpserver: bypass_validation: 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_ntp_ntpserver: authentication: <value in [disable, enable]> id: <value of integer> key: <value of string> key-id: <value of integer> ntpv3: <value in [disable, enable]> server: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_vip_sslserverciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_vip\_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_vip_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\_vip\_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 \| \| 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: SSL/TLS cipher suites to offer to a server, ordered by priority. fmgr_firewall_vip_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> vip: <your own value> state: <value in [present, absent]> firewall_vip_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_system_certificate_ssh – SSH certificates and keys. fortinet.fortimanager.fmgr\_system\_certificate\_ssh – SSH 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_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ssh dictionary \| \| the top level parameters set \| \| \| certificate string \| \| no description \| \| \| comment string \| \| SSH certificate comment. \| \| \| name string \| \| Name of SSH certificate. \| \| \| 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: SSH certificates and keys. fmgr_system_certificate_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, ...] state: <value in [present, absent]> system_certificate_ssh: certificate: <value of string> comment: <value of string> name: <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) ansible fortinet.fortimanager.fmgr_dynamic_certificate_local_dynamicmapping – no description fortinet.fortimanager.fmgr\_dynamic\_certificate\_local\_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_certificate_local_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\_certificate\_local\_dynamicmapping dictionary \| \| the top level parameters set \| \| \| \_scope list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| local-cert string \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| local string / required \| \| the parameter (local) 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_certificate_local_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> local: <your own value> state: <value in [present, absent]> dynamic_certificate_local_dynamicmapping: _scope: - name: <value of string> vdom: <value of string> 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) ansible fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6delegatedprefixlist – Advertised IPv6 delegated prefix list. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_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_dynamicmapping_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 \| \| 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\_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_dynamicmapping_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> dynamic_mapping: <your own value> state: <value in [present, absent]> fsp_vlan_dynamicmapping_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)	programming_docs
ansible fortinet.fortimanager.fmgr_switchcontroller_lldpprofile_customtlvs – Configuration method to edit custom TLV entries. fortinet.fortimanager.fmgr\_switchcontroller\_lldpprofile\_customtlvs – Configuration method to edit custom TLV 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_switchcontroller_lldpprofile_customtlvs`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_customtlvs dictionary \| \| the top level parameters set \| \| \| 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). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 custom TLV entries. fmgr_switchcontroller_lldpprofile_customtlvs: bypass_validation: False workspace_locking_adom: <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_customtlvs: information-string: <value of string> name: <value of string> oui: <value of string> subtype: <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_report_group – Report group. fortinet.fortimanager.fmgr\_system\_report\_group – Report 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_report_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\_report\_group dictionary \| \| the top level parameters set \| \| \| adom string \| \| Admin domain name. \| \| \| case-insensitive string \| Choices:* disable * enable ← \| Case insensitive. disable - Disable the case insensitive match. enable - Enable the case insensitive match. \| \| \| chart-alternative list / elements=string \| \| no description \| \| \| \| chart-name string \| \| Chart name. \| \| \| \| chart-replace string \| \| Chart replacement. \| \| \| group-by list / elements=string \| \| no description \| \| \| \| var-expression string \| \| Variable expression. \| \| \| \| var-name string \| \| Variable name. \| \| \| \| var-type string \| Choices:* integer * string ← * enum * ip \| Variable type. integer - Integer. string - String. enum - Enum. ip - IP. \| \| \| group-id integer \| Default:0 \| Group ID. \| \| \| report-like string \| \| Report pattern. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 group. fmgr_system_report_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_report_group: adom: <value of string> case-insensitive: <value in [disable, enable]> chart-alternative: - chart-name: <value of string> chart-replace: <value of string> group-by: - var-expression: <value of string> var-name: <value of string> var-type: <value in [integer, string, enum, ...]> group-id: <value of integer> report-like: <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_service_group – no description fortinet.fortimanager.fmgr\_pm\_config\_metafields\_firewall\_service\_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_pm_config_metafields_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_group 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_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, ...] pm_config_metafields_firewall_service_group: 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_switchcontroller_managedswitch_stormcontrol – Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_stormcontrol – Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption. ================================================================================================================================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_stormcontrol`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 storm control for measuring traffic activity using data rates to prevent traffic disruption. fmgr_switchcontroller_managedswitch_stormcontrol: bypass_validation: 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)	programming_docs
ansible fortinet.fortimanager.fmgr_firewall_address6template – Configure IPv6 address templates. fortinet.fortimanager.fmgr\_firewall\_address6template – Configure IPv6 address templates. ========================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_address6template`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_address6template dictionary \| \| the top level parameters set \| \| \| \_image-base64 string \| \| no description \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| ip6 string \| \| IPv6 address prefix. \| \| \| name string \| \| IPv6 address template name. \| \| \| subnet-segment list / elements=string \| \| no description \| \| \| \| bits integer \| \| Number of bits. \| \| \| \| exclusive string \| Choices:* disable * enable \| Enable/disable exclusive value. \| \| \| \| id integer \| \| Subnet segment ID. \| \| \| \| name string \| \| Subnet segment name. \| \| \| \| values list / elements=string \| \| no description \| \| \| \| \| name string \| \| Subnet segment value name. \| \| \| \| \| value string \| \| Subnet segment value. \| \| \| subnet-segment-count integer \| \| Number of IPv6 subnet segments. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 templates. fmgr_firewall_address6template: bypass_validation: False workspace_locking_adom: <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_address6template: ip6: <value of string> name: <value of string> subnet-segment: - bits: <value of integer> exclusive: <value in [disable, enable]> id: <value of integer> name: <value of string> values: - name: <value of string> value: <value of string> subnet-segment-count: <value of integer> _image-base64: <value of string> 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_firewall_profileprotocoloptions_ftp – Configure FTP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_ftp – Configure FTP 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_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 \| \| firewall\_profileprotocoloptions\_ftp dictionary \| \| the top level parameters set \| \| \| 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). \| \| \| inspect-all string \| Choices:* disable * enable \| Enable/disable the inspection of all ports for the protocol. \| \| \| options list / elements=string \| Choices:* clientcomfort * no-content-summary * oversize * splice * bypass-rest-command * bypass-mode-command \| no description \| \| \| oversize-limit integer \| \| Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). \| \| \| ports integer \| \| no description \| \| \| scan-bzip2 string \| Choices:* disable * enable \| Enable/disable scanning of BZip2 compressed files. \| \| \| ssl-offloaded string \| Choices:* no * yes \| SSL decryption and encryption performed by an external device. \| \| \| status string \| Choices:* disable * enable \| Enable/disable the active status of scanning for this protocol. \| \| \| stream-based-uncompressed-limit integer \| \| Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based 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 FTP protocol options. fmgr_firewall_profileprotocoloptions_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-protocol-options: <your own value> firewall_profileprotocoloptions_ftp: comfort-amount: <value of integer> comfort-interval: <value of integer> inspect-all: <value in [disable, enable]> options: - clientcomfort - no-content-summary - oversize - splice - bypass-rest-command - bypass-mode-command oversize-limit: <value of integer> ports: <value of integer> scan-bzip2: <value in [disable, enable]> status: <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_dynamic_vpntunnel – no description fortinet.fortimanager.fmgr\_dynamic\_vpntunnel – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 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-ipsec 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_vpntunnel: bypass_validation: False workspace_locking_adom: <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_vpntunnel: description: <value of string> dynamic_mapping: - _scope: - name: <value of string> vdom: <value of string> local-ipsec: <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_certificate_ca – CA certificate. fortinet.fortimanager.fmgr\_system\_certificate\_ca – CA 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_ca`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_ca dictionary \| \| the top level parameters set \| \| \| ca string \| \| no description \| \| \| comment string \| \| CA 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: CA certificate. fmgr_system_certificate_ca: bypass_validation: 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_ca: ca: <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)	programming_docs
ansible fortinet.fortimanager.fmgr_system_fortiview_setting – FortiView settings. fortinet.fortimanager.fmgr\_system\_fortiview\_setting – FortiView 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_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\_fortiview\_setting dictionary \| \| the top level parameters set \| \| \| not-scanned-apps string \| Choices:* exclude * include ← \| Include/Exclude Not.Scanned applications in FortiView. Set as exclude if you want to filter out never scanned applications. exclude - Exclude Not.Scanned applications in FortiView. include - Include Not.Scanned applications in FortiView. \| \| \| resolve-ip string \| Choices:* disable ← * enable \| Enable or disable resolving IP address to hostname in FortiView. disable - Disable resolving IP address to hostname. enable - Enable resolving IP address to hostname. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 settings. fmgr_system_fortiview_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_fortiview_setting: not-scanned-apps: <value in [exclude, include]> resolve-ip: <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_hostchecksoftware – SSL-VPN host check software. fortinet.fortimanager.fmgr\_vpnsslweb\_hostchecksoftware – SSL-VPN host check software. ======================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vpnsslweb\_hostchecksoftware dictionary \| \| the top level parameters set \| \| \| check-item-list list / elements=string \| \| no description \| \| \| \| 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. \| \| \| guid string \| \| Globally unique ID. \| \| \| name string \| \| Name. \| \| \| os-type string \| Choices:* macos * windows \| OS type. \| \| \| type string \| Choices:* av * fw \| 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: SSL-VPN host check software. fmgr_vpnsslweb_hostchecksoftware: bypass_validation: False workspace_locking_adom: <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]> vpnsslweb_hostchecksoftware: check-item-list: - 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> guid: <value of string> name: <value of string> os-type: <value in [macos, windows]> type: <value in [av, fw]> 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_user_radius_accountingserver – Additional accounting servers. fortinet.fortimanager.fmgr\_user\_radius\_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_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 \| \| 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\_accountingserver dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> state: <value in [present, absent]> user_radius_accountingserver: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_schedule_onetime – Onetime schedule configuration. fortinet.fortimanager.fmgr\_firewall\_schedule\_onetime – Onetime schedule 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_onetime`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_onetime dictionary \| \| the top level parameters set \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| end string \| \| Schedule end date and time, format hh:mm yyyy/mm/dd. \| \| \| expiration-days integer \| \| Write an event log message this many days before the schedule expires. \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| global-object integer \| \| Global Object. \| \| \| name string \| \| Onetime schedule name. \| \| \| start string \| \| Schedule start date and time, format hh:mm yyyy/mm/dd. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Onetime schedule configuration. fmgr_firewall_schedule_onetime: bypass_validation: False workspace_locking_adom: <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_onetime: color: <value of integer> end: <value of string> expiration-days: <value of integer> name: <value of string> start: <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)	programming_docs
ansible fortinet.fortimanager.fmgr_system_locallog_syslogd2_filter – Filter for syslog logging. fortinet.fortimanager.fmgr\_system\_locallog\_syslogd2\_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_syslogd2_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\_syslogd2\_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_syslogd2_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_syslogd2_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_system_replacemsggroup_nacquar – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_nacquar – 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_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 \| \| 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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_spamfilter_bword_entries – Spam filter banned word. fortinet.fortimanager.fmgr\_spamfilter\_bword\_entries – Spam filter banned word. ================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_bword_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 \| \| bword string / required \| \| the parameter (bword) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_bword\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* spam * clear \| Mark spam or good. \| \| \| id integer \| \| Banned word entry ID. \| \| \| language string \| Choices:* western * simch * trach * japanese * korean * french * thai * spanish \| Language for the banned word. \| \| \| pattern string \| \| Pattern for the banned word. \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| score integer \| \| Score value. \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| where string \| Choices:* subject * body * all \| Component of the email to be scanned. \| \| 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 banned word. fmgr_spamfilter_bword_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> bword: <your own value> state: <value in [present, absent]> spamfilter_bword_entries: action: <value in [spam, clear]> id: <value of integer> language: <value in [western, simch, trach, ...]> pattern: <value of string> pattern-type: <value in [wildcard, regexp]> score: <value of integer> status: <value in [disable, enable]> where: <value in [subject, body, all]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_config_workspace_lock – Lock an ADOM in workspace mode. fortinet.fortimanager.fmgr\_pm\_config\_workspace\_lock – Lock an ADOM in workspace 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_pm_config_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 ADOM in workspace mode. fmgr_pm_config_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_system_sql_customskipidx – List of aditional SQL skip index fields. fortinet.fortimanager.fmgr\_system\_sql\_customskipidx – List of aditional SQL skip index fields. ================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sql_customskipidx`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_sql\_customskipidx dictionary \| \| the top level parameters set \| \| \| device-type string \| Choices:* FortiGate ← * FortiManager * FortiClient * FortiMail * FortiWeb * FortiSandbox * FortiProxy \| Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy \| \| \| id integer \| Default:0 \| Add or Edit log index fields. \| \| \| index-field string \| \| Field to be added to skip index. \| \| \| log-type string \| Choices:* app-ctrl ← * attack * content * dlp * emailfilter * event * generic * history * traffic * virus * voip * webfilter * netscan * fct-event * fct-traffic * fct-netscan * waf * gtp * dns * ssh * ssl * file-filter * asset * protocol * siem \| Log type. app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl file-filter asset \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 aditional SQL skip index fields. fmgr_system_sql_customskipidx: bypass_validation: 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_sql_customskipidx: device-type: <value in [FortiGate, FortiManager, FortiClient, ...]> id: <value of integer> index-field: <value of string> log-type: <value in [app-ctrl, attack, content, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_address6template_subnetsegment – IPv6 subnet segments. fortinet.fortimanager.fmgr\_firewall\_address6template\_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_address6template_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-template string / required \| \| the parameter (address6-template) 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\_address6template\_subnetsegment dictionary \| \| the top level parameters set \| \| \| bits integer \| \| Number of bits. \| \| \| exclusive string \| Choices:* disable * enable \| Enable/disable exclusive value. \| \| \| id integer \| \| Subnet segment ID. \| \| \| name string \| \| Subnet segment name. \| \| \| values list / elements=string \| \| no description \| \| \| \| name string \| \| Subnet segment value name. \| \| \| \| value string \| \| Subnet segment 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: IPv6 subnet segments. fmgr_firewall_address6template_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-template: <your own value> state: <value in [present, absent]> firewall_address6template_subnetsegment: bits: <value of integer> exclusive: <value in [disable, enable]> id: <value of integer> name: <value of string> values: - 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) ansible fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_realservers – Select the real servers that this Access Proxy will distribute traffic to. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_apigateway\_realservers – Select the 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_apigateway_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 \| \| api-gateway string / required \| \| the parameter (api-gateway) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_accessproxy\_apigateway\_realservers dictionary \| \| the top level parameters set \| \| \| address string \| \| Address or address group of the real server. \| \| \| health-check string \| Choices:* disable * enable \| Enable to check the responsiveness of the real server before forwarding traffic. \| \| \| health-check-proto string \| Choices:* ping * http * tcp-connect \| Protocol of the health check monitor to use when polling to determine servers connectivity status. \| \| \| http-host string \| \| HTTP server domain name in HTTP header. \| \| \| id integer \| \| Real server ID. \| \| \| ip string \| \| IP address of the real server. \| \| \| mappedport string \| \| Port for communicating with the real server. \| \| \| port integer \| \| Port for communicating with the real server. \| \| \| status string \| Choices:* active * standby * disable \| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is 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 real servers that this Access Proxy will distribute traffic to. fmgr_firewall_accessproxy_apigateway_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> api-gateway: <your own value> state: <value in [present, absent]> firewall_accessproxy_apigateway_realservers: address: <value of string> health-check: <value in [disable, enable]> health-check-proto: <value in [ping, http, tcp-connect]> http-host: <value of string> id: <value of integer> ip: <value of string> mappedport: <value of string> port: <value of integer> status: <value in [active, standby, disable]> weight: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_user_metadata – Configure meta data. fortinet.fortimanager.fmgr\_system\_admin\_user\_metadata – Configure meta data. ================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_admin_user_metadata`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_metadata dictionary \| \| the top level parameters set \| \| \| fieldlength integer \| Default:0 \| Field length. \| \| \| fieldname string \| \| Field name. \| \| \| fieldvalue string \| \| Field value. \| \| \| importance string \| Choices:* optional ← * required \| Importance. optional - This field is optional. required - This field is required. \| \| \| status string \| Choices:* disabled * enabled ← \| Status. disabled - This field is disabled. enabled - This field is enabled. \| \| 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: Configure meta data. fmgr_system_admin_user_metadata: bypass_validation: 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_metadata: fieldlength: <value of integer> fieldname: <value of string> fieldvalue: <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_snmp_community_hosts – Configure IPv4 SNMP managers fortinet.fortimanager.fmgr\_devprof\_system\_snmp\_community\_hosts – Configure IPv4 SNMP managers ================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_hosts`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| community string / required \| \| the parameter (community) in requested url \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_snmp\_community\_hosts dictionary \| \| the top level parameters set \| \| \| 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. \| \| 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 IPv4 SNMP managers fmgr_devprof_system_snmp_community_hosts: bypass_validation: False workspace_locking_adom: <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> community: <your own value> state: <value in [present, absent]> devprof_system_snmp_community_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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_excluderange – Exclude one or more ranges of IP addresses from being assigned to clients. fortinet.fortimanager.fmgr\_system\_dhcp\_server\_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_system_dhcp_server_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 \| \| 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 \| \| server string / required \| \| the parameter (server) in requested url \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| system\_dhcp\_server\_excluderange dictionary \| \| the top level parameters set \| \| \| end-ip string \| \| End of IP range. \| \| \| id integer \| \| ID. \| \| \| start-ip string \| \| Start of IP range. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_system_dhcp_server_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> server: <your own value> state: <value in [present, absent]> system_dhcp_server_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_maxcookie – Maximum number of cookies in HTTP request. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_maxcookie – Maximum number of cookies in HTTP request. ============================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_maxcookie`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_maxcookie dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 cookies in HTTP request. fmgr_waf_profile_constraint_maxcookie: bypass_validation: False workspace_locking_adom: <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_maxcookie: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_script_execute – Run script. fortinet.fortimanager.fmgr\_dvmdb\_script\_execute – Run script. ================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_script_execute`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_script\_execute dictionary \| \| the top level parameters set \| \| \| adom string \| \| no description \| \| \| package string \| \| no description \| \| \| scope list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| script string \| \| Script name. \| \| 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: Run script. fmgr_dvmdb_script_execute: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> dvmdb_script_execute: adom: <value of string> package: <value of string> scope: - name: <value of string> vdom: <value of string> script: <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_move – Move and/or rename a policy package within the same ADOM. fortinet.fortimanager.fmgr\_securityconsole\_package\_move – Move and/or rename 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_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 \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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\_move dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM name. \| \| \| dst\_name string \| \| Name of the new policy package. If omitted from request, original name will be kept or a new name will be generated in case of... \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Move and/or rename a policy package within the same ADOM. fmgr_securityconsole_package_move: bypass_validation: 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_move: adom: <value of string> dst_name: <value of string> dst_parent: <value of string> 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_hotspot20_anqpnetworkauthtype – Configure network authentication type. fortinet.fortimanager.fmgr\_hotspot20\_anqpnetworkauthtype – Configure network authentication type. =================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_anqpnetworkauthtype`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_anqpnetworkauthtype dictionary \| \| the top level parameters set \| \| \| auth-type string \| Choices:* acceptance-of-terms * online-enrollment * http-redirection * dns-redirection \| Network authentication type. \| \| \| name string \| \| Authentication type name. \| \| \| url string \| \| Redirect 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 network authentication type. fmgr_hotspot20_anqpnetworkauthtype: bypass_validation: False workspace_locking_adom: <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_anqpnetworkauthtype: auth-type: <value in [acceptance-of-terms, online-enrollment, http-redirection, ...]> name: <value of string> url: <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_backup_allsettings – Scheduled backup settings. fortinet.fortimanager.fmgr\_system\_backup\_allsettings – Scheduled backup 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_backup_allsettings`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_backup\_allsettings dictionary \| \| the top level parameters set \| \| \| cert string \| \| SSH certificate for authentication. \| \| \| crptpasswd string \| \| no description \| \| \| directory string \| \| Directory in which file will be stored on backup server. \| \| \| passwd string \| \| no description \| \| \| protocol string \| Choices:* sftp ← * ftp * scp \| Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. \| \| \| server string \| \| Backup server name/IP. \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. \| \| \| time string \| \| Time to backup. \| \| \| user string \| \| Backup server login user. \| \| \| week\_days list / elements=string \| Choices:* monday * tuesday * wednesday * thursday * friday * saturday * sunday \| 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: Scheduled backup settings. fmgr_system_backup_allsettings: bypass_validation: 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_backup_allsettings: cert: <value of string> crptpasswd: <value of string> directory: <value of string> passwd: <value of string> protocol: <value in [sftp, ftp, scp]> server: <value of string> status: <value in [disable, enable]> time: <value of string> user: <value of string> week_days: - monday - tuesday - wednesday - thursday - friday - saturday - sunday ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_profile_datamaskcustomfields – Customized datamask fields. fortinet.fortimanager.fmgr\_system\_admin\_profile\_datamaskcustomfields – Customized datamask fields. ====================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_profile_datamaskcustomfields`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 \| \| 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 \| \| system\_admin\_profile\_datamaskcustomfields dictionary \| \| the top level parameters set \| \| \| field-category list / elements=string \| Choices:* log * fortiview * alert * ueba * all \| no description \| \| \| field-name string \| \| Field name. \| \| \| field-status string \| Choices:* disable * enable ← \| Field status. disable - Disable field. enable - Enable field. \| \| \| field-type string \| Choices:* string ← * ip * mac * email * unknown \| Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Customized datamask fields. fmgr_system_admin_profile_datamaskcustomfields: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] profile: <your own value> state: <value in [present, absent]> system_admin_profile_datamaskcustomfields: field-category: - log - fortiview - alert - ueba - all field-name: <value of string> field-status: <value in [disable, enable]> field-type: <value in [string, ip, mac, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_obj – Lock a specific object, where the url contains the full path to the object fortinet.fortimanager.fmgr\_dvmdb\_workspace\_lock\_obj – Lock a specific object, where the url contains the full path to the object ==================================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_dvmdb_workspace_lock_obj`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| object\_url\_name string / required \| \| the parameter (object\_url\_name) in requested url \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Lock a specific object, where the url contains the full path to the object fmgr_dvmdb_workspace_lock_obj: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> object_url_name: <your own value> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_user_device_tagging – Config object tagging. fortinet.fortimanager.fmgr\_user\_device\_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_user_device_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 \| \| 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\_tagging dictionary \| \| the top level parameters set \| \| \| category string \| \| Tag category. \| \| \| name string \| \| Tagging entry name. \| \| \| 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: Config object tagging. fmgr_user_device_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> device: <your own value> state: <value in [present, absent]> user_device_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_vpn_certificate_remote – Remote certificate as a PEM file. fortinet.fortimanager.fmgr\_vpn\_certificate\_remote – Remote certificate as a PEM file. ======================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vpn\_certificate\_remote dictionary \| \| the top level parameters set \| \| \| name string \| \| Name. \| \| \| range string \| Choices:* global * vdom \| Either the global or VDOM IP address range for the remote certificate. \| \| \| remote string \| \| Remote certificate. \| \| \| source string \| Choices:* factory * user * bundle * fortiguard \| Remote certificate source 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: Remote certificate as a PEM file. fmgr_vpn_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, ...] adom: <your own value> state: <value in [present, absent]> vpn_certificate_remote: name: <value of string> range: <value in [global, vdom]> remote: <value of string> source: <value in [factory, user, bundle, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_system_interface_ipv6 – IPv6 of interface. fortinet.fortimanager.fmgr\_system\_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_system_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 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 \| \| system\_interface\_ipv6 dictionary \| \| the top level parameters set \| \| \| ip6-address string \| Default:"::/0" \| IPv6 address/prefix of interface. \| \| \| ip6-allowaccess list / elements=string \| Choices:* ping * https * ssh * snmp * http * webservice * https-logging \| no description \| \| \| ip6-autoconf string \| Choices:* disable * enable ← \| Enable/disable address auto config (SLAAC). disable - Disable setting. enable - Enable setting. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_system_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, ...] interface: <your own value> system_interface_ipv6: ip6-address: <value of string> ip6-allowaccess: - ping - https - ssh - snmp - http - webservice - https-logging ip6-autoconf: <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_dlp_filepattern – Configure file patterns used by DLP blocking. fortinet.fortimanager.fmgr\_dlp\_filepattern – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| 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. \| \| \| id integer \| \| ID. \| \| \| name string \| \| Name of table containing the file pattern list. \| \| 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 file patterns used by DLP blocking. fmgr_dlp_filepattern: bypass_validation: False workspace_locking_adom: <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_filepattern: comment: <value of string> entries: - file-type: <value in [unknown, ignored, exe, ...]> filter-type: <value in [pattern, type]> pattern: <value of string> id: <value of integer> name: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu)	programming_docs
ansible fortinet.fortimanager.fmgr_application_list_entries_parameters – Application parameters. fortinet.fortimanager.fmgr\_application\_list\_entries\_parameters – Application parameters. ============================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_entries_parameters`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values 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\_entries\_parameters dictionary \| \| the top level parameters set \| \| \| 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. \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| list string / required \| \| the parameter (list) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Application parameters. fmgr_application_list_entries_parameters: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> list: <your own value> entries: <your own value> state: <value in [present, absent]> application_list_entries_parameters: id: <value of integer> value: <value of string> members: - id: <value of integer> 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) ansible fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod – EAP Methods. fortinet.fortimanager.fmgr\_hotspot20\_anqpnairealm\_nailist\_eapmethod – EAP Methods. ====================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_eapmethod`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values 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\_eapmethod dictionary \| \| the top level parameters set \| \| \| 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. \| \| nai-list string / required \| \| the parameter (nai-list) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: EAP Methods. fmgr_hotspot20_anqpnairealm_nailist_eapmethod: bypass_validation: False workspace_locking_adom: <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> nai-list: <your own value> state: <value in [present, absent]> hotspot20_anqpnairealm_nailist_eapmethod: 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, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_script_scriptschedule – Script schedule table. fortinet.fortimanager.fmgr\_dvmdb\_script\_scriptschedule – Script schedule 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_script_scriptschedule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_script\_scriptschedule dictionary \| \| the top level parameters set \| \| \| datetime string \| \| Indicates the date and time of the schedule. It should follow the following format for each scheduling type: onetime: "YYYY-MM-DD hh:mm:ss" daily: "hh:mm" weekly: "hh:mm" monthly: "DD hh:mm" \| \| \| day\_of\_week string \| Choices:* unknown * sun ← * mon * tue * wed * thu * fri * sat \| no description \| \| \| device integer \| \| Name or id of an existing device in the database. \| \| \| name string \| \| no description \| \| \| run\_on\_db string \| Choices:* disable ← * enable \| Indicates if the scheduled script should be executed on device database. It should always be disable for tcl scripts. \| \| \| type string \| Choices:* auto * onetime * daily * weekly * monthly \| 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 \| \| script string / required \| \| the parameter (script) 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: Script schedule table. fmgr_dvmdb_script_scriptschedule: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> script: <your own value> state: <value in [present, absent]> dvmdb_script_scriptschedule: datetime: <value of string> day_of_week: <value in [unknown, sun, mon, ...]> device: <value of integer> name: <value of string> run_on_db: <value in [disable, enable]> type: <value in [auto, onetime, daily, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_ioc – IoC settings. fortinet.fortimanager.fmgr\_system\_log\_ioc – IoC settings. ============================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_log_ioc`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_ioc dictionary \| \| the top level parameters set \| \| \| notification string \| Choices:* disable * enable ← \| Disable/Enable IoC notification. disable - Disable IoC feature. enable - Enable IoC feature. \| \| \| notification-throttle integer \| Default:1440 \| Minute value for throttling the rate of IoC notifications. \| \| \| rescan-max-runner integer \| Default:8 \| Max count of cocurrent runner of IoC rescan. \| \| \| rescan-run-at integer \| Default:24 \| When to run IoC rescan. \| \| \| rescan-status string \| Choices:* disable * enable ← \| Disable/Enable IoC rescan. disable - Disable IoC feature. enable - Enable IoC feature. \| \| \| status string \| Choices:* disable * enable ← \| Disable/Enable IoC feature. disable - Disable IoC feature. enable - Enable IoC feature. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: IoC settings. fmgr_system_log_ioc: bypass_validation: 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_ioc: notification: <value in [disable, enable]> notification-throttle: <value of integer> rescan-max-runner: <value of integer> rescan-run-at: <value of integer> rescan-status: <value in [disable, enable]> 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_ntp – NTP settings. fortinet.fortimanager.fmgr\_system\_ntp – NTP 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_ntp`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ntp dictionary \| \| the top level parameters set \| \| \| ntpserver list / elements=string \| \| no description \| \| \| \| authentication string \| Choices:* disable ← * enable \| Enable/disable MD5 authentication. disable - Disable setting. enable - Enable setting. \| \| \| \| id integer \| Default:0 \| Time server ID. \| \| \| \| key string \| \| no description \| \| \| \| key-id integer \| Default:0 \| Key ID for authentication. \| \| \| \| ntpv3 string \| Choices:* disable ← * enable \| Enable/disable NTPv3. disable - Disable setting. enable - Enable setting. \| \| \| \| server string \| \| IP address/hostname of NTP Server. \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable NTP. disable - Disable setting. enable - Enable setting. \| \| \| sync\_interval integer \| Default:60 \| NTP sync interval (min). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: NTP settings. fmgr_system_ntp: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] system_ntp: ntpserver: - authentication: <value in [disable, enable]> id: <value of integer> key: <value of string> key-id: <value of integer> ntpv3: <value in [disable, enable]> server: <value of string> status: <value in [disable, enable]> sync_interval: <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_dynamic_interface – no description fortinet.fortimanager.fmgr\_dynamic\_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_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\_interface dictionary \| \| the top level parameters set \| \| \| color integer \| \| no description \| \| \| default-mapping string \| Choices:* disable * enable \| no description \| \| \| defmap-intf string \| \| no description \| \| \| defmap-intrazone-deny string \| Choices:* disable * enable \| no description \| \| \| defmap-zonemember 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 \| \| \| \| 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 \| \| \| egress-shaping-profile string \| \| no description \| \| \| ingress-shaping-profile string \| \| no description \| \| \| name string \| \| no description \| \| \| platform\_mapping list / elements=string \| \| no description \| \| \| \| egress-shaping-profile string \| \| no description \| \| \| \| ingress-shaping-profile string \| \| no description \| \| \| \| intf-zone string \| \| no description \| \| \| \| intrazone-deny string \| Choices:* disable * enable \| no description \| \| \| \| name string \| \| no description \| \| \| single-intf 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_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_interface: color: <value of integer> default-mapping: <value in [disable, enable]> defmap-intf: <value of string> defmap-intrazone-deny: <value in [disable, enable]> defmap-zonemember: <value of string> description: <value of string> dynamic_mapping: - _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> egress-shaping-profile: <value of string> name: <value of string> single-intf: <value in [disable, enable]> ingress-shaping-profile: <value of string> platform_mapping: - egress-shaping-profile: <value of string> ingress-shaping-profile: <value of string> intf-zone: <value of string> intrazone-deny: <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_dnsfilter_domainfilter_entries – DNS domain filter entries. fortinet.fortimanager.fmgr\_dnsfilter\_domainfilter\_entries – DNS domain 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_dnsfilter_domainfilter_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 \| \| dnsfilter\_domainfilter\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* block * allow * monitor \| Action to take for domain filter matches. \| \| \| domain string \| \| Domain entries to be filtered. \| \| \| id integer \| \| Id. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this domain filter. \| \| \| type string \| Choices:* simple * regex * wildcard \| DNS domain filter type. \| \| domain-filter string / required \| \| the parameter (domain-filter) 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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 domain filter entries. fmgr_dnsfilter_domainfilter_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> domain-filter: <your own value> state: <value in [present, absent]> dnsfilter_domainfilter_entries: action: <value in [block, allow, monitor]> domain: <value of string> id: <value of integer> status: <value in [disable, enable]> type: <value in [simple, regex, wildcard]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_updateschedule – Configure the schedule when built-in FortiGuard retrieves antivirus and IPS updates. fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_updateschedule – Configure the schedule when built-in FortiGuard retrieves 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_fdssetting_updateschedule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_updateschedule dictionary \| \| the top level parameters set \| \| \| day string \| Choices:* Sunday * Monday ← * Tuesday * Wednesday * Thursday * Friday * Saturday \| Configure the day the update will occur, if the freqnecy is weekly (Sunday - Saturday, default = Monday). Sunday - Update every Sunday. Monday - Update every Monday. Tuesday - Update every Tuesday. Wednesday - Update every Wednesday. Thursday - Update every Thursday. Friday - Update every Friday. Saturday - Update every Saturday. \| \| \| frequency string \| Choices:* every ← * daily * weekly \| Configure update frequency: every - time interval, daily - once a day, weekly - once a week (default = every). every - Time interval. daily - Every day. weekly - Every week. \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable scheduled updates. disable - Disable setting. enable - Enable setting. \| \| \| time 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 the schedule when built-in FortiGuard retrieves antivirus and IPS updates. fmgr_fmupdate_fdssetting_updateschedule: bypass_validation: 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_updateschedule: day: <value in [Sunday, Monday, Tuesday, ...]> frequency: <value in [every, daily, weekly]> status: <value in [disable, enable]> time: <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_locallog_disk_setting – Settings for local disk logging. fortinet.fortimanager.fmgr\_system\_locallog\_disk\_setting – Settings for local disk 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_disk_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\_disk\_setting dictionary \| \| the top level parameters set \| \| \| diskfull string \| Choices:* overwrite ← * nolog \| Policy to apply when disk is full. overwrite - Overwrite oldest log when disk is full. nolog - Stop logging when disk is full. \| \| \| log-disk-full-percentage integer \| Default:80 \| Consider log disk as full at this usage percentage. \| \| \| max-log-file-size integer \| Default:100 \| Maximum log file size before rolling. \| \| \| roll-day list / elements=string \| Choices:* sunday * monday * tuesday * wednesday * thursday * friday * saturday \| no description \| \| \| roll-schedule string \| Choices:* none ← * daily * weekly \| Frequency to check log file for rolling. none - Not scheduled. daily - Every day. weekly - Every week. \| \| \| roll-time string \| \| no description \| \| \| server-type string \| Choices:* FTP ← * SFTP * SCP \| Server type. FTP - Upload via FTP. SFTP - Upload via SFTP. SCP - Upload via SCP. \| \| \| 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 ← \| Enable/disable local disk log. disable - Do not log to local disk. enable - Log to local disk. \| \| \| upload string \| Choices:* disable ← * enable \| Upload log file when rolling. disable - Disable uploading when rolling log file. enable - Enable uploading when rolling log file. \| \| \| upload-delete-files string \| Choices:* disable * enable ← \| Delete log files after uploading (default = enable). disable - Do not delete log files after uploading. enable - Delete log files after uploading. \| \| \| upload-time string \| \| no description \| \| \| uploaddir string \| \| Log file upload remote directory. \| \| \| uploadip string \| Default:"0.0.0.0" \| IP address of log uploading server. \| \| \| uploadpass string \| \| no description \| \| \| uploadport integer \| Default:0 \| Server port (0 = default protocol port). \| \| \| uploadsched string \| Choices:* disable ← * enable \| Scheduled upload (disable = upload when rolling). disable - Upload when rolling. enable - Scheduled upload. \| \| \| uploadtype list / elements=string \| Choices:* event \| no description \| \| \| uploaduser string \| \| User account in upload server. \| \| \| uploadzip string \| Choices:* disable ← * enable \| Compress upload logs. disable - Upload log files as plain text. enable - Upload log files compressed. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 local disk logging. fmgr_system_locallog_disk_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_disk_setting: diskfull: <value in [overwrite, nolog]> log-disk-full-percentage: <value of integer> max-log-file-size: <value of integer> roll-day: - sunday - monday - tuesday - wednesday - thursday - friday - saturday roll-schedule: <value in [none, daily, weekly]> roll-time: <value of string> server-type: <value in [FTP, SFTP, SCP]> severity: <value in [emergency, alert, critical, ...]> status: <value in [disable, enable]> upload: <value in [disable, enable]> upload-delete-files: <value in [disable, enable]> upload-time: <value of string> uploaddir: <value of string> uploadip: <value of string> uploadpass: <value of string> uploadport: <value of integer> uploadsched: <value in [disable, enable]> uploadtype: - event uploaduser: <value of string> uploadzip: <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_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_multicastaddress6\_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_multicastaddress6_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\_multicastaddress6\_tagging dictionary \| \| the top level parameters set \| \| \| category string \| \| Tag category. \| \| \| name string \| \| Tagging entry name. \| \| \| tags string \| \| no description \| \| multicast-address6 string / required \| \| the parameter (multicast-address6) 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_multicastaddress6_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-address6: <your own value> state: <value in [present, absent]> firewall_multicastaddress6_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_certificate_template – no description fortinet.fortimanager.fmgr\_certificate\_template – no description ================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_certificate_template`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| certificate\_template dictionary \| \| the top level parameters set \| \| \| city string \| \| no description \| \| \| country string \| \| no description \| \| \| curve-name string \| Choices:* secp256r1 ← * secp384r1 * secp521r1 \| no description \| \| \| digest-type string \| Choices:* sha1 ← * sha256 \| no description \| \| \| email string \| \| no description \| \| \| id-type string \| Choices:* host-ip ← * domain-name * email \| no description \| \| \| key-size string \| Choices:* 512 * 1024 * 1536 * 2048 ← * 4096 \| no description \| \| \| key-type string \| Choices:* rsa ← * ec \| no description \| \| \| name string \| \| no description \| \| \| organization string \| \| no description \| \| \| organization-unit string \| \| no description \| \| \| scep-password string \| \| no description \| \| \| scep-server string \| \| no description \| \| \| state string \| \| no description \| \| \| subject-name string \| \| no description \| \| \| type string \| Choices:* external ← * local \| 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_certificate_template: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> certificate_template: city: <value of string> country: <value of string> digest-type: <value in [sha1, sha256]> email: <value of string> id-type: <value in [host-ip, domain-name, email]> key-size: <value in [512, 1024, 1536, ...]> key-type: <value in [rsa, ec]> name: <value of string> organization: <value of string> organization-unit: <value of string> scep-password: <value of string> scep-server: <value of string> state: <value of string> subject-name: <value of string> type: <value in [external, local]> curve-name: <value in [secp256r1, secp384r1, secp521r1]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_analyzer_virusreport – Send virus detection notification to FortiGuard. fortinet.fortimanager.fmgr\_fmupdate\_analyzer\_virusreport – Send virus detection notification to 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_analyzer_virusreport`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_analyzer\_virusreport dictionary \| \| the top level parameters set \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable sending virus detection notification to FortiGuard (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: Send virus detection notification to FortiGuard. fmgr_fmupdate_analyzer_virusreport: bypass_validation: 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_analyzer_virusreport: 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_pkg_firewall_localinpolicy – Configure user defined IPv4 local-in policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_localinpolicy – Configure user defined IPv4 local-in 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_localinpolicy`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_localinpolicy dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* deny * accept \| Action performed on traffic matching the policy (default = deny). \| \| \| comments string \| \| Comment. \| \| \| dstaddr string \| \| Destination address object from available options. \| \| \| dstaddr-negate string \| Choices:* disable * enable \| When enabled dstaddr specifies what the destination address must NOT be. \| \| \| ha-mgmt-intf-only string \| Choices:* disable * enable \| Enable/disable dedicating the HA management interface only for local-in policy. \| \| \| intf string \| \| Incoming interface name from available options. \| \| \| policyid integer \| \| User defined local in policy ID. \| \| \| schedule string \| \| Schedule object from available options. \| \| \| service string \| \| Service object from available options. \| \| \| service-negate string \| Choices:* disable * enable \| When enabled service specifies what the service must NOT be. \| \| \| srcaddr string \| \| Source address object from available options. \| \| \| srcaddr-negate string \| Choices:* disable * enable \| When enabled srcaddr specifies what the source address must NOT be. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this local-in 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 user defined IPv4 local-in policies. fmgr_pkg_firewall_localinpolicy: bypass_validation: False workspace_locking_adom: <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_localinpolicy: action: <value in [deny, accept]> dstaddr: <value of string> ha-mgmt-intf-only: <value in [disable, enable]> intf: <value of string> policyid: <value of integer> schedule: <value of string> service: <value of string> srcaddr: <value of string> status: <value in [disable, enable]> comments: <value of string> uuid: <value of string> dstaddr-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_pm_config_reset_database – Reset Global ADOM to a specific version. fortinet.fortimanager.fmgr\_pm\_config\_reset\_database – Reset Global ADOM to a specific 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_reset_database`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_reset\_database dictionary \| \| the top level parameters set \| \| \| mr integer \| \| no description \| \| \| version integer \| \| Integer major release value (eg. 500 or 5). \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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: Reset Global ADOM to a specific version. fmgr_pm_config_reset_database: bypass_validation: 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_reset_database: mr: <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_spamfilter_bwl_entries – Anti-spam black/white list entries. fortinet.fortimanager.fmgr\_spamfilter\_bwl\_entries – Anti-spam black/white list 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_spamfilter_bwl_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 \| \| bwl string / required \| \| the parameter (bwl) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_bwl\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* spam * clear * reject \| Reject, mark as spam or good email. \| \| \| addr-type string \| Choices:* ipv4 * ipv6 \| IP address type. \| \| \| email-pattern string \| \| Email address pattern. \| \| \| id integer \| \| Entry ID. \| \| \| ip4-subnet string \| \| IPv4 network address/subnet mask bits. \| \| \| ip6-subnet string \| \| IPv6 network address/subnet mask bits. \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| type string \| Choices:* ip * email \| Entry type. \| \| 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: Anti-spam black/white list entries. fmgr_spamfilter_bwl_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> bwl: <your own value> state: <value in [present, absent]> spamfilter_bwl_entries: action: <value in [spam, clear, reject]> addr-type: <value in [ipv4, ipv6]> email-pattern: <value of string> id: <value of integer> ip4-subnet: <value of string> ip6-subnet: <value of string> pattern-type: <value in [wildcard, regexp]> status: <value in [disable, enable]> type: <value in [ip, email]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_notification_entries – modify this antivirus notification list fortinet.fortimanager.fmgr\_antivirus\_notification\_entries – modify this antivirus notification 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_antivirus_notification_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 \| \| antivirus\_notification\_entries dictionary \| \| the top level parameters set \| \| \| name string \| \| virus name or prefix \| \| \| prefix string \| Choices:* disable * enable \| enable prefix matches based on this name \| \| \| status string \| Choices:* disable * enable \| enable this entry for notifications \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| notification string / required \| \| the parameter (notification) 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: modify this antivirus notification list fmgr_antivirus_notification_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> notification: <your own value> state: <value in [present, absent]> antivirus_notification_entries: name: <value of string> prefix: <value in [disable, enable]> 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_fips – Settings for FIPS-CC mode. fortinet.fortimanager.fmgr\_system\_fips – Settings for FIPS-CC 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_system_fips`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_fips dictionary \| \| the top level parameters set \| \| \| entropy-token string \| Choices:* enable ← * disable * dynamic \| Enable/disable entropy token when switching to FIPS mode. enable - Enable entropy token. disable - Disable entropy token. dynamic - Dynamically detect entropy token during bootup. \| \| \| re-seed-interval integer \| Default:1440 \| Kernel FIPS-compliant PRNG re-seed interval (0 to 1440 minutes) \| \| \| status string \| Choices:* disable ← * enable \| Enable/disable FIPS-CC mode. disable - Disable FIPS-CC mode. enable - Enable FIPS-CC 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: Settings for FIPS-CC mode. fmgr_system_fips: bypass_validation: 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_fips: entropy-token: <value in [enable, disable, dynamic]> re-seed-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_dvm_cmd_discover_device – Probe a remote device and retrieve its device information and system status. fortinet.fortimanager.fmgr\_dvm\_cmd\_discover\_device – Probe a remote device and retrieve its device information and system 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_dvm_cmd_discover_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\_discover\_device dictionary \| \| the top level parameters set \| \| \| device dictionary \| \| no description \| \| \| \| adm\_pass string \| \| no description \| \| \| \| adm\_usr string \| \| no description \| \| \| \| ip 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: Probe a remote device and retrieve its device information and system status. fmgr_dvm_cmd_discover_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_discover_device: device: adm_pass: <value of string> adm_usr: <value of string> 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_header_policy6 – Configure IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_header\_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_header_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\_header\_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_header_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_header_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_log_ratelimit_device – Device log rate limit. fortinet.fortimanager.fmgr\_system\_log\_ratelimit\_device – Device log 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_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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\_device dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 log rate limit. fmgr_system_log_ratelimit_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, ...] state: <value in [present, absent]> system_log_ratelimit_device: device: <value of string> filter-type: <value in [devid]> id: <value of integer> 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_firewall_vip_sslciphersuites – SSL/TLS cipher suites acceptable from a client, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_vip\_sslciphersuites – SSL/TLS cipher suites acceptable from a client, 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_vip_sslciphersuites`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sslciphersuites 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. \| \| \| id integer \| \| no description \| \| \| priority integer \| \| SSL/TLS cipher suites priority. \| \| \| versions list / elements=string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: SSL/TLS cipher suites acceptable from a client, ordered by priority. fmgr_firewall_vip_sslciphersuites: bypass_validation: False workspace_locking_adom: <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_sslciphersuites: cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> id: <value of integer> versions: - ssl-3.0 - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 priority: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_workflow_approvalmatrix_approver – Approver. fortinet.fortimanager.fmgr\_system\_workflow\_approvalmatrix\_approver – Approver. ================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_workflow_approvalmatrix_approver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| approval-matrix string / required \| \| the parameter (approval-matrix) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_workflow\_approvalmatrix\_approver dictionary \| \| the top level parameters set \| \| \| member string \| \| Member of approver. \| \| \| 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: Approver. fmgr_system_workflow_approvalmatrix_approver: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] approval-matrix: <your own value> state: <value in [present, absent]> system_workflow_approvalmatrix_approver: member: <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_fmupdate_fdssetting_pushoverridetoclient_announceip – Announce IP addresses for the device. fortinet.fortimanager.fmgr\_fmupdate\_fdssetting\_pushoverridetoclient\_announceip – Announce IP addresses for the 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_fmupdate_fdssetting_pushoverridetoclient_announceip`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_pushoverridetoclient\_announceip dictionary \| \| the top level parameters set \| \| \| id integer \| Default:0 \| ID of the announce IP address (1 - 10). \| \| \| ip string \| Default:"0.0.0.0" \| Announce IPv4 address. \| \| \| port integer \| Default:8890 \| Announce IP port (1 - 65535, default = 8890). \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Announce IP addresses for the device. fmgr_fmupdate_fdssetting_pushoverridetoclient_announceip: bypass_validation: 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_pushoverridetoclient_announceip: id: <value of integer> ip: <value of string> 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_switchcontroller_managedswitch_snmptrapthreshold – Configuration method to edit Simple Network Management Protocol fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_snmptrapthreshold – Configuration method to edit Simple Network Management Protocol ================================================================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmptrapthreshold`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_snmptrapthreshold dictionary \| \| the top level parameters set \| \| \| trap-high-cpu-threshold integer \| \| CPU usage when trap is sent. \| \| \| trap-log-full-threshold integer \| \| Log disk usage when trap is sent. \| \| \| trap-low-memory-threshold integer \| \| Memory usage when trap is sent. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configuration method to edit Simple Network Management Protocol fmgr_switchcontroller_managedswitch_snmptrapthreshold: bypass_validation: False workspace_locking_adom: <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> switchcontroller_managedswitch_snmptrapthreshold: trap-high-cpu-threshold: <value of integer> trap-log-full-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_system_log_settings – Log settings. fortinet.fortimanager.fmgr\_system\_log\_settings – Log settings. ================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_log_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 \| \| 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\_settings dictionary \| \| the top level parameters set \| \| \| browse-max-logfiles integer \| Default:10000 \| Maximum number of log files for each log browse attempt for each Adom. \| \| \| dns-resolve-dstip string \| Choices:* disable ← * enable \| Enable/Disable resolving destination IP by DNS. disable - Disable resolving destination IP by DNS. enable - Enable resolving destination IP by DNS. \| \| \| download-max-logs integer \| Default:500000 \| Maximum number of logs for each log download attempt. \| \| \| FAC-custom-field1 string \| \| Name of custom log field to index. \| \| \| FAZ-custom-field1 string \| \| Name of custom log field to index. \| \| \| FCH-custom-field1 string \| \| Name of custom log field to index. \| \| \| FCT-custom-field1 string \| \| Name of custom log field to index. \| \| \| FDD-custom-field1 string \| \| Name of custom log field to index. \| \| \| FGT-custom-field1 string \| \| Name of custom log field to index. \| \| \| FMG-custom-field1 string \| \| Name of custom log field to index. \| \| \| FML-custom-field1 string \| \| Name of custom log field to index. \| \| \| FPX-custom-field1 string \| \| Name of custom log field to index. \| \| \| FSA-custom-field1 string \| \| Name of custom log field to index. \| \| \| FWB-custom-field1 string \| \| Name of custom log field to index. \| \| \| ha-auto-migrate string \| Choices:* disable ← * enable \| Enabled/Disable automatically merging HA members logs to HA cluster. disable - Disable automatically merging HA members logs to HA cluster. enable - Enable automatically merging HA members logs to HA cluster. \| \| \| import-max-logfiles integer \| Default:10000 \| Maximum number of log files for each log import attempt. \| \| \| log-file-archive-name string \| Choices:* basic ← * extended \| Log file name format for archiving, such as backup, upload or download. basic - Basic format for log archive file name, e.g. FGT20C0000000001.tlog.1417797247.log. extended - Extended format for log archive file name, e.g. FGT20C0000000001.2014-12-05-08:34:58.tlog.1417797247.log. \| \| \| rolling-analyzer dictionary \| \| no description \| \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| \| password string \| \| no description \| \| \| \| password2 string \| \| no description \| \| \| \| password3 string \| \| no description \| \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| \| username string \| \| Upload server login username. \| \| \| \| username2 string \| \| Upload server login username2. \| \| \| \| username3 string \| \| Upload server login username3. \| \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| \| rolling-local dictionary \| \| no description \| \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| \| password string \| \| no description \| \| \| \| password2 string \| \| no description \| \| \| \| password3 string \| \| no description \| \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| \| username string \| \| Upload server login username. \| \| \| \| username2 string \| \| Upload server login username2. \| \| \| \| username3 string \| \| Upload server login username3. \| \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| \| rolling-regular dictionary \| \| no description \| \| \| \| days list / elements=string \| Choices:* sun * mon * tue * wed * thu * fri * sat \| no description \| \| \| \| del-files string \| Choices:* disable ← * enable \| Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. \| \| \| \| directory string \| \| Upload server directory, for Unix server, use absolute \| \| \| \| file-size integer \| Default:200 \| Roll log files when they reach this size (MB). \| \| \| \| gzip-format string \| Choices:* disable ← * enable \| Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. \| \| \| \| hour integer \| Default:0 \| Log files rolling schedule (hour). \| \| \| \| ip string \| Default:"0.0.0.0" \| Upload server IP address. \| \| \| \| ip2 string \| Default:"0.0.0.0" \| Upload server IP2 address. \| \| \| \| ip3 string \| Default:"0.0.0.0" \| Upload server IP3 address. \| \| \| \| log-format string \| Choices:* native ← * text * csv \| Format of uploaded log files. native - Native format (text or compact). text - Text format (convert if necessary). csv - CSV (comma-separated value) format. \| \| \| \| min integer \| Default:0 \| Log files rolling schedule (minutes). \| \| \| \| password string \| \| no description \| \| \| \| password2 string \| \| no description \| \| \| \| password3 string \| \| no description \| \| \| \| port integer \| Default:0 \| Upload server IP1 port number. \| \| \| \| port2 integer \| Default:0 \| Upload server IP2 port number. \| \| \| \| port3 integer \| Default:0 \| Upload server IP3 port number. \| \| \| \| server-type string \| Choices:* ftp ← * sftp * scp \| Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. \| \| \| \| upload string \| Choices:* disable ← * enable \| Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. \| \| \| \| upload-hour integer \| Default:0 \| Log files upload schedule (hour). \| \| \| \| upload-mode string \| Choices:* backup ← * mirror \| Upload mode with multiple servers. backup - Servers are attempted and used one after the other upon failure to connect. mirror - All configured servers are attempted and used. \| \| \| \| upload-trigger string \| Choices:* on-roll ← * on-schedule \| Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. \| \| \| \| username string \| \| Upload server login username. \| \| \| \| username2 string \| \| Upload server login username2. \| \| \| \| username3 string \| \| Upload server login username3. \| \| \| \| when string \| Choices:* none ← * daily * weekly \| Roll log files periodically. none - Do not roll log files periodically. daily - Roll log files daily. weekly - Roll log files on certain days of week. \| \| \| sync-search-timeout integer \| Default:60 \| Maximum number of seconds for running a log search session in synchronous 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: Log settings. fmgr_system_log_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, ...] system_log_settings: FAC-custom-field1: <value of string> FAZ-custom-field1: <value of string> FCH-custom-field1: <value of string> FCT-custom-field1: <value of string> FDD-custom-field1: <value of string> FGT-custom-field1: <value of string> FMG-custom-field1: <value of string> FML-custom-field1: <value of string> FPX-custom-field1: <value of string> FSA-custom-field1: <value of string> FWB-custom-field1: <value of string> browse-max-logfiles: <value of integer> dns-resolve-dstip: <value in [disable, enable]> download-max-logs: <value of integer> ha-auto-migrate: <value in [disable, enable]> import-max-logfiles: <value of integer> log-file-archive-name: <value in [basic, extended]> rolling-analyzer: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <value of integer> rolling-local: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <value of integer> rolling-regular: days: - sun - mon - tue - wed - thu - fri - sat del-files: <value in [disable, enable]> directory: <value of string> file-size: <value of integer> gzip-format: <value in [disable, enable]> hour: <value of integer> ip: <value of string> ip2: <value of string> ip3: <value of string> log-format: <value in [native, text, csv]> min: <value of integer> password: <value of string> password2: <value of string> password3: <value of string> server-type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload-hour: <value of integer> upload-mode: <value in [backup, mirror]> upload-trigger: <value in [on-roll, on-schedule]> username: <value of string> username2: <value of string> username3: <value of string> when: <value in [none, daily, weekly]> port: <value of integer> port2: <value of integer> port3: <value of integer> sync-search-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)	programming_docs
ansible fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist – Retrieve a list of devices. fortinet.fortimanager.fmgr\_dvm\_cmd\_reload\_devlist – Retrieve 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_reload_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\_reload\_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 \| \| \| from string \| Choices:* um * fgfm * apache * dvm * fwm * xml * json ← \| no description \| \| \| reload-dev-member-list list / elements=string \| \| no description \| \| \| \| name string \| \| no description \| \| \| \| vdom string \| \| no description \| \| \| tag string \| \| Revision name for the retrieved configuration. \| \| 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: Retrieve a list of devices. fmgr_dvm_cmd_reload_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_reload_devlist: adom: <value of string> flags: - none - create_task - nonblocking - log_dev from: <value in [um, fgfm, apache, ...]> reload-dev-member-list: - name: <value of string> vdom: <value of string> 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_webfilter_profile_antiphish_inspectionentries – AntiPhishing entries. fortinet.fortimanager.fmgr\_webfilter\_profile\_antiphish\_inspectionentries – AntiPhishing 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_profile_antiphish_inspectionentries`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_inspectionentries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* log * block * exempt \| Action to be taken upon an AntiPhishing match. \| \| \| fortiguard-category string \| \| no description \| \| \| name string \| \| Inspection target 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: AntiPhishing entries. fmgr_webfilter_profile_antiphish_inspectionentries: bypass_validation: False workspace_locking_adom: <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_antiphish_inspectionentries: action: <value in [log, block, exempt]> fortiguard-category: <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_radius_dynamicmapping – Configure RADIUS server entries. fortinet.fortimanager.fmgr\_user\_radius\_dynamicmapping – 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_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 \| \| 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 dictionary \| \| the top level parameters set \| \| \| \_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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> radius: <your own value> state: <value in [present, absent]> user_radius_dynamicmapping: _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 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_vip6_realservers – Select the real servers that this server load balancing VIP will distribute traffic to. fortinet.fortimanager.fmgr\_firewall\_vip6\_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_vip6_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\_vip6\_realservers dictionary \| \| the top level parameters set \| \| \| client-ip string \| \| Only clients in this IP range can connect to this real server. \| \| \| healthcheck string \| Choices:* disable * enable * vip \| Enable to check the responsiveness of the real server before forwarding traffic. \| \| \| holddown-interval integer \| \| Time in seconds that the health check monitor continues to monitor an unresponsive server that should be active. \| \| \| http-host string \| \| HTTP server domain name in HTTP header. \| \| \| id integer \| \| Real server ID. \| \| \| ip string \| \| IPv6 address of the real server. \| \| \| max-connections integer \| \| Max number of active connections that can directed to the real server. When reached, sessions are sent to other real servers. \| \| \| monitor string \| \| Name of the health check monitor to use when polling to determine a virtual servers connectivity status. \| \| \| port integer \| \| Port for communicating with the real server. Required if port forwarding is enabled. \| \| \| status string \| Choices:* active * standby * disable \| Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. \| \| \| weight integer \| \| Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Select the real servers that this server load balancing VIP will distribute traffic to. fmgr_firewall_vip6_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> vip6: <your own value> state: <value in [present, absent]> firewall_vip6_realservers: client-ip: <value of string> healthcheck: <value in [disable, enable, vip]> holddown-interval: <value of integer> http-host: <value of string> 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_user_tacacs – Configure TACACS+ server entries. fortinet.fortimanager.fmgr\_user\_tacacs – Configure TACACS+ 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_tacacs`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_tacacs dictionary \| \| the top level parameters set \| \| \| authen-type string \| Choices:* auto * ascii * pap * chap * mschap \| Allowed authentication protocols/methods. \| \| \| authorization string \| Choices:* disable * enable \| Enable/disable TACACS+ authorization. \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_scope list / elements=string \| \| no description \| \| \| \| \| name string \| \| no description \| \| \| \| \| vdom string \| \| no description \| \| \| \| authen-type string \| Choices:* auto * ascii * pap * chap * mschap \| no description \| \| \| \| authorization string \| Choices:* disable * enable \| no description \| \| \| \| interface string \| \| no description \| \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| no description \| \| \| \| key string \| \| no description \| \| \| \| port integer \| \| no description \| \| \| \| secondary-key string \| \| no description \| \| \| \| secondary-server string \| \| no description \| \| \| \| server string \| \| no description \| \| \| \| source-ip string \| \| no description \| \| \| \| tertiary-key string \| \| no description \| \| \| \| tertiary-server string \| \| no description \| \| \| interface string \| \| Specify outgoing interface to reach server. \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| Specify how to select outgoing interface to reach server. \| \| \| key string \| \| no description \| \| \| name string \| \| TACACS+ server entry name. \| \| \| port integer \| \| Port number of the TACACS+ server. \| \| \| secondary-key string \| \| no description \| \| \| secondary-server string \| \| Secondary TACACS+ server CN domain name or IP address. \| \| \| server string \| \| Primary TACACS+ server CN domain name or IP address. \| \| \| source-ip string \| \| source IP for communications to TACACS+ server. \| \| \| tertiary-key string \| \| no description \| \| \| tertiary-server string \| \| Tertiary TACACS+ server CN domain name or IP 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 TACACS+ server entries. fmgr_user_tacacs: bypass_validation: False workspace_locking_adom: <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_tacacs: authen-type: <value in [auto, ascii, pap, ...]> authorization: <value in [disable, enable]> dynamic_mapping: - _scope: - name: <value of string> vdom: <value of string> authen-type: <value in [auto, ascii, pap, ...]> authorization: <value in [disable, enable]> key: <value of string> port: <value of integer> secondary-key: <value of string> secondary-server: <value of string> server: <value of string> source-ip: <value of string> tertiary-key: <value of string> tertiary-server: <value of string> interface: <value of string> interface-select-method: <value in [auto, sdwan, specify]> key: <value of string> name: <value of string> port: <value of integer> secondary-key: <value of string> secondary-server: <value of string> server: <value of string> source-ip: <value of string> tertiary-key: <value of string> tertiary-server: <value of string> 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_emailfilter_profile_pop3 – POP3. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_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. \| \| \| 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: POP3. fmgr_emailfilter_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> emailfilter_profile_pop3: action: <value in [pass, tag]> 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_emailfilter_profile_filefilter – File filter. fortinet.fortimanager.fmgr\_emailfilter\_profile\_filefilter – File 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_emailfilter_profile_filefilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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 dictionary \| \| the top level parameters set \| \| \| entries list / elements=string \| \| no description \| \| \| \| 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 \| \| \| log string \| Choices:* disable * enable \| Enable/disable file filter logging. \| \| \| scan-archive-contents string \| Choices:* disable * enable \| Enable/disable file filter archive contents scan. \| \| \| status string \| Choices:* disable * enable \| Enable/disable file filter. \| \| 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. fmgr_emailfilter_profile_filefilter: bypass_validation: False workspace_locking_adom: <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_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 log: <value in [disable, enable]> scan-archive-contents: <value in [disable, enable]> 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_vip64_dynamicmapping – Configure IPv6 to IPv4 virtual IPs. fortinet.fortimanager.fmgr\_firewall\_vip64\_dynamicmapping – 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_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\_vip64\_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 \| \| \| 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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Configure IPv6 to IPv4 virtual IPs. fmgr_firewall_vip64_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> vip64: <your own value> state: <value in [present, absent]> firewall_vip64_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> 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_notification – Configure AntiVirus notification lists. fortinet.fortimanager.fmgr\_antivirus\_notification – Configure AntiVirus notification 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_antivirus_notification`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values 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\_notification dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| name string \| \| virus name or prefix \| \| \| \| prefix string \| Choices:* disable * enable \| enable prefix matches based on this name \| \| \| \| status string \| Choices:* disable * enable \| enable this entry for notifications \| \| \| id integer \| \| ID. \| \| \| name string \| \| Name of table. \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 notification lists. fmgr_antivirus_notification: bypass_validation: False workspace_locking_adom: <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_notification: comment: <value of string> entries: - name: <value of string> prefix: <value in [disable, enable]> 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_waf_profile_constraint_malformed – Enable/disable malformed HTTP request check. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_malformed – Enable/disable malformed HTTP request 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_malformed`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_malformed 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 malformed HTTP request check. fmgr_waf_profile_constraint_malformed: bypass_validation: False workspace_locking_adom: <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_malformed: 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_vap_portalmessageoverrides – Individual message overrides. fortinet.fortimanager.fmgr\_vap\_portalmessageoverrides – Individual message overrides. ======================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_portalmessageoverrides`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_portalmessageoverrides dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Individual message overrides. fmgr_vap_portalmessageoverrides: bypass_validation: False workspace_locking_adom: <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> vap_portalmessageoverrides: 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_multilayer – Configure multilayer mode. fortinet.fortimanager.fmgr\_fmupdate\_multilayer – Configure multilayer 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_fmupdate_multilayer`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_multilayer dictionary \| \| the top level parameters set \| \| \| webspam-rating string \| Choices:* disable * enable ← \| Enable/disable URL/Antispam rating service (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 multilayer mode. fmgr_fmupdate_multilayer: bypass_validation: 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_multilayer: webspam-rating: <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_api_sdnconnector – Query SDN connector data. fortinet.fortimanager.fmgr\_sys\_api\_sdnconnector – Query SDN connector data. ============================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_sys_api_sdnconnector`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_api\_sdnconnector dictionary \| \| the top level parameters set \| \| \| adom string \| \| ADOM name. \| \| \| command string \| \| For ACI and Nuage connector only, can be either egps or tenants. \| \| \| connector\_name string \| \| Connector object in ADOM to be queried. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Query SDN connector data. fmgr_sys_api_sdnconnector: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] sys_api_sdnconnector: adom: <value of string> command: <value of string> connector_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_vpnsslweb_portal_bookmarkgroup – Portal bookmark group. fortinet.fortimanager.fmgr\_vpnsslweb\_portal\_bookmarkgroup – Portal bookmark 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_vpnsslweb_portal_bookmarkgroup`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| bookmarks list / elements=string \| \| no description \| \| \| \| 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. \| \| \| name string \| \| Bookmark 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: Portal bookmark group. fmgr_vpnsslweb_portal_bookmarkgroup: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> portal: <your own value> state: <value in [present, absent]> vpnsslweb_portal_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> 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_bonjourprofile – Configure Bonjour profiles. fortinet.fortimanager.fmgr\_bonjourprofile – Configure Bonjour 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_bonjourprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bonjourprofile dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| name string \| \| Bonjour profile name. \| \| \| policy-list list / elements=string \| \| no description \| \| \| \| 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: Configure Bonjour profiles. fmgr_bonjourprofile: bypass_validation: False workspace_locking_adom: <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]> bonjourprofile: comment: <value of string> name: <value of string> policy-list: - 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)	programming_docs
ansible fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange – Port ranges in the custom entry. fortinet.fortimanager.fmgr\_firewall\_internetservicecustom\_entry\_portrange – Port ranges in the custom entry. ================================================================================================================ Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| entry string / required \| \| the parameter (entry) in requested url \| \| firewall\_internetservicecustom\_entry\_portrange dictionary \| \| the top level parameters set \| \| \| end-port integer \| \| Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535). \| \| \| id integer \| \| Custom entry port range ID. \| \| \| start-port integer \| \| Integer value for starting TCP/UDP/SCTP destination port in range (1 to 65535). \| \| internet-service-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: Port ranges in the custom entry. fmgr_firewall_internetservicecustom_entry_portrange: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> internet-service-custom: <your own value> entry: <your own value> state: <value in [present, absent]> firewall_internetservicecustom_entry_portrange: end-port: <value of integer> id: <value of integer> start-port: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_wtpprofile_lbs – Set various location based service fortinet.fortimanager.fmgr\_wtpprofile\_lbs – Set various location based 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_wtpprofile_lbs`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_lbs dictionary \| \| the top level parameters set \| \| \| aeroscout string \| Choices:* disable * enable \| Enable/disable AeroScout Real Time Location Service (RTLS) support. \| \| \| aeroscout-ap-mac string \| Choices:* bssid * board-mac \| Use BSSID or board MAC address as AP MAC address in the Aeroscout AP message. \| \| \| aeroscout-mmu-report string \| Choices:* disable * enable \| Enable/disable MU compounded report. \| \| \| aeroscout-mu string \| Choices:* disable * enable \| Enable/disable AeroScout support. \| \| \| aeroscout-mu-factor integer \| \| AeroScout Mobile Unit (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 Ekahua blink mode (also called AiRISTA Flow Blink Mode) to find the location of devices connected to a wireless... \| \| \| ekahau-tag string \| \| WiFi frame MAC address or WiFi Tag. \| \| \| erc-server-ip string \| \| IP address of Ekahua RTLS Controller (ERC). \| \| \| erc-server-port integer \| \| Ekahua 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 WiFi netwo... \| \| \| 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). \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 various location based service fmgr_wtpprofile_lbs: bypass_validation: False workspace_locking_adom: <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_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-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]> fortipresence-ble: <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_serveroverridestatus – Configure strict/loose server override. fortinet.fortimanager.fmgr\_fmupdate\_serveroverridestatus – Configure strict/loose server override. ==================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_serveroverridestatus`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_serveroverridestatus dictionary \| \| the top level parameters set \| \| \| mode string \| Choices:* strict * loose ← \| Server override mode (default = loose). strict - Access override server only. loose - Allow access other servers. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 strict/loose server override. fmgr_fmupdate_serveroverridestatus: bypass_validation: 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_serveroverridestatus: mode: <value in [strict, loose]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_securitypolicy_8021x – Configure 802. fortinet.fortimanager.fmgr\_switchcontroller\_securitypolicy\_8021x – Configure 802. ==================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_securitypolicy_8021x`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_securitypolicy\_8021x dictionary \| \| the top level parameters set \| \| \| auth-fail-vlan string \| Choices:* disable * enable \| Enable to allow limited access to clients that cannot authenticate. \| \| \| auth-fail-vlan-id string \| \| VLAN ID on which authentication failed. \| \| \| auth-fail-vlanid integer \| \| VLAN ID on which authentication failed. \| \| \| authserver-timeout-period integer \| \| Authentication server timeout period (3 - 15 sec, default = 3). \| \| \| authserver-timeout-vlan string \| Choices:* disable * enable \| Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. \| \| \| authserver-timeout-vlanid string \| \| Authentication server timeout VLAN name. \| \| \| eap-auto-untagged-vlans string \| Choices:* disable * enable \| Enable/disable automatic inclusion of untagged VLANs. \| \| \| eap-passthru string \| Choices:* disable * enable \| Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication. \| \| \| framevid-apply string \| Choices:* disable * enable \| Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. \| \| \| guest-auth-delay integer \| \| Guest authentication delay (1 - 900 sec, default = 30). \| \| \| guest-vlan string \| Choices:* disable * enable \| Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients. \| \| \| guest-vlan-id string \| \| Guest VLAN name. \| \| \| guest-vlanid integer \| \| Guest VLAN ID. \| \| \| mac-auth-bypass string \| Choices:* disable * enable \| Enable/disable MAB for this policy. \| \| \| name string \| \| Policy name. \| \| \| open-auth string \| Choices:* disable * enable \| Enable/disable open authentication for this policy. \| \| \| policy-type string \| Choices:* 802.1X \| Policy type. \| \| \| radius-timeout-overwrite string \| Choices:* disable * enable \| Enable to override the global RADIUS session timeout. \| \| \| security-mode string \| Choices:* 802.1X * 802.1X-mac-based \| Port or MAC based 802.1X security mode. \| \| \| user-group string \| \| Name of user-group to assign to this MAC Authentication Bypass (MAB) 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: Configure 802. fmgr_switchcontroller_securitypolicy_8021x: bypass_validation: False workspace_locking_adom: <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_securitypolicy_8021x: auth-fail-vlan: <value in [disable, enable]> auth-fail-vlan-id: <value of string> auth-fail-vlanid: <value of integer> eap-passthru: <value in [disable, enable]> guest-auth-delay: <value of integer> guest-vlan: <value in [disable, enable]> guest-vlan-id: <value of string> guest-vlanid: <value of integer> mac-auth-bypass: <value in [disable, enable]> name: <value of string> open-auth: <value in [disable, enable]> policy-type: <value in [802.1X]> radius-timeout-overwrite: <value in [disable, enable]> security-mode: <value in [802.1X, 802.1X-mac-based]> user-group: <value of string> framevid-apply: <value in [disable, enable]> eap-auto-untagged-vlans: <value in [disable, enable]> authserver-timeout-period: <value of integer> authserver-timeout-vlan: <value in [disable, enable]> authserver-timeout-vlanid: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu)	programming_docs
ansible fortinet.fortimanager.fmgr_antivirus_profile_ssh – Configure SFTP and SCP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_ssh – Configure SFTP and SCP 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_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 \| \| antivirus\_profile\_ssh 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:* 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 \| \| 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 SFTP and SCP AntiVirus options. fmgr_antivirus_profile_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: <your own value> antivirus_profile_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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_devicedisable – Disable client device logging. fortinet.fortimanager.fmgr\_system\_log\_devicedisable – Disable client device 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_log_devicedisable`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_devicedisable dictionary \| \| the top level parameters set \| \| \| device string \| \| Device to be disabled logging \| \| \| id integer \| Default:0 \| ID of device logging disable entry. \| \| \| TTL string \| \| Time to Live \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Disable client device logging. fmgr_system_log_devicedisable: bypass_validation: 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_devicedisable: TTL: <value of string> device: <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_gtp_messageratelimitv0 – Message rate limiting for GTP version 0. fortinet.fortimanager.fmgr\_firewall\_gtp\_messageratelimitv0 – Message rate limiting for GTP version 0. ======================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_messageratelimitv0`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_messageratelimitv0 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 0. fmgr_firewall_gtp_messageratelimitv0: bypass_validation: False workspace_locking_adom: <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_messageratelimitv0: 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_service_custom – Configure custom services. fortinet.fortimanager.fmgr\_firewall\_service\_custom – Configure custom 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_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 \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_custom dictionary \| \| the top level parameters set \| \| \| app-category integer \| \| no description \| \| \| app-service-type string \| Choices:* disable * app-id * app-category \| Application service type. \| \| \| application integer \| \| no description \| \| \| category string \| \| Service category. \| \| \| check-reset-range string \| Choices:* disable * default * strict \| Configure the type of ICMP error message verification. \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| comment string \| \| no description \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| fqdn string \| \| Fully qualified domain name. \| \| \| global-object integer \| \| Global Object. \| \| \| helper string \| Choices:* disable * auto * ftp * tftp * ras * h323 * tns * mms * sip * pptp * rtsp * dns-udp * dns-tcp * pmap * rsh * dcerpc * mgcp * gtp-c * gtp-u * gtp-b \| Helper name. \| \| \| icmpcode integer \| \| ICMP code. \| \| \| icmptype integer \| \| ICMP type. \| \| \| iprange string \| \| Start and end of the IP range associated with service. \| \| \| name string \| \| Custom service name. \| \| \| protocol string \| Choices:* ICMP * IP * TCP/UDP/SCTP * ICMP6 * HTTP * FTP * CONNECT * SOCKS * ALL * SOCKS-TCP * SOCKS-UDP \| Protocol type based on IANA numbers. \| \| \| protocol-number integer \| \| IP protocol number. \| \| \| proxy string \| Choices:* disable * enable \| Enable/disable web proxy service. \| \| \| sctp-portrange string \| \| Multiple SCTP port ranges. \| \| \| session-ttl integer \| \| Session TTL (300 - 604800, 0 = default). \| \| \| tcp-halfclose-timer integer \| \| Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). \| \| \| tcp-halfopen-timer integer \| \| Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). \| \| \| tcp-portrange string \| \| Multiple TCP port ranges. \| \| \| tcp-rst-timer integer \| \| Set the length of the TCP CLOSE state in seconds (5 - 300 sec, 0 = default). \| \| \| tcp-timewait-timer integer \| \| Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). \| \| \| udp-idle-timer integer \| \| UDP half close timeout (0 - 86400 sec, 0 = default). \| \| \| udp-portrange string \| \| Multiple UDP port ranges. \| \| \| visibility string \| Choices:* disable * enable \| Enable/disable the visibility of the service 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 custom services. fmgr_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, ...] adom: <your own value> state: <value in [present, absent]> firewall_service_custom: app-category: <value of integer> app-service-type: <value in [disable, app-id, app-category]> application: <value of integer> category: <value of string> check-reset-range: <value in [disable, default, strict]> color: <value of integer> comment: <value of string> fqdn: <value of string> helper: <value in [disable, auto, ftp, ...]> icmpcode: <value of integer> icmptype: <value of integer> iprange: <value of string> name: <value of string> protocol: <value in [ICMP, IP, TCP/UDP/SCTP, ...]> protocol-number: <value of integer> proxy: <value in [disable, enable]> sctp-portrange: <value of string> session-ttl: <value of integer> tcp-halfclose-timer: <value of integer> tcp-halfopen-timer: <value of integer> tcp-portrange: <value of string> tcp-timewait-timer: <value of integer> udp-idle-timer: <value of integer> udp-portrange: <value of string> visibility: <value in [disable, enable]> global-object: <value of integer> fabric-object: <value in [disable, enable]> tcp-rst-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)	programming_docs
ansible fortinet.fortimanager.fmgr_wanopt_profile_mapi – Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features. fortinet.fortimanager.fmgr\_wanopt\_profile\_mapi – Enable/disable MAPI email WAN Optimization and configure MAPI 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_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 \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| wanopt\_profile\_mapi 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 \| \| \| 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 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 MAPI email WAN Optimization and configure MAPI WAN Optimization features. fmgr_wanopt_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> wanopt_profile_mapi: byte-caching: <value in [disable, enable]> log-traffic: <value in [disable, enable]> port: <value of integer> secure-tunnel: <value in [disable, enable]> 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) ansible fortinet.fortimanager.fmgr_wtpprofile_lan – WTP LAN port mapping. fortinet.fortimanager.fmgr\_wtpprofile\_lan – WTP LAN port mapping. =================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_lan`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_lan dictionary \| \| the top level parameters set \| \| \| 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. \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 LAN port mapping. fmgr_wtpprofile_lan: bypass_validation: False workspace_locking_adom: <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_lan: 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> port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]> port-esl-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) ansible fortinet.fortimanager.fmgr_system_dhcp_server_iprange – DHCP IP range configuration. fortinet.fortimanager.fmgr\_system\_dhcp\_server\_iprange – DHCP IP range 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_dhcp_server_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| server string / required \| \| the parameter (server) in requested url \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| system\_dhcp\_server\_iprange dictionary \| \| the top level parameters set \| \| \| end-ip string \| \| End of IP range. \| \| \| id integer \| \| ID. \| \| \| start-ip string \| \| Start of IP range. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: DHCP IP range configuration. fmgr_system_dhcp_server_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> server: <your own value> state: <value in [present, absent]> system_dhcp_server_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_pkg_firewall_consolidated_policy_sectionvalue – Configure consolidated IPv4/IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_consolidated\_policy\_sectionvalue – 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_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\_consolidated\_policy\_sectionvalue 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. \| \| 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 consolidated IPv4/IPv6 policies. fmgr_pkg_firewall_consolidated_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_consolidated_policy_sectionvalue: 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)	programming_docs
ansible fortinet.fortimanager.fmgr_waf_profile_constraint_contentlength – HTTP content length in request. fortinet.fortimanager.fmgr\_waf\_profile\_constraint\_contentlength – HTTP content length in request. ===================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_contentlength`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_contentlength dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 content length in request. fmgr_waf_profile_constraint_contentlength: bypass_validation: False workspace_locking_adom: <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_contentlength: 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_user_exchange – Configure MS Exchange server entries. fortinet.fortimanager.fmgr\_user\_exchange – Configure MS Exchange 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_exchange`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_exchange dictionary \| \| the top level parameters set \| \| \| addr-type string \| Choices:* ipv4 * ipv6 \| Indicate whether the server IP-address is IPv4 or IPv6. \| \| \| auth-level string \| Choices:* low * medium * normal * high * connect * call * packet * integrity * privacy \| Authentication security level used for the RPC protocol layer. \| \| \| auth-type string \| Choices:* spnego * ntlm * kerberos \| Authentication security type used for the RPC protocol layer. \| \| \| auto-discover-kdc string \| Choices:* disable * enable \| Enable/disable automatic discovery of KDC IP addresses. \| \| \| connect-protocol string \| Choices:* rpc-over-tcp * rpc-over-http * rpc-over-https \| Connection protocol used to connect to MS Exchange service. \| \| \| domain-name string \| \| MS Exchange server fully qualified domain name. \| \| \| http-auth-type string \| Choices:* ntlm * basic \| Authentication security type used for the HTTP transport. \| \| \| ip string \| \| Server IPv4 address. \| \| \| ip6 string \| \| Server IPv6 address. \| \| \| kdc-ip string \| \| no description \| \| \| name string \| \| MS Exchange server entry name. \| \| \| password string \| \| no description \| \| \| server-name string \| \| MS Exchange server hostname. \| \| \| ssl-min-proto-version string \| Choices:* default * TLSv1-1 * TLSv1-2 * SSLv3 * TLSv1 \| Minimum SSL/TLS protocol version for HTTPS transport (default is to follow system global setting). \| \| \| username string \| \| User name used to sign in to the server. Must have proper permissions for service. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 MS Exchange server entries. fmgr_user_exchange: bypass_validation: False workspace_locking_adom: <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_exchange: addr-type: <value in [ipv4, ipv6]> auth-level: <value in [low, medium, normal, ...]> auth-type: <value in [spnego, ntlm, kerberos]> connect-protocol: <value in [rpc-over-tcp, rpc-over-http, rpc-over-https]> domain-name: <value of string> http-auth-type: <value in [ntlm, basic]> ip: <value of string> ip6: <value of string> kdc-ip: <value of string> name: <value of string> password: <value of string> server-name: <value of string> ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]> username: <value of string> auto-discover-kdc: <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_devicedetectionportal – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_devicedetectionportal – 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_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 \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_replacemsg\_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. \| \| 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_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> devprof: <your own value> devprof_system_replacemsg_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_fmupdate_publicnetwork – Enable/disable access to the public FortiGuard. fortinet.fortimanager.fmgr\_fmupdate\_publicnetwork – Enable/disable access to the public 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_publicnetwork`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_publicnetwork dictionary \| \| the top level parameters set \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable public network (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: Enable/disable access to the public FortiGuard. fmgr_fmupdate_publicnetwork: bypass_validation: 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_publicnetwork: 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_qosprofile – Configure WiFi quality of service fortinet.fortimanager.fmgr\_qosprofile – Configure WiFi quality of 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_qosprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| qosprofile dictionary \| \| the top level parameters set \| \| \| bandwidth-admission-control string \| Choices:* disable * enable \| Enable/disable WMM bandwidth admission control. \| \| \| bandwidth-capacity integer \| \| Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). \| \| \| burst string \| Choices:* disable * enable \| Enable/disable client rate burst. \| \| \| call-admission-control string \| Choices:* disable * enable \| Enable/disable WMM call admission control. \| \| \| call-capacity integer \| \| Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10). \| \| \| comment string \| \| Comment. \| \| \| downlink integer \| \| Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). \| \| \| downlink-sta integer \| \| Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). \| \| \| dscp-wmm-be integer \| \| no description \| \| \| dscp-wmm-bk integer \| \| no description \| \| \| dscp-wmm-mapping string \| Choices:* disable * enable \| Enable/disable Differentiated Services Code Point (DSCP) mapping. \| \| \| dscp-wmm-vi integer \| \| no description \| \| \| dscp-wmm-vo integer \| \| no description \| \| \| name string \| \| WiFi QoS profile name. \| \| \| uplink integer \| \| Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). \| \| \| uplink-sta integer \| \| Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). \| \| \| wmm string \| Choices:* disable * enable \| Enable/disable WiFi multi-media (WMM) control. \| \| \| wmm-be-dscp integer \| \| DSCP marking for best effort access (default = 0). \| \| \| wmm-bk-dscp integer \| \| DSCP marking for background access (default = 8). \| \| \| wmm-dscp-marking string \| Choices:* disable * enable \| Enable/disable WMM Differentiated Services Code Point (DSCP) marking. \| \| \| wmm-uapsd string \| Choices:* disable * enable \| Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. \| \| \| wmm-vi-dscp integer \| \| DSCP marking for video access (default = 32). \| \| \| wmm-vo-dscp integer \| \| DSCP marking for voice access (default = 48). \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 WiFi quality of service fmgr_qosprofile: bypass_validation: False workspace_locking_adom: <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]> qosprofile: bandwidth-admission-control: <value in [disable, enable]> bandwidth-capacity: <value of integer> burst: <value in [disable, enable]> call-admission-control: <value in [disable, enable]> call-capacity: <value of integer> comment: <value of string> downlink: <value of integer> downlink-sta: <value of integer> dscp-wmm-be: <value of integer> dscp-wmm-bk: <value of integer> dscp-wmm-mapping: <value in [disable, enable]> dscp-wmm-vi: <value of integer> dscp-wmm-vo: <value of integer> name: <value of string> uplink: <value of integer> uplink-sta: <value of integer> wmm: <value in [disable, enable]> wmm-uapsd: <value in [disable, enable]> wmm-be-dscp: <value of integer> wmm-bk-dscp: <value of integer> wmm-dscp-marking: <value in [disable, enable]> wmm-vi-dscp: <value of integer> wmm-vo-dscp: <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_vip_dynamicmapping_sslciphersuites – SSL/TLS cipher suites acceptable from a client, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_vip\_dynamicmapping\_sslciphersuites – SSL/TLS cipher suites acceptable from a client, 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_vip_dynamicmapping_sslciphersuites`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_vip\_dynamicmapping\_sslciphersuites 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 \| no description \| \| \| id integer \| \| no description \| \| \| priority integer \| \| no description \| \| \| versions list / elements=string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: SSL/TLS cipher suites acceptable from a client, ordered by priority. fmgr_firewall_vip_dynamicmapping_sslciphersuites: bypass_validation: False workspace_locking_adom: <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> dynamic_mapping: <your own value> state: <value in [present, absent]> firewall_vip_dynamicmapping_sslciphersuites: cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> id: <value of integer> versions: - ssl-3.0 - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 priority: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_dynamicmapping – Configure Virtual Access Points fortinet.fortimanager.fmgr\_vap\_dynamicmapping – 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_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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\_dynamicmapping 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 \| \| \| \_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, 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 \| \| 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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> vap: <your own value> state: <value in [present, absent]> vap_dynamicmapping: _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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_sql_tsindexfield – List of SQL text search index fields. fortinet.fortimanager.fmgr\_system\_sql\_tsindexfield – List of SQL text search index fields. ============================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sql_tsindexfield`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_sql\_tsindexfield dictionary \| \| the top level parameters set \| \| \| category string \| \| Category of text search index fields. \| \| \| value string \| \| Fields of text search index. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 SQL text search index fields. fmgr_system_sql_tsindexfield: bypass_validation: 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_sql_tsindexfield: category: <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_securityconsole_package_cancel_install – Cancel policy install and clear preview cache. fortinet.fortimanager.fmgr\_securityconsole\_package\_cancel\_install – Cancel policy install and clear 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_cancel_install`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_cancel\_install dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM 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: Cancel policy install and clear preview cache. fmgr_securityconsole_package_cancel_install: bypass_validation: 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_cancel_install: adom: <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_mirror – Configuration method to edit FortiSwitch packet mirror. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_mirror – Configuration method to edit FortiSwitch packet 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_switchcontroller_managedswitch_mirror`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 packet mirror. fmgr_switchcontroller_managedswitch_mirror: bypass_validation: 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> state: <value in [present, absent]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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 – Web proxy address configuration. fortinet.fortimanager.fmgr\_firewall\_proxyaddress – Web proxy 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_firewall_proxyaddress`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| \_image-base64 string \| \| no description \| \| \| case-sensitivity string \| Choices:* disable * enable \| Enable to make the pattern case sensitive. \| \| \| category string \| \| FortiGuard category ID. \| \| \| color integer \| \| Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). \| \| \| comment string \| \| Optional comments. \| \| \| header string \| \| HTTP header name as a regular expression. \| \| \| header-group list / elements=string \| \| no description \| \| \| \| case-sensitivity string \| Choices:* disable * enable \| Case sensitivity in pattern. \| \| \| \| header string \| \| HTTP header regular expression. \| \| \| \| header-name string \| \| HTTP header. \| \| \| \| id integer \| \| ID. \| \| \| header-name string \| \| Name of HTTP header. \| \| \| host string \| \| Address object for the host. \| \| \| host-regex string \| \| Host name as a regular expression. \| \| \| method list / elements=string \| Choices:* delete * get * head * options * post * put * trace * connect \| no description \| \| \| name string \| \| Address name. \| \| \| path string \| \| URL path as a regular expression. \| \| \| query string \| \| Match the query part of the URL as a regular expression. \| \| \| referrer string \| Choices:* disable * enable \| Enable/disable use of referrer field in the HTTP header to match the address. \| \| \| tagging list / elements=string \| \| no description \| \| \| \| category string \| \| Tag category. \| \| \| \| name string \| \| Tagging entry name. \| \| \| \| tags string \| \| no description \| \| \| type string \| Choices:* host-regex * url * category * method * ua * header * src-advanced * dst-advanced \| Proxy address type. \| \| \| ua list / elements=string \| Choices:* chrome * ms * firefox * safari * other \| no description \| \| \| uuid string \| \| Universally Unique Identifier (UUID; automatically assigned but can be manually reset). \| \| \| visibility string \| Choices:* disable * enable \| Enable/disable visibility of the object in the GUI. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Web proxy address configuration. fmgr_firewall_proxyaddress: bypass_validation: False workspace_locking_adom: <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_proxyaddress: case-sensitivity: <value in [disable, enable]> category: <value of string> color: <value of integer> comment: <value of string> header: <value of string> header-group: - case-sensitivity: <value in [disable, enable]> header: <value of string> header-name: <value of string> id: <value of integer> header-name: <value of string> host: <value of string> host-regex: <value of string> method: - delete - get - head - options - post - put - trace - connect name: <value of string> path: <value of string> query: <value of string> referrer: <value in [disable, enable]> tagging: - category: <value of string> name: <value of string> tags: <value of string> type: <value in [host-regex, url, category, ...]> ua: - chrome - ms - firefox - safari - other uuid: <value of string> visibility: <value in [disable, enable]> _image-base64: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu)	programming_docs
ansible fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress – Options for the DHCP server to assign IP settings to specific MAC addresses. fortinet.fortimanager.fmgr\_system\_dhcp\_server\_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_system_dhcp_server_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 \| \| 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 \| \| server string / required \| \| the parameter (server) in requested url \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| system\_dhcp\_server\_reservedaddress dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_system_dhcp_server_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> server: <your own value> state: <value in [present, absent]> system_dhcp_server_reservedaddress: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_sslciphersuites – SSL/TLS cipher suites acceptable from a client, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_vip6\_sslciphersuites – SSL/TLS cipher suites acceptable from a client, 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_sslciphersuites`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sslciphersuites 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 acceptable from a client, ordered by priority. fmgr_firewall_vip6_sslciphersuites: bypass_validation: False workspace_locking_adom: <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_sslciphersuites: 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_application_custom – Configure custom application signatures. fortinet.fortimanager.fmgr\_application\_custom – Configure custom application signatures. ========================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 \| \| application\_custom dictionary \| \| the top level parameters set \| \| \| behavior string \| \| Custom application signature behavior. \| \| \| category string \| \| Custom application category ID (use ? to view available options). \| \| \| comment string \| \| Comment. \| \| \| id integer \| \| no description \| \| \| name string \| \| no description \| \| \| protocol string \| \| Custom application signature protocol. \| \| \| signature string \| \| The text that makes up the actual custom application signature. \| \| \| tag string \| \| Signature tag. \| \| \| technology string \| \| Custom application signature technology. \| \| \| vendor string \| \| Custom application signature vendor. \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 custom application signatures. fmgr_application_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]> application_custom: behavior: <value of string> category: <value of string> comment: <value of string> id: <value of integer> name: <value of string> protocol: <value of string> signature: <value of string> tag: <value of string> technology: <value of string> vendor: <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_snmp_user – SNMP user configuration. fortinet.fortimanager.fmgr\_devprof\_system\_snmp\_user – SNMP user 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_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 \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_user dictionary \| \| the top level parameters set \| \| \| auth-proto string \| Choices:* md5 * sha * sha224 * sha256 * sha384 * sha512 \| Authentication protocol. \| \| \| auth-pwd string \| \| no description \| \| \| events list / elements=string \| Choices:* cpu-high * mem-low * log-full * intf-ip * vpn-tun-up * vpn-tun-down * ha-switch * fm-conf-change * ips-signature * ips-anomaly * temperature-high * voltage-alert * av-virus * av-oversize * av-pattern * av-fragmented * ha-hb-failure * fan-failure * ha-member-up * ha-member-down * ent-conf-change * av-conserve * av-bypass * av-oversize-passed * av-oversize-blocked * ips-pkg-update * fm-if-change * power-supply-failure * amc-bypass * faz-disconnect * 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 \| \| \| ha-direct string \| Choices:* disable * enable \| Enable/disable direct management of HA cluster members. \| \| \| name string \| \| SNMP user name. \| \| \| notify-hosts string \| \| no description \| \| \| notify-hosts6 string \| \| IPv6 SNMP managers to send notifications (traps) to. \| \| \| priv-proto string \| Choices:* aes * des * aes256 * aes256cisco \| 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. \| \| \| source-ip string \| \| Source IP for SNMP trap. \| \| \| source-ipv6 string \| \| Source IPv6 for SNMP trap. \| \| \| status string \| Choices:* disable * enable \| Enable/disable this SNMP user. \| \| \| trap-lport integer \| \| SNMPv3 local trap port (default = 162). \| \| \| trap-rport integer \| \| SNMPv3 trap remote port (default = 162). \| \| \| trap-status string \| Choices:* disable * enable \| Enable/disable traps for this SNMP user. \| \| 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 user configuration. fmgr_devprof_system_snmp_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, ...] adom: <your own value> devprof: <your own value> state: <value in [present, absent]> devprof_system_snmp_user: auth-proto: <value in [md5, sha, sha224, ...]> auth-pwd: <value of string> events: - cpu-high - mem-low - log-full - intf-ip - vpn-tun-up - vpn-tun-down - ha-switch - fm-conf-change - ips-signature - ips-anomaly - temperature-high - voltage-alert - av-virus - av-oversize - av-pattern - av-fragmented - ha-hb-failure - fan-failure - ha-member-up - ha-member-down - ent-conf-change - av-conserve - av-bypass - av-oversize-passed - av-oversize-blocked - ips-pkg-update - fm-if-change - power-supply-failure - amc-bypass - faz-disconnect - 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 ha-direct: <value in [disable, enable]> name: <value of string> notify-hosts: <value of string> notify-hosts6: <value of string> priv-proto: <value in [aes, des, aes256, ...]> 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]> source-ip: <value of string> source-ipv6: <value of string> status: <value in [disable, enable]> trap-lport: <value of integer> trap-rport: <value of integer> trap-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_vip_dynamicmapping – Configure virtual IP for IPv4. fortinet.fortimanager.fmgr\_firewall\_vip\_dynamicmapping – Configure virtual IP for IPv4. ========================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_vip_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\_vip\_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 \| \| \| dns-mapping-ttl integer \| \| no description \| \| \| extaddr string \| \| no description \| \| \| extintf string \| \| no description \| \| \| extip string \| \| no description \| \| \| extport string \| \| no description \| \| \| gratuitous-arp-interval integer \| \| no description \| \| \| http-cookie-age integer \| \| no description \| \| \| http-cookie-domain string \| \| no description \| \| \| http-cookie-domain-from-host string \| Choices:* disable * enable \| no description \| \| \| http-cookie-generation integer \| \| no description \| \| \| http-cookie-path string \| \| no description \| \| \| http-cookie-share string \| Choices:* disable * same-ip \| no description \| \| \| http-ip-header string \| Choices:* disable * enable \| no description \| \| \| http-ip-header-name string \| \| no description \| \| \| http-multiplex string \| Choices:* disable * enable \| no description \| \| \| http-redirect string \| Choices:* disable * enable \| no description \| \| \| https-cookie-secure string \| Choices:* disable * enable \| no description \| \| \| id integer \| \| no description \| \| \| ldb-method string \| Choices:* static * round-robin * weighted * least-session * least-rtt * first-alive * http-host \| no description \| \| \| mapped-addr string \| \| no description \| \| \| mappedip string \| \| no description \| \| \| mappedport string \| \| no description \| \| \| max-embryonic-connections integer \| \| no description \| \| \| monitor string \| \| no description \| \| \| nat-source-vip string \| Choices:* disable * enable \| no description \| \| \| outlook-web-access string \| Choices:* disable * enable \| no description \| \| \| persistence string \| Choices:* none * http-cookie * ssl-session-id \| no description \| \| \| portforward string \| Choices:* disable * enable \| no description \| \| \| portmapping-type string \| Choices:* 1-to-1 * m-to-n \| no description \| \| \| protocol string \| Choices:* tcp * udp * sctp * icmp \| no description \| \| \| realservers list / elements=string \| \| no description \| \| \| \| address string \| \| no description \| \| \| \| client-ip string \| \| no description \| \| \| \| healthcheck string \| Choices:* disable * enable * vip \| no description \| \| \| \| holddown-interval integer \| \| no description \| \| \| \| http-host string \| \| no description \| \| \| \| id integer \| \| no description \| \| \| \| ip string \| \| no description \| \| \| \| max-connections integer \| \| no description \| \| \| \| monitor string \| \| no description \| \| \| \| port integer \| \| no description \| \| \| \| seq integer \| \| no description \| \| \| \| status string \| Choices:* active * standby * disable \| no description \| \| \| \| type string \| Choices:* ip * address \| no description \| \| \| \| weight integer \| \| no description \| \| \| server-type string \| Choices:* http * https * ssl * tcp * udp * ip * imaps * pop3s * smtps * ssh \| no description \| \| \| service string \| \| no description \| \| \| src-filter string \| \| no description \| \| \| srcintf-filter string \| \| no description \| \| \| ssl-algorithm string \| Choices:* high * medium * low * custom \| no description \| \| \| ssl-certificate string \| \| no description \| \| \| ssl-cipher-suites list / elements=string \| \| no description \| \| \| \| cipher string \| Choices:* TLS-RSA-WITH-RC4-128-MD5 * TLS-RSA-WITH-RC4-128-SHA * TLS-RSA-WITH-DES-CBC-SHA * TLS-RSA-WITH-3DES-EDE-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA * TLS-RSA-WITH-AES-256-CBC-SHA * TLS-RSA-WITH-AES-128-CBC-SHA256 * TLS-RSA-WITH-AES-256-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-RSA-WITH-SEED-CBC-SHA * TLS-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-RSA-WITH-DES-CBC-SHA * TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA * TLS-DHE-RSA-WITH-AES-256-CBC-SHA * TLS-DHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-DHE-RSA-WITH-AES-256-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-RSA-WITH-SEED-CBC-SHA * TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-RC4-128-SHA * TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA * TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256 * TLS-DHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-DHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-AES-128-CBC-SHA * TLS-DHE-DSS-WITH-AES-256-CBC-SHA * TLS-DHE-DSS-WITH-AES-128-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-128-GCM-SHA256 * TLS-DHE-DSS-WITH-AES-256-CBC-SHA256 * TLS-DHE-DSS-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA * TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256 * TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384 * TLS-RSA-WITH-AES-128-GCM-SHA256 * TLS-RSA-WITH-AES-256-GCM-SHA384 * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA * TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256 * TLS-DHE-DSS-WITH-SEED-CBC-SHA * TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256 * TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384 * TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256 * TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384 * TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA * TLS-DHE-DSS-WITH-DES-CBC-SHA * TLS-AES-128-GCM-SHA256 * TLS-AES-256-GCM-SHA384 * TLS-CHACHA20-POLY1305-SHA256 \| no description \| \| \| \| id integer \| \| no description \| \| \| \| priority integer \| \| no description \| \| \| \| versions list / elements=string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| \| ssl-client-fallback string \| Choices:* disable * enable \| no description \| \| \| ssl-client-rekey-count integer \| \| no description \| \| \| ssl-client-renegotiation string \| Choices:* deny * allow * secure \| no description \| \| \| ssl-client-session-state-max integer \| \| no description \| \| \| ssl-client-session-state-timeout integer \| \| no description \| \| \| ssl-client-session-state-type string \| Choices:* disable * time * count * both \| no description \| \| \| ssl-dh-bits string \| Choices:* 768 * 1024 * 1536 * 2048 * 3072 * 4096 \| no description \| \| \| ssl-hpkp string \| Choices:* disable * enable * report-only \| no description \| \| \| ssl-hpkp-age integer \| \| no description \| \| \| ssl-hpkp-backup string \| \| no description \| \| \| ssl-hpkp-include-subdomains string \| Choices:* disable * enable \| no description \| \| \| ssl-hpkp-primary string \| \| no description \| \| \| ssl-hpkp-report-uri string \| \| no description \| \| \| ssl-hsts string \| Choices:* disable * enable \| no description \| \| \| ssl-hsts-age integer \| \| no description \| \| \| ssl-hsts-include-subdomains string \| Choices:* disable * enable \| no description \| \| \| ssl-http-location-conversion string \| Choices:* disable * enable \| no description \| \| \| ssl-http-match-host string \| Choices:* disable * enable \| no description \| \| \| ssl-max-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| \| ssl-min-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * tls-1.3 \| no description \| \| \| ssl-mode string \| Choices:* half * full \| no description \| \| \| ssl-pfs string \| Choices:* require * deny * allow \| no description \| \| \| ssl-send-empty-frags string \| Choices:* disable * enable \| no description \| \| \| ssl-server-algorithm string \| Choices:* high * low * medium * custom * client \| no description \| \| \| ssl-server-max-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * client * tls-1.3 \| no description \| \| \| ssl-server-min-version string \| Choices:* ssl-3.0 * tls-1.0 * tls-1.1 * tls-1.2 * client * tls-1.3 \| no description \| \| \| ssl-server-session-state-max integer \| \| no description \| \| \| ssl-server-session-state-timeout integer \| \| no description \| \| \| ssl-server-session-state-type string \| Choices:* disable * time * count * both \| no description \| \| \| status string \| Choices:* disable * enable \| Enable/disable VIP. \| \| \| type string \| Choices:* static-nat * load-balance * server-load-balance * dns-translation * fqdn * access-proxy \| no description \| \| \| uuid string \| \| no description \| \| \| weblogic-server string \| Choices:* disable * enable \| no description \| \| \| websphere-server string \| Choices:* disable * enable \| no description \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Configure virtual IP for IPv4. fmgr_firewall_vip_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> vip: <your own value> state: <value in [present, absent]> firewall_vip_dynamicmapping: _scope: - name: <value of string> vdom: <value of string> arp-reply: <value in [disable, enable]> color: <value of integer> comment: <value of string> dns-mapping-ttl: <value of integer> extaddr: <value of string> extintf: <value of string> extip: <value of string> extport: <value of string> gratuitous-arp-interval: <value of integer> http-cookie-age: <value of integer> http-cookie-domain: <value of string> http-cookie-domain-from-host: <value in [disable, enable]> http-cookie-generation: <value of integer> http-cookie-path: <value of string> http-cookie-share: <value in [disable, same-ip]> http-ip-header: <value in [disable, enable]> http-ip-header-name: <value of string> http-multiplex: <value in [disable, enable]> https-cookie-secure: <value in [disable, enable]> id: <value of integer> ldb-method: <value in [static, round-robin, weighted, ...]> mapped-addr: <value of string> mappedip: <value of string> mappedport: <value of string> max-embryonic-connections: <value of integer> monitor: <value of string> nat-source-vip: <value in [disable, enable]> outlook-web-access: <value in [disable, enable]> persistence: <value in [none, http-cookie, ssl-session-id]> portforward: <value in [disable, enable]> portmapping-type: <value in [1-to-1, m-to-n]> protocol: <value in [tcp, udp, sctp, ...]> realservers: - client-ip: <value of string> healthcheck: <value in [disable, enable, vip]> holddown-interval: <value of integer> http-host: <value of string> ip: <value of string> max-connections: <value of integer> monitor: <value of string> port: <value of integer> seq: <value of integer> status: <value in [active, standby, disable]> weight: <value of integer> address: <value of string> id: <value of integer> type: <value in [ip, address]> server-type: <value in [http, https, ssl, ...]> service: <value of string> src-filter: <value of string> srcintf-filter: <value of string> ssl-algorithm: <value in [high, medium, low, ...]> ssl-certificate: <value of string> ssl-cipher-suites: - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> id: <value of integer> versions: - ssl-3.0 - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 priority: <value of integer> ssl-client-fallback: <value in [disable, enable]> ssl-client-renegotiation: <value in [deny, allow, secure]> ssl-client-session-state-max: <value of integer> ssl-client-session-state-timeout: <value of integer> ssl-client-session-state-type: <value in [disable, time, count, ...]> ssl-dh-bits: <value in [768, 1024, 1536, ...]> ssl-hpkp: <value in [disable, enable, report-only]> ssl-hpkp-age: <value of integer> ssl-hpkp-backup: <value of string> ssl-hpkp-include-subdomains: <value in [disable, enable]> ssl-hpkp-primary: <value of string> ssl-hpkp-report-uri: <value of string> ssl-hsts: <value in [disable, enable]> ssl-hsts-age: <value of integer> ssl-hsts-include-subdomains: <value in [disable, enable]> ssl-http-location-conversion: <value in [disable, enable]> ssl-http-match-host: <value in [disable, enable]> ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-mode: <value in [half, full]> ssl-pfs: <value in [require, deny, allow]> ssl-send-empty-frags: <value in [disable, enable]> ssl-server-algorithm: <value in [high, low, medium, ...]> ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]> ssl-server-session-state-max: <value of integer> ssl-server-session-state-timeout: <value of integer> ssl-server-session-state-type: <value in [disable, time, count, ...]> type: <value in [static-nat, load-balance, server-load-balance, ...]> uuid: <value of string> weblogic-server: <value in [disable, enable]> websphere-server: <value in [disable, enable]> http-redirect: <value in [disable, enable]> ssl-client-rekey-count: <value of integer> status: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_sensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source. fortinet.fortimanager.fmgr\_dlp\_sensitivity – 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_sensitivity`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_sensitivity 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_sensitivity: bypass_validation: False workspace_locking_adom: <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_sensitivity: 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_addrgrp_tagging – Config object tagging. fortinet.fortimanager.fmgr\_firewall\_addrgrp\_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_addrgrp_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 \| \| --- \| --- \| --- \| \| addrgrp string / required \| \| the parameter (addrgrp) in requested url \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_addrgrp\_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_addrgrp_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> addrgrp: <your own value> state: <value in [present, absent]> firewall_addrgrp_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_dvm_cmd_del_device – Delete a device. fortinet.fortimanager.fmgr\_dvm\_cmd\_del\_device – Delete 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_del_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\_del\_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: Delete a device. fmgr_dvm_cmd_del_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_del_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) ansible fortinet.fortimanager.fmgr_system_syslog – Syslog servers. fortinet.fortimanager.fmgr\_system\_syslog – Syslog 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_syslog`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_syslog dictionary \| \| the top level parameters set \| \| \| ip string \| \| Syslog server IP address or hostname. \| \| \| name string \| \| Syslog server name. \| \| \| port integer \| Default:514 \| Syslog server 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: Syslog servers. fmgr_system_syslog: bypass_validation: 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_syslog: ip: <value of string> name: <value of string> 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_switchcontroller_managedswitch_8021xsettings – Configuration method to edit FortiSwitch 802. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_8021xsettings – Configuration method to edit FortiSwitch 802. ========================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_8021xsettings`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 802. fmgr_switchcontroller_managedswitch_8021xsettings: bypass_validation: 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_user_fsso – Configure Fortinet Single Sign On fortinet.fortimanager.fmgr\_user\_fsso – 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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_fsso dictionary \| \| the top level parameters set \| \| \| \_gui\_meta string \| \| no description \| \| \| dynamic\_mapping list / elements=string \| \| no description \| \| \| \| \_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 \| \| \| group-poll-interval integer \| \| Interval in minutes within to fetch groups from FSSO server, or unset to disable. \| \| \| interface string \| \| Specify outgoing interface to reach server. \| \| \| interface-select-method string \| Choices:* auto * sdwan * specify \| Specify how to select outgoing interface to reach server. \| \| \| ldap-poll string \| Choices:* disable * enable \| Enable/disable automatic fetching of groups from LDAP server. \| \| \| ldap-poll-filter string \| \| Filter used to fetch groups. \| \| \| ldap-poll-interval integer \| \| Interval in minutes within to fetch groups from LDAP server. \| \| \| ldap-server string \| \| LDAP server to get group information. \| \| \| name string \| \| Name. \| \| \| password string \| \| no description \| \| \| password2 string \| \| no description \| \| \| password3 string \| \| no description \| \| \| password4 string \| \| no description \| \| \| password5 string \| \| no description \| \| \| port integer \| \| Port of the first FSSO collector agent. \| \| \| port2 integer \| \| Port of the second FSSO collector agent. \| \| \| port3 integer \| \| Port of the third FSSO collector agent. \| \| \| port4 integer \| \| Port of the fourth FSSO collector agent. \| \| \| port5 integer \| \| Port of the fifth FSSO collector agent. \| \| \| server string \| \| Domain name or IP address of the first FSSO collector agent. \| \| \| server2 string \| \| Domain name or IP address of the second FSSO collector agent. \| \| \| server3 string \| \| Domain name or IP address of the third FSSO collector agent. \| \| \| server4 string \| \| Domain name or IP address of the fourth FSSO collector agent. \| \| \| server5 string \| \| Domain name or IP address of the fifth FSSO collector agent. \| \| \| source-ip string \| \| Source IP for communications to FSSO agent. \| \| \| source-ip6 string \| \| IPv6 source for communications to FSSO agent. \| \| \| ssl string \| Choices:* disable * enable \| Enable/disable use of SSL. \| \| \| ssl-trusted-cert string \| \| Trusted server certificate or CA certificate. \| \| \| type string \| Choices:* default * fortiems * fortinac * fortiems-cloud \| Server type. \| \| \| user-info-server string \| \| LDAP server to get user information. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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: bypass_validation: False workspace_locking_adom: <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_fsso: _gui_meta: <value of string> dynamic_mapping: - _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]> ldap-server: <value of string> name: <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> ldap-poll: <value in [disable, enable]> ldap-poll-filter: <value of string> ldap-poll-interval: <value of integer> ssl: <value in [disable, enable]> ssl-trusted-cert: <value of string> type: <value in [default, fortiems, fortinac, ...]> user-info-server: <value of string> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_firewall_sslsshprofile_dot – Configure DNS over TLS options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_dot – Configure DNS over TLS 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_dot`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_dot dictionary \| \| the top level parameters set \| \| \| cert-validation-failure string \| Choices:* allow * block * ignore \| Action based on certificate validation failure. \| \| \| cert-validation-timeout string \| Choices:* allow * block * ignore \| Action based on certificate validation timeout. \| \| \| client-certificate string \| Choices:* bypass * inspect * block \| Action based on received client certificate. \| \| \| expired-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is expired. \| \| \| proxy-after-tcp-handshake string \| Choices:* 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:* enable * strict * disable \| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. \| \| \| status string \| Choices:* disable * deep-inspection \| Configure protocol inspection status. \| \| \| unsupported-ssl-cipher string \| Choices:* block * allow \| Action based on the SSL cipher used being unsupported. \| \| \| unsupported-ssl-negotiation string \| Choices:* block * allow \| Action based on the SSL negotiation used being unsupported. \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is not issued by a trusted CA. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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 DNS over TLS options. fmgr_firewall_sslsshprofile_dot: bypass_validation: False workspace_locking_adom: <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_dot: 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]> sni-server-cert-check: <value in [enable, strict, disable]> status: <value in [disable, deep-inspection]> unsupported-ssl-cipher: <value in [block, allow]> unsupported-ssl-negotiation: <value in [block, allow]> untrusted-server-cert: <value in [allow, block, ignore]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_firewall_mmsprofile_flood – Flood configuration. fortinet.fortimanager.fmgr\_firewall\_mmsprofile\_flood – Flood 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_flood`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_flood 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: Flood configuration. fmgr_firewall_mmsprofile_flood: bypass_validation: False workspace_locking_adom: <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_flood: 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_profileprotocoloptions_imap – Configure IMAP protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_imap – Configure IMAP 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_imap`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_profileprotocoloptions\_imap 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 \| no description \| \| \| oversize-limit integer \| \| Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). \| \| \| ports integer \| \| no description \| \| \| proxy-after-tcp-handshake string \| Choices:* disable * enable \| Proxy traffic after the TCP 3-way handshake has been established (not before). \| \| \| scan-bzip2 string \| Choices:* disable * enable \| Enable/disable scanning of BZip2 compressed files. \| \| \| ssl-offloaded string \| Choices:* no * yes \| SSL decryption and encryption performed by an external device. \| \| \| status string \| Choices:* disable * enable \| Enable/disable the active status of scanning for this protocol. \| \| \| uncompressed-nest-limit integer \| \| Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). \| \| \| uncompressed-oversize-limit integer \| \| Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). \| \| 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 IMAP protocol options. fmgr_firewall_profileprotocoloptions_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-protocol-options: <your own value> firewall_profileprotocoloptions_imap: inspect-all: <value in [disable, enable]> options: - oversize - fragmail - no-content-summary oversize-limit: <value of integer> ports: <value of integer> scan-bzip2: <value in [disable, enable]> status: <value in [disable, enable]> uncompressed-nest-limit: <value of integer> uncompressed-oversize-limit: <value of integer> 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_firewall_multicastaddress – Configure multicast addresses. fortinet.fortimanager.fmgr\_firewall\_multicastaddress – Configure multicast 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_multicastaddress`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| associated-interface string \| \| Interface associated with the address object. When setting up a policy, only addresses associated with this interface are avai... \| \| \| color integer \| \| Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). \| \| \| comment string \| \| Comment. \| \| \| end-ip string \| \| Final IPv4 address (inclusive) in the range for the address. \| \| \| name string \| \| Multicast address name. \| \| \| start-ip string \| \| First IPv4 address (inclusive) in the range for the address. \| \| \| subnet string \| \| Broadcast address and subnet. \| \| \| tagging list / elements=string \| \| no description \| \| \| \| category string \| \| Tag category. \| \| \| \| name string \| \| Tagging entry name. \| \| \| \| tags string \| \| no description \| \| \| type string \| Choices:* multicastrange * broadcastmask \| Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. \| \| \| visibility string \| Choices:* disable * enable \| Enable/disable visibility of the 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 multicast addresses. fmgr_firewall_multicastaddress: bypass_validation: False workspace_locking_adom: <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_multicastaddress: associated-interface: <value of string> color: <value of integer> comment: <value of string> end-ip: <value of string> name: <value of string> start-ip: <value of string> subnet: <value of string> tagging: - category: <value of string> name: <value of string> tags: <value of string> type: <value in [multicastrange, broadcastmask]> 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_gtp_iewhitelist_entries – Entries of white list fortinet.fortimanager.fmgr\_gtp\_iewhitelist\_entries – Entries of white list ============================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_gtp_iewhitelist_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 \| \| gtp\_iewhitelist\_entries dictionary \| \| the top level parameters set \| \| \| id integer \| \| Entry ID. \| \| \| ie integer \| \| IE ID (1 - 255). \| \| \| message integer \| \| Message ID (1 - 255). \| \| ie-white-list string / required \| \| the parameter (ie-white-list) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Entries of white list fmgr_gtp_iewhitelist_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> ie-white-list: <your own value> state: <value in [present, absent]> gtp_iewhitelist_entries: id: <value of integer> ie: <value of integer> message: <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_policy – no description fortinet.fortimanager.fmgr\_pm\_config\_metafields\_firewall\_policy – 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_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 \| \| pm\_config\_metafields\_firewall\_policy 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_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, ...] pm_config_metafields_firewall_policy: 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_waf_subclass – Hidden table for datasource. fortinet.fortimanager.fmgr\_waf\_subclass – 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_subclass`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_subclass dictionary \| \| the top level parameters set \| \| \| id integer \| \| Signature subclass ID. \| \| \| name string \| \| Signature subclass 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_subclass: bypass_validation: False workspace_locking_adom: <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_subclass: 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_dvmdb_script – Script table. fortinet.fortimanager.fmgr\_dvmdb\_script – Script 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_script`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_script dictionary \| \| the top level parameters set \| \| \| content string \| \| The full content of the script result log. \| \| \| desc string \| \| no description \| \| \| filter\_build integer \| \| The value will be ignored in add/set/update requests if filter\_ostype is not set. It has no effect if target is "adom\_database". \| \| \| filter\_device integer \| \| Name or id of an existing device in the database. It has no effect if target is "adom\_database". \| \| \| filter\_hostname string \| \| The value has no effect if target is "adom\_database". \| \| \| filter\_ostype string \| Choices:* unknown ← * fos \| The value has no effect if target is "adom\_database". \| \| \| filter\_osver string \| Choices:* unknown ← * 4.00 * 5.00 * 6.00 \| The value will be ignored in add/set/update requests if filter\_ostype is not set. It has no effect if target is "adom\_database". \| \| \| filter\_platform string \| \| The value will be ignored in add/set/update requests if filter\_ostype is not set. It has no effect if target is "adom\_database". \| \| \| filter\_serial string \| \| The value has no effect if target is "adom\_database". \| \| \| modification\_time string \| \| It is a read-only attribute indicating the time when the script was created or modified. The value will be ignored in add/set/... \| \| \| name string \| \| no description \| \| \| script\_schedule list / elements=string \| \| no description \| \| \| \| datetime string \| \| Indicates the date and time of the schedule. It should follow the following format for each scheduling type: onetime: "YYYY-MM-DD hh:mm:ss" daily: "hh:mm" weekly: "hh:mm" monthly: "DD hh:mm" \| \| \| \| day\_of\_week string \| Choices:* unknown * sun ← * mon * tue * wed * thu * fri * sat \| no description \| \| \| \| device integer \| \| Name or id of an existing device in the database. \| \| \| \| name string \| \| no description \| \| \| \| run\_on\_db string \| Choices:* disable ← * enable \| Indicates if the scheduled script should be executed on device database. It should always be disable for tcl scripts. \| \| \| \| type string \| Choices:* auto * onetime * daily * weekly * monthly \| no description \| \| \| target string \| Choices:* device\_database ← * remote\_device * adom\_database \| no description \| \| \| type string \| Choices:* cli * tcl * cligrp \| 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: Script table. fmgr_dvmdb_script: bypass_validation: False workspace_locking_adom: <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_script: content: <value of string> desc: <value of string> filter_build: <value of integer> filter_device: <value of integer> filter_hostname: <value of string> filter_ostype: <value in [unknown, fos]> filter_osver: <value in [unknown, 4.00, 5.00, ...]> filter_platform: <value of string> filter_serial: <value of string> modification_time: <value of string> name: <value of string> script_schedule: - datetime: <value of string> day_of_week: <value in [unknown, sun, mon, ...]> device: <value of integer> name: <value of string> run_on_db: <value in [disable, enable]> type: <value in [auto, onetime, daily, ...]> target: <value in [device_database, remote_device, adom_database]> type: <value in [cli, tcl, cligrp]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_bword_entries – Spam filter banned word. fortinet.fortimanager.fmgr\_emailfilter\_bword\_entries – Spam filter banned word. ================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_emailfilter_bword_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 \| \| bword string / required \| \| the parameter (bword) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| emailfilter\_bword\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* spam * clear \| Mark spam or good. \| \| \| id integer \| \| Banned word entry ID. \| \| \| language string \| Choices:* western * simch * trach * japanese * korean * french * thai * spanish \| Language for the banned word. \| \| \| pattern string \| \| Pattern for the banned word. \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| score integer \| \| Score value. \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| where string \| Choices:* all * subject * body \| Component of the email to be scanned. \| \| 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 banned word. fmgr_emailfilter_bword_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> bword: <your own value> state: <value in [present, absent]> emailfilter_bword_entries: action: <value in [spam, clear]> id: <value of integer> language: <value in [western, simch, trach, ...]> pattern: <value of string> pattern-type: <value in [wildcard, regexp]> score: <value of integer> status: <value in [disable, enable]> where: <value in [all, subject, body]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_bwl – Configure anti-spam black/white list. fortinet.fortimanager.fmgr\_spamfilter\_bwl – Configure anti-spam black/white list. =================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_spamfilter_bwl`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| 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\_bwl dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* spam * clear * reject \| Reject, mark as spam or good email. \| \| \| \| addr-type string \| Choices:* ipv4 * ipv6 \| IP address type. \| \| \| \| email-pattern string \| \| Email address pattern. \| \| \| \| id integer \| \| Entry ID. \| \| \| \| ip4-subnet string \| \| IPv4 network address/subnet mask bits. \| \| \| \| ip6-subnet string \| \| IPv6 network address/subnet mask bits. \| \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| \| type string \| Choices:* ip * email \| Entry type. \| \| \| id integer \| \| ID. \| \| \| name string \| \| Name of table. \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure anti-spam black/white list. fmgr_spamfilter_bwl: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> spamfilter_bwl: comment: <value of string> entries: - action: <value in [spam, clear, reject]> addr-type: <value in [ipv4, ipv6]> email-pattern: <value of string> id: <value of integer> ip4-subnet: <value of string> ip6-subnet: <value of string> pattern-type: <value in [wildcard, regexp]> status: <value in [disable, enable]> type: <value in [ip, email]> id: <value of integer> name: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs – Configure CIFS protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_cifs – Configure CIFS 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_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 \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| domain-controller string \| \| Domain for which to decrypt CIFS traffic. \| \| \| file-filter dictionary \| \| no description \| \| \| \| entries list / elements=string \| \| no description \| \| \| \| \| action string \| Choices:* log * block \| Action taken for matched file. \| \| \| \| \| comment string \| \| Comment. \| \| \| \| \| direction string \| Choices:* any * incoming * outgoing \| Match files transmitted in the sessions originating or reply direction. \| \| \| \| \| file-type string \| \| no description \| \| \| \| \| filter string \| \| Add a file filter. \| \| \| \| \| protocol list / elements=string \| Choices:* cifs \| no description \| \| \| \| log string \| Choices:* disable * enable \| Enable/disable file filter logging. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable file filter. \| \| \| options list / elements=string \| Choices:* oversize \| no description \| \| \| oversize-limit integer \| \| Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). \| \| \| ports integer \| \| no description \| \| \| scan-bzip2 string \| Choices:* disable * enable \| Enable/disable scanning of BZip2 compressed files. \| \| \| server-credential-type string \| Choices:* none * credential-replication * credential-keytab \| CIFS server credential type. \| \| \| server-keytab list / elements=string \| \| no description \| \| \| \| keytab string \| \| Base64 encoded keytab file containing credential of the server. \| \| \| \| password string \| \| no description \| \| \| \| principal string \| \| Service principal. For example, "host/[email protected]". \| \| \| status string \| Choices:* disable * enable \| Enable/disable the active status of scanning for this protocol. \| \| \| tcp-window-maximum integer \| \| Maximum dynamic TCP window size (default = 8MB). \| \| \| tcp-window-minimum integer \| \| Minimum dynamic TCP window size (default = 128KB). \| \| \| tcp-window-size integer \| \| Set TCP static window size (default = 256KB). \| \| \| tcp-window-type string \| Choices:* system * static * dynamic \| Specify type of TCP window to use for this protocol. \| \| \| uncompressed-nest-limit integer \| \| Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). \| \| \| uncompressed-oversize-limit integer \| \| Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). \| \| 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 CIFS protocol options. fmgr_firewall_profileprotocoloptions_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-protocol-options: <your own value> firewall_profileprotocoloptions_cifs: ports: <value of integer> status: <value in [disable, enable]> options: - oversize oversize-limit: <value of integer> scan-bzip2: <value in [disable, enable]> tcp-window-maximum: <value of integer> tcp-window-minimum: <value of integer> tcp-window-size: <value of integer> tcp-window-type: <value in [system, static, dynamic]> uncompressed-nest-limit: <value of integer> uncompressed-oversize-limit: <value of integer> domain-controller: <value of string> file-filter: entries: - action: <value in [log, block]> comment: <value of string> direction: <value in [any, incoming, outgoing]> file-type: <value of string> filter: <value of string> protocol: - cifs log: <value in [disable, enable]> status: <value in [disable, enable]> server-credential-type: <value in [none, credential-replication, credential-keytab]> server-keytab: - keytab: <value of string> password: <value of string> principal: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings_certextension – Configure certificate extension for user certificate. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_serverpubkeyauthsettings\_certextension – Configure certificate extension for user 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_firewall_accessproxy_serverpubkeyauthsettings_certextension`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access-proxy string / required \| \| the parameter (access-proxy) in requested url \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_accessproxy\_serverpubkeyauthsettings\_certextension dictionary \| \| the top level parameters set \| \| \| critical string \| Choices:* no * yes \| Critical option. \| \| \| data string \| \| Name of certificate extension. \| \| \| name string \| \| Name of certificate extension. \| \| \| type string \| Choices:* fixed * user \| Type of certificate extension. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 certificate extension for user certificate. fmgr_firewall_accessproxy_serverpubkeyauthsettings_certextension: bypass_validation: False workspace_locking_adom: <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_serverpubkeyauthsettings_certextension: critical: <value in [no, yes]> data: <value of string> name: <value of string> type: <value in [fixed, 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)	programming_docs
ansible fortinet.fortimanager.fmgr_spamfilter_iptrust – Configure AntiSpam IP trust. fortinet.fortimanager.fmgr\_spamfilter\_iptrust – Configure AntiSpam IP trust. ============================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_spamfilter_iptrust`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| 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\_iptrust dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| addr-type string \| Choices:* ipv4 * ipv6 \| Type of address. \| \| \| \| id integer \| \| Trusted IP entry ID. \| \| \| \| ip4-subnet string \| \| IPv4 network address or network address/subnet mask bits. \| \| \| \| ip6-subnet string \| \| IPv6 network address/subnet mask bits. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| id integer \| \| ID. \| \| \| name string \| \| Name of table. \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure AntiSpam IP trust. fmgr_spamfilter_iptrust: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> spamfilter_iptrust: comment: <value of string> entries: - addr-type: <value in [ipv4, ipv6]> id: <value of integer> ip4-subnet: <value of string> ip6-subnet: <value of string> status: <value in [disable, enable]> id: <value of integer> name: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_dvmdb_group_objectmember – Device group table. fortinet.fortimanager.fmgr\_dvmdb\_group\_objectmember – 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_objectmember`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_objectmember dictionary \| \| the top level parameters set \| \| \| name string \| \| no description \| \| \| vdom string \| \| no description \| \| 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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_objectmember: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> group: <your own value> state: <value in [present, absent]> dvmdb_group_objectmember: 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_user_peergrp – Configure peer groups. fortinet.fortimanager.fmgr\_user\_peergrp – Configure peer 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_peergrp`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_peergrp dictionary \| \| the top level parameters set \| \| \| member string \| \| Peer group members. \| \| \| name string \| \| Peer 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: Configure peer groups. fmgr_user_peergrp: bypass_validation: False workspace_locking_adom: <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_peergrp: 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_securityconsole_abort – Abort and cancel a security console task. fortinet.fortimanager.fmgr\_securityconsole\_abort – Abort and cancel a security console task. ============================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_abort`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_abort dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM 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: Abort and cancel a security console task. fmgr_securityconsole_abort: bypass_validation: 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_abort: adom: <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_mmschecksum_entries – modify this MMS content checksum list fortinet.fortimanager.fmgr\_antivirus\_mmschecksum\_entries – modify this MMS content checksum 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_antivirus_mmschecksum_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 \| \| antivirus\_mmschecksum\_entries dictionary \| \| the top level parameters set \| \| \| checksum string \| \| MMS attachment checksum value (CRC32) \| \| \| name string \| \| entry name, for administrator reference \| \| \| status string \| Choices:* disable * enable \| apply this entry during attachment inspection \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| mms-checksum string / required \| \| the parameter (mms-checksum) 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: modify this MMS content checksum list fmgr_antivirus_mmschecksum_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> mms-checksum: <your own value> state: <value in [present, absent]> antivirus_mmschecksum_entries: checksum: <value of string> 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_securityconsole_sign_certificate_template – Generate and sign certificate on the target device. fortinet.fortimanager.fmgr\_securityconsole\_sign\_certificate\_template – Generate and sign certificate on the target 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_securityconsole_sign_certificate_template`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sign\_certificate\_template 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 \| \| \| template 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: Generate and sign certificate on the target device. fmgr_securityconsole_sign_certificate_template: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] securityconsole_sign_certificate_template: adom: <value of string> scope: - name: <value of string> vdom: <value of string> template: <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_obj – Commit change fortinet.fortimanager.fmgr\_dvmdb\_workspace\_commit\_obj – 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_obj`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| object\_url\_name string / required \| \| the parameter (object\_url\_name) in requested url \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Commit change fmgr_dvmdb_workspace_commit_obj: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> object_url_name: <your own value> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_vapgroup – Configure virtual Access Point fortinet.fortimanager.fmgr\_vapgroup – Configure 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_vapgroup`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vapgroup dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| name string \| \| Group Name \| \| \| vaps string \| \| List of SSIDs to be included in the VAP group. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 Point fmgr_vapgroup: bypass_validation: False workspace_locking_adom: <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]> vapgroup: comment: <value of string> name: <value of string> vaps: <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_group_chartalternative – Chart alternatives. fortinet.fortimanager.fmgr\_system\_report\_group\_chartalternative – Chart alternatives. ========================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_system_report_group_chartalternative`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| group string / required \| \| the parameter (group) in requested url \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| system\_report\_group\_chartalternative dictionary \| \| the top level parameters set \| \| \| chart-name string \| \| Chart name. \| \| \| chart-replace string \| \| Chart replacement. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Chart alternatives. fmgr_system_report_group_chartalternative: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] group: <your own value> state: <value in [present, absent]> system_report_group_chartalternative: chart-name: <value of string> chart-replace: <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_fortishield – Configure FortiGuard - AntiSpam. fortinet.fortimanager.fmgr\_emailfilter\_fortishield – Configure FortiGuard - AntiSpam. ======================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fortishield`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_fortishield dictionary \| \| the top level parameters set \| \| \| spam-submit-force string \| Choices:* disable * enable \| Enable/disable force insertion of a new mime entity for the submission text. \| \| \| spam-submit-srv string \| \| Hostname of the spam submission server. \| \| \| spam-submit-txt2htm string \| Choices:* disable * enable \| Enable/disable conversion of text email to HTML email. \| \| 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 FortiGuard - AntiSpam. fmgr_emailfilter_fortishield: bypass_validation: False workspace_locking_adom: <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_fortishield: spam-submit-force: <value in [disable, enable]> spam-submit-srv: <value of string> spam-submit-txt2htm: <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_address6template_subnetsegment_values – Subnet segment values. fortinet.fortimanager.fmgr\_firewall\_address6template\_subnetsegment\_values – Subnet segment values. ====================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_address6template_subnetsegment_values`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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-template string / required \| \| the parameter (address6-template) 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\_address6template\_subnetsegment\_values dictionary \| \| the top level parameters set \| \| \| name string \| \| Subnet segment value name. \| \| \| value string \| \| Subnet segment 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 \| \| subnet-segment string / required \| \| the parameter (subnet-segment) 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: Subnet segment values. fmgr_firewall_address6template_subnetsegment_values: bypass_validation: False workspace_locking_adom: <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-template: <your own value> subnet-segment: <your own value> state: <value in [present, absent]> firewall_address6template_subnetsegment_values: 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) ansible fortinet.fortimanager.fmgr_system_replacemsggroup_spam – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_spam – 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_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 \| \| 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\_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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_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> replacemsg-group: <your own value> state: <value in [present, absent]> system_replacemsggroup_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_spamfilter_bword – Configure AntiSpam banned word list. fortinet.fortimanager.fmgr\_spamfilter\_bword – Configure AntiSpam banned word list. ==================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_spamfilter_bword`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| 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\_bword dictionary \| \| the top level parameters set \| \| \| comment string \| \| Optional comments. \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* spam * clear \| Mark spam or good. \| \| \| \| id integer \| \| Banned word entry ID. \| \| \| \| language string \| Choices:* western * simch * trach * japanese * korean * french * thai * spanish \| Language for the banned word. \| \| \| \| pattern string \| \| Pattern for the banned word. \| \| \| \| pattern-type string \| Choices:* wildcard * regexp \| Wildcard pattern or regular expression. \| \| \| \| score integer \| \| Score value. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable status. \| \| \| \| where string \| Choices:* subject * body * all \| Component of the email to be scanned. \| \| \| 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 banned word list. fmgr_spamfilter_bword: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> spamfilter_bword: comment: <value of string> entries: - action: <value in [spam, clear]> id: <value of integer> language: <value in [western, simch, trach, ...]> pattern: <value of string> pattern-type: <value in [wildcard, regexp]> score: <value of integer> status: <value in [disable, enable]> where: <value in [subject, body, all]> id: <value of integer> name: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_firewall_addrgrp – Configure IPv4 address groups. fortinet.fortimanager.fmgr\_firewall\_addrgrp – Configure IPv4 address groups. ============================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_firewall_addrgrp`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_addrgrp dictionary \| \| the top level parameters set \| \| \| \_image-base64 string \| \| no description \| \| \| allow-routing string \| Choices:* disable * enable \| Enable/disable use of this group in the static route configuration. \| \| \| category string \| Choices:* default * ztna-ems-tag * ztna-geo-tag \| Address group category. \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| comment string \| \| no description \| \| \| 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 \| \| \| \| category string \| Choices:* default * ztna-ems-tag * ztna-geo-tag \| Address group category. \| \| \| \| color integer \| \| no description \| \| \| \| comment string \| \| no description \| \| \| \| exclude string \| Choices:* disable * enable \| no description \| \| \| \| exclude-member string \| \| no description \| \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| \| global-object integer \| \| no description \| \| \| \| member list / elements=string \| \| no description \| \| \| \| tags string \| \| no description \| \| \| \| type string \| Choices:* default * array * folder \| no description \| \| \| \| uuid string \| \| no description \| \| \| \| visibility string \| Choices:* disable * enable \| no description \| \| \| exclude string \| Choices:* disable * enable \| Enable/disable address exclusion. \| \| \| exclude-member string \| \| Address exclusion member. \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| global-object integer \| \| Global Object. \| \| \| member list / elements=string \| \| no description \| \| \| name string \| \| Address group name. \| \| \| tagging list / elements=string \| \| no description \| \| \| \| category string \| \| Tag category. \| \| \| \| name string \| \| Tagging entry name. \| \| \| \| tags string \| \| no description \| \| \| type string \| Choices:* default * array * folder \| Address group type. \| \| \| 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. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure IPv4 address groups. fmgr_firewall_addrgrp: bypass_validation: False workspace_locking_adom: <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_addrgrp: allow-routing: <value in [disable, enable]> color: <value of integer> comment: <value of string> dynamic_mapping: - _scope: - name: <value of string> vdom: <value of string> allow-routing: <value in [disable, enable]> color: <value of integer> comment: <value of string> exclude: <value in [disable, enable]> exclude-member: <value of string> member: <value of list> tags: <value of string> uuid: <value of string> visibility: <value in [disable, enable]> _image-base64: <value of string> global-object: <value of integer> type: <value in [default, array, folder]> fabric-object: <value in [disable, enable]> category: <value in [default, ztna-ems-tag, ztna-geo-tag]> member: <value of list> 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]> exclude: <value in [disable, enable]> exclude-member: <value of string> _image-base64: <value of string> global-object: <value of integer> type: <value in [default, array, folder]> fabric-object: <value in [disable, enable]> category: <value in [default, ztna-ems-tag, ztna-geo-tag]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu)	programming_docs
ansible fortinet.fortimanager.fmgr_pkg_firewall_dospolicy6_anomaly – Anomaly name. fortinet.fortimanager.fmgr\_pkg\_firewall\_dospolicy6\_anomaly – Anomaly 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_pkg_firewall_dospolicy6_anomaly`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| DoS-policy6 string / required \| \| the parameter (DoS-policy6) in requested url \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| pkg string / required \| \| the parameter (pkg) in requested url \| \| pkg\_firewall\_dospolicy6\_anomaly dictionary \| \| the top level parameters set \| \| \| 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 = 5m). Requ... \| \| \| 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 has a d... \| \| \| threshold(default) 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: Anomaly name. fmgr_pkg_firewall_dospolicy6_anomaly: bypass_validation: False workspace_locking_adom: <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> DoS-policy6: <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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_customurllist – Configure the URL database for rating and filtering. fortinet.fortimanager.fmgr\_fmupdate\_customurllist – Configure the URL database for rating and filtering. ========================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_customurllist`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_customurllist dictionary \| \| the top level parameters set \| \| \| db\_selection list / elements=string \| Choices:* both * custom-url * fortiguard-db \| 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 the URL database for rating and filtering. fmgr_fmupdate_customurllist: bypass_validation: 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_customurllist: db_selection: - both - custom-url - fortiguard-db ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mmsprofile_notification – Notification configuration. fortinet.fortimanager.fmgr\_firewall\_mmsprofile\_notification – Notification 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_notification`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_notification dictionary \| \| the top level parameters set \| \| \| alert-int integer \| \| Alert notification send interval. \| \| \| alert-int-mode string \| Choices:* hours * minutes \| Alert notification interval mode. \| \| \| alert-src-msisdn string \| \| Specify from address for alert messages. \| \| \| alert-status string \| Choices:* disable * enable \| Alert notification status. \| \| \| bword-int integer \| \| Banned word notification send interval. \| \| \| bword-int-mode string \| Choices:* hours * minutes \| Banned word notification interval mode. \| \| \| bword-status string \| Choices:* disable * enable \| Banned word notification status. \| \| \| carrier-endpoint-bwl-int integer \| \| Carrier end point black/white list notification send interval. \| \| \| carrier-endpoint-bwl-int-mode string \| Choices:* hours * minutes \| Carrier end point black/white list notification interval mode. \| \| \| carrier-endpoint-bwl-status string \| Choices:* disable * enable \| Carrier end point black/white list notification status. \| \| \| days-allowed list / elements=string \| Choices:* sunday * monday * tuesday * wednesday * thursday * friday * saturday \| no description \| \| \| detect-server string \| Choices:* disable * enable \| Enable/disable automatic server address determination. \| \| \| dupe-int integer \| \| Duplicate notification send interval. \| \| \| dupe-int-mode string \| Choices:* hours * minutes \| Duplicate notification interval mode. \| \| \| dupe-status string \| Choices:* disable * enable \| Duplicate notification status. \| \| \| file-block-int integer \| \| File block notification send interval. \| \| \| file-block-int-mode string \| Choices:* hours * minutes \| File block notification interval mode. \| \| \| file-block-status string \| Choices:* disable * enable \| File block notification status. \| \| \| flood-int integer \| \| Flood notification send interval. \| \| \| flood-int-mode string \| Choices:* hours * minutes \| Flood notification interval mode. \| \| \| flood-status string \| Choices:* disable * enable \| Flood notification status. \| \| \| from-in-header string \| Choices:* disable * enable \| Enable/disable insertion of from address in HTTP header. \| \| \| mms-checksum-int integer \| \| MMS checksum notification send interval. \| \| \| mms-checksum-int-mode string \| Choices:* hours * minutes \| MMS checksum notification interval mode. \| \| \| mms-checksum-status string \| Choices:* disable * enable \| MMS checksum notification status. \| \| \| mmsc-hostname string \| \| Host name or IP address of the MMSC. \| \| \| mmsc-password string \| \| no description \| \| \| mmsc-port integer \| \| Port used on the MMSC for sending MMS messages (1 - 65535). \| \| \| mmsc-url string \| \| URL used on the MMSC for sending MMS messages. \| \| \| mmsc-username string \| \| User name required for authentication with the MMSC. \| \| \| msg-protocol string \| Choices:* mm1 * mm3 * mm4 * mm7 \| Protocol to use for sending notification messages. \| \| \| msg-type string \| Choices:* submit-req * deliver-req \| MM7 message type. \| \| \| protocol string \| \| Protocol. \| \| \| rate-limit integer \| \| Rate limit for sending notification messages (0 - 250). \| \| \| tod-window-duration string \| \| Time of day window duration. \| \| \| tod-window-end string \| \| Obsolete. \| \| \| tod-window-start string \| \| Time of day window start. \| \| \| user-domain string \| \| Domain name to which the user addresses belong. \| \| \| vas-id string \| \| VAS identifier. \| \| \| vasp-id string \| \| VASP identifier. \| \| \| virus-int integer \| \| Virus notification send interval. \| \| \| virus-int-mode string \| Choices:* hours * minutes \| Virus notification interval mode. \| \| \| virus-status string \| Choices:* disable * enable \| Virus notification status. \| \| 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: Notification configuration. fmgr_firewall_mmsprofile_notification: bypass_validation: False workspace_locking_adom: <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_notification: alert-int: <value of integer> alert-int-mode: <value in [hours, minutes]> alert-src-msisdn: <value of string> alert-status: <value in [disable, enable]> bword-int: <value of integer> bword-int-mode: <value in [hours, minutes]> bword-status: <value in [disable, enable]> carrier-endpoint-bwl-int: <value of integer> carrier-endpoint-bwl-int-mode: <value in [hours, minutes]> carrier-endpoint-bwl-status: <value in [disable, enable]> days-allowed: - sunday - monday - tuesday - wednesday - thursday - friday - saturday detect-server: <value in [disable, enable]> dupe-int: <value of integer> dupe-int-mode: <value in [hours, minutes]> dupe-status: <value in [disable, enable]> file-block-int: <value of integer> file-block-int-mode: <value in [hours, minutes]> file-block-status: <value in [disable, enable]> flood-int: <value of integer> flood-int-mode: <value in [hours, minutes]> flood-status: <value in [disable, enable]> from-in-header: <value in [disable, enable]> mms-checksum-int: <value of integer> mms-checksum-int-mode: <value in [hours, minutes]> mms-checksum-status: <value in [disable, enable]> mmsc-hostname: <value of string> mmsc-password: <value of string> mmsc-port: <value of integer> mmsc-url: <value of string> mmsc-username: <value of string> msg-protocol: <value in [mm1, mm3, mm4, ...]> msg-type: <value in [submit-req, deliver-req]> protocol: <value of string> rate-limit: <value of integer> tod-window-duration: <value of string> tod-window-end: <value of string> tod-window-start: <value of string> user-domain: <value of string> vas-id: <value of string> vasp-id: <value of string> virus-int: <value of integer> virus-int-mode: <value in [hours, minutes]> virus-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_antiphish_custompatterns – Custom username and password regex patterns. fortinet.fortimanager.fmgr\_webfilter\_profile\_antiphish\_custompatterns – Custom username and password regex patterns. ======================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_custompatterns`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_custompatterns dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 username and password regex patterns. fmgr_webfilter_profile_antiphish_custompatterns: bypass_validation: False workspace_locking_adom: <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_antiphish_custompatterns: category: <value in [username, password]> pattern: <value of string> type: <value in [regex, literal]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_anqp3gppcellular – Configure 3GPP public land mobile network fortinet.fortimanager.fmgr\_hotspot20\_anqp3gppcellular – Configure 3GPP public land mobile network =================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_anqp3gppcellular`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_anqp3gppcellular dictionary \| \| the top level parameters set \| \| \| mcc-mnc-list list / elements=string \| \| no description \| \| \| \| id integer \| \| ID. \| \| \| \| mcc string \| \| Mobile country code. \| \| \| \| mnc string \| \| Mobile network code. \| \| \| name string \| \| 3GPP PLMN 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 3GPP public land mobile network fmgr_hotspot20_anqp3gppcellular: bypass_validation: False workspace_locking_adom: <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_anqp3gppcellular: mcc-mnc-list: - id: <value of integer> mcc: <value of string> mnc: <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_template – no description fortinet.fortimanager.fmgr\_template – no description ===================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_template`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| state string / required \| Choices:* present * absent \| the directive to create, update or delete an object \| \| template dictionary \| \| the top level parameters set \| \| \| description string \| \| no description \| \| \| modification-time string \| \| no description \| \| \| name string \| \| no description \| \| \| script 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_template: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> template: description: <value of string> modification-time: <value of string> name: <value of string> script: <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_disk_filter – Filter for disk logging. fortinet.fortimanager.fmgr\_system\_locallog\_disk\_filter – Filter for disk 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_disk_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\_disk\_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 disk logging. fmgr_system_locallog_disk_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_disk_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_vpn_ssl_settings_authenticationrule – Authentication rule for SSL VPN. fortinet.fortimanager.fmgr\_vpn\_ssl\_settings\_authenticationrule – Authentication rule for 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_authenticationrule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_authenticationrule dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Authentication rule for SSL VPN. fmgr_vpn_ssl_settings_authenticationrule: bypass_validation: 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> state: <value in [present, absent]> vpn_ssl_settings_authenticationrule: 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_youtubechannelfilter – Configure YouTube channel filter. fortinet.fortimanager.fmgr\_videofilter\_youtubechannelfilter – Configure 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_videofilter_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 dictionary \| \| the top level parameters set \| \| \| comment string \| \| Comment. \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* block * bypass * monitor \| YouTube channel filter action. \| \| \| \| channel-id string \| \| Channel ID. \| \| \| \| comment string \| \| Comment. \| \| \| \| id integer \| \| ID. \| \| \| id integer \| \| ID. \| \| \| 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 YouTube channel filter. fmgr_videofilter_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> state: <value in [present, absent]> videofilter_youtubechannelfilter: comment: <value of string> entries: - action: <value in [block, bypass, monitor]> channel-id: <value of string> comment: <value of string> id: <value of integer> 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_system_locallog_fortianalyzer3_filter – Filter for FortiAnalyzer3 logging. fortinet.fortimanager.fmgr\_system\_locallog\_fortianalyzer3\_filter – Filter for FortiAnalyzer3 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_fortianalyzer3_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\_fortianalyzer3\_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 FortiAnalyzer3 logging. fmgr_system_locallog_fortianalyzer3_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_fortianalyzer3_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_firewall_sslsshprofile_imaps – Configure IMAPS options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_imaps – Configure IMAPS 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_imaps`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_imaps 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 IMAPS options. fmgr_firewall_sslsshprofile_imaps: bypass_validation: False workspace_locking_adom: <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_imaps: 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) ansible fortinet.fortimanager.fmgr_firewall_schedule_recurring – Recurring schedule configuration. fortinet.fortimanager.fmgr\_firewall\_schedule\_recurring – Recurring schedule 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_recurring`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_recurring dictionary \| \| the top level parameters set \| \| \| color integer \| \| Color of icon on the GUI. \| \| \| day list / elements=string \| Choices:* sunday * monday * tuesday * wednesday * thursday * friday * saturday * none \| no description \| \| \| end string \| \| Time of day to end the schedule, format hh:mm. \| \| \| fabric-object string \| Choices:* disable * enable \| Security Fabric global object setting. \| \| \| global-object integer \| \| Global Object. \| \| \| name string \| \| Recurring schedule name. \| \| \| start string \| \| Time of day to start the schedule, format hh:mm. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: Recurring schedule configuration. fmgr_firewall_schedule_recurring: bypass_validation: False workspace_locking_adom: <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_recurring: color: <value of integer> day: - sunday - monday - tuesday - wednesday - thursday - friday - saturday - none end: <value of string> name: <value of string> start: <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_firewall_wildcardfqdn_custom – Config global/VDOM Wildcard FQDN address. fortinet.fortimanager.fmgr\_firewall\_wildcardfqdn\_custom – Config global/VDOM Wildcard FQDN 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_wildcardfqdn_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 \| \| firewall\_wildcardfqdn\_custom dictionary \| \| the top level parameters set \| \| \| color integer \| \| GUI icon color. \| \| \| comment string \| \| Comment. \| \| \| name string \| \| Address name. \| \| \| uuid string \| \| Universally Unique Identifier (UUID; automatically assigned but can be manually reset). \| \| \| visibility string \| Choices:* disable * enable \| Enable/disable address visibility. \| \| \| wildcard-fqdn string \| \| Wildcard FQDN. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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/VDOM Wildcard FQDN address. fmgr_firewall_wildcardfqdn_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]> firewall_wildcardfqdn_custom: color: <value of integer> comment: <value of string> name: <value of string> uuid: <value of string> visibility: <value in [disable, enable]> wildcard-fqdn: <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 – IPS sensor filter. fortinet.fortimanager.fmgr\_ips\_sensor\_entries – IPS sensor 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_ips_sensor_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 \| \| ips\_sensor\_entries dictionary \| \| the top level parameters set \| \| \| 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 pcap format... \| \| \| 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 attacker. \| \| \| 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 enable. Fi... \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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: IPS sensor filter. fmgr_ips_sensor_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> sensor: <your own value> state: <value in [present, absent]> ips_sensor_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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_sslexempt – Servers to exempt from SSL inspection. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_sslexempt – Servers to exempt from SSL inspection. ======================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_sslexempt`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sslexempt dictionary \| \| the top level parameters set \| \| \| address string \| \| IPv4 address object. \| \| \| address6 string \| \| IPv6 address object. \| \| \| fortiguard-category string \| \| FortiGuard category ID. \| \| \| id integer \| \| ID number. \| \| \| regex string \| \| Exempt servers by regular expression. \| \| \| type string \| Choices:* fortiguard-category * address * address6 * wildcard-fqdn * regex \| Type of address object (IPv4 or IPv6) or FortiGuard category. \| \| \| wildcard-fqdn string \| \| Exempt servers by wildcard FQDN. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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: Servers to exempt from SSL inspection. fmgr_firewall_sslsshprofile_sslexempt: bypass_validation: False workspace_locking_adom: <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> state: <value in [present, absent]> firewall_sslsshprofile_sslexempt: address: <value of string> address6: <value of string> fortiguard-category: <value of string> id: <value of integer> regex: <value of string> type: <value in [fortiguard-category, address, address6, ...]> wildcard-fqdn: <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_macfilterlist – Create a list of MAC addresses for MAC address filtering. fortinet.fortimanager.fmgr\_vap\_macfilterlist – Create a list of MAC addresses for MAC address filtering. ========================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_macfilterlist`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_macfilterlist dictionary \| \| the top level parameters set \| \| \| id integer \| \| ID. \| \| \| mac string \| \| MAC address. \| \| \| mac-filter-policy string \| Choices:* deny * allow \| Deny or allow the client with this MAC 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: Create a list of MAC addresses for MAC address filtering. fmgr_vap_macfilterlist: bypass_validation: False workspace_locking_adom: <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_macfilterlist: id: <value of integer> mac: <value of string> mac-filter-policy: <value in [deny, 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_devprof_system_snmp_community_hosts6 – Configure IPv6 SNMP managers. fortinet.fortimanager.fmgr\_devprof\_system\_snmp\_community\_hosts6 – Configure IPv6 SNMP managers. ==================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_hosts6`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| community string / required \| \| the parameter (community) in requested url \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_snmp\_community\_hosts6 dictionary \| \| the top level parameters set \| \| \| 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. \| \| 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 IPv6 SNMP managers. fmgr_devprof_system_snmp_community_hosts6: bypass_validation: False workspace_locking_adom: <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> community: <your own value> state: <value in [present, absent]> devprof_system_snmp_community_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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mapi – Configure MAPI protocol options. fortinet.fortimanager.fmgr\_firewall\_profileprotocoloptions\_mapi – Configure MAPI 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_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 \| \| firewall\_profileprotocoloptions\_mapi dictionary \| \| the top level parameters set \| \| \| options list / elements=string \| Choices:* fragmail * oversize * no-content-summary \| no description \| \| \| oversize-limit integer \| \| Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). \| \| \| ports integer \| \| no description \| \| \| scan-bzip2 string \| Choices:* disable * enable \| Enable/disable scanning of BZip2 compressed files. \| \| \| status string \| Choices:* disable * enable \| Enable/disable the active status of scanning for this protocol. \| \| \| uncompressed-nest-limit integer \| \| Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). \| \| \| uncompressed-oversize-limit integer \| \| Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). \| \| 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 MAPI protocol options. fmgr_firewall_profileprotocoloptions_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-protocol-options: <your own value> firewall_profileprotocoloptions_mapi: options: - fragmail - oversize - no-content-summary oversize-limit: <value of integer> ports: <value of integer> scan-bzip2: <value in [disable, enable]> status: <value in [disable, enable]> uncompressed-nest-limit: <value of integer> uncompressed-oversize-limit: <value of integer> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_fortiguard – Configure FortiGuard services. fortinet.fortimanager.fmgr\_system\_fortiguard – Configure FortiGuard 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_system_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 \| \| 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\_fortiguard dictionary \| \| the top level parameters set \| \| \| antispam-cache string \| Choices:* disable * enable \| Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance. \| \| \| antispam-cache-mpercent integer \| \| Maximum percent of FortiGate memory the antispam cache is allowed to use (1 - 15%). \| \| \| antispam-cache-ttl integer \| \| Time-to-live for antispam cache entries in seconds (300 - 86400). Lower times reduce the cache size. Higher times may improve ... \| \| \| antispam-expiration integer \| \| no description \| \| \| antispam-force-off string \| Choices:* disable * enable \| Enable/disable turning off the FortiGuard antispam service. \| \| \| antispam-license integer \| \| no description \| \| \| antispam-timeout integer \| \| Antispam query time out (1 - 30 sec, default = 7). \| \| \| anycast-sdns-server-ip string \| \| IP address of the FortiGuard anycast DNS rating server. \| \| \| anycast-sdns-server-port integer \| \| Port to connect to on the FortiGuard anycast DNS rating server. \| \| \| auto-join-forticloud string \| Choices:* disable * enable \| Automatically connect to and login to FortiCloud. \| \| \| ddns-server-ip string \| \| IP address of the FortiDDNS server. \| \| \| ddns-server-port integer \| \| Port used to communicate with FortiDDNS servers. \| \| \| fortiguard-anycast string \| Choices:* disable * enable \| Enable/disable use of FortiGuards anycast network. \| \| \| fortiguard-anycast-source string \| Choices:* fortinet * aws * debug \| Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. Default is Fortinet. \| \| \| 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. \| \| \| load-balance-servers integer \| \| Number of servers to alternate between as first FortiGuard option. \| \| \| outbreak-prevention-cache string \| Choices:* disable * enable \| Enable/disable FortiGuard Virus Outbreak Prevention cache. \| \| \| outbreak-prevention-cache-mpercent integer \| \| Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%, default = 2). \| \| \| outbreak-prevention-cache-ttl integer \| \| Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec, default = 300). \| \| \| outbreak-prevention-expiration integer \| \| no description \| \| \| outbreak-prevention-force-off string \| Choices:* disable * enable \| Turn off FortiGuard Virus Outbreak Prevention service. \| \| \| outbreak-prevention-license integer \| \| no description \| \| \| outbreak-prevention-timeout integer \| \| FortiGuard Virus Outbreak Prevention time out (1 - 30 sec, default = 7). \| \| \| persistent-connection string \| Choices:* disable * enable \| Enable/disable use of persistent connection to receive update notification from FortiGuard. \| \| \| port string \| Choices:* 53 * 80 * 8888 * 443 \| Port used to communicate with the FortiGuard servers. \| \| \| protocol string \| Choices:* udp * http * https \| Protocol used to communicate with the FortiGuard servers. \| \| \| proxy-password string \| \| no description \| \| \| proxy-server-ip string \| \| IP address of the proxy server. \| \| \| proxy-server-port integer \| \| Port used to communicate with the proxy server. \| \| \| proxy-username string \| \| Proxy user name. \| \| \| sandbox-region string \| \| Cloud sandbox region. \| \| \| sdns-options list / elements=string \| Choices:* include-question-section \| no description \| \| \| sdns-server-ip string \| \| no description \| \| \| sdns-server-port integer \| \| Port used to communicate with FortiDNS servers. \| \| \| service-account-id string \| \| Service account ID. \| \| \| source-ip string \| \| Source IPv4 address used to communicate with FortiGuard. \| \| \| source-ip6 string \| \| Source IPv6 address used to communicate with FortiGuard. \| \| \| update-build-proxy string \| Choices:* disable * enable \| Enable/disable proxy dictionary rebuild. \| \| \| update-extdb string \| Choices:* disable * enable \| Enable/disable external resource update. \| \| \| update-ffdb string \| Choices:* disable * enable \| Enable/disable Internet Service Database update. \| \| \| update-server-location string \| Choices:* any * usa \| Signature update server location. \| \| \| update-uwdb string \| Choices:* disable * enable \| Enable/disable allowlist update. \| \| \| videofilter-expiration integer \| \| no description \| \| \| videofilter-license integer \| \| no description \| \| \| webfilter-cache string \| Choices:* disable * enable \| Enable/disable FortiGuard web filter caching. \| \| \| webfilter-cache-ttl integer \| \| Time-to-live for web filter cache entries in seconds (300 - 86400). \| \| \| webfilter-expiration integer \| \| no description \| \| \| webfilter-force-off string \| Choices:* disable * enable \| Enable/disable turning off the FortiGuard web filtering service. \| \| \| webfilter-license integer \| \| no description \| \| \| webfilter-timeout integer \| \| Web filter query time out (1 - 30 sec, default = 7). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 services. fmgr_system_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> system_fortiguard: antispam-cache: <value in [disable, enable]> antispam-cache-mpercent: <value of integer> antispam-cache-ttl: <value of integer> antispam-expiration: <value of integer> antispam-force-off: <value in [disable, enable]> antispam-license: <value of integer> antispam-timeout: <value of integer> auto-join-forticloud: <value in [disable, enable]> ddns-server-ip: <value of string> ddns-server-port: <value of integer> load-balance-servers: <value of integer> outbreak-prevention-cache: <value in [disable, enable]> outbreak-prevention-cache-mpercent: <value of integer> outbreak-prevention-cache-ttl: <value of integer> outbreak-prevention-expiration: <value of integer> outbreak-prevention-force-off: <value in [disable, enable]> outbreak-prevention-license: <value of integer> outbreak-prevention-timeout: <value of integer> port: <value in [53, 80, 8888, ...]> sdns-server-ip: <value of string> sdns-server-port: <value of integer> service-account-id: <value of string> source-ip: <value of string> source-ip6: <value of string> update-server-location: <value in [any, usa]> webfilter-cache: <value in [disable, enable]> webfilter-cache-ttl: <value of integer> webfilter-expiration: <value of integer> webfilter-force-off: <value in [disable, enable]> webfilter-license: <value of integer> webfilter-timeout: <value of integer> protocol: <value in [udp, http, https]> proxy-password: <value of string> proxy-server-ip: <value of string> proxy-server-port: <value of integer> proxy-username: <value of string> sandbox-region: <value of string> fortiguard-anycast: <value in [disable, enable]> fortiguard-anycast-source: <value in [fortinet, aws, debug]> interface: <value of string> interface-select-method: <value in [auto, sdwan, specify]> sdns-options: - include-question-section anycast-sdns-server-ip: <value of string> anycast-sdns-server-port: <value of integer> persistent-connection: <value in [disable, enable]> update-build-proxy: <value in [disable, enable]> update-extdb: <value in [disable, enable]> update-ffdb: <value in [disable, enable]> update-uwdb: <value in [disable, enable]> videofilter-expiration: <value of integer> videofilter-license: <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_wtpprofile_radio2 – Configuration options for radio 2. fortinet.fortimanager.fmgr\_wtpprofile\_radio2 – Configuration options for radio 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_wtpprofile_radio2`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_radio2 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 \| \| Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). \| \| \| auto-power-level string \| Choices:* disable * enable \| Enable/disable automatic power-level adjustment to prevent co-channel interference (default = disable). \| \| \| auto-power-low integer \| \| Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). \| \| \| auto-power-target string \| \| The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). \| \| \| band string \| Choices:* 802.11b * 802.11a * 802.11g * 802.11n * 802.11ac * 802.11n-5G * 802.11g-only * 802.11n-only * 802.11n,g-only * 802.11ac-only * 802.11ac,n-only * 802.11n-5G-only * 802.11ax-5G * 802.11ax * 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 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 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:* disable * enable * 80MHz * 40MHz * 20MHz * 160MHz \| Channel bandwidth: 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 \| \| DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255, default = 1). ... \| \| \| 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 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 = 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 2. fmgr_wtpprofile_radio2: bypass_validation: False workspace_locking_adom: <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_radio2: 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 [disable, enable, 80MHz, ...]> 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> airtime-fairness: <value in [disable, enable]> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_devprof_system_replacemsg_sslvpn – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_sslvpn – 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_sslvpn`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_sslvpn 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_sslvpn: bypass_validation: False workspace_locking_adom: <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_sslvpn: 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_admin_user – Admin user. fortinet.fortimanager.fmgr\_system\_admin\_user – Admin user. ============================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 dictionary \| \| the top level parameters set \| \| \| adom list / elements=string \| \| no description \| \| \| \| adom-name string \| \| Admin domain names. \| \| \| adom-exclude list / elements=string \| \| no description \| \| \| \| adom-name string \| \| Admin domain names. \| \| \| app-filter list / elements=string \| \| no description \| \| \| \| app-filter-name string \| \| App filter name. \| \| \| avatar string \| \| Image file for avatar (maximum 4K base64 encoded). \| \| \| ca string \| \| PKI user certificate CA (CA name in local). \| \| \| change-password string \| Choices:* disable ← * enable \| Enable/disable restricted user to change self password. disable - Disable setting. enable - Enable setting. \| \| \| dashboard list / elements=string \| \| no description \| \| \| \| column integer \| Default:0 \| Widgets column ID. \| \| \| \| diskio-content-type string \| Choices:* util ← * iops * blks \| Disk I/O Monitor widgets chart type. util - bandwidth utilization. iops - the number of I/O requests. blks - the amount of data of I/O requests. \| \| \| \| diskio-period string \| Choices:* 1hour ← * 8hour * 24hour \| Disk I/O Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. \| \| \| \| log-rate-period string \| Choices:* 2min * 1hour * 6hours \| Log receive monitor widgets data period. 2min - 2 minutes. 1hour - 1 hour. 6hours - 6 hours. \| \| \| \| log-rate-topn string \| Choices:* 1 * 2 * 3 * 4 * 5 ← \| Log receive monitor widgets number of top items to display. 1 - Top 1. 2 - Top 2. 3 - Top 3. 4 - Top 4. 5 - Top 5. \| \| \| \| log-rate-type string \| Choices:* log * device ← \| Log receive monitor widgets statistics breakdown options. log - Show log rates for each log type. device - Show log rates for each device. \| \| \| \| moduleid integer \| Default:0 \| Widget ID. \| \| \| \| name string \| \| Widget name. \| \| \| \| num-entries integer \| Default:10 \| Number of entries. \| \| \| \| refresh-interval integer \| Default:300 \| Widgets refresh interval. \| \| \| \| res-cpu-display string \| Choices:* average ← * each \| Widgets CPU display type. average - Average usage of CPU. each - Each usage of CPU. \| \| \| \| res-period string \| Choices:* 10min ← * hour * day \| Widgets data period. 10min - Last 10 minutes. hour - Last hour. day - Last day. \| \| \| \| res-view-type string \| Choices:* real-time * history ← \| Widgets data view type. real-time - Real-time view. history - History view. \| \| \| \| status string \| Choices:* close * open ← \| Widgets opened/closed state. close - Widget closed. open - Widget opened. \| \| \| \| tabid integer \| Default:0 \| ID of tab where widget is displayed. \| \| \| \| time-period string \| Choices:* 1hour ← * 8hour * 24hour \| Log Database Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. \| \| \| \| widget-type string \| Choices:* top-lograte * sysres * sysinfo * licinfo * jsconsole * sysop * alert * statistics * rpteng * raid * logrecv * devsummary * logdb-perf * logdb-lag * disk-io * log-rcvd-fwd \| Widget type. top-lograte - Log Receive Monitor. sysres - System resources. sysinfo - System Information. licinfo - License Information. jsconsole - CLI Console. sysop - Unit Operation. alert - Alert Message Console. statistics - Statistics. rpteng - Report Engine. raid - Disk Monitor. logrecv - Logs/Data Received. devsummary - Device Summary. logdb-perf - Log Database Performance Monitor. logdb-lag - Log Database Lag Time. disk-io - Disk I/O. log-rcvd-fwd - Log receive and forwarding Monitor. \| \| \| dashboard-tabs list / elements=string \| \| no description \| \| \| \| name string \| \| Tab name. \| \| \| \| tabid integer \| Default:0 \| Tab ID. \| \| \| description string \| \| Description. \| \| \| dev-group string \| \| device group. \| \| \| email-address string \| \| Email address. \| \| \| ext-auth-accprofile-override string \| Choices:* disable ← * enable \| Allow to use the access profile provided by the remote authentication server. disable - Disable access profile override. enable - Enable access profile override. \| \| \| ext-auth-adom-override string \| Choices:* disable ← * enable \| Allow to use the ADOM provided by the remote authentication server. disable - Disable ADOM override. enable - Enable ADOM override. \| \| \| ext-auth-group-match string \| \| Only administrators belonging to this group can login. \| \| \| first-name string \| \| First name. \| \| \| force-password-change string \| Choices:* disable ← * enable \| Enable/disable force password change on next login. disable - Disable setting. enable - Enable setting. \| \| \| group string \| \| Group name. \| \| \| hidden integer \| Default:0 \| Hidden administrator. \| \| \| ips-filter list / elements=string \| \| no description \| \| \| \| ips-filter-name string \| \| IPS filter name. \| \| \| ipv6\_trusthost1 string \| Default:"::/0" \| Admin user trusted host IPv6, default ::/0 for all. \| \| \| ipv6\_trusthost10 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost2 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost3 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost4 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost5 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost6 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost7 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost8 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| ipv6\_trusthost9 string \| Default:"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128" \| Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. \| \| \| last-name string \| \| Last name. \| \| \| ldap-server string \| \| LDAP server name. \| \| \| login-max integer \| Default:32 \| Max login session for this user. \| \| \| meta-data list / elements=string \| \| no description \| \| \| \| fieldlength integer \| Default:0 \| Field length. \| \| \| \| fieldname string \| \| Field name. \| \| \| \| fieldvalue string \| \| Field value. \| \| \| \| importance string \| Choices:* optional ← * required \| Importance. optional - This field is optional. required - This field is required. \| \| \| \| status string \| Choices:* disabled * enabled ← \| Status. disabled - This field is disabled. enabled - This field is enabled. \| \| \| mobile-number string \| \| Mobile number. \| \| \| pager-number string \| \| Pager number. \| \| \| password string \| \| no description \| \| \| password-expire string \| \| no description \| \| \| phone-number string \| \| Phone number. \| \| \| policy-package list / elements=string \| \| no description \| \| \| \| policy-package-name string \| \| Policy package names. \| \| \| profileid string \| Default:"Restricted\_User" \| Profile ID. \| \| \| radius\_server string \| \| RADIUS server name. \| \| \| restrict-access string \| Choices:* disable ← * enable \| Enable/disable restricted access to development VDOM. disable - Disable setting. enable - Enable setting. \| \| \| restrict-dev-vdom list / elements=string \| \| no description \| \| \| \| dev-vdom string \| \| Device or device VDOM. \| \| \| rpc-permit string \| Choices:* read-write * none ← * read \| set none/read/read-write rpc-permission. read-write - Read-write permission. none - No permission. read - Read-only permission. \| \| \| ssh-public-key1 string \| \| no description \| \| \| ssh-public-key2 string \| \| no description \| \| \| ssh-public-key3 string \| \| no description \| \| \| subject string \| \| PKI user certificate name constraints. \| \| \| tacacs-plus-server string \| \| TACACS+ server name. \| \| \| trusthost1 string \| Default:"0.0.0.0 0.0.0.0" \| Admin user trusted host IP, default 0.0.0.0 0.0.0.0 for all. \| \| \| trusthost10 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost2 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost3 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost4 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost5 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost6 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost7 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost8 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| trusthost9 string \| Default:"255.255.255.255 255.255.255.255" \| Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. \| \| \| two-factor-auth string \| Choices:* disable ← * enable \| Enable 2-factor authentication (certificate + password). disable - Disable 2-factor authentication. enable - Enable 2-factor authentication. \| \| \| use-global-theme string \| Choices:* disable * enable ← \| Enable/disble global theme for administration GUI. disable - Disable setting. enable - Enable setting. \| \| \| user-theme string \| Choices:* blue ← * green * red * melongene * spring * summer * autumn * winter * circuit-board * calla-lily * binary-tunnel * mars * blue-sea * technology * landscape * twilight * canyon * northern-light * astronomy * fish * penguin * mountain * panda * parrot * cave * zebra * contrast-dark \| Color scheme to use for the admin user GUI. blue - Blueberry green - Kiwi red - Cherry melongene - Plum spring - Spring summer - Summer autumn - Autumn winter - Winter circuit-board - Circuit Board calla-lily - Calla Lily binary-tunnel - Binary Tunnel mars - Mars blue-sea - Blue Sea technology - Technology landscape - Landscape twilight - Twilight canyon - Canyon northern-light - Northern Light astronomy - Astronomy fish - Fish penguin - Penguin mountain - Mountain panda - Panda parrot - Parrot cave - Cave zebra - Zebra contrast-dark - High Contrast Dark \| \| \| user\_type string \| Choices:* local ← * radius * ldap * tacacs-plus * pki-auth * group * sso \| User type. local - Local user. radius - RADIUS user. ldap - LDAP user. tacacs-plus - TACACS+ user. pki-auth - PKI user. group - Group user. \| \| \| userid string \| \| User name. \| \| \| web-filter list / elements=string \| \| no description \| \| \| \| web-filter-name string \| \| Web filter name. \| \| \| wildcard string \| Choices:* disable ← * enable \| Enable/disable wildcard remote authentication. disable - Disable username wildcard. enable - Enable username wildcard. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Admin user. fmgr_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, ...] state: <value in [present, absent]> system_admin_user: adom: - adom-name: <value of string> adom-exclude: - adom-name: <value of string> app-filter: - app-filter-name: <value of string> avatar: <value of string> ca: <value of string> change-password: <value in [disable, enable]> dashboard: - column: <value of integer> diskio-content-type: <value in [util, iops, blks]> diskio-period: <value in [1hour, 8hour, 24hour]> log-rate-period: <value in [2min , 1hour, 6hours]> log-rate-topn: <value in [1, 2, 3, ...]> log-rate-type: <value in [log, device]> moduleid: <value of integer> name: <value of string> num-entries: <value of integer> refresh-interval: <value of integer> res-cpu-display: <value in [average , each]> res-period: <value in [10min , hour, day]> res-view-type: <value in [real-time , history]> status: <value in [close, open]> tabid: <value of integer> time-period: <value in [1hour, 8hour, 24hour]> widget-type: <value in [top-lograte, sysres, sysinfo, ...]> dashboard-tabs: - name: <value of string> tabid: <value of integer> description: <value of string> dev-group: <value of string> email-address: <value of string> ext-auth-accprofile-override: <value in [disable, enable]> ext-auth-adom-override: <value in [disable, enable]> ext-auth-group-match: <value of string> first-name: <value of string> force-password-change: <value in [disable, enable]> group: <value of string> hidden: <value of integer> ips-filter: - ips-filter-name: <value of string> ipv6_trusthost1: <value of string> ipv6_trusthost10: <value of string> ipv6_trusthost2: <value of string> ipv6_trusthost3: <value of string> ipv6_trusthost4: <value of string> ipv6_trusthost5: <value of string> ipv6_trusthost6: <value of string> ipv6_trusthost7: <value of string> ipv6_trusthost8: <value of string> ipv6_trusthost9: <value of string> last-name: <value of string> ldap-server: <value of string> meta-data: - fieldlength: <value of integer> fieldname: <value of string> fieldvalue: <value of string> importance: <value in [optional, required]> status: <value in [disabled, enabled]> mobile-number: <value of string> pager-number: <value of string> password: <value of string> password-expire: <value of string> phone-number: <value of string> policy-package: - policy-package-name: <value of string> profileid: <value of string> radius_server: <value of string> restrict-access: <value in [disable, enable]> restrict-dev-vdom: - dev-vdom: <value of string> rpc-permit: <value in [read-write, none, read]> ssh-public-key1: <value of string> ssh-public-key2: <value of string> ssh-public-key3: <value of string> subject: <value of string> tacacs-plus-server: <value of string> trusthost1: <value of string> trusthost10: <value of string> trusthost2: <value of string> trusthost3: <value of string> trusthost4: <value of string> trusthost5: <value of string> trusthost6: <value of string> trusthost7: <value of string> trusthost8: <value of string> trusthost9: <value of string> two-factor-auth: <value in [disable, enable]> user_type: <value in [local, radius, ldap, ...]> userid: <value of string> web-filter: - web-filter-name: <value of string> wildcard: <value in [disable, enable]> login-max: <value of integer> use-global-theme: <value in [disable, enable]> user-theme: <value in [blue, green, red, ...]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_iprange – DHCP IP range configuration. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_dhcpserver\_iprange – DHCP IP range 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_dynamicmapping_dhcpserver_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 \| \| 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\_iprange 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: DHCP IP range configuration. fmgr_fsp_vlan_dynamicmapping_dhcpserver_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> vlan: <your own value> dynamic_mapping: <your own value> state: <value in [present, absent]> fsp_vlan_dynamicmapping_dhcpserver_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_dnsfilter_profile_ftgddns_filters – FortiGuard DNS domain filters. fortinet.fortimanager.fmgr\_dnsfilter\_profile\_ftgddns\_filters – FortiGuard DNS domain filters. ================================================================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_ftgddns_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 \| \| dnsfilter\_profile\_ftgddns\_filters dictionary \| \| the top level parameters set \| \| \| 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. \| \| 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: FortiGuard DNS domain filters. fmgr_dnsfilter_profile_ftgddns_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]> dnsfilter_profile_ftgddns_filters: action: <value in [monitor, block]> category: <value of string> 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_fsp_vlan_dhcpserver_reservedaddress – Options for the DHCP server to assign IP settings to specific MAC addresses. fortinet.fortimanager.fmgr\_fsp\_vlan\_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_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 \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| fsp\_vlan\_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_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> state: <value in [present, absent]> fsp_vlan_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_dvmdb_workflow_submit – no description fortinet.fortimanager.fmgr\_dvmdb\_workflow\_submit – 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_submit`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| dvmdb\_workflow\_submit dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| \| fmgip string \| \| no description \| \| \| mail\_user string \| \| no description \| \| \| no\_diff integer \| \| no description \| \| \| no\_mail integer \| \| no description \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list with which the conditions to succeed will be overriden \| \| session\_id string / required \| \| the parameter (session\_id) in requested url \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: no description fmgr_dvmdb_workflow_submit: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> session_id: <your own value> dvmdb_workflow_submit: desc: <value of string> fmgip: <value of string> mail_user: <value of string> no_diff: <value of integer> no_mail: <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_dvmdb_folder – no description fortinet.fortimanager.fmgr\_dvmdb\_folder – 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_folder`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_folder dictionary \| \| the top level parameters set \| \| \| desc string \| \| no description \| \| \| name string \| \| no description \| \| \| parent 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: no description fmgr_dvmdb_folder: bypass_validation: False workspace_locking_adom: <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_folder: desc: <value of string> name: <value of string> parent: <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_cifs_profile_filefilter – File filter. fortinet.fortimanager.fmgr\_cifs\_profile\_filefilter – File 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_cifs_profile_filefilter`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| cifs\_profile\_filefilter dictionary \| \| the top level parameters set \| \| \| entries list / elements=string \| \| no description \| \| \| \| action string \| Choices:* block * log \| Action taken for matched file. \| \| \| \| comment string \| \| Comment. \| \| \| \| direction string \| Choices:* incoming * outgoing * any \| Match files transmitted in the sessions originating or reply direction. \| \| \| \| file-type string \| \| no description \| \| \| \| filter string \| \| Add a file filter. \| \| \| \| protocol list / elements=string \| Choices:* cifs \| no description \| \| \| log string \| Choices:* disable * enable \| Enable/disable file filter logging. \| \| \| status string \| Choices:* disable * enable \| Enable/disable file filter. \| \| 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. fmgr_cifs_profile_filefilter: bypass_validation: False workspace_locking_adom: <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> cifs_profile_filefilter: entries: - action: <value in [block, log]> comment: <value of string> direction: <value in [incoming, outgoing, any]> file-type: <value of string> filter: <value of string> protocol: - cifs log: <value in [disable, enable]> 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_fmupdate_fctservices – Configure FortiGuard to provide services to FortiClient installations. fortinet.fortimanager.fmgr\_fmupdate\_fctservices – Configure FortiGuard to provide services to FortiClient installations. ========================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_fctservices`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_fctservices dictionary \| \| the top level parameters set \| \| \| port integer \| Default:80 \| Configure the port number on which the built-in FortiGuard should provide updates to FortiClient installations (1 - 65535, def... \| \| \| status string \| Choices:* disable * enable ← \| Enable/disable built-in FortiGuard service to FortiClient installations (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 FortiGuard to provide services to FortiClient installations. fmgr_fmupdate_fctservices: bypass_validation: 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_fctservices: port: <value of integer> status: <value in [disable, enable]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_securityconsole_install_preview – Generate install preview for a device. fortinet.fortimanager.fmgr\_securityconsole\_install\_preview – Generate install preview for 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_securityconsole_install_preview`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_preview dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM name. \| \| \| device string \| \| no description \| \| \| flags list / elements=string \| Choices:* none * json \| no description \| \| \| vdoms 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: Generate install preview for a device. fmgr_securityconsole_install_preview: bypass_validation: 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_preview: adom: <value of string> device: <value of string> flags: - none - json vdoms: <value of string> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message of the api response Sample: OK. \| ### Authors * Link Zheng (@chillancezen) * Jie Xue (@JieX19) * Frank Shen (@fshen01) * Hongbin Lu (@fgtdev-hblu) ansible fortinet.fortimanager.fmgr_vpnsslweb_portal – Portal. fortinet.fortimanager.fmgr\_vpnsslweb\_portal – Portal. ======================================================= Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vpnsslweb\_portal dictionary \| \| the top level parameters set \| \| \| allow-user-access list / elements=string \| Choices:* web * ftp * telnet * smb * vnc * rdp * ssh * ping * citrix * portforward * sftp \| no description \| \| \| auto-connect string \| Choices:* disable * enable \| Enable/disable automatic connect by client when system is up. \| \| \| bookmark-group list / elements=string \| \| no description \| \| \| \| bookmarks list / elements=string \| \| no description \| \| \| \| \| 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. \| \| \| \| name string \| \| Bookmark group name. \| \| \| custom-lang string \| \| Change the web portal display language. Overrides config system global set language. You can use config system custom-language... \| \| \| customize-forticlient-download-url string \| Choices:* disable * enable \| Enable support of customized download URL for FortiClient. \| \| \| display-bookmark string \| Choices:* disable * enable \| Enable to display the web portal bookmark widget. \| \| \| display-connection-tools string \| Choices:* disable * enable \| Enable to display the web portal connection tools widget. \| \| \| display-history string \| Choices:* disable * enable \| Enable to display the web portal user login history widget. \| \| \| display-status string \| Choices:* disable * enable \| Enable to display the web portal status widget. \| \| \| dns-server1 string \| \| IPv4 DNS server 1. \| \| \| dns-server2 string \| \| IPv4 DNS server 2. \| \| \| dns-suffix string \| \| DNS suffix. \| \| \| exclusive-routing string \| Choices:* disable * enable \| Enable/disable all traffic go through tunnel only. \| \| \| forticlient-download string \| Choices:* disable * enable \| Enable/disable download option for FortiClient. \| \| \| forticlient-download-method string \| Choices:* direct * ssl-vpn \| FortiClient download method. \| \| \| heading string \| \| Web portal heading message. \| \| \| hide-sso-credential string \| Choices:* disable * enable \| Enable to prevent SSO credential being sent to client. \| \| \| host-check string \| Choices:* none * av * fw * av-fw * custom \| Type of host checking performed on endpoints. \| \| \| host-check-interval integer \| \| Periodic host check interval. Value of 0 means disabled and host checking only happens when the endpoint connects. \| \| \| host-check-policy string \| \| One or more policies to require the endpoint to have specific security software. \| \| \| ip-mode string \| Choices:* range * user-group \| Method by which users of this SSL-VPN tunnel obtain IP addresses. \| \| \| ip-pools string \| \| IPv4 firewall source address objects reserved for SSL-VPN tunnel mode clients. \| \| \| ipv6-dns-server1 string \| \| IPv6 DNS server 1. \| \| \| ipv6-dns-server2 string \| \| IPv6 DNS server 2. \| \| \| ipv6-exclusive-routing string \| Choices:* disable * enable \| Enable/disable all IPv6 traffic go through tunnel only. \| \| \| ipv6-pools string \| \| IPv4 firewall source address objects reserved for SSL-VPN tunnel mode clients. \| \| \| ipv6-service-restriction string \| Choices:* disable * enable \| Enable/disable IPv6 tunnel service restriction. \| \| \| ipv6-split-tunneling string \| Choices:* disable * enable \| Enable/disable IPv6 split tunneling. \| \| \| ipv6-split-tunneling-routing-address string \| \| IPv6 SSL-VPN tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneli... \| \| \| ipv6-split-tunneling-routing-negate string \| Choices:* disable * enable \| Enable to negate IPv6 split tunneling routing address. \| \| \| ipv6-tunnel-mode string \| Choices:* disable * enable \| Enable/disable IPv6 SSL-VPN tunnel mode. \| \| \| ipv6-wins-server1 string \| \| IPv6 WINS server 1. \| \| \| ipv6-wins-server2 string \| \| IPv6 WINS server 2. \| \| \| keep-alive string \| Choices:* disable * enable \| Enable/disable automatic reconnect for FortiClient connections. \| \| \| limit-user-logins string \| Choices:* disable * enable \| Enable to limit each user to one SSL-VPN session at a time. \| \| \| mac-addr-action string \| Choices:* deny * allow \| Client MAC address action. \| \| \| mac-addr-check string \| Choices:* disable * enable \| Enable/disable MAC address host checking. \| \| \| mac-addr-check-rule list / elements=string \| \| no description \| \| \| \| mac-addr-list string \| \| no description \| \| \| \| mac-addr-mask integer \| \| Client MAC address mask. \| \| \| \| name string \| \| Client MAC address check rule name. \| \| \| macos-forticlient-download-url string \| \| Download URL for Mac FortiClient. \| \| \| name string \| \| Portal name. \| \| \| os-check string \| Choices:* disable * enable \| Enable to let the FortiGate decide action based on client OS. \| \| \| os-check-list dictionary \| \| no description \| \| \| \| action string \| Choices:* allow * check-up-to-date * deny \| OS check options. \| \| \| \| latest-patch-level string \| \| Latest OS patch level. \| \| \| \| name string \| \| Name. \| \| \| \| tolerance integer \| \| OS patch level tolerance. \| \| \| prefer-ipv6-dns string \| Choices:* disable * enable \| prefer to query IPv6 dns first if enabled. \| \| \| redir-url string \| \| Client login redirect URL. \| \| \| rewrite-ip-uri-ui string \| Choices:* disable * enable \| Rewrite contents for URI contains IP and "/ui/". (default = disable) \| \| \| save-password string \| Choices:* disable * enable \| Enable/disable FortiClient saving the users password. \| \| \| service-restriction string \| Choices:* disable * enable \| Enable/disable tunnel service restriction. \| \| \| skip-check-for-browser string \| Choices:* disable * enable \| Enable to skip host check for browser support. \| \| \| skip-check-for-unsupported-browser string \| Choices:* disable * enable \| Enable to skip host check if browser does not support it. \| \| \| skip-check-for-unsupported-os string \| Choices:* disable * enable \| Enable to skip host check if client OS does not support it. \| \| \| smb-max-version string \| Choices:* smbv1 * smbv2 * smbv3 \| SMB maximum client protocol version. \| \| \| smb-min-version string \| Choices:* smbv1 * smbv2 * smbv3 \| SMB minimum client protocol version. \| \| \| smb-ntlmv1-auth string \| Choices:* disable * enable \| Enable support of NTLMv1 for Samba authentication. \| \| \| smbv1 string \| Choices:* disable * enable \| Enable/disable support of SMBv1 for Samba. \| \| \| split-dns list / elements=string \| \| no description \| \| \| \| dns-server1 string \| \| DNS server 1. \| \| \| \| dns-server2 string \| \| DNS server 2. \| \| \| \| domains string \| \| Split DNS domains used for SSL-VPN clients separated by comma(,). \| \| \| \| id integer \| \| ID. \| \| \| \| ipv6-dns-server1 string \| \| IPv6 DNS server 1. \| \| \| \| ipv6-dns-server2 string \| \| IPv6 DNS server 2. \| \| \| split-tunneling string \| Choices:* disable * enable \| Enable/disable IPv4 split tunneling. \| \| \| split-tunneling-routing-address string \| \| IPv4 SSL-VPN tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneli... \| \| \| split-tunneling-routing-negate string \| Choices:* disable * enable \| Enable to negate split tunneling routing address. \| \| \| theme string \| Choices:* gray * blue * orange * crimson * steelblue * darkgrey * green * melongene * red * mariner * neutrino * jade * graphite * dark-matter * onyx * eclipse \| Web portal color scheme. \| \| \| transform-backward-slashes string \| Choices:* disable * enable \| Transform backward slashes to forward slashes in URLs. \| \| \| tunnel-mode string \| Choices:* disable * enable \| Enable/disable IPv4 SSL-VPN tunnel mode. \| \| \| use-sdwan string \| Choices:* disable * enable \| Use SD-WAN rules to get output interface. \| \| \| user-bookmark string \| Choices:* disable * enable \| Enable to allow web portal users to create their own bookmarks. \| \| \| user-group-bookmark string \| Choices:* disable * enable \| Enable to allow web portal users to create bookmarks for all users in the same user group. \| \| \| web-mode string \| Choices:* disable * enable \| Enable/disable SSL VPN web mode. \| \| \| windows-forticlient-download-url string \| \| Download URL for Windows FortiClient. \| \| \| wins-server1 string \| \| IPv4 WINS server 1. \| \| \| wins-server2 string \| \| IPv4 WINS server 1. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Portal. fmgr_vpnsslweb_portal: bypass_validation: False workspace_locking_adom: <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]> vpnsslweb_portal: allow-user-access: - web - ftp - telnet - smb - vnc - rdp - ssh - ping - citrix - portforward - sftp auto-connect: <value in [disable, enable]> bookmark-group: - 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> name: <value of string> custom-lang: <value of string> customize-forticlient-download-url: <value in [disable, enable]> display-bookmark: <value in [disable, enable]> display-connection-tools: <value in [disable, enable]> display-history: <value in [disable, enable]> display-status: <value in [disable, enable]> dns-server1: <value of string> dns-server2: <value of string> dns-suffix: <value of string> exclusive-routing: <value in [disable, enable]> forticlient-download: <value in [disable, enable]> forticlient-download-method: <value in [direct, ssl-vpn]> heading: <value of string> hide-sso-credential: <value in [disable, enable]> host-check: <value in [none, av, fw, ...]> host-check-interval: <value of integer> host-check-policy: <value of string> ip-mode: <value in [range, user-group]> ip-pools: <value of string> ipv6-dns-server1: <value of string> ipv6-dns-server2: <value of string> ipv6-exclusive-routing: <value in [disable, enable]> ipv6-pools: <value of string> ipv6-service-restriction: <value in [disable, enable]> ipv6-split-tunneling: <value in [disable, enable]> ipv6-split-tunneling-routing-address: <value of string> ipv6-tunnel-mode: <value in [disable, enable]> ipv6-wins-server1: <value of string> ipv6-wins-server2: <value of string> keep-alive: <value in [disable, enable]> limit-user-logins: <value in [disable, enable]> mac-addr-action: <value in [deny, allow]> mac-addr-check: <value in [disable, enable]> mac-addr-check-rule: - mac-addr-list: <value of string> mac-addr-mask: <value of integer> name: <value of string> macos-forticlient-download-url: <value of string> name: <value of string> os-check: <value in [disable, enable]> redir-url: <value of string> save-password: <value in [disable, enable]> service-restriction: <value in [disable, enable]> skip-check-for-unsupported-browser: <value in [disable, enable]> skip-check-for-unsupported-os: <value in [disable, enable]> smb-ntlmv1-auth: <value in [disable, enable]> smbv1: <value in [disable, enable]> split-dns: - dns-server1: <value of string> dns-server2: <value of string> domains: <value of string> id: <value of integer> ipv6-dns-server1: <value of string> ipv6-dns-server2: <value of string> split-tunneling: <value in [disable, enable]> split-tunneling-routing-address: <value of string> theme: <value in [gray, blue, orange, ...]> tunnel-mode: <value in [disable, enable]> user-bookmark: <value in [disable, enable]> user-group-bookmark: <value in [disable, enable]> web-mode: <value in [disable, enable]> windows-forticlient-download-url: <value of string> wins-server1: <value of string> wins-server2: <value of string> skip-check-for-browser: <value in [disable, enable]> smb-max-version: <value in [smbv1, smbv2, smbv3]> smb-min-version: <value in [smbv1, smbv2, smbv3]> transform-backward-slashes: <value in [disable, enable]> ipv6-split-tunneling-routing-negate: <value in [disable, enable]> split-tunneling-routing-negate: <value in [disable, enable]> os-check-list: action: <value in [allow, check-up-to-date, deny]> latest-patch-level: <value of string> name: <value of string> tolerance: <value of integer> use-sdwan: <value in [disable, enable]> prefer-ipv6-dns: <value in [disable, enable]> rewrite-ip-uri-ui: <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_address6_subnetsegment – IPv6 subnet segments. fortinet.fortimanager.fmgr\_firewall\_address6\_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_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 \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_address6\_subnetsegment dictionary \| \| the top level parameters set \| \| \| name string \| \| Name. \| \| \| type string \| Choices:* any * specific \| Subnet segment type. \| \| \| value string \| \| Subnet segment 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: IPv6 subnet segments. fmgr_firewall_address6_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> state: <value in [present, absent]> firewall_address6_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_user_vcenter_rule – no description fortinet.fortimanager.fmgr\_user\_vcenter\_rule – 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_rule`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_rule dictionary \| \| the top level parameters set \| \| \| name string \| \| no description \| \| \| rule string \| \| no description \| \| vcenter string / required \| \| the parameter (vcenter) 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_user_vcenter_rule: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> vcenter: <your own value> state: <value in [present, absent]> user_vcenter_rule: name: <value of string> rule: <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_ipv6_ip6extraaddr – Extra IPv6 address prefixes of interface. fortinet.fortimanager.fmgr\_fsp\_vlan\_dynamicmapping\_interface\_ipv6\_ip6extraaddr – Extra IPv6 address prefixes 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_ip6extraaddr`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_ip6extraaddr dictionary \| \| the top level parameters set \| \| \| prefix 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: Extra IPv6 address prefixes of interface. fmgr_fsp_vlan_dynamicmapping_interface_ipv6_ip6extraaddr: bypass_validation: False workspace_locking_adom: <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_ipv6_ip6extraaddr: prefix: <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_dhcpserver_iprange – DHCP IP range configuration. fortinet.fortimanager.fmgr\_fsp\_vlan\_dhcpserver\_iprange – DHCP IP range 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_dhcpserver_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 \| \| fsp\_vlan\_dhcpserver\_iprange 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: DHCP IP range configuration. fmgr_fsp_vlan_dhcpserver_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> vlan: <your own value> state: <value in [present, absent]> fsp_vlan_dhcpserver_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_dvmdb_adom_objectmember – ADOM table, most attributes are read-only and can only be changed internally. fortinet.fortimanager.fmgr\_dvmdb\_adom\_objectmember – 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_objectmember`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_objectmember dictionary \| \| the top level parameters set \| \| \| name string \| \| no description \| \| \| vdom 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: ADOM table, most attributes are read-only and can only be changed internally. fmgr_dvmdb_adom_objectmember: bypass_validation: False workspace_locking_adom: <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_adom_objectmember: 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_authentication_scheme – Configure Authentication Schemes. fortinet.fortimanager.fmgr\_authentication\_scheme – Configure Authentication Schemes. ====================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install fortinet.fortimanager`. To use it in a playbook, specify: `fortinet.fortimanager.fmgr_authentication_scheme`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| authentication\_scheme dictionary \| \| the top level parameters set \| \| \| domain-controller string \| \| Domain controller setting. \| \| \| ems-device-owner string \| Choices:* disable * enable \| Enable/disable SSH public-key authentication with device owner (default = disable). \| \| \| fsso-agent-for-ntlm string \| \| FSSO agent to use for NTLM authentication. \| \| \| fsso-guest string \| Choices:* disable * enable \| Enable/disable user fsso-guest authentication (default = disable). \| \| \| kerberos-keytab string \| \| Kerberos keytab setting. \| \| \| method list / elements=string \| Choices:* ntlm * basic * digest * form * negotiate * fsso * rsso * ssh-publickey * saml * cert \| no description \| \| \| name string \| \| Authentication scheme name. \| \| \| negotiate-ntlm string \| Choices:* disable * enable \| Enable/disable negotiate authentication for NTLM (default = disable). \| \| \| require-tfa string \| Choices:* disable * enable \| Enable/disable two-factor authentication (default = disable). \| \| \| saml-server string \| \| SAML configuration. \| \| \| saml-timeout integer \| \| SAML authentication timeout in seconds. \| \| \| ssh-ca string \| \| SSH CA name. \| \| \| user-database string \| \| Authentication server to contain user information; "local" (default) or "123" (for LDAP). \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 Authentication Schemes. fmgr_authentication_scheme: bypass_validation: False workspace_locking_adom: <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]> authentication_scheme: domain-controller: <value of string> fsso-agent-for-ntlm: <value of string> fsso-guest: <value in [disable, enable]> kerberos-keytab: <value of string> method: - ntlm - basic - digest - form - negotiate - fsso - rsso - ssh-publickey - saml - cert name: <value of string> negotiate-ntlm: <value in [disable, enable]> require-tfa: <value in [disable, enable]> ssh-ca: <value of string> user-database: <value of string> ems-device-owner: <value in [disable, enable]> saml-server: <value of string> saml-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_vpn_certificate_ocspserver – OCSP server configuration. fortinet.fortimanager.fmgr\_vpn\_certificate\_ocspserver – OCSP server 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_vpn_certificate_ocspserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 \| \| vpn\_certificate\_ocspserver dictionary \| \| the top level parameters set \| \| \| cert string \| \| OCSP server certificate. \| \| \| name string \| \| OCSP server entry name. \| \| \| secondary-cert string \| \| Secondary OCSP server certificate. \| \| \| secondary-url string \| \| Secondary OCSP server URL. \| \| \| source-ip string \| \| Source IP address for communications to the OCSP server. \| \| \| unavail-action string \| Choices:* revoke * ignore \| Action when server is unavailable (revoke the certificate or ignore the result of the check). \| \| \| url string \| \| OCSP server URL. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: OCSP server configuration. fmgr_vpn_certificate_ocspserver: bypass_validation: False workspace_locking_adom: <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]> vpn_certificate_ocspserver: cert: <value of string> name: <value of string> secondary-cert: <value of string> secondary-url: <value of string> source-ip: <value of string> unavail-action: <value in [revoke, ignore]> url: <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_workspace_commit – Commit changes to an ADOM. fortinet.fortimanager.fmgr\_pm\_config\_workspace\_commit – Commit changes to an 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_pm_config_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 changes to an ADOM. fmgr_pm_config_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_switchcontroller_managedswitch_remotelog – Configure logging by FortiSwitch device to a remote syslog server. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_remotelog – Configure logging by FortiSwitch device to a 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_switchcontroller_managedswitch_remotelog`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_remotelog dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 logging by FortiSwitch device to a remote syslog server. fmgr_switchcontroller_managedswitch_remotelog: bypass_validation: False workspace_locking_adom: <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_remotelog: 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_emailserver – Configure the email server used by the FortiGate various things. fortinet.fortimanager.fmgr\_devprof\_system\_emailserver – Configure the email server used by the FortiGate various things. =========================================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_emailserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_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\_emailserver dictionary \| \| the top level parameters set \| \| \| authenticate string \| Choices:* disable * enable \| Enable/disable 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. \| \| \| password string \| \| no description \| \| \| port integer \| \| SMTP server port. \| \| \| reply-to string \| \| Reply-To email address. \| \| \| security string \| Choices:* none * starttls * smtps \| Connection security used by the email server. \| \| \| server string \| \| SMTP server IP address or hostname. \| \| \| source-ip string \| \| SMTP server IPv4 source IP. \| \| \| source-ip6 string \| \| SMTP server IPv6 source IP. \| \| \| ssl-min-proto-version string \| Choices:* default * TLSv1 * TLSv1-1 * TLSv1-2 * SSLv3 \| Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). \| \| \| type string \| Choices:* custom \| Use FortiGuard Message service or custom email server. \| \| \| username string \| \| SMTP server user name for authentication. \| \| \| validate-server string \| Choices:* disable * enable \| Enable/disable validation of server certificate. \| \| 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 the email server used by the FortiGate various things. fmgr_devprof_system_emailserver: bypass_validation: False workspace_locking_adom: <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_emailserver: authenticate: <value in [disable, enable]> password: <value of string> port: <value of integer> reply-to: <value of string> security: <value in [none, starttls, smtps]> server: <value of string> source-ip: <value of string> source-ip6: <value of string> ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]> type: <value in [custom]> username: <value of string> validate-server: <value in [disable, enable]> 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_hotspot20_anqpipaddresstype – Configure IP address type availability. fortinet.fortimanager.fmgr\_hotspot20\_anqpipaddresstype – Configure IP address type availability. ================================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_anqpipaddresstype`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_anqpipaddresstype dictionary \| \| the top level parameters set \| \| \| ipv4-address-type string \| Choices:* not-available * not-known * public * port-restricted * single-NATed-private * double-NATed-private * port-restricted-and-single-NATed * port-restricted-and-double-NATed \| IPv4 address type. \| \| \| ipv6-address-type string \| Choices:* not-available * available * not-known \| IPv6 address type. \| \| \| name string \| \| IP type 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 IP address type availability. fmgr_hotspot20_anqpipaddresstype: bypass_validation: False workspace_locking_adom: <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_anqpipaddresstype: ipv4-address-type: <value in [not-available, not-known, public, ...]> ipv6-address-type: <value in [not-available, available, not-known]> 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_logfetch_clientprofile – Log-fetch client profile settings. fortinet.fortimanager.fmgr\_system\_logfetch\_clientprofile – Log-fetch client profile 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_clientprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_clientprofile dictionary \| \| the top level parameters set \| \| \| client-adom string \| \| Log-fetch client sides adom name. \| \| \| data-range string \| Choices:* custom ← \| Data-range for fetched logs. custom - Specify some other date and time range. \| \| \| data-range-value integer \| Default:10 \| Last n days or hours. \| \| \| device-filter list / elements=string \| \| no description \| \| \| \| 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. \| \| \| end-time* string \| \| no description \| \| \| id integer \| Default:0 \| Log-fetch client profile ID. \| \| \| index-fetch-logs string \| Choices:* disable * enable ← \| Enable/Disable indexing logs automatically after fetching logs. disable - Disable attribute function. enable - Enable attribute function. \| \| \| log-filter list / elements=string \| \| no description \| \| \| \| field string \| \| Field name. \| \| \| \| id integer \| Default:0 \| Log filter ID. \| \| \| \| oper string \| Choices:* = ← * != * < * > * <= * >= * contain * not-contain * match \| Field filter operator. < - =Less than or equal to > - =Greater than or equal to contain - Contain not-contain - Not contain match - Match (expression) \| \| \| \| value string \| \| Field filter operand or free-text matching expression. \| \| \| log-filter-logic string \| Choices:* and * or ← \| And/Or logic for log-filters. and - Logic And. or - Logic Or. \| \| \| log-filter-status string \| Choices:* disable ← * enable \| Enable/Disable log-filter. disable - Disable attribute function. enable - Enable attribute function. \| \| \| name string \| \| Name of log-fetch client profile. \| \| \| password string \| \| no description \| \| \| secure-connection string \| Choices:* disable * enable ← \| Enable/Disable protecting log-fetch connection with TLS/SSL. disable - Disable attribute function. enable - Enable attribute function. \| \| \| server-adom string \| \| Log-fetch server sides adom name. \| \| \| server-ip string \| Default:"0.0.0.0" \| Log-fetch server IP address. \| \| \| start-time string \| \| no description \| \| \| sync-adom-config string \| Choices:* disable ← * enable \| Enable/Disable sync adom related config. disable - Disable attribute function. enable - Enable attribute function. \| \| \| user string \| \| Log-fetch server login username. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 client profile settings. fmgr_system_logfetch_clientprofile: bypass_validation: 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_logfetch_clientprofile: client-adom: <value of string> data-range: <value in [custom]> data-range-value: <value of integer> device-filter: - adom: <value of string> device: <value of string> id: <value of integer> vdom: <value of string> end-time: <value of string> id: <value of integer> index-fetch-logs: <value in [disable, enable]> log-filter: - field: <value of string> id: <value of integer> oper: <value in [=, !=, <, ...]> value: <value of string> log-filter-logic: <value in [and, or]> log-filter-status: <value in [disable, enable]> name: <value of string> password: <value of string> secure-connection: <value in [disable, enable]> server-adom: <value of string> server-ip: <value of string> start-time: <value of string> sync-adom-config: <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_system_snmp_community_hosts – Allow hosts configuration. fortinet.fortimanager.fmgr\_system\_snmp\_community\_hosts – Allow hosts 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_community_hosts`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 \| \| community string / required \| \| the parameter (community) 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\_snmp\_community\_hosts dictionary \| \| the top level parameters set \| \| \| id integer \| Default:0 \| Host entry ID. \| \| \| interface string \| \| Allow interface name. \| \| \| ip string \| Default:"0.0.0.0 0.0.0.0" \| Allow host IP 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: Allow hosts configuration. fmgr_system_snmp_community_hosts: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] community: <your own value> state: <value in [present, absent]> system_snmp_community_hosts: id: <value of integer> interface: <value of string> 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)	programming_docs
ansible fortinet.fortimanager.fmgr_waf_profile_method – Method restriction. fortinet.fortimanager.fmgr\_waf\_profile\_method – Method restriction. ====================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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\_method dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Method restriction. fmgr_waf_profile_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_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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_user – SNMP user configuration. fortinet.fortimanager.fmgr\_system\_snmp\_user – SNMP user 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_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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\_user dictionary \| \| the top level parameters set \| \| \| auth-proto string \| Choices:* md5 * sha ← \| Authentication protocol. md5 - HMAC-MD5-96 authentication protocol. sha - HMAC-SHA-96 authentication protocol. \| \| \| auth-pwd string \| \| no description \| \| \| events list / elements=string \| Choices:* disk\_low * ha\_switch * intf\_ip\_chg * sys\_reboot * cpu\_high * mem\_low * log-alert * log-rate * log-data-rate * lic-gbday * lic-dev-quota * cpu-high-exclude-nice \| no description \| \| \| name string \| \| SNMP user name. \| \| \| notify-hosts string \| \| Hosts to send notifications (traps) to. \| \| \| notify-hosts6 string \| \| IPv6 hosts to send notifications (traps) to. \| \| \| priv-proto string \| Choices:* aes ← * des \| Privacy (encryption) protocol. aes - CFB128-AES-128 symmetric encryption protocol. des - CBC-DES symmetric encryption protocol. \| \| \| priv-pwd string \| \| no description \| \| \| queries string \| Choices:* disable * enable ← \| Enable/disable queries for this user. disable - Disable setting. enable - Enable setting. \| \| \| query-port integer \| Default:161 \| SNMPv3 query port. \| \| \| security-level string \| Choices:* no-auth-no-priv ← * auth-no-priv * auth-priv \| Security level for message authentication and encryption. no-auth-no-priv - Message with no authentication and no privacy (encryption). auth-no-priv - Message with authentication but no privacy (encryption). auth-priv - Message with authentication and privacy (encryption). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 user configuration. fmgr_system_snmp_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, ...] state: <value in [present, absent]> system_snmp_user: auth-proto: <value in [md5, sha]> auth-pwd: <value of string> events: - disk_low - ha_switch - intf_ip_chg - sys_reboot - cpu_high - mem_low - log-alert - log-rate - log-data-rate - lic-gbday - lic-dev-quota - cpu-high-exclude-nice name: <value of string> notify-hosts: <value of string> notify-hosts6: <value of string> priv-proto: <value in [aes, des]> 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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_mail – Replacement messages. fortinet.fortimanager.fmgr\_devprof\_system\_replacemsg\_mail – 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_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 \| \| devprof string / required \| \| the parameter (devprof) in requested url \| \| devprof\_system\_replacemsg\_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. \| \| 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_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> devprof: <your own value> devprof_system_replacemsg_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) ansible fortinet.fortimanager.fmgr_securityconsole_pblock_clone – no description fortinet.fortimanager.fmgr\_securityconsole\_pblock\_clone – 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_pblock_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\_pblock\_clone dictionary \| \| the top level parameters set \| \| \| adom string \| \| Source ADOM name. \| \| \| dst\_name string \| \| no description \| \| \| pblock 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_pblock_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_pblock_clone: adom: <value of string> dst_name: <value of string> pblock: <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_sql – SQL settings. fortinet.fortimanager.fmgr\_system\_sql – SQL 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_sql`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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\_sql dictionary \| \| the top level parameters set \| \| \| background-rebuild string \| Choices:* disable * enable ← \| Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. \| \| \| compress-table-min-age integer \| Default:7 \| Minimum age in days for SQL tables to be compressed. \| \| \| custom-index list / elements=string \| \| no description \| \| \| \| case-sensitive string \| Choices:* disable ← * enable \| Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. \| \| \| \| device-type string \| Choices:* FortiGate ← * FortiManager * FortiClient * FortiMail * FortiWeb * FortiCache * FortiSandbox * FortiDDoS * FortiAuthenticator * FortiProxy \| Device type. FortiGate - Device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. FortiCache - Set device type to FortiCache FortiSandbox - Set device type to FortiSandbox FortiDDoS - Set device type to FortiDDoS FortiAuthenticator - Set device type to FortiAuthenticator FortiProxy - Set device type to FortiProxy \| \| \| \| id integer \| Default:0 \| Add or Edit log index fields. \| \| \| \| index-field string \| \| Log field name to be indexed. \| \| \| \| log-type string \| Choices:* none * app-ctrl * attack * content * dlp * emailfilter * event * generic * history * traffic ← * virus * voip * webfilter * netscan * fct-event * fct-traffic * fct-netscan * waf * gtp * dns * ssh * ssl * file-filter * asset * protocol * siem \| Log type. none - none app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl \| \| \| custom-skipidx list / elements=string \| \| no description \| \| \| \| device-type string \| Choices:* FortiGate ← * FortiManager * FortiClient * FortiMail * FortiWeb * FortiSandbox * FortiProxy \| Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy \| \| \| \| id integer \| Default:0 \| Add or Edit log index fields. \| \| \| \| index-field string \| \| Field to be added to skip index. \| \| \| \| log-type string \| Choices:* app-ctrl ← * attack * content * dlp * emailfilter * event * generic * history * traffic * virus * voip * webfilter * netscan * fct-event * fct-traffic * fct-netscan * waf * gtp * dns * ssh * ssl * file-filter * asset * protocol * siem \| Log type. app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl file-filter asset \| \| \| database-name string \| \| Database name. \| \| \| database-type string \| Choices:* mysql * postgres ← \| Database type. mysql - MySQL database. postgres - PostgreSQL local database. \| \| \| device-count-high string \| Choices:* disable ← * enable \| Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. \| \| \| event-table-partition-time integer \| Default:0 \| Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs. \| \| \| fct-table-partition-time integer \| Default:240 \| Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs. \| \| \| logtype list / elements=string \| Choices:* none * app-ctrl * attack * content * dlp * emailfilter * event * generic * history * traffic * virus * voip * webfilter * netscan * fct-event * fct-traffic * fct-netscan * waf * gtp * dns * ssh * ssl * file-filter * asset * protocol * siem \| no description \| \| \| password string \| \| no description \| \| \| prompt-sql-upgrade string \| Choices:* disable * enable ← \| Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. \| \| \| rebuild-event string \| Choices:* disable * enable ← \| Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. \| \| \| rebuild-event-start-time string \| \| no description \| \| \| server string \| \| Database IP or hostname. \| \| \| start-time string \| \| no description \| \| \| status string \| Choices:* disable * local ← \| SQL database status. disable - Disable SQL database. local - Enable local database. \| \| \| text-search-index string \| Choices:* disable ← * enable \| Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. \| \| \| traffic-table-partition-time integer \| Default:0 \| Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs. \| \| \| ts-index-field list / elements=string \| \| no description \| \| \| \| category string \| \| Category of text search index fields. \| \| \| \| value string \| \| Fields of text search index. \| \| \| username string \| \| User name for login remote database. \| \| \| utm-table-partition-time integer \| Default:0 \| Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: SQL settings. fmgr_system_sql: bypass_validation: 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_sql: background-rebuild: <value in [disable, enable]> custom-index: - case-sensitive: <value in [disable, enable]> device-type: <value in [FortiGate, FortiManager, FortiClient, ...]> id: <value of integer> index-field: <value of string> log-type: <value in [none, app-ctrl, attack, ...]> database-name: <value of string> database-type: <value in [mysql, postgres]> device-count-high: <value in [disable, enable]> event-table-partition-time: <value of integer> fct-table-partition-time: <value of integer> logtype: - none - app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem password: <value of string> prompt-sql-upgrade: <value in [disable, enable]> rebuild-event: <value in [disable, enable]> rebuild-event-start-time: <value of string> server: <value of string> start-time: <value of string> status: <value in [disable, local]> text-search-index: <value in [disable, enable]> traffic-table-partition-time: <value of integer> ts-index-field: - category: <value of string> value: <value of string> username: <value of string> utm-table-partition-time: <value of integer> custom-skipidx: - device-type: <value in [FortiGate, FortiManager, FortiClient, ...]> id: <value of integer> index-field: <value of string> log-type: <value in [app-ctrl, attack, content, ...]> compress-table-min-age: <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_domaincontroller_extraserver – extra servers. fortinet.fortimanager.fmgr\_user\_domaincontroller\_extraserver – extra 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_domaincontroller_extraserver`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| domain-controller string / required \| \| the parameter (domain-controller) 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\_domaincontroller\_extraserver dictionary \| \| the top level parameters set \| \| \| id integer \| \| Server ID. \| \| \| ip-address string \| \| Domain controller IP address. \| \| \| port integer \| \| Port to be used for communication with the domain controller (default = 445). \| \| \| source-ip-address string \| \| FortiGate IPv4 address to be used for communication with the domain controller. \| \| \| source-port integer \| \| Source port to be used for communication with the domain controller. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: extra servers. fmgr_user_domaincontroller_extraserver: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> domain-controller: <your own value> state: <value in [present, absent]> user_domaincontroller_extraserver: id: <value of integer> ip-address: <value of string> port: <value of integer> source-ip-address: <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_antivirus_profile_http – Configure HTTP AntiVirus options. fortinet.fortimanager.fmgr\_antivirus\_profile\_http – Configure HTTP 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_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 \| \| antivirus\_profile\_http 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-optimize string \| Choices:* disable * enable \| Enable/disable AV optimization for this protocol. \| \| \| 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 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 HTTP AntiVirus options. fmgr_antivirus_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> antivirus_profile_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-optimize: <value in [disable, enable]> 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_internetservicename – Define internet service names. fortinet.fortimanager.fmgr\_firewall\_internetservicename – Define internet service names. ========================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_internetservicename`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_internetservicename dictionary \| \| the top level parameters set \| \| \| city-id integer \| \| City ID. \| \| \| country-id integer \| \| Country or Area ID. \| \| \| internet-service-id string \| \| Internet Service ID. \| \| \| name string \| \| Internet Service name. \| \| \| region-id integer \| \| Region ID. \| \| \| type string \| Choices:* default * location \| Internet Service name 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: Define internet service names. fmgr_firewall_internetservicename: bypass_validation: False workspace_locking_adom: <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_internetservicename: city-id: <value of integer> country-id: <value of integer> internet-service-id: <value of string> name: <value of string> region-id: <value of integer> type: <value in [default, location]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| always \| The descriptive message 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_smtps – Configure SMTPS options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_smtps – Configure SMTPS 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_smtps`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_smtps 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 SMTPS options. fmgr_firewall_sslsshprofile_smtps: bypass_validation: False workspace_locking_adom: <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_smtps: 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) ansible fortinet.fortimanager.fmgr_webfilter_contentheader_entries – Configure content types used by web filter. fortinet.fortimanager.fmgr\_webfilter\_contentheader\_entries – Configure content types used by web 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_contentheader_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-header string / required \| \| the parameter (content-header) 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\_contentheader\_entries dictionary \| \| the top level parameters set \| \| \| action string \| Choices:* exempt * block * allow \| Action to take for this content type. \| \| \| category string \| \| Categories that this content type applies to. \| \| \| pattern string \| \| Content type (regular expression). \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 content types used by web filter. fmgr_webfilter_contentheader_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-header: <your own value> state: <value in [present, absent]> webfilter_contentheader_entries: action: <value in [exempt, block, allow]> category: <value of string> 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_hotspot20_hsprofile – Configure hotspot profile. fortinet.fortimanager.fmgr\_hotspot20\_hsprofile – Configure hotspot 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_hotspot20_hsprofile`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_hsprofile dictionary \| \| the top level parameters set \| \| \| 3gpp-plmn string \| \| 3GPP PLMN name. \| \| \| access-network-asra string \| Choices:* disable * enable \| Enable/disable additional step required for access (ASRA). \| \| \| access-network-esr string \| Choices:* disable * enable \| Enable/disable emergency services reachable (ESR). \| \| \| access-network-internet string \| Choices:* disable * enable \| Enable/disable connectivity to the Internet. \| \| \| access-network-type string \| Choices:* private-network * private-network-with-guest-access * chargeable-public-network * free-public-network * personal-device-network * emergency-services-only-network * test-or-experimental * wildcard \| Access network type. \| \| \| access-network-uesa string \| Choices:* disable * enable \| Enable/disable unauthenticated emergency service accessible (UESA). \| \| \| anqp-domain-id integer \| \| ANQP Domain ID (0-65535). \| \| \| bss-transition string \| Choices:* disable * enable \| Enable/disable basic service set (BSS) transition Support. \| \| \| conn-cap string \| \| Connection capability name. \| \| \| deauth-request-timeout integer \| \| Deauthentication request timeout (in seconds). \| \| \| dgaf string \| Choices:* disable * enable \| Enable/disable downstream group-addressed forwarding (DGAF). \| \| \| domain-name string \| \| Domain name. \| \| \| gas-comeback-delay integer \| \| GAS comeback delay (0 or 100 - 4000 milliseconds, default = 500). \| \| \| gas-fragmentation-limit integer \| \| GAS fragmentation limit (512 - 4096, default = 1024). \| \| \| hessid string \| \| Homogeneous extended service set identifier (HESSID). \| \| \| ip-addr-type string \| \| IP address type name. \| \| \| l2tif string \| Choices:* disable * enable \| Enable/disable Layer 2 traffic inspection and filtering. \| \| \| nai-realm string \| \| NAI realm list name. \| \| \| name string \| \| Hotspot profile name. \| \| \| network-auth string \| \| Network authentication name. \| \| \| oper-friendly-name string \| \| Operator friendly name. \| \| \| osu-provider string \| \| Manually selected list of OSU provider(s). \| \| \| osu-ssid string \| \| Online sign up (OSU) SSID. \| \| \| pame-bi string \| Choices:* disable * enable \| Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). \| \| \| proxy-arp string \| Choices:* disable * enable \| Enable/disable Proxy ARP. \| \| \| qos-map string \| \| QoS MAP set ID. \| \| \| roaming-consortium string \| \| Roaming consortium list name. \| \| \| venue-group string \| Choices:* unspecified * assembly * business * educational * factory * institutional * mercantile * residential * storage * utility * vehicular * outdoor \| Venue group. \| \| \| venue-name string \| \| Venue name. \| \| \| venue-type string \| Choices:* unspecified * arena * stadium * passenger-terminal * amphitheater * amusement-park * place-of-worship * convention-center * library * museum * restaurant * theater * bar * coffee-shop * zoo-or-aquarium * emergency-center * doctor-office * bank * fire-station * police-station * post-office * professional-office * research-facility * attorney-office * primary-school * secondary-school * university-or-college * factory * hospital * long-term-care-facility * rehab-center * group-home * prison-or-jail * retail-store * grocery-market * auto-service-station * shopping-mall * gas-station * private * hotel-or-motel * dormitory * boarding-house * automobile * airplane * bus * ferry * ship-or-boat * train * motor-bike * muni-mesh-network * city-park * rest-area * traffic-control * bus-stop * kiosk \| Venue type. \| \| \| wan-metrics string \| \| WAN metric name. \| \| \| wnm-sleep-mode string \| Choices:* disable * enable \| Enable/disable wireless network management (WNM) sleep mode. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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 hotspot profile. fmgr_hotspot20_hsprofile: bypass_validation: False workspace_locking_adom: <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_hsprofile: 3gpp-plmn: <value of string> access-network-asra: <value in [disable, enable]> access-network-esr: <value in [disable, enable]> access-network-internet: <value in [disable, enable]> access-network-type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]> access-network-uesa: <value in [disable, enable]> anqp-domain-id: <value of integer> bss-transition: <value in [disable, enable]> conn-cap: <value of string> deauth-request-timeout: <value of integer> dgaf: <value in [disable, enable]> domain-name: <value of string> gas-comeback-delay: <value of integer> gas-fragmentation-limit: <value of integer> hessid: <value of string> ip-addr-type: <value of string> l2tif: <value in [disable, enable]> nai-realm: <value of string> name: <value of string> network-auth: <value of string> oper-friendly-name: <value of string> osu-provider: <value of string> osu-ssid: <value of string> pame-bi: <value in [disable, enable]> proxy-arp: <value in [disable, enable]> qos-map: <value of string> roaming-consortium: <value of string> venue-group: <value in [unspecified, assembly, business, ...]> venue-name: <value of string> venue-type: <value in [unspecified, arena, stadium, ...]> wan-metrics: <value of string> wnm-sleep-mode: <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_extendercontroller_dataplan – FortiExtender dataplan configuration. fortinet.fortimanager.fmgr\_extendercontroller\_dataplan – FortiExtender dataplan 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_extendercontroller_dataplan`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_dataplan dictionary \| \| the top level parameters set \| \| \| apn string \| \| APN configuration. \| \| \| auth-type string \| Choices:* none * pap * chap \| Authentication type. \| \| \| billing-date integer \| \| Billing day of the month (1 - 31). \| \| \| capacity integer \| \| Capacity in MB (0 - 102400000). \| \| \| carrier string \| \| Carrier configuration. \| \| \| iccid string \| \| ICCID configuration. \| \| \| modem-id string \| Choices:* all * modem1 * modem2 \| Dataplans modem specifics, if any. \| \| \| monthly-fee integer \| \| Monthly fee of dataplan (0 - 100000, in local currency). \| \| \| name string \| \| FortiExtender dataplan name \| \| \| overage string \| Choices:* disable * enable \| Enable/disable dataplan overage detection. \| \| \| password string \| \| no description \| \| \| pdn string \| Choices:* ipv4-only * ipv6-only * ipv4-ipv6 \| PDN type. \| \| \| preferred-subnet integer \| \| Preferred subnet mask (8 - 32). \| \| \| private-network string \| Choices:* disable * enable \| Enable/disable dataplan private network support. \| \| \| signal-period integer \| \| Signal period (600 to 18000 seconds). \| \| \| signal-threshold integer \| \| Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100 dBm. \| \| \| slot string \| Choices:* sim1 * sim2 \| SIM slot configuration. \| \| \| status string \| Choices:* disable * enable \| FortiExtender dataplan (enable or disable). \| \| \| type string \| Choices:* carrier * slot * iccid * generic \| Type preferences configuration. \| \| \| username string \| \| Username. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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: FortiExtender dataplan configuration. fmgr_extendercontroller_dataplan: bypass_validation: False workspace_locking_adom: <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_dataplan: apn: <value of string> auth-type: <value in [none, pap, chap]> billing-date: <value of integer> capacity: <value of integer> carrier: <value of string> iccid: <value of string> modem-id: <value in [all, modem1, modem2]> monthly-fee: <value of integer> name: <value of string> overage: <value in [disable, enable]> password: <value of string> pdn: <value in [ipv4-only, ipv6-only, ipv4-ipv6]> preferred-subnet: <value of integer> private-network: <value in [disable, enable]> signal-period: <value of integer> signal-threshold: <value of integer> slot: <value in [sim1, sim2]> status: <value in [disable, enable]> type: <value in [carrier, slot, iccid, ...]> 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_switchcontroller_managedswitch_ports – Managed-switch port list. fortinet.fortimanager.fmgr\_switchcontroller\_managedswitch\_ports – Managed-switch port 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_switchcontroller_managedswitch_ports`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ports dictionary \| \| the top level parameters set \| \| \| 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. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Managed-switch port list. fmgr_switchcontroller_managedswitch_ports: bypass_validation: False workspace_locking_adom: <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_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]> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_mail – Alert emails. fortinet.fortimanager.fmgr\_system\_mail – Alert emails. ======================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_mail dictionary \| \| the top level parameters set \| \| \| auth string \| Choices:* disable ← * enable \| Enable authentication. disable - Disable authentication. enable - Enable authentication. \| \| \| auth-type string \| Choices:* psk ← * certificate \| SMTP authentication type. psk - Use username and password to authenticate. certificate - Use local certificate to authenticate. \| \| \| id string \| \| Mail Service ID. \| \| \| local-cert string \| \| SMTP local certificate. \| \| \| passwd string \| \| no description \| \| \| port integer \| Default:25 \| SMTP server port. \| \| \| secure-option string \| Choices:* default ← * none * smtps * starttls \| Communication secure option. default - Try STARTTLS, proceed as plain text communication otherwise. none - Communication will be in plain text format. smtps - Communication will be protected by SMTPS. starttls - Communication will be protected by STARTTLS. \| \| \| server string \| \| SMTP server. \| \| \| user string \| \| SMTP account username. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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 emails. fmgr_system_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, ...] state: <value in [present, absent]> system_mail: auth: <value in [disable, enable]> id: <value of string> passwd: <value of string> port: <value of integer> secure-option: <value in [default, none, smtps, ...]> server: <value of string> user: <value of string> auth-type: <value in [psk, certificate]> 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) ansible fortinet.fortimanager.fmgr_pkg_firewall_policy6_sectionvalue – Configure IPv6 policies. fortinet.fortimanager.fmgr\_pkg\_firewall\_policy6\_sectionvalue – 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_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\_policy6\_sectionvalue dictionary \| \| the top level parameters set \| \| \| attr string \| Choices:* label * global-label \| no description \| \| \| name string \| \| no description \| \| policy6 string / required \| \| the parameter (policy6) 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 policies. fmgr_pkg_firewall_policy6_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> policy6: <your own value> state: <value in [present, absent]> pkg_firewall_policy6_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_sys_login_user – Log into the device with user name and password. fortinet.fortimanager.fmgr\_sys\_login\_user – Log into the device with user name and password. =============================================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_login_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 \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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\_login\_user dictionary \| \| the top level parameters set \| \| \| passwd string \| \| 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: Log into the device with user name and password. fmgr_sys_login_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, ...] sys_login_user: passwd: <value of string> 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_firewall_accessproxy_apigateway_sslciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority. fortinet.fortimanager.fmgr\_firewall\_accessproxy\_apigateway\_sslciphersuites – 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_accessproxy_apigateway_sslciphersuites`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure 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 \| \| api-gateway string / required \| \| the parameter (api-gateway) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| firewall\_accessproxy\_apigateway\_sslciphersuites 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:* 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 \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_accessproxy_apigateway_sslciphersuites: bypass_validation: False workspace_locking_adom: <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> api-gateway: <your own value> state: <value in [present, absent]> firewall_accessproxy_apigateway_sslciphersuites: cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]> priority: <value of integer> versions: - tls-1.0 - tls-1.1 - tls-1.2 - tls-1.3 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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_ssl – Configure SSL options. fortinet.fortimanager.fmgr\_firewall\_sslsshprofile\_ssl – Configure SSL 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_ssl`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_ssl 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. \| \| \| inspect-all string \| Choices:* disable * certificate-inspection * deep-inspection \| Level of SSL inspection. \| \| \| invalid-server-cert string \| Choices:* allow * block \| Allow or block the invalid SSL session server certificate. \| \| \| revoked-server-cert string \| Choices:* allow * block * ignore \| Action based on server certificate is revoked. \| \| \| sni-server-cert-check string \| Choices:* disable * enable * strict \| Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. \| \| \| unsupported-ssl string \| Choices:* bypass * inspect * block \| Action based on the SSL encryption used being unsupported. \| \| \| unsupported-ssl-cipher string \| Choices:* allow * block \| Action based on the SSL cipher used being unsupported. \| \| \| unsupported-ssl-negotiation string \| Choices:* allow * block \| Action based on the SSL negotiation used being unsupported. \| \| \| untrusted-cert string \| Choices:* allow * block * ignore \| Allow, ignore, or block the untrusted SSL session server certificate. \| \| \| untrusted-server-cert string \| Choices:* allow * block * ignore \| Allow, ignore, or block the untrusted SSL session server certificate. \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the 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 SSL options. fmgr_firewall_sslsshprofile_ssl: bypass_validation: False workspace_locking_adom: <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_ssl: allow-invalid-server-cert: <value in [disable, enable]> client-cert-request: <value in [bypass, inspect, block]> inspect-all: <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]> 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_pm_config_metafields_firewall_address – no description fortinet.fortimanager.fmgr\_pm\_config\_metafields\_firewall\_address – 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_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 \| \| --- \| --- \| --- \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_address 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_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, ...] pm_config_metafields_firewall_address: 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_emailfilter_profile_gmail – Gmail. fortinet.fortimanager.fmgr\_emailfilter\_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_emailfilter_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 \| \| emailfilter\_profile\_gmail dictionary \| \| the top level parameters set \| \| \| log string \| Choices:* disable * enable \| Enable/disable logging. \| \| \| log-all string \| Choices:* disable * enable \| Enable/disable logging of all email traffic. \| \| enable\_log boolean \| Choices:* no ← * yes \| Enable/Disable logging for task \| \| 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: Gmail. fmgr_emailfilter_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> emailfilter_profile_gmail: log: <value in [disable, enable]> 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_system_replacemsggroup_sslvpn – Replacement message table entries. fortinet.fortimanager.fmgr\_system\_replacemsggroup\_sslvpn – 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_sslvpn`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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\_sslvpn 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_sslvpn: bypass_validation: False workspace_locking_adom: <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_sslvpn: 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_system_global – Global range attributes. fortinet.fortimanager.fmgr\_system\_global – Global range attributes. ===================================================================== Note This plugin is part of the [fortinet.fortimanager collection](https://galaxy.ansible.com/fortinet/fortimanager) (version 2.1.3). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `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_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 \| \| proposed\_method string \| Choices:* update * set * add \| The overridden method for the underlying Json RPC request \| \| rc\_failed list / elements=string \| \| the rc codes list with which the conditions to fail will be overriden \| \| rc\_succeeded list / elements=string \| \| the rc codes list 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\_global dictionary \| \| the top level parameters set \| \| \| admin-lockout-duration integer \| Default:60 \| Lockout duration(sec) for administration. \| \| \| admin-lockout-threshold integer \| Default:3 \| Lockout threshold for administration. \| \| \| adom-mode string \| Choices:* normal ← * advanced \| ADOM mode. normal - Normal ADOM mode. advanced - Advanced ADOM mode. \| \| \| adom-rev-auto-delete string \| Choices:* disable * by-revisions ← * by-days \| Auto delete features for old ADOM revisions. disable - Disable auto delete function for ADOM revision. by-revisions - Auto delete ADOM revisions by maximum number of revisions. by-days - Auto delete ADOM revisions by maximum days. \| \| \| adom-rev-max-backup-revisions integer \| Default:5 \| Maximum number of ADOM revisions to backup. \| \| \| adom-rev-max-days integer \| Default:30 \| Number of days to keep old ADOM revisions. \| \| \| adom-rev-max-revisions integer \| Default:120 \| Maximum number of ADOM revisions to keep. \| \| \| adom-select string \| Choices:* disable * enable ← \| Enable/disable select ADOM after login. disable - Disable select ADOM after login. enable - Enable select ADOM after login. \| \| \| adom-status string \| Choices:* disable ← * enable \| ADOM status. disable - Disable ADOM mode. enable - Enable ADOM mode. \| \| \| clone-name-option string \| Choices:* default ← * keep \| set the clone object names option. default - Add a prefix of Clone of to the clone name. keep - Keep the original name for user to edit. \| \| \| clt-cert-req string \| Choices:* disable ← * enable * optional \| Require client certificate for GUI login. disable - Disable setting. enable - Require client certificate for GUI login. optional - Optional client certificate for GUI login. \| \| \| console-output string \| Choices:* standard ← * more \| Console output mode. standard - Standard output. more - More page output. \| \| \| country-flag string \| Choices:* disable * enable ← \| Country flag Status. disable - Disable country flag icon beside ip address. enable - Enable country flag icon beside ip address. \| \| \| create-revision string \| Choices:* disable ← * enable \| Enable/disable create revision by default. disable - Disable create revision by default. enable - Enable create revision by default. \| \| \| daylightsavetime string \| Choices:* disable * enable ← \| Enable/disable daylight saving time. disable - Disable setting. enable - Enable setting. \| \| \| default-disk-quota integer \| Default:1000 \| Default disk quota for registered device (MB). \| \| \| detect-unregistered-log-device string \| Choices:* disable * enable ← \| Detect unregistered logging device from log message. disable - Disable attribute function. enable - Enable attribute function. \| \| \| device-view-mode string \| Choices:* regular ← * tree \| Set devices/groups view mode. regular - Regular view mode. tree - Tree view mode. \| \| \| dh-params string \| Choices:* 1024 * 1536 * 2048 ← * 3072 * 4096 * 6144 * 8192 \| Minimum size of Diffie-Hellman prime for SSH/HTTPS (bits). 1024 - 1024 bits. 1536 - 1536 bits. 2048 - 2048 bits. 3072 - 3072 bits. 4096 - 4096 bits. 6144 - 6144 bits. 8192 - 8192 bits. \| \| \| disable-module list / elements=string \| Choices:* fortiview-noc * none * fortirecorder * siem * soc * ai \| no description \| \| \| enc-algorithm string \| Choices:* low * medium * high ← \| SSL communication encryption algorithms. low - SSL communication using all available encryption algorithms. medium - SSL communication using high and medium encryption algorithms. high - SSL communication using high encryption algorithms. \| \| \| faz-status string \| Choices:* disable ← * enable \| FAZ status. disable - Disable FAZ feature. enable - Enable FAZ feature. \| \| \| fgfm-ca-cert string \| \| set the extra fgfm CA certificates. \| \| \| fgfm-local-cert string \| \| set the fgfm local certificate. \| \| \| fgfm-ssl-protocol string \| Choices:* sslv3 * tlsv1.0 * tlsv1.1 * tlsv1.2 ← * tlsv1.3 \| set the lowest SSL protocols for fgfmsd. sslv3 - set SSLv3 as the lowest version. tlsv1.0 - set TLSv1.0 as the lowest version. tlsv1.1 - set TLSv1.1 as the lowest version. tlsv1.2 - set TLSv1.2 as the lowest version (default). \| \| \| ha-member-auto-grouping string \| Choices:* disable * enable ← \| Enable/disable automatically group HA members feature disable - Disable automatically grouping HA members feature. enable - Enable automatically grouping HA members only when group name is unique in your network. \| \| \| hitcount\_concurrent integer \| Default:100 \| The number of FortiGates that FortiManager polls at one time (10 - 500, default = 100). \| \| \| hitcount\_interval integer \| Default:300 \| The interval for getting hit count from managed FortiGate devices, in seconds (60 - 86400, default = 300). \| \| \| hostname string \| Default:"FMG-VM64" \| System hostname. \| \| \| import-ignore-addr-cmt string \| Choices:* disable ← * enable \| Enable/Disable import ignore of address comments. disable - Disable import ignore of address comments. enable - Enable import ignore of address comments. \| \| \| language string \| Choices:* english ← * simch * japanese * korean * spanish * trach \| System global language. english - English simch - Simplified Chinese japanese - Japanese korean - Korean spanish - Spanish trach - Traditional Chinese \| \| \| latitude string \| \| fmg location latitude \| \| \| ldap-cache-timeout integer \| Default:86400 \| LDAP browser cache timeout (seconds). \| \| \| ldapconntimeout integer \| Default:60000 \| LDAP connection timeout (msec). \| \| \| lock-preempt string \| Choices:* disable ← * enable \| Enable/disable ADOM lock override. disable - Disable lock preempt. enable - Enable lock preempt. \| \| \| log-checksum string \| Choices:* none ← * md5 * md5-auth \| Record log file hash value, timestamp, and authentication code at transmission or rolling. none - No record log file checksum. md5 - Record log files MD5 hash value only. md5-auth - Record log files MD5 hash value and authentication code. \| \| \| log-forward-cache-size integer \| Default:0 \| Log forwarding disk cache size (GB). \| \| \| longitude string \| \| fmg location longitude \| \| \| max-log-forward integer \| Default:5 \| Maximum number of log-forward and aggregation settings. \| \| \| max-running-reports integer \| Default:1 \| Maximum number of reports generating at one time. \| \| \| mc-policy-disabled-adoms list / elements=string \| \| no description \| \| \| \| adom-name string \| \| Adom names. \| \| \| multiple-steps-upgrade-in-autolink string \| Choices:* disable ← * enable \| Enable/disable multiple steps upgade in autolink process disable - Disable setting. enable - Enable setting. \| \| \| object-revision-db-max integer \| Default:100000 \| Maximum revisions for a single database (10,000-1,000,000 default 100,000). \| \| \| object-revision-mandatory-note string \| Choices:* disable * enable ← \| Enable/disable mandatory note when create revision. disable - Disable object revision. enable - Enable object revision. \| \| \| object-revision-object-max integer \| Default:100 \| Maximum revisions for a single object (10-1000 default 100). \| \| \| object-revision-status string \| Choices:* disable * enable ← \| Enable/disable create revision when modify objects. disable - Disable object revision. enable - Enable object revision. \| \| \| oftp-ssl-protocol string \| Choices:* sslv3 * tlsv1.0 * tlsv1.1 * tlsv1.2 ← * tlsv1.3 \| set the lowest SSL protocols for oftpd. sslv3 - set SSLv3 as the lowest version. tlsv1.0 - set TLSv1.0 as the lowest version. tlsv1.1 - set TLSv1.1 as the lowest version. tlsv1.2 - set TLSv1.2 as the lowest version (default). \| \| \| partial-install string \| Choices:* disable ← * enable \| Enable/Disable partial install (install some objects). disable - Disable partial install function. enable - Enable partial install function. \| \| \| partial-install-force string \| Choices:* disable ← * enable \| Enable/Disable partial install when devdb is modified. disable - Disable partial install when devdb is modified. enable - Enable partial install when devdb is modified. \| \| \| partial-install-rev string \| Choices:* disable ← * enable \| Enable/Disable auto creating adom revision for partial install. disable - Disable partial install revision. enable - Enable partial install revision. \| \| \| per-policy-lock string \| Choices:* disable ← * enable \| Enable/Disable per policy lock. disable - Disable per policy lock. enable - Enable per policy lock. \| \| \| perform-improve-by-ha string \| Choices:* disable ← * enable \| Enable/Disable performance improvement by distributing tasks to HA slaves. disable - Disable performance improvement by HA. enable - Enable performance improvement by HA. \| \| \| policy-hit-count string \| Choices:* disable ← * enable \| show policy hit count. disable - Disable policy hit count. enable - Enable policy hit count. \| \| \| policy-object-icon string \| Choices:* disable ← * enable \| show icons of policy objects. disable - Disable icon of policy objects. enable - Enable icon of policy objects. \| \| \| policy-object-in-dual-pane string \| Choices:* disable ← * enable \| show policies and objects in dual pane. disable - Disable polices and objects in dual pane. enable - Enable polices and objects in dual pane. \| \| \| pre-login-banner string \| Choices:* disable ← * enable \| Enable/disable pre-login banner. disable - Disable pre-login banner. enable - Enable pre-login banner. \| \| \| pre-login-banner-message string \| \| Pre-login banner message. \| \| \| private-data-encryption string \| Choices:* disable ← * enable \| Enable/disable private data encryption using an AES 128-bit key. disable - Disable private data encryption using an AES 128-bit key. enable - Enable private data encryption using an AES 128-bit key. \| \| \| remoteauthtimeout integer \| Default:10 \| Remote authentication (RADIUS/LDAP) timeout (sec). \| \| \| search-all-adoms string \| Choices:* disable ← * enable \| Enable/Disable Search all ADOMs for where-used query. disable - Disable search all ADOMs for where-used queries. enable - Enable search all ADOMs for where-used queries. \| \| \| ssl-low-encryption string \| Choices:* disable ← * enable \| SSL low-grade encryption. disable - Disable SSL low-grade encryption. enable - Enable SSL low-grade encryption. \| \| \| ssl-protocol list / elements=string \| Choices:* tlsv1.2 * tlsv1.1 * tlsv1.0 * sslv3 * tlsv1.3 \| no description \| \| \| ssl-static-key-ciphers string \| Choices:* disable * enable ← \| Enable/disable SSL static key ciphers. disable - Disable setting. enable - Enable setting. \| \| \| task-list-size integer \| Default:2000 \| Maximum number of completed tasks to keep. \| \| \| tftp string \| Choices:* disable ← * enable \| Enable/disable TFTP in `exec restore image` command (disabled by default in FIPS mode) disable - Disable TFTP enable - Enable TFTP \| \| \| 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 * 88 * 89 * 90 * 91 \| Time zone. 00 - (GMT-12:00) Eniwetak, Kwajalein. 01 - (GMT-11:00) Midway Island, Samoa. 02 - (GMT-10:00) Hawaii. 03 - (GMT-9:00) Alaska. 04 - (GMT-8:00) Pacific Time (US & Canada). 05 - (GMT-7:00) Arizona. 06 - (GMT-7:00) Mountain Time (US & Canada). 07 - (GMT-6:00) Central America. 08 - (GMT-6:00) Central Time (US & Canada). 09 - (GMT-6:00) Mexico City. 10 - (GMT-6:00) Saskatchewan. 11 - (GMT-5:00) Bogota, Lima, Quito. 12 - (GMT-5:00) Eastern Time (US & Canada). 13 - (GMT-5:00) Indiana (East). 14 - (GMT-4:00) Atlantic Time (Canada). 15 - (GMT-4:00) La Paz. 16 - (GMT-4:00) Santiago. 17 - (GMT-3:30) Newfoundland. 18 - (GMT-3:00) Brasilia. 19 - (GMT-3:00) Buenos Aires, Georgetown. 20 - (GMT-3:00) Nuuk (Greenland). 21 - (GMT-2:00) Mid-Atlantic. 22 - (GMT-1:00) Azores. 23 - (GMT-1:00) Cape Verde Is. 24 - (GMT) Monrovia. 25 - (GMT) Greenwich Mean Time:Dublin, Edinburgh, Lisbon, London. 26 - (GMT+1:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna. 27 - (GMT+1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague. 28 - (GMT+1:00) Brussels, Copenhagen, Madrid, Paris. 29 - (GMT+1:00) Sarajevo, Skopje, Warsaw, Zagreb. 30 - (GMT+1:00) West Central Africa. 31 - (GMT+2:00) Athens, Sofia, Vilnius. 32 - (GMT+2:00) Bucharest. 33 - (GMT+2:00) Cairo. 34 - (GMT+2:00) Harare, Pretoria. 35 - (GMT+2:00) Helsinki, Riga,Tallinn. 36 - (GMT+2:00) Jerusalem. 37 - (GMT+3:00) Baghdad. 38 - (GMT+3:00) Kuwait, Riyadh. 39 - (GMT+3:00) St.Petersburg, Volgograd. 40 - (GMT+3:00) Nairobi. 41 - (GMT+3:30) Tehran. 42 - (GMT+4:00) Abu Dhabi, Muscat. 43 - (GMT+4:00) Baku. 44 - (GMT+4:30) Kabul. 45 - (GMT+5:00) Ekaterinburg. 46 - (GMT+5:00) Islamabad, Karachi,Tashkent. 47 - (GMT+5:30) Calcutta, Chennai, Mumbai, New Delhi. 48 - (GMT+5:45) Kathmandu. 49 - (GMT+6:00) Almaty, Novosibirsk. 50 - (GMT+6:00) Astana, Dhaka. 51 - (GMT+6:00) Sri Jayawardenapura. 52 - (GMT+6:30) Rangoon. 53 - (GMT+7:00) Bangkok, Hanoi, Jakarta. 54 - (GMT+7:00) Krasnoyarsk. 55 - (GMT+8:00) Beijing,ChongQing, HongKong,Urumqi. 56 - (GMT+8:00) Irkutsk, Ulaanbaatar. 57 - (GMT+8:00) Kuala Lumpur, Singapore. 58 - (GMT+8:00) Perth. 59 - (GMT+8:00) Taipei. 60 - (GMT+9:00) Osaka, Sapporo, Tokyo, Seoul. 61 - (GMT+9:00) Yakutsk. 62 - (GMT+9:30) Adelaide. 63 - (GMT+9:30) Darwin. 64 - (GMT+10:00) Brisbane. 65 - (GMT+10:00) Canberra, Melbourne, Sydney. 66 - (GMT+10:00) Guam, Port Moresby. 67 - (GMT+10:00) Hobart. 68 - (GMT+10:00) Vladivostok. 69 - (GMT+11:00) Magadan. 70 - (GMT+11:00) Solomon Is., New Caledonia. 71 - (GMT+12:00) Auckland, Wellington. 72 - (GMT+12:00) Fiji, Kamchatka, Marshall Is. 73 - (GMT+13:00) Nukualofa. 74 - (GMT-4:30) Caracas. 75 - (GMT+1:00) Namibia. 76 - (GMT-5:00) Brazil-Acre. 77 - (GMT-4:00) Brazil-West. 78 - (GMT-3:00) Brazil-East. 79 - (GMT-2:00) Brazil-DeNoronha. 80 - (GMT+14:00) Kiritimati. 81 - (GMT-7:00) Baja California Sur, Chihuahua. 82 - (GMT+12:45) Chatham Islands. 83 - (GMT+3:00) Minsk. 84 - (GMT+13:00) Samoa. 85 - (GMT+3:00) Istanbul. 86 - (GMT-4:00) Paraguay. 87 - (GMT) Casablanca. 88 - (GMT+3:00) Moscow. 89 - (GMT) Greenwich Mean Time. \| \| \| tunnel-mtu integer \| Default:1500 \| Maximum transportation unit(68 - 9000). \| \| \| usg string \| Choices:* disable ← * enable \| Enable/disable Fortiguard server restriction. disable - Contact any Fortiguard server enable - Contact Fortiguard server in USA only \| \| \| vdom-mirror string \| Choices:* disable ← * enable \| VDOM mirror. disable - Disable VDOM mirror function. enable - Enable VDOM mirror function. \| \| \| webservice-proto list / elements=string \| Choices:* tlsv1.2 * tlsv1.1 * tlsv1.0 * sslv3 * sslv2 * tlsv1.3 \| no description \| \| \| workflow-max-sessions integer \| Default:500 \| Maximum number of workflow sessions per ADOM (minimum 100). \| \| \| workspace-mode string \| Choices:* disabled ← * normal * workflow * per-adom \| Set workspace mode (ADOM Locking). disabled - Workspace disabled. normal - Workspace lock mode. workflow - Workspace workflow 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: Global range attributes. fmgr_system_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, ...] system_global: admin-lockout-duration: <value of integer> admin-lockout-threshold: <value of integer> adom-mode: <value in [normal, advanced]> adom-rev-auto-delete: <value in [disable, by-revisions, by-days]> adom-rev-max-backup-revisions: <value of integer> adom-rev-max-days: <value of integer> adom-rev-max-revisions: <value of integer> adom-select: <value in [disable, enable]> adom-status: <value in [disable, enable]> clt-cert-req: <value in [disable, enable, optional]> console-output: <value in [standard, more]> country-flag: <value in [disable, enable]> create-revision: <value in [disable, enable]> daylightsavetime: <value in [disable, enable]> default-disk-quota: <value of integer> detect-unregistered-log-device: <value in [disable, enable]> device-view-mode: <value in [regular, tree]> dh-params: <value in [1024, 1536, 2048, ...]> disable-module: - fortiview-noc - none - fortirecorder - siem - soc - ai enc-algorithm: <value in [low, medium, high]> faz-status: <value in [disable, enable]> fgfm-local-cert: <value of string> fgfm-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]> ha-member-auto-grouping: <value in [disable, enable]> hitcount_concurrent: <value of integer> hitcount_interval: <value of integer> hostname: <value of string> import-ignore-addr-cmt: <value in [disable, enable]> language: <value in [english, simch, japanese, ...]> latitude: <value of string> ldap-cache-timeout: <value of integer> ldapconntimeout: <value of integer> lock-preempt: <value in [disable, enable]> log-checksum: <value in [none, md5, md5-auth]> log-forward-cache-size: <value of integer> longitude: <value of string> max-log-forward: <value of integer> max-running-reports: <value of integer> oftp-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]> partial-install: <value in [disable, enable]> partial-install-force: <value in [disable, enable]> partial-install-rev: <value in [disable, enable]> perform-improve-by-ha: <value in [disable, enable]> policy-hit-count: <value in [disable, enable]> policy-object-in-dual-pane: <value in [disable, enable]> pre-login-banner: <value in [disable, enable]> pre-login-banner-message: <value of string> remoteauthtimeout: <value of integer> search-all-adoms: <value in [disable, enable]> ssl-low-encryption: <value in [disable, enable]> ssl-protocol: - tlsv1.2 - tlsv1.1 - tlsv1.0 - sslv3 - tlsv1.3 ssl-static-key-ciphers: <value in [disable, enable]> task-list-size: <value of integer> tftp: <value in [disable, enable]> timezone: <value in [00, 01, 02, ...]> tunnel-mtu: <value of integer> usg: <value in [disable, enable]> vdom-mirror: <value in [disable, enable]> webservice-proto: - tlsv1.2 - tlsv1.1 - tlsv1.0 - sslv3 - sslv2 - tlsv1.3 workflow-max-sessions: <value of integer> workspace-mode: <value in [disabled, normal, workflow, ...]> clone-name-option: <value in [default, keep]> fgfm-ca-cert: <value of string> mc-policy-disabled-adoms: - adom-name: <value of string> policy-object-icon: <value in [disable, enable]> private-data-encryption: <value in [disable, enable]> per-policy-lock: <value in [disable, enable]> multiple-steps-upgrade-in-autolink: <value in [disable, enable]> object-revision-db-max: <value of integer> object-revision-mandatory-note: <value in [disable, enable]> object-revision-object-max: <value of integer> object-revision-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_wanprof_system_virtualwanlink – Configure redundant internet connections using SD-WAN fortinet.fortimanager.fmgr\_wanprof\_system\_virtualwanlink – 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_virtualwanlink`. New in version 2.10: of fortinet.fortimanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is able to configure a FortiManager device. * Examples include all parameters and values which need to be adjusted to data sources before usage. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adom string / required \| \| the parameter (adom) in requested url \| \| bypass\_validation boolean \| Choices:* no ← * yes \| only set to True when module 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 dictionary \| \| the top level parameters set \| \| \| 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). \| \| \| \| 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. \| \| \| 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 - 4294967295). Used for SD-WAN rules or priority rules. \| \| \| \| seq-num integer \| \| Sequence number(1-255). \| \| \| \| source string \| \| Source IP address used in the health-check packet to the server. \| \| \| \| source6 string \| \| Source IPv6 address used in the health-check packet to the server. \| \| \| \| spillover-threshold integer \| \| Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, 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, 0 - 255). \| \| \| \| weight integer \| \| Weight of this interface for weighted load balancing. (0 - 255) More traffic is directed to interfaces with higher wei... \| \| \| neighbor list / elements=string \| \| no description \| \| \| \| health-check string \| \| SD-WAN health-check name. \| \| \| \| ip string \| \| IP 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. \| \| \| \| health-check string \| \| Health check. \| \| \| \| hold-down-time integer \| \| Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). \| \| \| \| id integer \| \| Priority rule ID (1 - 4000). \| \| \| \| input-device string \| \| Source interface name. \| \| \| \| internet-service string \| Choices:* disable * enable \| Enable/disable use of Internet service for application-based load balancing. \| \| \| \| internet-service-app-ctrl integer \| \| no description \| \| \| \| internet-service-app-ctrl-group string \| \| Application control based Internet Service group list. \| \| \| \| internet-service-ctrl integer \| \| no description \| \| \| \| internet-service-ctrl-group string \| \| Control-based Internet Service group list. \| \| \| \| internet-service-custom string \| \| Custom Internet service name list. \| \| \| \| internet-service-custom-group string \| \| Custom Internet Service group list. \| \| \| \| internet-service-group string \| \| Internet Service group list. \| \| \| \| internet-service-id string \| \| Internet service ID list. \| \| \| \| internet-service-name string \| \| Internet service name list. \| \| \| \| jitter-weight integer \| \| Coefficient of jitter in the formula of custom-profile-1. \| \| \| \| latency-weight integer \| \| Coefficient of latency in the formula of custom-profile-1. \| \| \| \| link-cost-factor string \| Choices:* latency * jitter * packet-loss * inbandwidth * outbandwidth * bibandwidth * custom-profile-1 \| Link cost factor. \| \| \| \| link-cost-threshold integer \| \| Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default =... \| \| \| \| member string \| \| Member sequence number. \| \| \| \| mode string \| Choices:* auto * manual * priority * sla * load-balance \| Control how the priority rule sets the priority of interfaces in the SD-WAN. \| \| \| \| name string \| \| Priority rule name. \| \| \| \| packet-loss-weight integer \| \| Coefficient of packet-loss in the formula of custom-profile-1. \| \| \| \| priority-members string \| \| Member sequence number list. \| \| \| \| protocol integer \| \| Protocol number. \| \| \| \| quality-link integer \| \| Quality grade. \| \| \| \| role string \| Choices:* primary * secondary * standalone \| Service role to work with neighbor. \| \| \| \| route-tag integer \| \| IPv4 route map route-tag. \| \| \| \| sla list / elements=string \| \| no description \| \| \| \| \| health-check string \| \| Virtual WAN Link health-check. \| \| \| \| \| id integer \| \| SLA ID. \| \| \| \| sla-compare-method string \| Choices:* order * number \| Method to compare SLA value for sla and load balance mode. \| \| \| \| src string \| \| Source address name. \| \| \| \| src-negate string \| Choices:* disable * enable \| Enable/disable negation of source address match. \| \| \| \| src6 string \| \| Source address6 name. \| \| \| \| standalone-action string \| Choices:* disable * enable \| Enable/disable service when selected neighbor role is standalone while service role is not standalone. \| \| \| \| start-port integer \| \| Start destination port number. \| \| \| \| status string \| Choices:* disable * enable \| Enable/disable SD-WAN service. \| \| \| \| tos string \| \| Type of service bit pattern. \| \| \| \| tos-mask string \| \| Type of service evaluated bits. \| \| \| \| users string \| \| User name. \| \| \| status string \| Choices:* disable * enable \| Enable/disable SD-WAN. \| \| workspace\_locking\_adom string \| \| the adom to lock for FortiManager running in workspace mode, the value can be global and others including root \| \| workspace\_locking\_timeout integer \| Default:300 \| the maximum time in seconds to wait for other user to release the workspace lock \| Notes ----- Note * Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace\_locking\_adom and workspace\_locking\_timeout help do the work. * To create or update an object, use state present directive. * To delete an object, use state absent directive. * Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc\_failed and rc\_succeeded Examples -------- ``` - hosts: 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_virtualwanlink: bypass_validation: False workspace_locking_adom: <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_virtualwanlink: fail-detect: <value in [disable, enable]> health-check: - _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]> load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]> members: - _dynamic-member: <value of string> comment: <value of string> gateway: <value of string> gateway6: <value of string> ingress-spillover-threshold: <value of integer> interface: <value of string> priority: <value of integer> seq-num: <value of integer> source: <value of string> source6: <value of string> spillover-threshold: <value of integer> status: <value in [disable, enable]> volume-ratio: <value of integer> weight: <value of integer> cost: <value of integer> service: - addr-mode: <value in [ipv4, ipv6]> bandwidth-weight: <value of integer> default: <value in [disable, enable]> dscp-forward: <value in [disable, enable]> dscp-forward-tag: <value of string> dscp-reverse: <value in [disable, enable]> dscp-reverse-tag: <value of string> dst: <value of string> dst-negate: <value in [disable, enable]> dst6: <value of string> end-port: <value of integer> gateway: <value in [disable, enable]> groups: <value of string> health-check: <value of string> hold-down-time: <value of integer> id: <value of integer> internet-service: <value in [disable, enable]> internet-service-ctrl: <value of integer> internet-service-ctrl-group: <value of string> internet-service-custom: <value of string> internet-service-custom-group: <value of string> internet-service-group: <value of string> internet-service-id: <value of string> jitter-weight: <value of integer> latency-weight: <value of integer> link-cost-factor: <value in [latency, jitter, packet-loss, ...]> link-cost-threshold: <value of integer> member: <value of string> mode: <value in [auto, manual, priority, ...]> name: <value of string> packet-loss-weight: <value of integer> priority-members: <value of string> protocol: <value of integer> quality-link: <value of integer> route-tag: <value of integer> sla: - health-check: <value of string> id: <value of integer> src: <value of string> src-negate: <value in [disable, enable]> src6: <value of string> start-port: <value of integer> status: <value in [disable, enable]> tos: <value of string> tos-mask: <value of string> users: <value of string> internet-service-app-ctrl: <value of integer> internet-service-app-ctrl-group: <value of string> role: <value in [primary, secondary, standalone]> sla-compare-method: <value in [order, number]> standalone-action: <value in [disable, enable]> input-device: <value of string> internet-service-name: <value of string> status: <value in [disable, enable]> 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> ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| request\_url string \| always \| The full url requested Sample: /sys/login/user \| \| response\_code integer \| always \| The status of api request \| \| response\_message string \| 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.