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.1.5).
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 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 |
Comments |
---|---|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
the top level parameters set |
|
Name or ID of the ADOM where the command is to be executed on. |
|
no description Choices:
|
|
no description |
|
Target ADOM to associate device VDOM with. |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Default: 1440 |
|
no description |
|
no description Default: 90 |
|
no description Default: 70 |
|
no description Default: 8760 |
|
no description |
|
no description Default: 2 |
|
no description Choices:
|
|
ems - (Value no longer used as of 4.3) provider - Global database. Choices:
|
|
no description Default: 2 |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Default: 1 |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
VM Meter vCPU count. |
|
VM Meter DR Site status. Choices:
|
|
VM Meter first deployment time (in UNIX timestamp). |
|
VM Meter last synchronized time (in UNIX timestamp). |
|
VM Meter device RAM size (in MB). |
|
VM Meter license type. Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
enabled - Value reserved for non-FOS HA devices. Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Default: 10 |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Default: -1 |
|
Unique name for the device. |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
Unique value for each device. |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
ADOM where the device group is located. Default is “root” if not specified. |
|
no description |
|
Target device group to associate device VDOM with. |
|
no description |
|
Enable/Disable logging for task Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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 |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)