faz_dvm_cmd_import_devlist – Import a list of ADOMs and devices.
Added in version 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.nameCorresponding 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.
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
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"
- 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...
- flags create_task - Create a new task in task manager database. type: list elements: str choices: [none, create_task, nonblocking] more...
- import_adom_members Associations between devices and ADOMs. type: list of dict more...
- import_adoms A list of ADOM and device group objects to be imported. type: list of dict
more...
- desc type: str more...
- 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...
- log_db_retention_hours type: int default: 1440 more...
- log_disk_quota type: int more...
- log_disk_quota_alert_thres type: int default: 90 more...
- log_disk_quota_split_ratio type: int default: 70 more...
- log_file_retention_hours type: int default: 8760 more...
- meta_fields type: dict more...
- mig_mr type: int default: 4 more...
- 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...
- mode ems - (Value no longer used as of 4.3) type: str choices: [ems, gms, provider] default: gms more...
- mr type: int default: 4 more...
- name type: str more...
- 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...
- 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...
- state type: int default: 1 more...
- uuid type: str more...
- create_time type: int more...
- workspace_mode type: int more...
- tz type: int more...
- lock_override type: int more...
- primary_dns_ip4 type: str more...
- primary_dns_ip6_1 type: int more...
- primary_dns_ip6_2 type: int more...
- primary_dns_ip6_3 type: int more...
- primary_dns_ip6_4 type: int more...
- secondary_dns_ip4 type: str more...
- secondary_dns_ip6_1 type: int more...
- secondary_dns_ip6_2 type: int more...
- secondary_dns_ip6_3 type: int more...
- secondary_dns_ip6_4 type: int more...
- import_devices A list of device objects to be imported. type: list of dict
more...
- adm_pass type: str elements: str more...
- adm_usr type: str more...
- app_ver type: str more...
- av_ver type: str more...
- beta type: int more...
- branch_pt type: int more...
- build type: int more...
- checksum type: str more...
- conf_status type: str choices: [unknown, insync, outofsync] default: unknown more...
- conn_mode type: str choices: [active, passive] default: passive more...
- conn_status type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
- db_status type: str choices: [unknown, nomod, mod] default: unknown more...
- desc type: str more...
- 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...
- fap_cnt type: int more...
- faz_full_act type: int more...
- faz_perm type: int more...
- faz_quota type: int more...
- faz_used type: int more...
- fex_cnt type: int more...
- 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...
- foslic_cpu VM Meter vCPU count. type: int more...
- foslic_dr_site VM Meter DR Site status. type: str choices: [disable, enable] default: disable more...
- foslic_inst_time VM Meter first deployment time (in UNIX timestamp). type: int more...
- foslic_last_sync VM Meter last synchronized time (in UNIX timestamp). type: int more...
- foslic_ram VM Meter device RAM size (in MB). type: int more...
- foslic_type VM Meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary more...
- foslic_utm VM Meter services type: list elements: str choices: [fw, av, ips, app, url, utm, fwb] more...
- fsw_cnt type: int more...
- ha_group_id type: int more...
- ha_group_name type: str more...
- 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...
- ha_slave type: list of dict more...
- hdisk_size type: int more...
- hostname type: str more...
- hw_rev_major type: int more...
- hw_rev_minor type: int more...
- ip type: str more...
- ips_ext type: int more...
- ips_ver type: str more...
- last_checked type: int more...
- last_resync type: int more...
- latitude type: str more...
- lic_flags type: int more...
- lic_region type: str more...
- location_from type: str more...
- logdisk_size type: int more...
- longitude type: str more...
- maxvdom type: int default: 10 more...
- meta_fields type: dict more...
- mgmt_id type: int more...
- mgmt_if type: str more...
- mgmt_mode type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
- mgt_vdom type: str more...
- module_sn type: str more...
- mr type: int default: -1 more...
- name Unique name for the device. type: str more...
- 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...
- 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...
- patch type: int more...
- platform_str type: str more...
- prefer_img_ver type: str more...
- psk type: str more...
- sn Unique value for each device. type: str more...
- vdom type: list of dict more...
- version type: int more...
- vm_cpu type: int more...
- vm_cpu_limit type: int more...
- vm_lic_expire type: int more...
- vm_mem type: int more...
- vm_mem_limit type: int more...
- 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...
- hyperscale type: int more...
- private_key type: str more...
- private_key_status type: int more...
- prio type: int more...
- role type: str choices: [master, ha-slave, autoscale-slave] default: master more...
- nsxt_service_name type: str more...
- vm_lic_overdue_since type: int more...
- first_tunnel_up type: int more...
- eip type: str more...
- mgmt_uuid type: str more...
- hw_generation type: int more...
- ha_vsn type: str more...
- relver_info type: str more...
- ha_upgrade_mode type: int more...
- vm_payg_status type: int more...
- sov_sase_license type: str more...
- cluster_worker type: str more...
- import_group_members Associations between devices and device groups. type: list of dict more...
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
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:
- 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.