Try SpotterImport a list of ADOMs and devices.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
dvm_cmd_import_devlist:
description: The top level parameters set.
required: false
suboptions:
adom:
description: Name or ID of the ADOM where the command is to be executed on.
type: str
flags:
choices:
- none
- create_task
- nonblocking
- log_dev
description: No description.
elements: str
type: list
import-adom-members:
description: Deprecated, please rename it to import_adom_members.
elements: dict
suboptions:
adom:
description: Target ADOM to associate device VDOM with.
type: str
dev:
description: No description.
type: str
vdom:
description: No description.
type: str
type: list
import-adoms:
description: Deprecated, please rename it to import_adoms.
elements: dict
suboptions:
create_time:
description: No description.
type: int
desc:
description: No description.
type: str
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
description: No description.
elements: str
type: list
lock_override:
description: No description.
type: int
log_db_retention_hours:
description: No description.
type: int
log_disk_quota:
description: No description.
type: int
log_disk_quota_alert_thres:
description: No description.
type: int
log_disk_quota_split_ratio:
description: No description.
type: int
log_file_retention_hours:
description: No description.
type: int
meta fields:
description: Deprecated, please rename it to meta_fields.
type: dict
mig_mr:
description: No description.
type: int
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'
description: No description.
type: str
mode:
choices:
- ems
- gms
- provider
description:
- ems -
- provider - Global database.
type: str
mr:
description: No description.
type: int
name:
description: No description.
type: str
os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
- '9.0'
description: No description.
type: 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
description: (list or str) No description.
type: raw
state:
description: No description.
type: int
tz:
description: No description.
type: int
uuid:
description: No description.
type: str
workspace_mode:
description: No description.
type: int
type: list
import-devices:
description: Deprecated, please rename it to import_devices.
elements: dict
suboptions:
adm_pass:
description: (list) No description.
type: raw
adm_usr:
description: No description.
type: str
app_ver:
description: No description.
type: str
av_ver:
description: No description.
type: str
beta:
description: No description.
type: int
branch_pt:
description: No description.
type: int
build:
description: No description.
type: int
checksum:
description: No description.
type: str
conf_status:
choices:
- unknown
- insync
- outofsync
description: No description.
type: str
conn_mode:
choices:
- active
- passive
description: No description.
type: str
conn_status:
choices:
- UNKNOWN
- up
- down
description: No description.
type: str
db_status:
choices:
- unknown
- nomod
- mod
description: No description.
type: str
desc:
description: No description.
type: str
dev_status:
choices:
- none
- unknown
- checkedin
- inprogress
- installed
- aborted
- sched
- retry
- canceled
- pending
- retrieved
- changed_conf
- sync_fail
- timeout
- rev_revert
- auto_updated
description: No description.
type: str
eip:
description: No description.
type: str
fap_cnt:
description: No description.
type: int
faz.full_act:
description: Deprecated, please rename it to faz_full_act.
type: int
faz.perm:
description: Deprecated, please rename it to faz_perm.
type: int
faz.quota:
description: Deprecated, please rename it to faz_quota.
type: int
faz.used:
description: Deprecated, please rename it to faz_used.
type: int
fex_cnt:
description: No description.
type: int
first_tunnel_up:
description: No description.
type: int
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
description: No description.
elements: str
type: list
foslic_cpu:
description: VM Meter vCPU count.
type: int
foslic_dr_site:
choices:
- disable
- enable
description: VM Meter DR Site status.
type: str
foslic_inst_time:
description: VM Meter first deployment time
type: int
foslic_last_sync:
description: VM Meter last synchronized time
type: int
foslic_ram:
description: VM Meter device RAM size
type: int
foslic_type:
choices:
- temporary
- trial
- regular
- trial_expired
description: VM Meter license type.
type: str
foslic_utm:
choices:
- fw
- av
- ips
- app
- url
- utm
- fwb
description: No description.
elements: str
type: list
fsw_cnt:
description: No description.
type: int
ha_group_id:
description: No description.
type: int
ha_group_name:
description: No description.
type: str
ha_mode:
choices:
- standalone
- AP
- AA
- ELBC
- DUAL
- enabled
- unknown
- fmg-enabled
- autoscale
description: Enabled - Value reserved for non-FOS HA devices.
type: str
ha_slave:
description: No description.
elements: dict
suboptions:
conf_status:
description: No description.
type: int
idx:
description: No description.
type: int
name:
description: No description.
type: str
prio:
description: No description.
type: int
role:
choices:
- slave
- master
description: No description.
type: str
sn:
description: No description.
type: str
status:
description: No description.
type: int
type: list
hdisk_size:
description: No description.
type: int
hostname:
description: No description.
type: str
hw_generation:
description: No description.
type: int
hw_rev_major:
description: No description.
type: int
hw_rev_minor:
description: No description.
type: int
hyperscale:
description: No description.
type: int
ip:
description: No description.
type: str
ips_ext:
description: No description.
type: int
ips_ver:
description: No description.
type: str
last_checked:
description: No description.
type: int
last_resync:
description: No description.
type: int
latitude:
description: No description.
type: str
lic_flags:
description: No description.
type: int
lic_region:
description: No description.
type: str
location_from:
description: No description.
type: str
logdisk_size:
description: No description.
type: int
longitude:
description: No description.
type: str
maxvdom:
description: No description.
type: int
meta fields:
description: Deprecated, please rename it to meta_fields.
type: dict
mgmt_id:
description: No description.
type: int
mgmt_if:
description: No description.
type: str
mgmt_mode:
choices:
- unreg
- fmg
- faz
- fmgfaz
description: No description.
type: str
mgmt_uuid:
description: No description.
type: str
mgt_vdom:
description: No description.
type: str
module_sn:
description: No description.
type: str
mr:
description: No description.
type: int
name:
description: Unique name for the device.
type: str
nsxt_service_name:
description: No description.
type: str
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
description: No description.
type: str
os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
- '9.0'
description: No description.
type: str
patch:
description: No description.
type: int
platform_str:
description: No description.
type: str
prefer_img_ver:
description: No description.
type: str
prio:
description: No description.
type: int
private_key:
description: No description.
type: str
private_key_status:
description: No description.
type: int
psk:
description: No description.
type: str
role:
choices:
- master
- ha-slave
- autoscale-slave
description: No description.
type: str
sn:
description: Unique value for each device.
type: str
vdom:
description: No description.
elements: dict
suboptions:
comments:
description: No description.
type: str
meta fields:
description: Deprecated, please rename it to meta_fields.
type: dict
name:
description: No description.
type: str
opmode:
choices:
- nat
- transparent
description: No description.
type: str
rtm_prof_id:
description: No description.
type: int
status:
description: No description.
type: str
vdom_type:
choices:
- traffic
- admin
description: No description.
type: str
vpn_id:
description: No description.
type: int
type: list
version:
description: No description.
type: int
vm_cpu:
description: No description.
type: int
vm_cpu_limit:
description: No description.
type: int
vm_lic_expire:
description: No description.
type: int
vm_lic_overdue_since:
description: No description.
type: int
vm_mem:
description: No description.
type: int
vm_mem_limit:
description: No description.
type: int
vm_status:
description: (int or str) No description.
type: raw
type: list
import-group-members:
description: Deprecated, please rename it to import_group_members.
elements: dict
suboptions:
adom:
description: ADOM where the device group is located.
type: str
dev:
description: No description.
type: str
grp:
description: Target device group to associate device VDOM with.
type: str
vdom:
description: No description.
type: str
type: list
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list