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

New in version 2.10.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
dvmdb_adom yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • dvmdb_adom - ADOM table, most attributes are read-only and can only be changed internally. type: dict
    • desc - No description for the parameter type: str more...
    • flags - No description for the parameter type: array 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] more...
    • log_db_retention_hours - No description for the parameter type: int default: 1440 more...
    • log_disk_quota - No description for the parameter type: int more...
    • log_disk_quota_alert_thres - No description for the parameter type: int default: 90 more...
    • log_disk_quota_split_ratio - No description for the parameter type: int default: 70 more...
    • log_file_retention_hours - No description for the parameter type: int default: 8760 more...
    • meta fields - No description for the parameter type: dict more...
    • mig_mr - No description for the parameter type: int default: 4 more...
    • mig_os_ver - No description for the parameter type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0] default: 6.0 more...
    • mode - ems - (Value no longer used as of 4. type: str choices: [ems, gms, provider] default: gms more...
    • mr - No description for the parameter type: int default: 4 more...
    • name - No description for the parameter type: str more...
    • os_ver - No description for the parameter type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0] default: 6.0 more...
    • restricted_prds - No description for the parameter type: array choices: [fos, foc, fml, fch, fwb, log, fct, faz, fsa, fsw, fmg, fdd, fac, fpx, fna, fdc, fsr, fad, ffw, fap, fxt, fts, fai, fwc] more...
    • state - No description for the parameter type: int default: 1 more...
    • uuid - No description for the parameter type: str more...
    • create_time - No description for the parameter type: int more...
    • workspace_mode - No description for the parameter type: int more...

Notes

Note

  • 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: fortianalyzer-inventory
  connection: httpapi
  collections:
  - fortinet.fortianalyzer
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
   - name: Alert console
     faz_fact:
        facts:
            selector: 'sys_status'
   - name: 'fetch adoms'
     faz_fact:
        facts:
            selector: 'dvmdb_adom'
            params:
                adom: 'root'

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_dvmdb_adom:
      dvmdb_adom:
        desc: adom created via ansible
        name: fooadom
      state: present
    name: ADOM table, most attributes are read-only and can only be changed internally.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.