fmgr_system_dm – Configure dm.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • system_dm - Configure dm. type: dict
    • concurrent_install_image_limit (Alias name: concurrent-install-image-limit) Maximum number of concurrent install image (1 - 1000). type: int default: 500 more...
    • concurrent_install_limit (Alias name: concurrent-install-limit) Maximum number of concurrent installs (5 - 2000). type: int default: 480 more...
    • concurrent_install_script_limit (Alias name: concurrent-install-script-limit) Maximum number of concurrent install scripts (5 - 2000). type: int default: 480 more...
    • discover_timeout (Alias name: discover-timeout) Check connection timeout when discover device (3 - 15). type: int default: 6 more...
    • dpm_logsize (Alias name: dpm-logsize) Maximum dpm log size per device (1 - 10000k). type: int default: 10000 more...
    • fgfm_sock_timeout (Alias name: 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 (Alias name: force-remote-diff) Always use remote diff when installing. type: str choices: [disable, enable] default: disable more...
    • fortiap_refresh_cnt (Alias name: fortiap-refresh-cnt) Max auto refresh fortiap number each time (1 - 10000). type: int default: 500 more...
    • fortiap_refresh_itvl (Alias name: 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 (Alias name: fortiext-refresh-cnt) Max device number for fortiextender auto refresh (1 - 10000). type: int default: 50 more...
    • install_image_timeout (Alias name: install-image-timeout) Maximum waiting time for image transfer and device upgrade (600 - 7200 sec). type: int default: 3600 more...
    • install_tunnel_retry_itvl (Alias name: install-tunnel-retry-itvl) Time to re-establish tunnel during install (10 - 60 sec). type: int default: 60 more...
    • max_revs (Alias name: max-revs) Maximum number of revisions saved (1 - 250). type: int default: 100 more...
    • nr_retry (Alias name: 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 (Alias name: retry-intvl) Retry interval. type: int default: 15 more...
    • rollback_allow_reboot (Alias name: rollback-allow-reboot) Enable/disable fortigate reboot to rollback when installing script/config. type: str choices: [disable, enable] default: disable more...
    • script_logsize (Alias name: script-logsize) Maximum script log size per device (1 - 10000k). type: int default: 100 more...
    • skip_scep_check (Alias name: 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 (Alias name: skip-tunnel-fcp-req) Enable/disable skip the fcp request sent from fgfm tunnel type: str choices: [disable, enable] default: enable more...
    • verify_install (Alias name: verify-install) Verify install against remote configuration. type: str choices: [disable, optimal, enable] default: enable more...
    • fgfm_install_refresh_count (Alias name: fgfm-install-refresh-count) Maximum fgfm install refresh attempt. type: int default: 10 more...
    • conf_merge_after_script (Alias name: conf-merge-after-script) Merge config after run script on remote device, instead of full retrieve. type: str choices: [disable, enable] default: disable more...
    • log_autoupdate (Alias name: log-autoupdate) Enable/disable autoupdate debug logging. type: str choices: [disable, enable] default: disable more...
    • fgfm_auto_retrieve_timeout (Alias name: fgfm-auto-retrieve-timeout) Maximum waiting time for auto retrieve(60 seconds - 3 hours, default 30min). type: int default: 1800 more...
    • install_fds_timeout (Alias name: install-fds-timeout) Maximum waiting time for fgt update during install (1-30 minutes, default 10). type: int default: 10 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dm.
      fortinet.fortimanager.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: <integer>
          concurrent_install_limit: <integer>
          concurrent_install_script_limit: <integer>
          discover_timeout: <integer>
          dpm_logsize: <integer>
          fgfm_sock_timeout: <integer>
          fgfm_keepalive_itvl: <integer>
          force_remote_diff: <value in [disable, enable]>
          fortiap_refresh_cnt: <integer>
          fortiap_refresh_itvl: <integer>
          fortiext_refresh_cnt: <integer>
          install_image_timeout: <integer>
          install_tunnel_retry_itvl: <integer>
          max_revs: <integer>
          nr_retry: <integer>
          retry: <value in [disable, enable]>
          retry_intvl: <integer>
          rollback_allow_reboot: <value in [disable, enable]>
          script_logsize: <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: <integer>
          conf_merge_after_script: <value in [disable, enable]>
          log_autoupdate: <value in [disable, enable]>
          fgfm_auto_retrieve_timeout: <integer>
          install_fds_timeout: <integer>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)