fortinet / fortinet.fortianalyzer / 1.4.0 / module / faz_dvm_cmd_import_devlist Import a list of ADOMs and devices. | "added in version" 1.0.0 of fortinet.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortianalyzer.faz_dvm_cmd_import_devlist (1.4.0) — module
Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0
collections: - name: fortinet.fortianalyzer version: 1.4.0
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.
- name: Example playbook connection: httpapi hosts: fortianalyzers tasks: - name: Import a list of ADOMs and devices. fortinet.fortianalyzer.faz_dvm_cmd_import_devlist: dvm_cmd_import_devlist: adom: root flags: - create_task - nonblocking vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
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 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 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 dvm_cmd_import_devlist: description: The top level parameters set. required: false suboptions: adom: description: Name or ID of the ADOM where the command is to be executed on. type: str flags: choices: - none - create_task - nonblocking description: no description elements: str type: list import-adom-members: description: no description elements: dict suboptions: adom: description: Target ADOM to associate device VDOM with. type: str dev: description: no description type: str vdom: description: no description type: str type: list import-adoms: description: no description elements: dict 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: list import-devices: description: no description elements: dict suboptions: adm_pass: description: no description type: str adm_usr: description: no description type: str app_ver: description: no description type: str av_ver: description: no description type: str beta: description: no description type: int branch_pt: description: no description type: int build: description: no description type: int checksum: description: no description type: str conf_status: choices: - unknown - insync - outofsync description: no description type: str conn_mode: choices: - active - passive description: no description type: str conn_status: choices: - UNKNOWN - up - down description: no description type: str db_status: choices: - unknown - nomod - mod description: no description type: str desc: description: no description type: str dev_status: choices: - none - unknown - checkedin - inprogress - installed - aborted - sched - retry - canceled - pending - retrieved - changed_conf - sync_fail - timeout - rev_revert - auto_updated description: no description type: str eip: description: no description type: str fap_cnt: description: no description type: int faz.full_act: description: no description type: int faz.perm: description: no description type: int faz.quota: description: no description type: int faz.used: description: no description type: int fex_cnt: description: no description type: int first_tunnel_up: description: no description type: int flags: choices: - has_hdd - vdom_enabled - discover - reload - interim_build - offline_mode - is_model - fips_mode - linked_to_model - ip-conflict - faz-autosync - need_reset - backup_mode - azure_vwan_nva - fgsp_configured - cnf_mode - sase_managed - override_management_intf description: no description elements: str type: list foslic_cpu: description: VM Meter vCPU count. type: int foslic_dr_site: choices: - disable - enable description: VM Meter DR Site status. type: str foslic_inst_time: description: VM Meter first deployment time (in UNIX timestamp). type: int foslic_last_sync: description: VM Meter last synchronized time (in UNIX timestamp). type: int foslic_ram: description: VM Meter device RAM size (in MB). type: int foslic_type: choices: - temporary - trial - regular - trial_expired description: VM Meter license type. type: str foslic_utm: choices: - fw - av - ips - app - url - utm - fwb description: no description elements: str type: list fsw_cnt: description: no description type: int ha_group_id: description: no description type: int ha_group_name: description: no description type: str ha_mode: choices: - standalone - AP - AA - ELBC - DUAL - enabled - unknown - fmg-enabled - autoscale description: enabled - Value reserved for non-FOS HA devices. type: str ha_slave: description: no description elements: dict suboptions: conf_status: description: no description type: int idx: description: no description type: int name: description: no description type: str prio: description: no description type: int role: choices: - slave - master description: no description type: str sn: description: no description type: str status: description: no description type: int type: list hdisk_size: description: no description type: int hostname: description: no description type: str hw_generation: description: no description type: int hw_rev_major: description: no description type: int hw_rev_minor: description: no description type: int hyperscale: description: no description type: int ip: description: no description type: str ips_ext: description: no description type: int ips_ver: description: no description type: str last_checked: description: no description type: int last_resync: description: no description type: int latitude: description: no description type: str lic_flags: description: no description type: int lic_region: description: no description type: str location_from: description: no description type: str logdisk_size: description: no description type: int longitude: description: no description type: str maxvdom: description: no description type: int meta fields: description: no description type: dict mgmt_id: description: no description type: int mgmt_if: description: no description type: str mgmt_mode: choices: - unreg - fmg - faz - fmgfaz description: no description type: str mgmt_uuid: description: no description type: str mgt_vdom: description: no description type: str module_sn: description: no description type: str mr: description: no description type: int name: description: Unique name for the device. type: str nsxt_service_name: description: no description type: str os_type: choices: - unknown - fos - fsw - foc - fml - faz - fwb - fch - fct - log - fmg - fsa - fdd - fac - fpx - fna - fdc - ffw - fsr - fad - fts - fap - fxt - fai - fwc - fis - fed - fpa - fca - ftc 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 patch: description: no description type: int platform_str: description: no description type: str prefer_img_ver: description: no description type: str prio: description: no description type: int private_key: description: no description type: str private_key_status: description: no description type: int psk: description: no description type: str role: choices: - master - ha-slave - autoscale-slave description: no description type: str sn: description: Unique value for each device. type: str vdom: description: no description elements: dict suboptions: comments: description: no description type: str meta fields: description: no description type: dict name: description: no description type: str opmode: choices: - nat - transparent description: no description type: str rtm_prof_id: description: no description type: int status: description: no description type: str vdom_type: choices: - traffic - admin description: no description type: str vpn_id: description: no description type: int type: list version: description: no description type: int vm_cpu: description: no description type: int vm_cpu_limit: description: no description type: int vm_lic_expire: description: no description type: int vm_lic_overdue_since: description: no description type: int vm_mem: description: no description type: int vm_mem_limit: description: no description type: int vm_status: description: no description type: int type: list import-group-members: description: no description elements: dict suboptions: adom: description: ADOM where the device group is located. Default is "root" if not specified. type: str dev: description: no description type: str grp: description: Target device group to associate device VDOM with. type: str vdom: description: no description type: str type: list type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
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