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.8.2).

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

create_task - Create a new task in task manager database.

nonblocking - The API will return immediately in for non-blocking call.

Choices:

  • "none"

  • "create_task"

  • "nonblocking"

  • "log_dev"

import_adom_members

aliases: import-adom-members

list / elements=dictionary

Associations between devices and ADOMs.

adom

string

Target ADOM to associate device VDOM with.

dev

string

Dev.

vdom

string

Vdom.

import_adoms

aliases: import-adoms

list / elements=dictionary

A list of ADOM and device group objects to be imported.

create_time

integer

Create time.

desc

string

Desc.

flags

list / elements=string

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"

lock_override

integer

Lock override.

log_db_retention_hours

integer

Log db retention hours.

log_disk_quota

integer

Log disk quota.

log_disk_quota_alert_thres

integer

Log disk quota alert thres.

log_disk_quota_split_ratio

integer

Log disk quota split ratio.

log_file_retention_hours

integer

Log file retention hours.

meta_fields

aliases: meta fields

dictionary

Default metafields

mig_mr

integer

Mig mr.

mig_os_ver

string

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"

mode

string

ems -

provider - Global database.

Choices:

  • "ems"

  • "gms"

  • "provider"

mr

integer

Mr.

name

string

Name.

os_ver

string

Os ver.

Choices:

  • "unknown"

  • "0.0"

  • "1.0"

  • "2.0"

  • "3.0"

  • "4.0"

  • "5.0"

  • "6.0"

  • "7.0"

  • "8.0"

  • "9.0"

primary_dns_ip4

string

Primary dns ip4.

primary_dns_ip6_1

integer

Primary dns ip6 1.

primary_dns_ip6_2

integer

Primary dns ip6 2.

primary_dns_ip6_3

integer

Primary dns ip6 3.

primary_dns_ip6_4

integer

Primary dns ip6 4.

restricted_prds

any

(list or str) Restricted prds.

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"

  • "fss"

secondary_dns_ip4

string

Secondary dns ip4.

secondary_dns_ip6_1

integer

Secondary dns ip6 1.

secondary_dns_ip6_2

integer

Secondary dns ip6 2.

secondary_dns_ip6_3

integer

Secondary dns ip6 3.

secondary_dns_ip6_4

integer

Secondary dns ip6 4.

state

integer

State.

tz

integer

Tz.

uuid

string

Uuid.

workspace_mode

integer

Workspace mode.

import_devices

aliases: import-devices

list / elements=dictionary

A list of device objects to be imported.

adm_pass

any

(list) Adm pass.

adm_usr

string

Adm usr.

app_ver

string

App ver.

av_ver

string

Av ver.

beta

integer

Beta.

branch_pt

integer

Branch pt.

build

integer

Build.

checksum

string

Checksum.

cluster_worker

string

Cluster worker.

conf_status

string

Conf status.

Choices:

  • "unknown"

  • "insync"

  • "outofsync"

conn_mode

string

Conn mode.

Choices:

  • "active"

  • "passive"

conn_status

string

Conn status.

Choices:

  • "UNKNOWN"

  • "up"

  • "down"

db_status

string

Db status.

Choices:

  • "unknown"

  • "nomod"

  • "mod"

desc

string

Desc.

dev_status

string

Dev status.

Choices:

  • "none"

  • "unknown"

  • "checkedin"

  • "inprogress"

  • "installed"

  • "aborted"

  • "sched"

  • "retry"

  • "canceled"

  • "pending"

  • "retrieved"

  • "changed_conf"

  • "sync_fail"

  • "timeout"

  • "rev_revert"

  • "auto_updated"

eip

string

Eip.

fap_cnt

integer

Fap cnt.

faz_full_act

aliases: faz.full_act

integer

Faz.

faz_perm

aliases: faz.perm

integer

Faz.

faz_quota

aliases: faz.quota

integer

Faz.

faz_used

aliases: faz.used

integer

Faz.

fex_cnt

integer

Fex cnt.

first_tunnel_up

integer

First tunnel up.

flags

list / elements=string

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"

  • "sdwan_management"

  • "deny_api_access"

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

VM Meter services

fw - Firewall

av - Anti-virus

ips - IPS

app - App control

url - Web filter

utm - Full UTM

fwb - FortiWeb

Choices:

  • "fw"

  • "av"

  • "ips"

  • "app"

  • "url"

  • "utm"

  • "fwb"

