fortinet.fortimanager.fmgr_dvmdb_adom – ADOM table, most attributes are read-only and can only be changed internally.

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_dvmdb_adom.

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
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
dvmdb_adom
dictionary
the top level parameters set
desc
string
no description
flags
list / elements=string
    Choices:
  • migration
  • db_export
  • no_vpn_console
  • backup
  • other_devices
  • central_sdwan
  • is_autosync
  • per_device_wtp
  • policy_check_on_install
  • install_on_policy_check_fail
  • auto_push_cfg
no description
log_db_retention_hours
integer
Default:
1440
no description
log_disk_quota
integer
no description
log_disk_quota_alert_thres
integer
Default:
90
no description
log_disk_quota_split_ratio
integer
Default:
70
no description
log_file_retention_hours
integer
Default:
8760
no description
meta fields
dictionary
no description
mig_mr
integer
Default:
2
no description
mig_os_ver
string
    Choices:
  • unknown
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0 ←
no description
mode
string
    Choices:
  • ems
  • gms ←
  • provider
ems - (Value no longer used as of 4.3)
provider - Global database.
mr
integer
Default:
2
no description
name
string
no description
os_ver
string
    Choices:
  • unknown
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0 ←
no description
restricted_prds
list / elements=string
    Choices:
  • fos
  • foc
  • fml
  • fch
  • fwb
  • log
  • fct
  • faz
  • fsa
  • fsw
  • fmg
  • fdd
  • fac
  • fpx
no description
state
integer
Default:
1
no description
uuid
string
no description
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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: ADOM table, most attributes are read-only and can only be changed internally.
     fmgr_dvmdb_adom:
        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, ...]
        state: <value in [present, absent]>
        dvmdb_adom:
           desc: <value of string>
           flags:
             - migration
             - db_export
             - no_vpn_console
             - backup
             - other_devices
             - central_sdwan
             - is_autosync
             - per_device_wtp
             - policy_check_on_install
             - install_on_policy_check_fail
             - auto_push_cfg
           log_db_retention_hours: <value of integer>
           log_disk_quota: <value of integer>
           log_disk_quota_alert_thres: <value of integer>
           log_disk_quota_split_ratio: <value of integer>
           log_file_retention_hours: <value of integer>
           meta fields: <value of dict>
           mig_mr: <value of integer>
           mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
           mode: <value in [ems, gms, provider]>
           mr: <value of integer>
           name: <value of string>
           os_ver: <value in [unknown, 0.0, 1.0, ...]>
           restricted_prds:
             - fos
             - foc
             - fml
             - fch
             - fwb
             - log
             - fct
             - faz
             - fsa
             - fsw
             - fmg
             - fdd
             - fac
             - fpx
           state: <value of integer>
           uuid: <value of string>

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)