fortinet.fortimanager.fmgr_system_dm module – Configure dm.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_dm.

New in fortinet.fortimanager 2.0.0

Synopsis 

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

Parameters 

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
system_dm dictionary	The top level parameters set.
concurrent-install-image-limit integer	Deprecated, please rename it to concurrent_install_image_limit. Maximum number of concurrent install image
concurrent-install-limit integer	Deprecated, please rename it to concurrent_install_limit. Maximum number of concurrent installs
concurrent-install-script-limit integer	Deprecated, please rename it to concurrent_install_script_limit. Maximum number of concurrent install scripts
conf-merge-after-script string	Deprecated, please rename it to conf_merge_after_script. Merge config after run script on remote device, instead of full retrieve. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
discover-timeout integer	Deprecated, please rename it to discover_timeout. Check connection timeout when discover device
dpm-logsize integer	Deprecated, please rename it to dpm_logsize. Maximum dpm log size per device
fgfm-auto-retrieve-timeout integer	Deprecated, please rename it to fgfm_auto_retrieve_timeout. Maximum waiting time for auto retrieve
fgfm-install-refresh-count integer	Deprecated, please rename it to fgfm_install_refresh_count. Maximum FGFM install refresh attempt.
fgfm-sock-timeout integer	Deprecated, please rename it to fgfm_sock_timeout. Maximum FGFM socket idle time
fgfm_keepalive_itvl integer	FGFM protocol keep alive interval
force-remote-diff string	Deprecated, please rename it to force_remote_diff. Always use remote diff when installing. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
fortiap-refresh-cnt integer	Deprecated, please rename it to fortiap_refresh_cnt. Max auto refresh FortiAP number each time
fortiap-refresh-itvl integer	Deprecated, please rename it to fortiap_refresh_itvl. Auto refresh FortiAP status interval
fortiext-refresh-cnt integer	Deprecated, please rename it to fortiext_refresh_cnt. Max device number for FortiExtender auto refresh
install-fds-timeout integer	Deprecated, please rename it to install_fds_timeout. Maximum waiting time for fgt update during install
install-image-timeout integer	Deprecated, please rename it to install_image_timeout. Maximum waiting time for image transfer and device upgrade
install-tunnel-retry-itvl integer	Deprecated, please rename it to install_tunnel_retry_itvl. Time to re-establish tunnel during install
log-autoupdate string	Deprecated, please rename it to log_autoupdate. Enable/disable autoupdate debug logging. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
max-revs integer	Deprecated, please rename it to max_revs. Maximum number of revisions saved
nr-retry integer	Deprecated, please rename it to nr_retry. Number of retries.
retry string	Enable/disable configuration install retry. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
retry-intvl integer	Deprecated, please rename it to retry_intvl. Retry interval.
rollback-allow-reboot string	Deprecated, please rename it to rollback_allow_reboot. Enable/disable FortiGate reboot to rollback when installing script/config. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
script-logsize integer	Deprecated, please rename it to script_logsize. Maximum script log size per device
skip-scep-check string	Deprecated, please rename it to skip_scep_check. Enable/disable installing scep related objects even if scep url is configured. disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
skip-tunnel-fcp-req string	Deprecated, please rename it to skip_tunnel_fcp_req. Enable/disable skip the fcp request sent from fgfm tunnel disable - Disable. enable - Enable. Choices: `"disable"` `"enable"`
verify-install string	Deprecated, please rename it to verify_install. Verify install against remote configuration. disable - Disable. optimal - Verify installation for command errors. enable - Always verify installation. Choices: `"disable"` `"optimal"` `"enable"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes 

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in 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 

- 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 here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_system_dm module – Configure dm.

Synopsis

Parameters

Notes

Examples

Return Values