fortinet.fortimanager.fmgr_system_dm module – Configure dm.

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run 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 version 2.10: of fortinet.fortimanager

Synopsis

  • This module is 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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_dm

dictionary

the top level parameters set

concurrent-install-image-limit

integer

Maximum number of concurrent install image (1 - 1000).

Default: 500

concurrent-install-limit

integer

Maximum number of concurrent installs (5 - 2000).

Default: 480

concurrent-install-script-limit

integer

Maximum number of concurrent install scripts (5 - 2000).

Default: 480

conf-merge-after-script

string

Merge config after run script on remote device, instead of full retrieve.

disable - Disable.

enable - Enable.

Choices:

  • disable ← (default)

  • enable

discover-timeout

integer

Check connection timeout when discover device (3 - 15).

Default: 6

dpm-logsize

integer

Maximum dpm log size per device (1 - 10000K).

Default: 10000

fgfm-install-refresh-count

integer

Maximum FGFM install refresh attempt.

Default: 10

fgfm-sock-timeout

integer

Maximum FGFM socket idle time (90 - 1800 sec).

Default: 360

fgfm_keepalive_itvl

integer

FGFM protocol keep alive interval (30 - 600 sec).

Default: 120

force-remote-diff

string

Always use remote diff when installing.

disable - Disable.

enable - Enable.

Choices:

  • disable ← (default)

  • enable

fortiap-refresh-cnt

integer

Max auto refresh FortiAP number each time (1 - 10000).

Default: 500

fortiap-refresh-itvl

integer

Auto refresh FortiAP status interval (0 - 1440) minutes, set to 0 will disable auto refresh.

Default: 10

fortiext-refresh-cnt

integer

Max device number for FortiExtender auto refresh (1 - 10000).

Default: 50

install-image-timeout

integer

Maximum waiting time for image transfer and device upgrade (600 - 7200 sec).

Default: 3600

install-tunnel-retry-itvl

integer

Time to re-establish tunnel during install (10 - 60 sec).

Default: 60

max-revs

integer

Maximum number of revisions saved (1 - 250).

Default: 100

nr-retry

integer

Number of retries.

Default: 1

retry

string

Enable/disable configuration install retry.

disable - Disable.

enable - Enable.

Choices:

  • disable

  • enable ← (default)

retry-intvl

integer

Retry interval.

Default: 15

rollback-allow-reboot

string

Enable/disable FortiGate reboot to rollback when installing script/config.

disable - Disable.

enable - Enable.

Choices:

  • disable ← (default)

  • enable

script-logsize

integer

Maximum script log size per device (1 - 10000K).

Default: 100

skip-scep-check

string

Enable/disable installing scep related objects even if scep url is configured.

disable - Disable.

enable - Enable.

Choices:

  • disable ← (default)

  • enable

skip-tunnel-fcp-req

string

Enable/disable skip the fcp request sent from fgfm tunnel

disable - Disable.

enable - Enable.

Choices:

  • disable

  • enable ← (default)

verify-install

string

Verify install against remote configuration.

disable - Disable.

optimal - Verify installation for command errors.

enable - Always verify installation.

Choices:

  • disable

  • optimal

  • enable ← (default)

workspace_locking_adom

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

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)