faz_dvm_cmd_import_devlist – Import a list of ADOMs and devices.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

dvm_cmd_import_devlist 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
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
dvm_cmd_import_devlist - Import a list of ADOMs and devices. type: dict

adom - Name or ID of the ADOM where the command is to be executed on. type: str more...

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

adom True True True True True True True True True True True True
flags - No description for the parameter type: array choices: [none, create_task, nonblocking] more...

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

flags True True True True True True True True True True True True
import-adom-members - No description for the parameter type: array more...

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

import-adom-members True True True True True True True True True True True True
- adom - Target ADOM to associate device VDOM with. type: str more...
  
  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
  
  adom True True True True True True True True True True True True
- dev - No description for the parameter type: str more...
  
  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
  
  dev True True True True True True True True True True True True
- vdom - No description for the parameter type: str more...
  
  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
  
  vdom True True True True True True True True True True True True
import-adoms - No description for the parameter type: array more...

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

import-adoms True True True True True True True True True True True True
- desc - No description for the parameter type: str more...
  
  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
  
  desc True True True True True True True True True True True True
- 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...
  
  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
  
  flags True True True True True True True True True True True True
- log_db_retention_hours - No description for the parameter type: int default: 1440 more...
  
  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
  
  log_db_retention_hours True True True True True True True True True True True True
- log_disk_quota - No description for the parameter type: int more...
  
  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
  
  log_disk_quota True True True True True True True True True True True True
- log_disk_quota_alert_thres - No description for the parameter type: int default: 90 more...
  
  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
  
  log_disk_quota_alert_thres True True True True True True True True True True True True
- log_disk_quota_split_ratio - No description for the parameter type: int default: 70 more...
  
  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
  
  log_disk_quota_split_ratio True True True True True True True True True True True True
- log_file_retention_hours - No description for the parameter type: int default: 8760 more...
  
  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
  
  log_file_retention_hours True True True True True True True True True True True True
- meta fields - No description for the parameter type: dict more...
  
  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
  
  meta fields True True True True True True True True True True True True
- mig_mr - No description for the parameter type: int default: 4 more...
  
  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
  
  mig_mr True True True True True True True True True True True True
- 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...
  
  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
  
  mig_os_ver True True True True True True True True True True True True
