fortinet.fortimanager.fmgr_system_dm – Configure dm.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr system dm module


fortinet.fortimanager.fmgr_system_dm – Configure dm.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 Choices/Defaults Comments

bypass_validation

boolean

  • no ←

  • yes

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

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

  • present
  • absent

the directive to create, update or delete an object

system_dm

dictionary

the top level parameters set

concurrent-install-image-limit

integer

Default:

500

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

concurrent-install-limit

integer

Default:

480

Maximum number of concurrent installs (5 - 2000).

concurrent-install-script-limit

integer

Default:

480

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

discover-timeout

integer

Default:

6

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

dpm-logsize

integer

Default:

10000

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

fgfm-sock-timeout

integer

Default:

360

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

fgfm_keepalive_itvl

integer

Default:

120

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

force-remote-diff

string

  • disable ←

  • enable

Always use remote diff when installing.

disable - Disable.

enable - Enable.

fortiap-refresh-cnt

integer

Default:

500

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

fortiap-refresh-itvl

integer

Default:

10

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

fortiext-refresh-cnt

integer

Default:

50

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

install-image-timeout

integer

Default:

3600

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

install-tunnel-retry-itvl

integer

Default:

60

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

max-revs

integer

Default:

100

Maximum number of revisions saved (1 - 250).

nr-retry

integer

Default:

1

Number of retries.

retry

string

  • disable

  • enable ←

Enable/disable configuration install retry.

disable - Disable.

enable - Enable.

retry-intvl

integer

Default:

15

Retry interval.

rollback-allow-reboot

string

  • disable ←

  • enable

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

disable - Disable.

enable - Enable.

script-logsize

integer

Default:

100

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

skip-scep-check

string

  • disable ←

  • enable

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

disable - Disable.

enable - Enable.

skip-tunnel-fcp-req

string

  • disable

  • enable ←

Enable/disable skip the fcp request sent from fgfm tunnel

disable - Disable.

enable - Enable.

verify-install

string

  • disable
  • optimal

  • enable ←

Verify install against remote configuration.

disable - Disable.

optimal - Verify installation for command errors.

enable - Always verify installation.

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

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



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]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_dm_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr_system_dm_module&oldid=63812"
Powered by MediaWiki