fmgr_system_dm – Configure dm.

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
system_dm 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
  • system_dm - no description type: dict
    • concurrent-install-image-limit - Maximum number of concurrent install image (1 - 1000). type: int default: 500 more...
    • concurrent-install-limit - Maximum number of concurrent installs (5 - 2000). type: int default: 480 more...
    • concurrent-install-script-limit - Maximum number of concurrent install scripts (5 - 2000). type: int default: 480 more...
    • discover-timeout - Check connection timeout when discover device (3 - 15). type: int default: 6 more...
    • dpm-logsize - Maximum dpm log size per device (1 - 10000K). type: int default: 10000 more...
    • fgfm-sock-timeout - Maximum FGFM socket idle time (90 - 1800 sec). type: int default: 360 more...
    • fgfm_keepalive_itvl - FGFM protocol keep alive interval (30 - 600 sec). type: int default: 120 more...
    • force-remote-diff - Always use remote diff when installing. type: str choices: [disable, enable] default: disable more...
    • fortiap-refresh-cnt - Max auto refresh FortiAP number each time (1 - 10000). type: int default: 500 more...
    • fortiap-refresh-itvl - Auto refresh FortiAP status interval (0 - 1440) minutes, set to 0 will disable auto refresh. type: int default: 10 more...
    • fortiext-refresh-cnt - Max device number for FortiExtender auto refresh (1 - 10000). type: int default: 50 more...
    • install-image-timeout - Maximum waiting time for image transfer and device upgrade (600 - 7200 sec). type: int default: 3600 more...
    • install-tunnel-retry-itvl - Time to re-establish tunnel during install (10 - 60 sec). type: int default: 60 more...
    • max-revs - Maximum number of revisions saved (1 - 250). type: int default: 100 more...
    • nr-retry - Number of retries. type: int default: 1 more...
    • retry - Enable/disable configuration install retry. type: str choices: [disable, enable] default: enable more...
    • retry-intvl - Retry interval. type: int default: 15 more...
    • rollback-allow-reboot - Enable/disable FortiGate reboot to rollback when installing script/config. type: str choices: [disable, enable] default: disable more...
    • script-logsize - Maximum script log size per device (1 - 10000K). type: int default: 100 more...
    • skip-scep-check - Enable/disable installing scep related objects even if scep url is configured. type: str choices: [disable, enable] default: disable more...
    • skip-tunnel-fcp-req - Enable/disable skip the fcp request sent from fgfm tunnel type: str choices: [disable, enable] default: enable more...
    • verify-install - Verify install against remote configuration. type: str choices: [disable, optimal, enable] default: enable more...
    • fgfm-install-refresh-count - Maximum FGFM install refresh attempt. type: int default: 10 more...
    • conf-merge-after-script - Merge config after run script on remote device, instead of full retrieve. type: str choices: [disable, enable] default: disable 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_system_dm:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        system_dm:
           concurrent-install-image-limit: <value of integer>
           concurrent-install-limit: <value of integer>
           concurrent-install-script-limit: <value of integer>
           discover-timeout: <value of integer>
           dpm-logsize: <value of integer>
           fgfm-sock-timeout: <value of integer>
           fgfm_keepalive_itvl: <value of integer>
           force-remote-diff: <value in [disable, enable]>
           fortiap-refresh-cnt: <value of integer>
           fortiap-refresh-itvl: <value of integer>
           fortiext-refresh-cnt: <value of integer>
           install-image-timeout: <value of integer>
           install-tunnel-retry-itvl: <value of integer>
           max-revs: <value of integer>
           nr-retry: <value of integer>
           retry: <value in [disable, enable]>
           retry-intvl: <value of integer>
           rollback-allow-reboot: <value in [disable, enable]>
           script-logsize: <value of integer>
           skip-scep-check: <value in [disable, enable]>
           skip-tunnel-fcp-req: <value in [disable, enable]>
           verify-install: <value in [disable, optimal, enable]>
           fgfm-install-refresh-count: <value of integer>
           conf-merge-after-script: <value in [disable, enable]>

Return Values

Common return values are documented: 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.