:source: faz_dvm_cmd_import_devlist.py
:orphan:
.. _faz_dvm_cmd_import_devlist:
faz_dvm_cmd_import_devlist -- Import a list of ADOMs and devices.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 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.
.. contents::
:local:
:depth: 1
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.
- This module supports check mode.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16.0
FortiAnalyzer Version Compatibility
------------------------------------
.. raw:: html
Supported Version Ranges: v6.2.1 -> latest
Parameters
----------
.. raw:: html
- 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"
- 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
- 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...
Supported Version Ranges: v6.2.1 -> latest
- flags create_task - Create a new task in task manager database. type: list elements: str choices: [none, create_task, nonblocking] more...
Supported Version Ranges: v6.2.1 -> latest
- import_adom_members Associations between devices and ADOMs. type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- adom Target ADOM to associate device VDOM with. type: str more...
Supported Version Ranges: v6.2.1 -> latest
- dev type: str more...
Supported Version Ranges: v6.2.1 -> latest
- vdom type: str more...
Supported Version Ranges: v6.2.1 -> latest
- import_adoms A list of ADOM and device group objects to be imported. type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- 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
- primary_dns_ip4 type: str more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_1 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_2 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_3 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_4 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip4 type: str more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_1 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_2 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_3 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_4 type: int more...
Supported Version Ranges: v7.4.3 -> latest
- import_devices A list of device objects to be imported. type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- adm_pass type: str elements: str more...
Supported Version Ranges: v6.2.1 -> latest
- adm_usr type: str more...
Supported Version Ranges: v6.2.1 -> latest
- app_ver type: str more...
Supported Version Ranges: v6.2.1 -> latest
- av_ver type: str more...
Supported Version Ranges: v6.2.1 -> latest
- beta type: int more...
Supported Version Ranges: v6.2.1 -> latest
- branch_pt type: int more...
Supported Version Ranges: v6.2.1 -> latest
- build type: int more...
Supported Version Ranges: v6.2.1 -> latest
- checksum type: str more...
Supported Version Ranges: v6.2.1 -> latest
- conf_status type: str choices: [unknown, insync, outofsync] default: unknown more...
Supported Version Ranges: v6.2.1 -> latest
- conn_mode type: str choices: [active, passive] default: passive more...
Supported Version Ranges: v6.2.1 -> latest
- conn_status type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
Supported Version Ranges: v6.2.1 -> latest
- db_status type: str choices: [unknown, nomod, mod] default: unknown more...
Supported Version Ranges: v6.2.1 -> latest
- desc type: str more...
Supported Version Ranges: v6.2.1 -> latest
- dev_status 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...
Supported Version Ranges: v6.2.1 -> latest
- fap_cnt type: int more...
Supported Version Ranges: v6.2.1 -> latest
- faz_full_act type: int more...
Supported Version Ranges: v6.2.1 -> latest
- faz_perm type: int more...
Supported Version Ranges: v6.2.1 -> latest
- faz_quota type: int more...
Supported Version Ranges: v6.2.1 -> latest
- faz_used type: int more...
Supported Version Ranges: v6.2.1 -> latest
- fex_cnt type: int more...
Supported Version Ranges: v6.2.1 -> latest
- flags type: list elements: str 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, sdwan_management, deny_api_access] more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_cpu VM Meter vCPU count. type: int more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_dr_site VM Meter DR Site status. type: str choices: [disable, enable] default: disable more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_inst_time VM Meter first deployment time (in UNIX timestamp). type: int more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_last_sync VM Meter last synchronized time (in UNIX timestamp). type: int more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_ram VM Meter device RAM size (in MB). type: int more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_type VM Meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary more...
Supported Version Ranges: v6.2.1 -> latest
- foslic_utm VM Meter services type: list elements: str choices: [fw, av, ips, app, url, utm, fwb] more...
Supported Version Ranges: v6.2.1 -> latest
- fsw_cnt type: int more...
Supported Version Ranges: v6.2.1 -> latest
- ha_group_id type: int more...
Supported Version Ranges: v6.2.1 -> latest
- ha_group_name type: str more...
Supported Version Ranges: v6.2.1 -> latest
- 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...
Supported Version Ranges: v6.2.1 -> latest
- ha_slave type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- idx type: int more...
Supported Version Ranges: v6.2.1 -> latest
- name type: str more...
Supported Version Ranges: v6.2.1 -> latest
- prio type: int more...
Supported Version Ranges: v6.2.1 -> latest
- role type: str choices: [slave, master] default: slave more...
Supported Version Ranges: v6.2.1 -> latest
- sn type: str more...
Supported Version Ranges: v6.2.1 -> latest
- status type: int more...
Supported Version Ranges: v6.2.1 -> latest
- conf_status type: int more...
Supported Version Ranges: v7.0.10 -> v7.0.14, v7.2.1 -> latest
- hdisk_size type: int more...
Supported Version Ranges: v6.2.1 -> latest
- hostname type: str more...
Supported Version Ranges: v6.2.1 -> latest
- hw_rev_major type: int more...
Supported Version Ranges: v6.2.1 -> latest
- hw_rev_minor type: int more...
Supported Version Ranges: v6.2.1 -> latest
- ip type: str more...
Supported Version Ranges: v6.2.1 -> latest
- ips_ext type: int more...
Supported Version Ranges: v6.2.1 -> latest
- ips_ver type: str more...
Supported Version Ranges: v6.2.1 -> latest
- last_checked type: int more...
Supported Version Ranges: v6.2.1 -> latest
- last_resync type: int more...
Supported Version Ranges: v6.2.1 -> latest
- latitude type: str more...
Supported Version Ranges: v6.2.1 -> latest
- lic_flags type: int more...
Supported Version Ranges: v6.2.1 -> latest
- lic_region type: str more...
Supported Version Ranges: v6.2.1 -> latest
- location_from type: str more...
Supported Version Ranges: v6.2.1 -> latest
- logdisk_size type: int more...
Supported Version Ranges: v6.2.1 -> latest
- longitude type: str more...
Supported Version Ranges: v6.2.1 -> latest
- maxvdom type: int default: 10 more...
Supported Version Ranges: v6.2.1 -> latest
- meta_fields type: dict
more...
Supported Version Ranges: v6.2.1 -> latest
- mgmt_id type: int more...
Supported Version Ranges: v6.2.1 -> v7.2.0
- mgmt_if type: str more...
Supported Version Ranges: v6.2.1 -> latest
- mgmt_mode type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
Supported Version Ranges: v6.2.1 -> latest
- mgt_vdom type: str more...
Supported Version Ranges: v6.2.1 -> latest
- module_sn type: str more...
Supported Version Ranges: v6.2.1 -> latest
- mr type: int default: -1 more...
Supported Version Ranges: v6.2.1 -> latest
- name Unique name for the device. type: str more...
Supported Version Ranges: v6.2.1 -> latest
- os_type type: str 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, fss, fra, sim] default: unknown 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: unknown more...
Supported Version Ranges: v6.2.1 -> latest
- patch type: int more...
Supported Version Ranges: v6.2.1 -> latest
- platform_str type: str more...
Supported Version Ranges: v6.2.1 -> latest
- prefer_img_ver type: str more...
Supported Version Ranges: v6.2.1 -> latest
- psk type: str more...
Supported Version Ranges: v6.2.1 -> latest
- sn Unique value for each device. type: str more...
Supported Version Ranges: v6.2.1 -> latest
- vdom type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- comments type: str more...
Supported Version Ranges: v6.2.1 -> latest
- name type: str more...
Supported Version Ranges: v6.2.1 -> latest
- opmode type: str choices: [nat, transparent] default: nat more...
Supported Version Ranges: v6.2.1 -> latest
- rtm_prof_id type: int more...
Supported Version Ranges: v6.2.1 -> latest
- status type: str more...
Supported Version Ranges: v6.2.1 -> latest
- vpn_id type: int more...
Supported Version Ranges: v6.2.1 -> latest
- meta_fields type: dict
more...
Supported Version Ranges: v6.4.3 -> latest
- vdom_type type: str choices: [traffic, admin] default: traffic more...
Supported Version Ranges: v7.2.0 -> latest
- version type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_cpu type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_cpu_limit type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_lic_expire type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_mem type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_mem_limit type: int more...
Supported Version Ranges: v6.2.1 -> latest
- vm_status type: int choices: [N/A, No License, Startup, Valid, Pending, Warning, Invalid, Invalid Copy, Evaluation Expired, Evaluation, Expires Soon, Expired, Grace Period, Validation Overdue] more...
Supported Version Ranges: v6.2.1 -> latest
- hyperscale type: int more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- private_key type: str more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.4 -> latest
- private_key_status type: int more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.4 -> latest
- prio type: int more...
Supported Version Ranges: v6.4.1 -> latest
- role type: str choices: [master, ha-slave, autoscale-slave] default: master more...
Supported Version Ranges: v6.4.1 -> latest
- nsxt_service_name type: str more...
Supported Version Ranges: v6.4.4 -> latest
- vm_lic_overdue_since type: int more...
Supported Version Ranges: v6.4.12 -> v6.4.15, v7.0.8 -> v7.0.14, v7.2.3 -> latest
- first_tunnel_up type: int more...
Supported Version Ranges: v7.0.4 -> v7.0.14, v7.2.1 -> latest
- eip type: str more...
Supported Version Ranges: v7.2.1 -> latest
- mgmt_uuid type: str more...
Supported Version Ranges: v7.2.1 -> latest
- hw_generation type: int more...
Supported Version Ranges: v7.2.4 -> v7.2.11, v7.4.1 -> latest
- ha_vsn type: str more...
Supported Version Ranges: v7.2.6 -> v7.2.11, v7.4.4 -> latest
- relver_info type: str more...
Supported Version Ranges: v7.4.3 -> latest
- ha_upgrade_mode type: int more...
Supported Version Ranges: v7.4.4 -> latest
- vm_payg_status type: int more...
Supported Version Ranges: v7.4.4 -> v7.4.8, v7.6.2 -> latest
- sov_sase_license type: str more...
Supported Version Ranges: v7.4.7 -> v7.4.8, v7.6.4 -> latest
- cluster_worker type: str more...
Supported Version Ranges: v7.6.0 -> latest
- import_group_members Associations between devices and device groups. type: list of dict
more...
Supported Version Ranges: v6.2.1 -> latest
- adom ADOM where the device group is located. Default is root if not specified. type: str more...
Supported Version Ranges: v6.2.1 -> latest
- dev type: str more...
Supported Version Ranges: v6.2.1 -> latest
- grp Target device group to associate device VDOM with. type: str more...
Supported Version Ranges: v6.2.1 -> latest
- vdom type: str more...
Supported Version Ranges: v6.2.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
--------
.. code-block:: yaml+jinja
- name: Example playbook
gather_facts: false
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_network_os: fortinet.fortianalyzer.fortianalyzer
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:
.. raw:: html
- 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)