fortinet.fortimanager.fmgr_dvm_cmd_import_devlist module – Import a list of ADOMs and devices.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvm_cmd_import_devlist.

New in fortinet.fortimanager 2.0.0

Synopsis

• This module is able to configure a FortiManager device.

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

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
dvm_cmd_import_devlist dictionary	The top level parameters set.
adom string	Name or ID of the ADOM where the command is to be executed on.
flags list / elements=string	No description. Choices: "none" "create_task" "nonblocking" "log_dev"
import-adom-members list / elements=dictionary	Deprecated, please rename it to import_adom_members.
adom string	Target ADOM to associate device VDOM with.
dev string	No description.
vdom string	No description.
import-adoms list / elements=dictionary	Deprecated, please rename it to import_adoms.
create_time integer	No description.
desc string	No description.
flags list / elements=string	No description. 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"
lock_override integer	No description.
log_db_retention_hours integer	No description.
log_disk_quota integer	No description.
log_disk_quota_alert_thres integer	No description.
log_disk_quota_split_ratio integer	No description.
log_file_retention_hours integer	No description.
meta fields dictionary	Deprecated, please rename it to meta_fields.
mig_mr integer	No description.
mig_os_ver string	No description. Choices: "unknown" "0.0" "1.0" "2.0" "3.0" "4.0" "5.0" "6.0" "7.0" "8.0" "9.0"
mode string	ems - provider - Global database. Choices: "ems" "gms" "provider"
mr integer	No description.
name string	No description.
os_ver string	No description. Choices: "unknown" "0.0" "1.0" "2.0" "3.0" "4.0" "5.0" "6.0" "7.0" "8.0" "9.0"
restricted_prds any	(list or str) No description. Choices: "fos" "foc" "fml" "fch" "fwb" "log" "fct" "faz" "fsa" "fsw" "fmg" "fdd" "fac" "fpx" "fna" "fdc" "ffw" "fsr" "fad" "fap" "fxt" "fts" "fai" "fwc" "fis" "fed" "fabric" "fpa" "fca" "ftc"
state integer	No description.
tz integer	No description.
uuid string	No description.
workspace_mode integer	No description.
import-devices list / elements=dictionary	Deprecated, please rename it to import_devices.
adm_pass any	(list) No description.
adm_usr string	No description.
app_ver string	No description.
av_ver string	No description.
beta integer	No description.
branch_pt integer	No description.
build integer	No description.
checksum string	No description.
conf_status string	No description. Choices: "unknown" "insync" "outofsync"
conn_mode string	No description. Choices: "active" "passive"
conn_status string	No description. Choices: "UNKNOWN" "up" "down"
db_status string	No description. Choices: "unknown" "nomod" "mod"
desc string	No description.
dev_status string	No description. Choices: "none" "unknown" "checkedin" "inprogress" "installed" "aborted" "sched" "retry" "canceled" "pending" "retrieved" "changed_conf" "sync_fail" "timeout" "rev_revert" "auto_updated"
eip string	No description.
fap_cnt integer	No description.
faz.full_act integer	Deprecated, please rename it to faz_full_act.
faz.perm integer	Deprecated, please rename it to faz_perm.
faz.quota integer	Deprecated, please rename it to faz_quota.
faz.used integer	Deprecated, please rename it to faz_used.
fex_cnt integer	No description.
first_tunnel_up integer	No description.
flags list / elements=string	No description. 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"
foslic_cpu integer	VM Meter vCPU count.
foslic_dr_site string	VM Meter DR Site status. Choices: "disable" "enable"
foslic_inst_time integer	VM Meter first deployment time
foslic_last_sync integer	VM Meter last synchronized time
foslic_ram integer	VM Meter device RAM size
foslic_type string	VM Meter license type. Choices: "temporary" "trial" "regular" "trial_expired"
foslic_utm list / elements=string	No description. Choices: "fw" "av" "ips" "app" "url" "utm" "fwb"
fsw_cnt integer	No description.
ha_group_id integer	No description.
ha_group_name string	No description.
ha_mode string	Enabled - Value reserved for non-FOS HA devices. Choices: "standalone" "AP" "AA" "ELBC" "DUAL" "enabled" "unknown" "fmg-enabled" "autoscale"
ha_slave list / elements=dictionary	No description.
conf_status integer	No description.
idx integer	No description.
name string	No description.
prio integer	No description.
role string	No description. Choices: "slave" "master"
sn string	No description.
status integer	No description.
hdisk_size integer	No description.
hostname string	No description.
hw_generation integer	No description.
hw_rev_major integer	No description.
hw_rev_minor integer	No description.
hyperscale integer	No description.
ip string	No description.
ips_ext integer	No description.
ips_ver string	No description.
last_checked integer	No description.
last_resync integer	No description.
latitude string	No description.
lic_flags integer	No description.
lic_region string	No description.
location_from string	No description.
logdisk_size integer	No description.
longitude string	No description.
maxvdom integer	No description.
meta fields dictionary	Deprecated, please rename it to meta_fields.
mgmt_id integer	No description.
mgmt_if string	No description.
mgmt_mode string	No description. Choices: "unreg" "fmg" "faz" "fmgfaz"
mgmt_uuid string	No description.
mgt_vdom string	No description.
module_sn string	No description.
mr integer	No description.
name string	Unique name for the device.
nsxt_service_name string	No description.
os_type string	No description. Choices: "unknown" "fos" "fsw" "foc" "fml" "faz" "fwb" "fch" "fct" "log" "fmg" "fsa" "fdd" "fac" "fpx" "fna" "fdc" "ffw" "fsr" "fad" "fap" "fxt" "fts" "fai" "fwc" "fis" "fed" "fpa" "fca" "ftc"
os_ver string	No description. Choices: "unknown" "0.0" "1.0" "2.0" "3.0" "4.0" "5.0" "6.0" "7.0" "8.0" "9.0"
patch integer	No description.
platform_str string	No description.
prefer_img_ver string	No description.
prio integer	No description.
private_key string	No description.
private_key_status integer	No description.
psk string	No description.
role string	No description. Choices: "master" "ha-slave" "autoscale-slave"
sn string	Unique value for each device.
vdom list / elements=dictionary	No description.
comments string	No description.
meta fields dictionary	Deprecated, please rename it to meta_fields.
name string	No description.
opmode string	No description. Choices: "nat" "transparent"
rtm_prof_id integer	No description.
status string	No description.
vdom_type string	No description. Choices: "traffic" "admin"
vpn_id integer	No description.
version integer	No description.
vm_cpu integer	No description.
vm_cpu_limit integer	No description.
vm_lic_expire integer	No description.
vm_lic_overdue_since integer	No description.
vm_mem integer	No description.
vm_mem_limit integer	No description.
vm_status any	(int or str) No description.
import-group-members list / elements=dictionary	Deprecated, please rename it to import_group_members.
adom string	ADOM where the device group is located.
dev string	No description.
grp string	Target device group to associate device VDOM with.
vdom string	No description.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Import a list of ADOMs and devices.
      fortinet.fortimanager.fmgr_dvm_cmd_import_devlist:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        dvm_cmd_import_devlist:
          adom: <string>
          flags:
            - none
            - create_task
            - nonblocking
            - log_dev
          import_adom_members:
            -
              adom: <string>
              dev: <string>
              vdom: <string>
          import_adoms:
            -
              desc: <string>
              flags:
                - 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
              log_db_retention_hours: <integer>
              log_disk_quota: <integer>
              log_disk_quota_alert_thres: <integer>
              log_disk_quota_split_ratio: <integer>
              log_file_retention_hours: <integer>
              meta_fields: <dict>
              mig_mr: <integer>
              mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
              mode: <value in [ems, gms, provider]>
              mr: <integer>
              name: <string>
              os_ver: <value in [unknown, 0.0, 1.0, ...]>
              restricted_prds: # <list or string>
                - fos
                - foc
                - fml
                - fch
                - fwb
                - log
                - fct
                - faz
                - fsa
                - fsw
                - fmg
                - fdd
                - fac
                - fpx
                - fna
                - fdc
                - ffw
                - fsr
                - fad
                - fap
                - fxt
                - fts
                - fai
                - fwc
                - fis
                - fed
                - fabric
                - fpa
                - fca
                - ftc
              state: <integer>
              uuid: <string>
              create_time: <integer>
              workspace_mode: <integer>
              tz: <integer>
              lock_override: <integer>
          import_devices:
            -
              adm_pass: <list or string>
              adm_usr: <string>
              app_ver: <string>
              av_ver: <string>
              beta: <integer>
              branch_pt: <integer>
              build: <integer>
              checksum: <string>
              conf_status: <value in [unknown, insync, outofsync]>
              conn_mode: <value in [active, passive]>
              conn_status: <value in [UNKNOWN, up, down]>
              db_status: <value in [unknown, nomod, mod]>
              desc: <string>
              dev_status: <value in [none, unknown, checkedin, ...]>
              fap_cnt: <integer>
              faz_full_act: <integer>
              faz_perm: <integer>
              faz_quota: <integer>
              faz_used: <integer>
              fex_cnt: <integer>
              flags:
                - 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
              foslic_cpu: <integer>
              foslic_dr_site: <value in [disable, enable]>
              foslic_inst_time: <integer>
              foslic_last_sync: <integer>
              foslic_ram: <integer>
              foslic_type: <value in [temporary, trial, regular, ...]>
              foslic_utm:
                - fw
                - av
                - ips
                - app
                - url
                - utm
                - fwb
              fsw_cnt: <integer>
              ha_group_id: <integer>
              ha_group_name: <string>
              ha_mode: <value in [standalone, AP, AA, ...]>
              ha_slave:
                -
                  idx: <integer>
                  name: <string>
                  prio: <integer>
                  role: <value in [slave, master]>
                  sn: <string>
                  status: <integer>
                  conf_status: <integer>
              hdisk_size: <integer>
              hostname: <string>
              hw_rev_major: <integer>
              hw_rev_minor: <integer>
              ip: <string>
              ips_ext: <integer>
              ips_ver: <string>
              last_checked: <integer>
              last_resync: <integer>
              latitude: <string>
              lic_flags: <integer>
              lic_region: <string>
              location_from: <string>
              logdisk_size: <integer>
              longitude: <string>
              maxvdom: <integer>
              meta_fields: <dict>
              mgmt_id: <integer>
              mgmt_if: <string>
              mgmt_mode: <value in [unreg, fmg, faz, ...]>
              mgt_vdom: <string>
              mr: <integer>
              name: <string>
              os_type: <value in [unknown, fos, fsw, ...]>
              os_ver: <value in [unknown, 0.0, 1.0, ...]>
              patch: <integer>
              platform_str: <string>
              psk: <string>
              sn: <string>
              vdom:
                -
                  comments: <string>
                  name: <string>
                  opmode: <value in [nat, transparent]>
                  rtm_prof_id: <integer>
                  status: <string>
                  vpn_id: <integer>
                  meta_fields: <dict>
                  vdom_type: <value in [traffic, admin]>
              version: <integer>
              vm_cpu: <integer>
              vm_cpu_limit: <integer>
              vm_lic_expire: <integer>
              vm_mem: <integer>
              vm_mem_limit: <integer>
              vm_status: <integer or string> <value in [N/A, No License, Startup, ...]>
              module_sn: <string>
              prefer_img_ver: <string>
              prio: <integer>
              role: <value in [master, ha-slave, autoscale-slave]>
              hyperscale: <integer>
              nsxt_service_name: <string>
              private_key: <string>
              private_key_status: <integer>
              vm_lic_overdue_since: <integer>
              first_tunnel_up: <integer>
              eip: <string>
              mgmt_uuid: <string>
              hw_generation: <integer>
          import_group_members:
            -
              adom: <string>
              dev: <string>
              grp: <string>
              vdom: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)