faz_dvmdb_adom.rst

source

faz_dvmdb_adom.py

orphan

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

1.0.0

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

• Possible variable names before 2.0.0: variable-name, variable name, variable.name
• Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.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 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.15.0

FortiAnalyzer Version Compatibility

Supported Version Ranges: v6.2.1 -> latest

Parameters

• access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
• bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
• enable_log Enable/Disable logging for task type: bool default: False
• forticloud_access_token Access token of forticloud analyzer API users. type: str
• log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
• proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
• version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
• rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
• rc_failed The rc codes list with which the conditions to fail will be overriden type: list
• 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 type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• flags type: list elements: str 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...

  Supported Version Ranges: v6.2.1 -> latest

• log_db_retention_hours type: int default: 1440 more...

  Supported Version Ranges: v6.2.1 -> latest

• log_disk_quota type: int more...

  Supported Version Ranges: v6.2.1 -> latest

• log_disk_quota_alert_thres type: int default: 90 more...

  Supported Version Ranges: v6.2.1 -> latest

• log_disk_quota_split_ratio type: int default: 70 more...

  Supported Version Ranges: v6.2.1 -> latest

• log_file_retention_hours type: int default: 8760 more...

  Supported Version Ranges: v6.2.1 -> latest

• meta_fields type: dict more...

  Supported Version Ranges: v6.2.1 -> latest

• mig_mr type: int default: 4 more...

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

• mode ems - (Value no longer used as of 4.3) type: str choices: [ems, gms, provider] default: gms more...

  Supported Version Ranges: v6.2.1 -> latest

• mr type: int default: 4 more...

  Supported Version Ranges: v6.2.1 -> latest

• name type: str more...

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

• restricted_prds type: list elements: str choices: [fos, foc, fml, fch, fwb, log, fct, faz, fsa, fsw, fmg, fdd, fac, fpx, fna, fdc, ffw, fsr, fad, fts, fap, fxt, fai, fwc] more...

  Supported Version Ranges: v6.2.1 -> latest

• state type: int default: 1 more...

  Supported Version Ranges: v6.2.1 -> latest

• uuid type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• create_time type: int more...

  Supported Version Ranges: v6.4.1 -> latest

• workspace_mode type: int more...

  Supported Version Ranges: v6.4.3 -> latest

• tz type: int more...

  Supported Version Ranges: v7.4.0 -> latest

• lock_override type: int more...

  Supported Version Ranges: v7.4.1 -> latest

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

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: ADOM table, most attributes are read-only and can only be changed internally.
      fortinet.fortianalyzer.faz_dvmdb_adom:
        dvmdb_adom:
          desc: adom created via ansible
          name: fooadom
        state: present
  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:

• 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 fortianalyzer version. returned: if params are not supported in the current version type: list

Status

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

Authors

• Xinwei Du (@dux-fortinet)
• Maxx Liu (@MaxxLiu22)
• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)