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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
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
    Choices:
  • none
  • create_task
  • nonblocking
  • log_dev
no description
import-adom-members
list / elements=string
no description
adom
string
Target ADOM to associate device VDOM with.
dev
string
no description
vdom
string
no description
import-adoms
list / elements=string
no description
create_time
integer
no description
desc
string
no description
flags
list / elements=string
    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
no description
log_db_retention_hours
integer
Default:
1440
no description
log_disk_quota
integer
no description
log_disk_quota_alert_thres
integer
Default:
90
no description
log_disk_quota_split_ratio
integer
Default:
70
no description
log_file_retention_hours
integer
Default:
8760
no description
meta fields
dictionary
no description
mig_mr
integer
Default:
2
no description
mig_os_ver
string
    Choices:
  • unknown
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0 ←
  • 7.0
  • 8.0
no description
mode
string
    Choices:
  • ems
  • gms ←
  • provider
ems - (Value no longer used as of 4.3)
provider - Global database.
mr
integer
Default:
2
no description
name
string
no description
os_ver
string
    Choices:
  • unknown
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0 ←
  • 7.0
  • 8.0
no description
restricted_prds
list / elements=string
    Choices:
  • fos
  • foc
  • fml
  • fch
  • fwb
  • log
  • fct
  • faz
  • fsa
  • fsw
  • fmg
  • fdd
  • fac
  • fpx
  • fna
  • fdc
  • ffw
  • fsr
  • fad
  • fap
  • fxt
no description
state
integer
Default:
1
no description
uuid
string
no description
workspace_mode
integer
no description
import-devices
list / elements=string
no description
adm_pass
string
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
    Choices:
  • unknown ←
  • insync
  • outofsync
no description
conn_mode
string
    Choices:
  • active
  • passive ←
no description
conn_status
string
    Choices:
  • UNKNOWN ←
  • up
  • down
no description
db_status
string
    Choices:
  • unknown ←
  • nomod
  • mod
no description
desc
string
no description
dev_status
string
    Choices:
  • none
  • unknown ←
  • checkedin
  • inprogress
  • installed
  • aborted
  • sched
  • retry
  • canceled
  • pending
  • retrieved
  • changed_conf
  • sync_fail
  • timeout
  • rev_revert
  • auto_updated
no description
fap_cnt
integer
no description
faz.full_act
integer
no description
faz.perm
integer
no description
faz.quota
integer
no description
faz.used
integer
no description
fex_cnt
integer
no description
flags
list / elements=string
    Choices:
  • has_hdd
  • vdom_enabled
  • discover
  • reload
  • interim_build
  • offline_mode
  • is_model
  • fips_mode
  • linked_to_model
  • ip-conflict
  • faz-autosync
no description
foslic_cpu
integer
VM Meter vCPU count.
foslic_dr_site
string
    Choices:
  • disable ←
  • enable
VM Meter DR Site status.
foslic_inst_time
integer
VM Meter first deployment time (in UNIX timestamp).
foslic_last_sync
integer
VM Meter last synchronized time (in UNIX timestamp).
foslic_ram
integer
VM Meter device RAM size (in MB).
foslic_type
string
    Choices:
  • temporary ←
  • trial
  • regular
  • trial_expired
VM Meter license type.
foslic_utm
list / elements=string
    Choices:
  • fw
  • av
  • ips
  • app
  • url
  • utm
  • fwb
no description
fsw_cnt
integer
no description
ha_group_id
integer
no description
ha_group_name
string
no description
ha_mode
string
    Choices:
  • standalone ←
  • AP
  • AA
  • ELBC
  • DUAL
  • enabled
  • unknown
  • fmg-enabled
  • autoscale
enabled - Value reserved for non-FOS HA devices.
ha_slave
list / elements=string
no description
idx
integer
no description
name
string
no description
prio
integer
no description
role
string
    Choices:
  • slave ←
  • master
no description
sn
string
no description
status
integer
no description
hdisk_size
integer
no description
hostname
string
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
Default:
10
no description
meta fields
dictionary
no description
mgmt_id
integer
no description
mgmt_if
string
no description
mgmt_mode
string
    Choices:
  • unreg ←
  • fmg
  • faz
  • fmgfaz
no description
mgt_vdom
string
no description
module_sn
string
no description
mr
integer
Default:
-1
no description
name
string
Unique name for the device.
nsxt_service_name
string
no description
os_type
string
    Choices:
  • unknown ←
  • fos
  • fsw
  • foc
  • fml
  • faz
  • fwb
  • fch
  • fct
  • log
  • fmg
  • fsa
  • fdd
  • fac
  • fpx
  • fna
  • fdc
  • ffw
  • fsr
  • fad
  • fap
  • fxt
no description
os_ver
string
    Choices:
  • unknown ←
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0
  • 7.0
  • 8.0
no description
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
    Choices:
  • master ←
  • ha-slave
  • autoscale-slave
no description
sn
string
Unique value for each device.
vdom
list / elements=string
no description
comments
string
no description
meta fields
dictionary
no description
name
string
no description
opmode
string
    Choices:
  • nat ←
  • transparent
