drmofu.fortianalyzer.faz_dvmdb_adom (1.3.0) — module

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

| "added in version" 1.0.0 of drmofu.fortianalyzer"

Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0


Add to requirements.yml

  collections:
    - name: drmofu.fortianalyzer
      version: 1.3.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object
    required: true
    type: str

log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - 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.log
    required: false
    type: str

rc_failed:
    description: the rc codes list with which the conditions to fail will be overriden
    elements: int
    required: false
    type: list

dvmdb_adom:
    description: the top level parameters set
    required: false
    suboptions:
      create_time:
        description: no description
        type: int
      desc:
        description: no description
        type: str
      flags:
        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
        description: no description
        elements: str
        type: list
      lock_override:
        description: no description
        type: int
      log_db_retention_hours:
        description: no description
        type: int
      log_disk_quota:
        description: no description
        type: int
      log_disk_quota_alert_thres:
        description: no description
        type: int
      log_disk_quota_split_ratio:
        description: no description
        type: int
      log_file_retention_hours:
        description: no description
        type: int
      meta fields:
        description: no description
        type: dict
      mig_mr:
        description: no description
        type: int
      mig_os_ver:
        choices:
        - unknown
        - '0.0'
        - '1.0'
        - '2.0'
        - '3.0'
        - '4.0'
        - '5.0'
        - '6.0'
        - '7.0'
        - '8.0'
        - '9.0'
        description: no description
        type: str
      mode:
        choices:
        - ems
        - gms
        - provider
        description:
        - ems - (Value no longer used as of 4.3)
        - provider - Global database.
        type: str
      mr:
        description: no description
        type: int
      name:
        description: no description
        type: str
      os_ver:
        choices:
        - unknown
        - '0.0'
        - '1.0'
        - '2.0'
        - '3.0'
        - '4.0'
        - '5.0'
        - '6.0'
        - '7.0'
        - '8.0'
        - '9.0'
        description: no description
        type: str
      restricted_prds:
        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
        description: no description
        elements: str
        type: list
      state:
        description: no description
        type: int
      tz:
        description: no description
        type: int
      uuid:
        description: no description
        type: str
      workspace_mode:
        description: no description
        type: int
    type: dict

enable_log:
    default: false
    description: Enable/Disable logging for task
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: the rc codes list with which the conditions to succeed will be overriden
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - set
    - update
    - add
    description: The overridden method for the underlying Json RPC request
    required: false
    type: str

bypass_validation:
    default: false
    description: only set to True when module schema diffs with FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

Outputs

meta:
  contains:
    request_url:
      description: The full url requested
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current fortianalyzer version.
  returned: complex
  type: list