fsw_cnt

integer

Fsw cnt.

ha_group_id

integer

Ha group id.

ha_group_name

string

Ha group name.

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

Ha slave.

conf_status

integer

Conf status.

idx

integer

Idx.

name

string

Name.

prio

integer

Prio.

role

string

Role.

Choices:

  • "slave"

  • "master"

sn

string

Sn.

status

integer

Status.

ha_upgrade_mode

integer

Ha upgrade mode.

ha_vsn

aliases: ha.vsn

string

Ha.

hdisk_size

integer

Hdisk size.

hostname

string

Hostname.

hw_generation

integer

Hw generation.

hw_rev_major

integer

Hw rev major.

hw_rev_minor

integer

Hw rev minor.

hyperscale

integer

Hyperscale.

ip

string

Ip.

ips_ext

integer

Ips ext.

ips_ver

string

Ips ver.

last_checked

integer

Last checked.

last_resync

integer

Last resync.

latitude

string

Latitude.

lic_flags

integer

Lic flags.

lic_region

string

Lic region.

location_from

string

Location from.

logdisk_size

integer

Logdisk size.

longitude

string

Longitude.

maxvdom

integer

Maxvdom.

meta_fields

aliases: meta fields

dictionary

Default metafields

mgmt_id

integer

Mgmt id.

mgmt_if

string

Mgmt if.

mgmt_mode

string

Mgmt mode.

Choices:

  • "unreg"

  • "fmg"

  • "faz"

  • "fmgfaz"

mgmt_uuid

string

Mgmt uuid.

mgt_vdom

string

Mgt vdom.

module_sn

string

Module sn.

mr

integer

Mr.

name

string

Unique name for the device.

nsxt_service_name

string

Nsxt service name.

os_type

string

Os type.

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"

  • "fss"

os_ver

string

Os ver.

Choices:

  • "unknown"

  • "0.0"

  • "1.0"

  • "2.0"

  • "3.0"

  • "4.0"

  • "5.0"

  • "6.0"

  • "7.0"

  • "8.0"

  • "9.0"

patch

integer

Patch.

platform_str

string

Platform str.

prefer_img_ver

string

Prefer img ver.

prio

integer

Prio.

private_key

string

Private key.

private_key_status

integer

Private key status.

psk

string

Psk.

relver_info

string

Relver info.

role

string

Role.

Choices:

  • "master"

  • "ha-slave"

  • "autoscale-slave"

sn

string

Unique value for each device.

vdom

list / elements=dictionary

Vdom.

comments

string

Comments.

meta_fields

aliases: meta fields

dictionary

Meta fields.

name

string

Name.

opmode

string

Opmode.

Choices:

  • "nat"

  • "transparent"

rtm_prof_id

integer

Rtm prof id.

status

string

Status.

vdom_type

string

Vdom type.

Choices:

  • "traffic"

  • "admin"

vpn_id

integer

Vpn id.

version

integer

Version.

vm_cpu

integer

Vm cpu.

vm_cpu_limit

integer

Vm cpu limit.

vm_lic_expire

integer

Vm lic expire.

vm_lic_overdue_since

integer

Vm lic overdue since.

vm_mem

integer

Vm mem.

vm_mem_limit

integer

Vm mem limit.

vm_payg_status

integer

Vm payg status.

vm_status

any

(int or str) Vm status.

import_group_members

aliases: import-group-members

list / elements=dictionary

Associations between devices and device groups.

adom

string

ADOM where the device group is located.

dev

string

Dev.

grp

string

Target device group to associate device VDOM with.

vdom

string

Vdom.

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"
                - "fss"
              state: <integer>
              uuid: <string>
              create_time: <integer>
              workspace_mode: <integer>
              tz: <integer>
              lock_override: <integer>
              primary_dns_ip4: <string>
              primary_dns_ip6_1: <integer>
              primary_dns_ip6_2: <integer>
              primary_dns_ip6_3: <integer>
              primary_dns_ip6_4: <integer>
              secondary_dns_ip4: <string>
              secondary_dns_ip6_1: <integer>
              secondary_dns_ip6_2: <integer>
              secondary_dns_ip6_3: <integer>
              secondary_dns_ip6_4: <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"
                - "sdwan_management"
                - "deny_api_access"
              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>
              relver_info: <string>
              cluster_worker: <string>
              ha_vsn: <string>
              ha_upgrade_mode: <integer>
              vm_payg_status: <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)