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

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
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • 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
  • dvmdb_adom - ADOM table, most attributes are read-only and can only be changed internally. type: dict
    • desc Desc. type: str more...
    • flags Flags. type: list 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, per_device_fsw, install_deselect_all] more...
    • log_db_retention_hours Log db retention hours. type: int default: 1440 more...
    • log_disk_quota Log disk quota. type: int more...
    • log_disk_quota_alert_thres Log disk quota alert thres. type: int default: 90 more...
    • log_disk_quota_split_ratio Log disk quota split ratio. type: int default: 70 more...
    • log_file_retention_hours Log file retention hours. type: int default: 8760 more...
    • meta_fields (Alias name: meta fields) Default metafields: none. type: dict more...
    • mig_mr Mig mr. type: int default: 2 more...
    • mig_os_ver Mig os ver. type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] default: 6.0 more...
    • mode Ems - (value no longer used as of 4. type: str choices: [ems, gms, provider] default: gms more...
    • mr Mr. type: int default: 2 more...
    • name Name. type: str more...
    • os_ver Os ver. type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] default: 6.0 more...
    • restricted_prds Restricted prds. type: list or str choices: [fos, foc, fml, fch, fwb, log, fct, faz, fsa, fsw, fmg, fdd, fac, fpx, fna, fdc, ffw, fsr, fad, fap, fxt, fts, fai, fwc, fis, fed, fabric, fpa, fca, ftc, fss] more...
    • state State. type: int default: 1 more...
    • uuid Uuid. type: str more...
    • create_time Create time. type: int more...
    • workspace_mode Workspace mode. type: int more...
    • tz Tz. type: int more...
    • lock_override Lock override. type: int more...
    • primary_dns_ip4 Primary dns ip4. type: str more...
    • primary_dns_ip6_1 Primary dns ip6 1. type: int more...
    • primary_dns_ip6_2 Primary dns ip6 2. type: int more...
    • primary_dns_ip6_3 Primary dns ip6 3. type: int more...
    • primary_dns_ip6_4 Primary dns ip6 4. type: int more...
    • secondary_dns_ip4 Secondary dns ip4. type: str more...
    • secondary_dns_ip6_1 Secondary dns ip6 1. type: int more...
    • secondary_dns_ip6_2 Secondary dns ip6 2. type: int more...
    • secondary_dns_ip6_3 Secondary dns ip6 3. type: int more...
    • secondary_dns_ip6_4 Secondary dns ip6 4. type: int 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: ADOM table, most attributes are read-only and can only be changed internally.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        dvmdb_adom:
          desc: <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"
            - "per_device_fsw"
            - "install_deselect_all"
          log_db_retention_hours: <integer>
          log_disk_quota: <integer>
          log_disk_quota_alert_thres: <integer>
          log_disk_quota_split_ratio: <integer>
          log_file_retention_hours: <integer>
          meta_fields: <dict>
          mig_mr: <integer>
          mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
          mode: <value in [ems, gms, provider]>
          mr: <integer>
          name: <string>
          os_ver: <value in [unknown, 0.0, 1.0, ...]>
          restricted_prds: # <list or string>
            - "fos"
            - "foc"
            - "fml"
            - "fch"
            - "fwb"
            - "log"
            - "fct"
            - "faz"
            - "fsa"
            - "fsw"
            - "fmg"
            - "fdd"
            - "fac"
            - "fpx"
            - "fna"
            - "fdc"
            - "ffw"
            - "fsr"
            - "fad"
            - "fap"
            - "fxt"
            - "fts"
            - "fai"
            - "fwc"
            - "fis"
            - "fed"
            - "fabric"
            - "fpa"
            - "fca"
            - "ftc"
            - "fss"
          state: <integer>
          uuid: <string>
          create_time: <integer>
          workspace_mode: <integer>
          tz: <integer>
          lock_override: <integer>
          primary_dns_ip4: <string>
          primary_dns_ip6_1: <integer>
          primary_dns_ip6_2: <integer>
          primary_dns_ip6_3: <integer>
          primary_dns_ip6_4: <integer>
          secondary_dns_ip4: <string>
          secondary_dns_ip6_1: <integer>
          secondary_dns_ip6_2: <integer>
          secondary_dns_ip6_3: <integer>
          secondary_dns_ip6_4: <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)