no description
rtm_prof_id
integer
no description
status
string
no description
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_mem
integer
no description
vm_mem_limit
integer
no description
vm_status
integer
no description
import-group-members
list / elements=string
no description
adom
string
ADOM where the device group is located. Default is "root" if not specified.
dev
string
no description
grp
string
Target device group to associate device VDOM with.
vdom
string
no description
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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.

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  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.
     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: <value of string>
           flags:
             - none
             - create_task
             - nonblocking
             - log_dev
           import-adom-members:
             -
                 adom: <value of string>
                 dev: <value of string>
                 vdom: <value of string>
           import-adoms:
             -
                 desc: <value of 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
                 log_db_retention_hours: <value of integer>
                 log_disk_quota: <value of integer>
                 log_disk_quota_alert_thres: <value of integer>
                 log_disk_quota_split_ratio: <value of integer>
                 log_file_retention_hours: <value of integer>
                 meta fields: <value of dict>
                 mig_mr: <value of integer>
                 mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
                 mode: <value in [ems, gms, provider]>
                 mr: <value of integer>
                 name: <value of string>
                 os_ver: <value in [unknown, 0.0, 1.0, ...]>
                 restricted_prds:
                   - fos
                   - foc
                   - fml
                   - fch
                   - fwb
                   - log
                   - fct
                   - faz
                   - fsa
                   - fsw
                   - fmg
                   - fdd
                   - fac
                   - fpx
                   - fna
                   - fdc
                   - ffw
                   - fsr
                   - fad
                   - fap
                   - fxt
                 state: <value of integer>
                 uuid: <value of string>
                 create_time: <value of integer>
                 workspace_mode: <value of integer>
           import-devices:
             -
                 adm_pass: <value of string>
                 adm_usr: <value of string>
                 app_ver: <value of string>
                 av_ver: <value of string>
                 beta: <value of integer>
                 branch_pt: <value of integer>
                 build: <value of integer>
                 checksum: <value of 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: <value of string>
                 dev_status: <value in [none, unknown, checkedin, ...]>
                 fap_cnt: <value of integer>
                 faz.full_act: <value of integer>
                 faz.perm: <value of integer>
                 faz.quota: <value of integer>
                 faz.used: <value of integer>
                 fex_cnt: <value of integer>
                 flags:
                   - has_hdd
                   - vdom_enabled
                   - discover
                   - reload
                   - interim_build
                   - offline_mode
                   - is_model
                   - fips_mode
                   - linked_to_model
                   - ip-conflict
                   - faz-autosync
                 foslic_cpu: <value of integer>
                 foslic_dr_site: <value in [disable, enable]>
                 foslic_inst_time: <value of integer>
                 foslic_last_sync: <value of integer>
                 foslic_ram: <value of integer>
                 foslic_type: <value in [temporary, trial, regular, ...]>
                 foslic_utm:
                   - fw
                   - av
                   - ips
                   - app
                   - url
                   - utm
                   - fwb
                 fsw_cnt: <value of integer>
                 ha_group_id: <value of integer>
                 ha_group_name: <value of string>
                 ha_mode: <value in [standalone, AP, AA, ...]>
                 ha_slave:
                   -
                       idx: <value of integer>
                       name: <value of string>
                       prio: <value of integer>
                       role: <value in [slave, master]>
                       sn: <value of string>
                       status: <value of integer>
                 hdisk_size: <value of integer>
                 hostname: <value of string>
                 hw_rev_major: <value of integer>
                 hw_rev_minor: <value of integer>
                 ip: <value of string>
                 ips_ext: <value of integer>
                 ips_ver: <value of string>
                 last_checked: <value of integer>
                 last_resync: <value of integer>
                 latitude: <value of string>
                 lic_flags: <value of integer>
                 lic_region: <value of string>
                 location_from: <value of string>
                 logdisk_size: <value of integer>
                 longitude: <value of string>
                 maxvdom: <value of integer>
                 meta fields: <value of dict>
                 mgmt_id: <value of integer>
                 mgmt_if: <value of string>
                 mgmt_mode: <value in [unreg, fmg, faz, ...]>
                 mgt_vdom: <value of string>
                 mr: <value of integer>
                 name: <value of string>
                 os_type: <value in [unknown, fos, fsw, ...]>
                 os_ver: <value in [unknown, 0.0, 1.0, ...]>
                 patch: <value of integer>
                 platform_str: <value of string>
                 psk: <value of string>
                 sn: <value of string>
                 vdom:
                   -
                       comments: <value of string>
                       name: <value of string>
                       opmode: <value in [nat, transparent]>
                       rtm_prof_id: <value of integer>
                       status: <value of string>
                       meta fields: <value of dict>
                       vpn_id: <value of integer>
                 version: <value of integer>
                 vm_cpu: <value of integer>
                 vm_cpu_limit: <value of integer>
                 vm_lic_expire: <value of integer>
                 vm_mem: <value of integer>
                 vm_mem_limit: <value of integer>
                 vm_status: <value of integer>
                 module_sn: <value of string>
                 prefer_img_ver: <value of string>
                 prio: <value of integer>
                 role: <value in [master, ha-slave, autoscale-slave]>
                 hyperscale: <value of integer>
                 nsxt_service_name: <value of string>
                 private_key: <value of string>
                 private_key_status: <value of integer>
           import-group-members:
             -
                 adom: <value of string>
                 dev: <value of string>
                 grp: <value of string>
                 vdom: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)