:source: fmgr_dvm_cmd_import_devlist.py
:orphan:
.. _fmgr_dvm_cmd_import_devlist:
fmgr_dvm_cmd_import_devlist -- Import a list of ADOMs and devices.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- dvm_cmd_import_devlist - Import a list of ADOMs and devices. type: dict
- adom Name or id of the adom where the command is to be executed on. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- flags Create_task - create a new task in task manager database. type: list choices: [none, create_task, nonblocking, log_dev]
more...
Supported Version Ranges: v6.0.0 -> latest
- import_adom_members (Alias name: import-adom-members) Associations between devices and adoms. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- adom Target adom to associate device vdom with. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dev Dev. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- import_adoms (Alias name: import-adoms) A list of adom and device group objects to be imported. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- desc Desc. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- flags Flags. type: list 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]
more...
Supported Version Ranges: v6.0.0 -> latest
- log_db_retention_hours Log db retention hours. type: int default: 1440
more...
Supported Version Ranges: v6.0.0 -> latest
- log_disk_quota Log disk quota. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- log_disk_quota_alert_thres Log disk quota alert thres. type: int default: 90
more...
Supported Version Ranges: v6.0.0 -> latest
- log_disk_quota_split_ratio Log disk quota split ratio. type: int default: 70
more...
Supported Version Ranges: v6.0.0 -> latest
- log_file_retention_hours Log file retention hours. type: int default: 8760
more...
Supported Version Ranges: v6.0.0 -> latest
- meta_fields (Alias name: meta fields) Default metafields: none. type: dict
more...
Supported Version Ranges: v6.0.0 -> latest
- mig_mr Mig mr. type: int default: 2
more...
Supported Version Ranges: v6.0.0 -> latest
- mig_os_ver Mig os ver. type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] default: 6.0
more...
Supported Version Ranges: v6.0.0 -> latest
- mode Ems - (value no longer used as of 4. type: str choices: [ems, gms, provider] default: gms
more...
Supported Version Ranges: v6.0.0 -> latest
- mr Mr. type: int default: 2
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- os_ver Os ver. type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] default: 6.0
more...
Supported Version Ranges: v6.0.0 -> latest
- restricted_prds Restricted prds. type: list or str 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, sim, fra]
more...
Supported Version Ranges: v6.0.0 -> latest
- state State. type: int default: 1
more...
Supported Version Ranges: v6.0.0 -> latest
- uuid Uuid. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- create_time Create time. type: int
more...
Supported Version Ranges: v6.4.1 -> latest
- workspace_mode Workspace mode. type: int
more...
Supported Version Ranges: v6.4.3 -> latest
- tz Tz. type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- lock_override Lock override. type: int
more...
Supported Version Ranges: v7.4.1 -> latest
- primary_dns_ip4 Primary dns ip4. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_1 Primary dns ip6 1. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_2 Primary dns ip6 2. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_3 Primary dns ip6 3. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- primary_dns_ip6_4 Primary dns ip6 4. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip4 Secondary dns ip4. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_1 Secondary dns ip6 1. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_2 Secondary dns ip6 2. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_3 Secondary dns ip6 3. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- secondary_dns_ip6_4 Secondary dns ip6 4. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- import_devices (Alias name: import-devices) A list of device objects to be imported. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- adm_pass Adm pass. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- adm_usr Adm usr. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- app_ver App ver. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- av_ver Av ver. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- beta Beta. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- branch_pt Branch pt. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- build Build. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- checksum Checksum. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- conf_status Conf status. type: str choices: [unknown, insync, outofsync] default: unknown
more...
Supported Version Ranges: v6.0.0 -> latest
- conn_mode Conn mode. type: str choices: [active, passive] default: passive
more...
Supported Version Ranges: v6.0.0 -> latest
- conn_status Conn status. type: str choices: [UNKNOWN, up, down] default: UNKNOWN
more...
Supported Version Ranges: v6.0.0 -> latest
- db_status Db status. type: str choices: [unknown, nomod, mod] default: unknown
more...
Supported Version Ranges: v6.0.0 -> latest
- desc Desc. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dev_status Dev status. type: str choices: [none, unknown, checkedin, inprogress, installed, aborted, sched, retry, canceled, pending, retrieved, changed_conf, sync_fail, timeout, rev_revert, auto_updated] default: unknown
more...
Supported Version Ranges: v6.0.0 -> latest
- fap_cnt Fap cnt. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- faz_full_act (Alias name: faz.full_act) Faz. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- faz_perm (Alias name: faz.perm) Faz. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- faz_quota (Alias name: faz.quota) Faz. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- faz_used (Alias name: faz.used) Faz. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- fex_cnt Fex cnt. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- flags Flags. type: list 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]
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_cpu Vm meter vcpu count. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_dr_site Vm meter dr site status. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_inst_time Vm meter first deployment time (in unix timestamp). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_last_sync Vm meter last synchronized time (in unix timestamp). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_ram Vm meter device ram size (in mb). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_type Vm meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary
more...
Supported Version Ranges: v6.0.0 -> latest
- foslic_utm Vm meter services type: list choices: [fw, av, ips, app, url, utm, fwb]
more...
Supported Version Ranges: v6.0.0 -> latest
- fsw_cnt Fsw cnt. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ha_group_id Ha group id. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ha_group_name Ha group name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- ha_mode Enabled - value reserved for non-fos ha devices. type: str choices: [standalone, AP, AA, ELBC, DUAL, enabled, unknown, fmg-enabled, autoscale] default: standalone
more...
Supported Version Ranges: v6.0.0 -> latest
- ha_slave Ha slave. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- idx Idx. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- prio Prio. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- role Role. type: str choices: [slave, master] default: slave
more...
Supported Version Ranges: v6.0.0 -> latest
- sn Sn. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- status Status. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- conf_status Conf status. type: int
more...
Supported Version Ranges: v7.0.10 -> v7.0.16, v7.2.1 -> latest
- hdisk_size Hdisk size. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- hostname Hostname. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- hw_rev_major Hw rev major. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- hw_rev_minor Hw rev minor. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ip Ip. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- ips_ext Ips ext. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ips_ver Ips ver. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- last_checked Last checked. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- last_resync Last resync. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- latitude Latitude. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- lic_flags Lic flags. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- lic_region Lic region. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- location_from Location from. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- logdisk_size Logdisk size. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- longitude Longitude. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- maxvdom Maxvdom. type: int default: 10
more...
Supported Version Ranges: v6.0.0 -> latest
- meta_fields (Alias name: meta fields) Default metafields: city, province/state, country, company/organization, contact. type: dict
more...
Supported Version Ranges: v6.0.0 -> latest
- mgmt_id Mgmt id. type: int
more...
Supported Version Ranges: v6.0.0 -> v7.2.0
- mgmt_if Mgmt if. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- mgmt_mode Mgmt mode. type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg
more...
Supported Version Ranges: v6.0.0 -> latest
- mgt_vdom Mgt vdom. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- mr Mr. type: int default: -1
more...
Supported Version Ranges: v6.0.0 -> latest
- name Unique name for the device. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- os_type Os type. type: str 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, fra, sim] default: unknown
more...
Supported Version Ranges: v6.0.0 -> latest
- os_ver Os ver. type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] default: unknown
more...
Supported Version Ranges: v6.0.0 -> latest
- patch Patch. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- platform_str Platform str. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- psk Psk. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- sn Unique value for each device. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- comments Comments. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- opmode Opmode. type: str choices: [nat, transparent] default: nat
more...
Supported Version Ranges: v6.0.0 -> latest
- rtm_prof_id Rtm prof id. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- status Status. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vpn_id Vpn id. type: int
more...
Supported Version Ranges: v6.2.2 -> latest
- meta_fields (Alias name: meta fields) Meta fields. type: dict
more...
Supported Version Ranges: v6.4.3 -> latest
- vdom_type Vdom type. type: str choices: [traffic, admin] default: traffic
more...
Supported Version Ranges: v7.2.0 -> latest
- version Version. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_cpu Vm cpu. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_cpu_limit Vm cpu limit. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_lic_expire Vm lic expire. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_mem Vm mem. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_mem_limit Vm mem limit. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vm_status Vm status. type: int or str choices: [N/A, No License, Startup, Valid, Pending, Warning, Invalid, Invalid Copy, Evaluation Expired, Evaluation, Expires Soon, Expired, Grace Period, Validation Overdue]
more...
Supported Version Ranges: v6.0.0 -> latest
- module_sn Module sn. type: str
more...
Supported Version Ranges: v6.2.1 -> latest
- prefer_img_ver Prefer img ver. type: str
more...
Supported Version Ranges: v6.2.1 -> latest
- prio Prio. type: int
more...
Supported Version Ranges: v6.4.1 -> latest
- role Role. type: str choices: [master, ha-slave, autoscale-slave] default: master
more...
Supported Version Ranges: v6.4.1 -> latest
- hyperscale Hyperscale. type: int
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- nsxt_service_name Nsxt service name. type: str
more...
Supported Version Ranges: v6.4.4 -> latest
- private_key Private key. type: str
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.4 -> latest
- private_key_status Private key status. type: int
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.4 -> latest
- vm_lic_overdue_since Vm lic overdue since. type: int
more...
Supported Version Ranges: v6.4.12 -> v6.4.15, v7.0.8 -> v7.0.16, v7.2.3 -> latest
- first_tunnel_up First tunnel up. type: int
more...
Supported Version Ranges: v7.0.4 -> v7.0.16, v7.2.1 -> latest
- eip Eip. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- mgmt_uuid Mgmt uuid. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- hw_generation Hw generation. type: int
more...
Supported Version Ranges: v7.2.4 -> v7.2.12, v7.4.1 -> latest
- relver_info Relver info. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- cluster_worker Cluster worker. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- ha_vsn (Alias name: ha.vsn) Ha. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.4 -> latest
- ha_upgrade_mode Ha upgrade mode. type: int
more...
Supported Version Ranges: v7.4.4 -> latest
- vm_payg_status Vm payg status. type: int
more...
Supported Version Ranges: v7.4.4 -> v7.4.10, v7.6.2 -> latest
- sov_sase_license Sov sase license. type: str
more...
Supported Version Ranges: v7.4.7 -> v7.4.10, v7.6.4 -> latest
- tunnel_sn Tunnel sn. type: str
more...
Supported Version Ranges: v7.6.5 -> latest
- import_group_members (Alias name: import-group-members) Associations between devices and device groups. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- adom Adom where the device group is located. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dev Dev. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- grp Target device group to associate device vdom with. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Import a list of ADOMs and devices.
fortinet.fortimanager.fmgr_dvm_cmd_import_devlist:
# workspace_locking_adom:
dvm_cmd_import_devlist:
# adom:
# flags: ["none", "create_task", "nonblocking", "log_dev"]
# import_adom_members:
# - adom:
# dev:
# vdom:
# import_adoms:
# - desc:
# 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:
# log_disk_quota:
# log_disk_quota_alert_thres:
# log_disk_quota_split_ratio:
# log_file_retention_hours:
# meta_fields:
# mig_mr:
# mig_os_ver:
# mode:
# mr:
# name:
# os_ver:
# restricted_prds: ["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", "sim", "fra"]
# state:
# uuid:
# create_time:
# workspace_mode:
# tz:
# lock_override:
# primary_dns_ip4:
# primary_dns_ip6_1:
# primary_dns_ip6_2:
# primary_dns_ip6_3:
# primary_dns_ip6_4:
# secondary_dns_ip4:
# secondary_dns_ip6_1:
# secondary_dns_ip6_2:
# secondary_dns_ip6_3:
# secondary_dns_ip6_4:
# import_devices:
# - adm_pass:
# adm_usr:
# app_ver:
# av_ver:
# beta:
# branch_pt:
# build:
# checksum:
# conf_status:
# conn_mode:
# conn_status:
# db_status:
# desc:
# dev_status:
# fap_cnt:
# faz_full_act:
# faz_perm:
# faz_quota:
# faz_used:
# fex_cnt:
# 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:
# foslic_dr_site:
# foslic_inst_time:
# foslic_last_sync:
# foslic_ram:
# foslic_type:
# foslic_utm: ["fw", "av", "ips", "app", "url", "utm", "fwb"]
# fsw_cnt:
# ha_group_id:
# ha_group_name:
# ha_mode:
# ha_slave:
# - idx:
# name:
# prio:
# role:
# sn:
# status:
# conf_status:
# hdisk_size:
# hostname:
# hw_rev_major:
# hw_rev_minor:
# ip:
# ips_ext:
# ips_ver:
# last_checked:
# last_resync:
# latitude:
# lic_flags:
# lic_region:
# location_from:
# logdisk_size:
# longitude:
# maxvdom:
# meta_fields:
# mgmt_id:
# mgmt_if:
# mgmt_mode:
# mgt_vdom:
# mr:
# name:
# os_type:
# os_ver:
# patch:
# platform_str:
# psk:
# sn:
# vdom:
# - comments:
# name:
# opmode:
# rtm_prof_id:
# status:
# vpn_id:
# meta_fields:
# vdom_type:
# version:
# vm_cpu:
# vm_cpu_limit:
# vm_lic_expire:
# vm_mem:
# vm_mem_limit:
# vm_status:
# module_sn:
# prefer_img_ver:
# prio:
# role:
# hyperscale:
# nsxt_service_name:
# private_key:
# private_key_status:
# vm_lic_overdue_since:
# first_tunnel_up:
# eip:
# mgmt_uuid:
# hw_generation:
# relver_info:
# cluster_worker:
# ha_vsn:
# ha_upgrade_mode:
# vm_payg_status:
# sov_sase_license:
# tunnel_sn:
# import_group_members:
# - adom:
# dev:
# grp:
# vdom:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)