fmgr_fmupdate_fdssetting – Configure FortiGuard settings.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
fmupdate_fdssetting yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • fmupdate_fdssetting - no description type: dict
    • User-Agent - Configure the user agent string. type: str default: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0) more...
    • fds-clt-ssl-protocol - The SSL protocols version for connecting fds server (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...
    • fds-ssl-protocol - The SSL protocols version for receiving fgt connection (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...
    • fmtr-log - fmtr log level type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
    • linkd-log - The linkd log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
    • max-av-ips-version - The maximum number of downloadable, full version AV/IPS packages (1 - 1000, default = 20). type: int default: 20 more...
    • max-work - The maximum number of worker processing download requests (1 - 32, default = 1). type: int default: 1 more...
    • push-override type: dict
      • ip - External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. type: str default: 0.0.0.0 more...
      • port - Receiving port number on the NAT device (1 - 65535, default = 9443). type: int default: 9443 more...
      • status - Enable/disable push updates for clients (default = disable). type: str choices: [disable, enable] default: disable more...
    • push-override-to-client type: dict
      • announce-ip - Announce-Ip. type: array more...
        • id - ID of the announce IP address (1 - 10). type: int default: 0 more...
        • ip - Announce IPv4 address. type: str default: 0.0.0.0 more...
        • port - Announce IP port (1 - 65535, default = 8890). type: int default: 8890 more...
      • status - Enable/disable push updates (default = disable). type: str choices: [disable, enable] default: disable more...
    • send_report - send report/fssi to fds server. type: str choices: [disable, enable] default: enable more...
    • send_setup - forward setup to fds server. type: str choices: [disable, enable] default: disable more...
    • server-override type: dict
      • servlist - Servlist. type: array more...
        • id - Override server ID (1 - 10). type: int default: 0 more...
        • ip - IPv4 address of the override server. type: str default: 0.0.0.0 more...
        • ip6 - IPv6 address of the override server. type: str default: :: more...
        • port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443 more...
        • service-type - Override service type. type: array choices: [fds, fct] more...
      • status - Override status. type: str choices: [disable, enable] default: disable more...
    • system-support-fct - Supported FortiClient versions. type: array choices: [4.x, 5.0, 5.2, 5.4, 5.6, 6.0, 6.2, 6.4, 7.0] more...
    • system-support-fgt - Supported FortiOS versions. type: array choices: [5.4, 5.6, 6.0, 6.2, 6.4, 7.0, 7.2] more...
    • system-support-fml - Supported FortiMail versions. type: array choices: [4.x, 5.x, 6.x, 6.0, 6.2, 6.4, 7.0] more...
    • system-support-fsa - Supported FortiSandbox versions. type: array choices: [1.x, 2.x, 3.x, 4.x, 3.0, 3.1, 3.2] more...
    • system-support-fsw - Supported FortiSwitch versions. type: array choices: [5.4, 5.6, 6.0, 6.2, 4.x, 5.0, 5.2, 6.4] more...
    • umsvc-log - The um_service log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
    • unreg-dev-option - set the option for unregister devices type: str choices: [ignore, svc-only, add-service] default: add-service more...
    • update-schedule type: dict
      • day - Configure the day the update will occur, if the freqnecy is weekly (Sunday - Saturday, default = Monday). type: str choices: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday] default: Monday more...
      • frequency - Configure update frequency: every - time interval, daily - once a day, weekly - once a week (default = every). type: str choices: [every, daily, weekly] default: every more...
      • status - Enable/disable scheduled updates. type: str choices: [disable, enable] default: enable more...
      • time - Time interval between updates, or the hour and minute when the update occurs (hh: 0 - 23, mm: 0 - 59 or 60 = random, default = 00:10). type: str more...
    • wanip-query-mode - public ip query mode type: str choices: [disable, ipify] default: disable more...
    • fortiguard-anycast - Enable/disable use of FortiGuards anycast network type: str choices: [disable, enable] default: disable more...
    • fortiguard-anycast-source - Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. type: str choices: [fortinet, aws] default: fortinet more...
    • system-support-fdc - No description for the parameter type: array choices: [3.x, 4.x] more...
    • system-support-fts - No description for the parameter type: array choices: [3.x, 4.x, 7.x] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: 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_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
             - 7.0
           system-support-fgt:
             - 5.4
             - 5.6
             - 6.0
             - 6.2
             - 6.4
             - 7.0
             - 7.2
           system-support-fml:
             - 4.x
             - 5.x
             - 6.x
             - 6.0
             - 6.2
             - 6.4
             - 7.0
           system-support-fsa:
             - 1.x
             - 2.x
             - 3.x
             - 4.x
             - 3.0
             - 3.1
             - 3.2
           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]>
           system-support-fdc:
             - 3.x
             - 4.x
           system-support-fts:
             - 3.x
             - 4.x
             - 7.x

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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