- mode - ems - (Value no longer used as of 4. type: str choices: [ems, gms, provider] default: gms more...
  
  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
  
  mode True True True True True True True True True True True True
- mr - No description for the parameter type: int default: 4 more...
  
  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
  
  mr True True True True True True True True True True True True
- name - No description for the parameter type: str more...
  
  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
  
  name True True True True True True True True True True True True
- 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...
  
  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
  
  os_ver True True True True True True True True True True True True
- 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...
  
  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
  
  restricted_prds True True True True True True True True True True True True
- state - No description for the parameter type: int default: 1 more...
  
  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
  
  state True True True True True True True True True True True True
- uuid - No description for the parameter type: str more...
  
  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
  
  uuid True True True True True True True True True True True True
- create_time - No description for the parameter type: int more...
  
  6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  create_time True True True True True True True
- workspace_mode - No description for the parameter type: int more...
  
  6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  workspace_mode True True True True True
import-devices - No description for the parameter type: array more...

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

import-devices True True True True True True True True True True True True
- adm_pass - No description for the parameter type: str more...
  
  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
  
  adm_pass True True True True True True True True True True True True
- adm_usr - No description for the parameter type: str more...
  
  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
  
  adm_usr True True True True True True True True True True True True
- app_ver - No description for the parameter type: str more...
  
  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
  
  app_ver True True True True True True True True True True True True
- av_ver - No description for the parameter type: str more...
  
  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
  
  av_ver True True True True True True True True True True True True
- beta - No description for the parameter type: int more...
  
  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
  
  beta True True True True True True True True True True True True
- branch_pt - No description for the parameter type: int more...
  
  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
  
  branch_pt True True True True True True True True True True True True
- build - No description for the parameter type: int more...
  
  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
  
  build True True True True True True True True True True True True
- checksum - No description for the parameter type: str more...
  
  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
  
  checksum True True True True True True True True True True True True
- conf_status - No description for the parameter type: str choices: [unknown, insync, outofsync] default: unknown more...
  
  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
  
  conf_status True True True True True True True True True True True True
- conn_mode - No description for the parameter type: str choices: [active, passive] default: passive more...
  
  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
  
  conn_mode True True True True True True True True True True True True
- conn_status - No description for the parameter type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
  
  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
  
  conn_status True True True True True True True True True True True True
- db_status - No description for the parameter type: str choices: [unknown, nomod, mod] default: unknown more...
  
  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
  
  db_status True True True True True True True True True True True True
- desc - No description for the parameter type: str more...
  
  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
  
  desc True True True True True True True True True True True True
- dev_status - No description for the parameter type: str choices: [none, unknown, checkedin, inprogress, installed, aborted, sched, retry, canceled, pending, retrieved, changed_conf, sync_fail, timeout, rev_revert, auto_updated] default: unknown more...
  
  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
  
  dev_status True True True True True True True True True True True True
- fap_cnt - No description for the parameter type: int more...
  
  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
  
  fap_cnt True True True True True True True True True True True True
- faz.full_act - No description for the parameter type: int more...
  
  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
  
  faz.full_act True True True True True True True True True True True True
- faz.perm - No description for the parameter type: int more...
  
  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
  
  faz.perm True True True True True True True True True True True True
- faz.quota - No description for the parameter type: int more...
  
  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
  
  faz.quota True True True True True True True True True True True True
- faz.used - No description for the parameter type: int more...
  
  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
  
  faz.used True True True True True True True True True True True True
- fex_cnt - No description for the parameter type: int more...
  
  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
  
  fex_cnt True True True True True True True True True True True True
- flags - No description for the parameter type: array choices: [has_hdd, vdom_enabled, discover, reload, interim_build, offline_mode, is_model, fips_mode, linked_to_model, ip-conflict, faz-autosync] more...
  
  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
  
  flags True True True True True True True True True True True True
- foslic_cpu - VM Meter vCPU count. type: int more...
  
  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
  
  foslic_cpu True True True True True True True True True True True True
- foslic_dr_site - VM Meter DR Site status. type: str choices: [disable, enable] default: disable more...
  
  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
  
  foslic_dr_site True True True True True True True True True True True True
- foslic_inst_time - VM Meter first deployment time (in UNIX timestamp). type: int more...
  
  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
  
  foslic_inst_time True True True True True True True True True True True True
- foslic_last_sync - VM Meter last synchronized time (in UNIX timestamp). type: int more...
  
  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
  
  foslic_last_sync True True True True True True True True True True True True
- foslic_ram - VM Meter device RAM size (in MB). type: int more...
  
  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
  
  foslic_ram True True True True True True True True True True True True
- foslic_type - VM Meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary more...
  
  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
  
  foslic_type True True True True True True True True True True True True
- foslic_utm - No description for the parameter type: array choices: [fw, av, ips, app, url, utm, fwb] more...
  
  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
  
  foslic_utm True True True True True True True True True True True True
- fsw_cnt - No description for the parameter type: int more...
  
  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
  
  fsw_cnt True True True True True True True True True True True True
- ha_group_id - No description for the parameter type: int more...
  
  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
  
  ha_group_id True True True True True True True True True True True True
- ha_group_name - No description for the parameter type: str more...
  
  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
  
  ha_group_name True True True True True True True True True True True True
- ha_mode - enabled - Value reserved for non-FOS HA devices. type: str choices: [standalone, AP, AA, ELBC, DUAL, enabled, unknown, fmg-enabled, autoscale] default: standalone more...
  
  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
  
  ha_mode True True True True True True True True True True True True
- ha_slave - No description for the parameter type: array more...
  
  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
  
  ha_slave True True True True True True True True True True True True
  - idx - No description for the parameter type: int more...
    
    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
    
    idx True True True True True True True True True True True True
  - name - No description for the parameter type: str more...
    
    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
    
    name True True True True True True True True True True True True
  - prio - No description for the parameter type: int more...
    
    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
    
    prio True True True True True True True True True True True True
  - role - No description for the parameter type: str choices: [slave, master] default: slave more...
    
    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
    
    role True True True True True True True True True True True True
  - sn - No description for the parameter type: str more...
    
    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
    
    sn True True True True True True True True True True True True
  - status - No description for the parameter type: int more...
    
    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
    
    status True True True True True True True True True True True True
- hdisk_size - No description for the parameter type: int more...
  
  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
  
  hdisk_size True True True True True True True True True True True True
- hostname - No description for the parameter type: str more...
  
  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
  
  hostname True True True True True True True True True True True True
- hw_rev_major - No description for the parameter type: int more...
  
  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
  
  hw_rev_major True True True True True True True True True True True True
- hw_rev_minor - No description for the parameter type: int more...
  
  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
  
  hw_rev_minor True True True True True True True True True True True True
- ip - No description for the parameter type: str more...
  
  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
  
  ip True True True True True True True True True True True True
- ips_ext - No description for the parameter type: int more...
  
  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
  
  ips_ext True True True True True True True True True True True True
- ips_ver - No description for the parameter type: str more...
  
  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
  
  ips_ver True True True True True True True True True True True True
- last_checked - No description for the parameter type: int more...
  
  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
  
  last_checked True True True True True True True True True True True True
- last_resync - No description for the parameter type: int more...
  
  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
  
  last_resync True True True True True True True True True True True True
- latitude - No description for the parameter type: str more...
  
  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
  
  latitude True True True True True True True True True True True True
- lic_flags - No description for the parameter type: int more...
  
  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
  
  lic_flags True True True True True True True True True True True True
- lic_region - No description for the parameter type: str more...
  
  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
  
  lic_region True True True True True True True True True True True True
- location_from - No description for the parameter type: str more...
  
  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
  
  location_from True True True True True True True True True True True True
- logdisk_size - No description for the parameter type: int more...
  
  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
  
  logdisk_size True True True True True True True True True True True True
- longitude - No description for the parameter type: str more...
  
  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
  
  longitude True True True True True True True True True True True True
- maxvdom - No description for the parameter type: int default: 10 more...
  
  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
  
  maxvdom True True True True True True True True True True True True
- meta fields - No description for the parameter type: dict more...
  
  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
  
  meta fields True True True True True True True True True True True True
- mgmt_id - No description for the parameter type: int more...
  
  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
  
  mgmt_id True True True True True True True True True True True True
- mgmt_if - No description for the parameter type: str more...
  
  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
  
  mgmt_if True True True True True True True True True True True True
- mgmt_mode - No description for the parameter type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
  
  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
  
  mgmt_mode True True True True True True True True True True True True
- mgt_vdom - No description for the parameter type: str more...
  
  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
  
  mgt_vdom True True True True True True True True True True True True
- module_sn - No description for the parameter type: str more...
  
  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
  
  module_sn True True True True True True True True True True True True
- mr - No description for the parameter type: int default: -1 more...
  
  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
  
  mr True True True True True True True True True True True True
- name - Unique name for the device. type: str more...
  
  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
  
  name True True True True True True True True True True True True
- os_type - No description for the parameter type: str choices: [unknown, fos, fsw, foc, fml, faz, fwb, fch, fct, log, fmg, fsa, fdd, fac, fpx, fna, fdc, fsr, fad, ffw, fap, fxt, fts, fai, fwc] default: unknown more...
  
  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
  
  os_type True True True True True True True True True True True True
- 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: unknown more...
  
  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
  
  os_ver True True True True True True True True True True True True
- patch - No description for the parameter type: int more...
  
  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
  
  patch True True True True True True True True True True True True
- platform_str - No description for the parameter type: str more...
  
  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
  
  platform_str True True True True True True True True True True True True
- prefer_img_ver - No description for the parameter type: str more...
  
  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
  
  prefer_img_ver True True True True True True True True True True True True
- psk - No description for the parameter type: str more...
  
  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
  
  psk True True True True True True True True True True True True
- sn - Unique value for each device. type: str more...
  
  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
  
  sn True True True True True True True True True True True True
- vdom - No description for the parameter type: array more...
  
  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
  
  vdom True True True True True True True True True True True True
  - comments - No description for the parameter type: str more...
    
    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
    
    comments True True True True True True True True True True True True
  - name - No description for the parameter type: str more...
    
    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
    
    name True True True True True True True True True True True True
  - opmode - No description for the parameter type: str choices: [nat, transparent] default: nat more...
    
    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
    
    opmode True True True True True True True True True True True True
  - rtm_prof_id - No description for the parameter type: int more...
    
    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
    
    rtm_prof_id True True True True True True True True True True True True
  - status - No description for the parameter type: str more...
    
    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
    
    status True True True True True True True True True True True True
  - vpn_id - No description for the parameter type: int more...
    
    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
    
    vpn_id True True True True True True True True True True True True
  - meta fields - No description for the parameter type: dict more...
    
    6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
    
    meta fields True True True True True
  - vdom_type - No description for the parameter type: str choices: [traffic, admin] default: traffic more...
    
    7.2.0
    
    vdom_type True
- version - No description for the parameter type: int more...
  
  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
  
  version True True True True True True True True True True True True
- vm_cpu - No description for the parameter type: int more...
  
  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
  
  vm_cpu True True True True True True True True True True True True
- vm_cpu_limit - No description for the parameter type: int more...
  
  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
  
  vm_cpu_limit True True True True True True True True True True True True
- vm_lic_expire - No description for the parameter type: int more...
  
  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
  
  vm_lic_expire True True True True True True True True True True True True
- vm_mem - No description for the parameter type: int more...
  
  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
  
  vm_mem True True True True True True True True True True True True
- vm_mem_limit - No description for the parameter type: int more...
  
  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
  
  vm_mem_limit True True True True True True True True True True True True
- vm_status - No description for the parameter type: int more...
  
  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
  
  vm_status True True True True True True True True True True True True
- prio - No description for the parameter type: int more...
  
  6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  prio True True True True True True True
- role - No description for the parameter type: str choices: [master, ha-slave, autoscale-slave] default: master more...
  
  6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  role True True True True True True True
- hyperscale - No description for the parameter type: int more...
  
  6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  hyperscale True True True True True
- nsxt_service_name - No description for the parameter type: str more...
  
  6.4.4 6.4.5 7.0.0 7.2.0
  
  nsxt_service_name True True True True
- private_key - No description for the parameter type: str more...
  
  6.4.4 6.4.5 7.0.0 7.2.0
  
  private_key True True True True
- private_key_status - No description for the parameter type: int more...
  
  6.4.4 6.4.5 7.0.0 7.2.0
  
  private_key_status True True True True
import-group-members - No description for the parameter type: array more...

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

import-group-members True True True True True True True True True True True True
- adom - ADOM where the device group is located. type: str more...
  
  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
  
  adom True True True True True True True True True True True True
- dev - No description for the parameter type: str more...
  
  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
  
  dev True True True True True True True True True True True True
- grp - Target device group to associate device VDOM with. type: str more...
  
  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
  
  grp True True True True True True True True True True True True
- vdom - No description for the parameter type: str more...
  
  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
  
  vdom True True True True True True True True True True True True

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 ¶

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_dvm_cmd_import_devlist:
      dvm_cmd_import_devlist:
        adom: root
        flags:
        - create_task
        - nonblocking
    name: Import a list of ADOMs and devices.
  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.

	`6.4.1`	`6.4.2`	`6.4.3`	`6.4.4`	`6.4.5`	`7.0.0`	`7.2.0`
create_time	True	True	True	True	True	True	True

	`6.4.3`	`6.4.4`	`6.4.5`	`7.0.0`	`7.2.0`
workspace_mode	True	True	True	True	True