fmgr_dvm_cmd_import_devlist – Import a list of ADOMs and devices.

New in version 2.0.0.

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 v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.2.0 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11 6.2.12
True True True True None True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12 6.4.13
True True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8 7.0.9
True True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3 7.2.4
True True True True True
7.4.0 7.4.1
True True

Parameters

  • 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...
    • flags - No description for the parameter type: list choices: [none, create_task, nonblocking, log_dev] more...
    • import-adom-members - No description for the parameter type: list more...
      • adom - Target ADOM to associate device VDOM with. type: str more...
      • dev - No description for the parameter type: str more...
      • vdom - No description for the parameter type: str more...
    • import-adoms - No description for the parameter type: list more...
      • desc - No description for the parameter type: str more...
      • flags - No description for the parameter 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...
      • log_db_retention_hours - No description for the parameter type: int default: 1440 more...
      • log_disk_quota - No description for the parameter type: int more...
      • log_disk_quota_alert_thres - No description for the parameter type: int default: 90 more...
      • log_disk_quota_split_ratio - No description for the parameter type: int default: 70 more...
      • log_file_retention_hours - No description for the parameter type: int default: 8760 more...
      • meta fields - No description for the parameter type: dict more...
      • mig_mr - No description for the parameter type: int default: 2 more...
      • mig_os_ver - No description for the parameter 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...
      • mode - ems - (Value no longer used as of 4. type: str choices: [ems, gms, provider] default: gms more...
      • mr - No description for the parameter type: int default: 2 more...
      • name - No description for the parameter type: str more...
      • os_ver - No description for the parameter 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...
      • restricted_prds - No description for the parameter 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] more...
      • state - No description for the parameter type: int default: 1 more...
      • uuid - No description for the parameter type: str more...
      • create_time - No description for the parameter type: int more...
      • workspace_mode - No description for the parameter type: int more...
      • tz - No description for the parameter type: int more...
      • lock_override - No description for the parameter type: int more...
    • import-devices - No description for the parameter type: list more...
      • adm_pass - No description for the parameter type: list more...
      • adm_usr - No description for the parameter type: str more...
      • app_ver - No description for the parameter type: str more...
      • av_ver - No description for the parameter type: str more...
      • beta - No description for the parameter type: int more...
      • branch_pt - No description for the parameter type: int more...
      • build - No description for the parameter type: int more...
      • checksum - No description for the parameter type: str more...
      • conf_status - No description for the parameter type: str choices: [unknown, insync, outofsync] default: unknown more...
      • conn_mode - No description for the parameter type: str choices: [active, passive] default: passive more...
      • conn_status - No description for the parameter type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
      • db_status - No description for the parameter type: str choices: [unknown, nomod, mod] default: unknown more...
      • desc - No description for the parameter type: str more...
      • dev_status - No description for the parameter 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...
      • fap_cnt - No description for the parameter type: int more...
      • faz.full_act - No description for the parameter type: int more...
      • faz.perm - No description for the parameter type: int more...
      • faz.quota - No description for the parameter type: int more...
      • faz.used - No description for the parameter type: int more...
      • fex_cnt - No description for the parameter type: int more...
      • flags - No description for the parameter 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] more...
      • foslic_cpu - VM Meter vCPU count. type: int more...
      • foslic_dr_site - VM Meter DR Site status. type: str choices: [disable, enable] default: disable more...
      • foslic_inst_time - VM Meter first deployment time (in UNIX timestamp). type: int more...
      • foslic_last_sync - VM Meter last synchronized time (in UNIX timestamp). type: int more...
      • foslic_ram - VM Meter device RAM size (in MB). type: int more...
      • foslic_type - VM Meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary more...
      • foslic_utm - No description for the parameter type: list choices: [fw, av, ips, app, url, utm, fwb] more...
      • fsw_cnt - No description for the parameter type: int more...
      • ha_group_id - No description for the parameter type: int more...
      • ha_group_name - No description for the parameter type: str more...
      • 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...
      • ha_slave - No description for the parameter type: list more...
        • idx - No description for the parameter type: int more...
        • name - No description for the parameter type: str more...
        • prio - No description for the parameter type: int more...
        • role - No description for the parameter type: str choices: [slave, master] default: slave more...
        • sn - No description for the parameter type: str more...
        • status - No description for the parameter type: int more...
        • conf_status - No description for the parameter type: int more...
      • hdisk_size - No description for the parameter type: int more...
      • hostname - No description for the parameter type: str more...
      • hw_rev_major - No description for the parameter type: int more...
      • hw_rev_minor - No description for the parameter type: int more...
      • ip - No description for the parameter type: str more...
      • ips_ext - No description for the parameter type: int more...
      • ips_ver - No description for the parameter type: str more...
      • last_checked - No description for the parameter type: int more...
      • last_resync - No description for the parameter type: int more...
      • latitude - No description for the parameter type: str more...
      • lic_flags - No description for the parameter type: int more...
      • lic_region - No description for the parameter type: str more...
      • location_from - No description for the parameter type: str more...
      • logdisk_size - No description for the parameter type: int more...
      • longitude - No description for the parameter type: str more...
      • maxvdom - No description for the parameter type: int default: 10 more...
      • meta fields - No description for the parameter type: dict more...
      • mgmt_id - No description for the parameter type: int more...
      • mgmt_if - No description for the parameter type: str more...
      • mgmt_mode - No description for the parameter type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
      • mgt_vdom - No description for the parameter type: str more...
      • mr - No description for the parameter type: int default: -1 more...
      • name - Unique name for the device. type: str more...
      • os_type - No description for the parameter 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] default: unknown more...
      • os_ver - No description for the parameter 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...
      • patch - No description for the parameter type: int more...
      • platform_str - No description for the parameter type: str more...
      • psk - No description for the parameter type: str more...
      • sn - Unique value for each device. type: str more...
      • vdom - No description for the parameter type: list more...
        • comments - No description for the parameter type: str more...
        • name - No description for the parameter type: str more...
        • opmode - No description for the parameter type: str choices: [nat, transparent] default: nat more...
        • rtm_prof_id - No description for the parameter type: int more...
        • status - No description for the parameter type: str more...
        • vpn_id - No description for the parameter type: int more...
        • meta fields - No description for the parameter type: dict more...
        • vdom_type - No description for the parameter type: str choices: [traffic, admin] default: traffic more...
      • version - No description for the parameter type: int more...
      • vm_cpu - No description for the parameter type: int more...
      • vm_cpu_limit - No description for the parameter type: int more...
      • vm_lic_expire - No description for the parameter type: int more...
      • vm_mem - No description for the parameter type: int more...
      • vm_mem_limit - No description for the parameter type: int more...
      • vm_status - No description for the parameter 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...
      • module_sn - No description for the parameter type: str more...
      • prefer_img_ver - No description for the parameter type: str more...
      • prio - No description for the parameter type: int more...
      • role - No description for the parameter type: str choices: [master, ha-slave, autoscale-slave] default: master more...
      • hyperscale - No description for the parameter type: int more...
      • nsxt_service_name - No description for the parameter type: str more...
      • private_key - No description for the parameter type: str more...
      • private_key_status - No description for the parameter type: int more...
      • vm_lic_overdue_since - No description for the parameter type: int more...
      • first_tunnel_up - No description for the parameter type: int more...
      • eip - No description for the parameter type: str more...
      • mgmt_uuid - No description for the parameter type: str more...
      • hw_generation - No description for the parameter type: int more...
    • import-group-members - No description for the parameter type: list more...
      • adom - ADOM where the device group is located. type: str more...
      • dev - No description for the parameter type: str more...
      • grp - Target device group to associate device VDOM with. type: str more...
      • vdom - No description for the parameter type: str more...

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: <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
              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
              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>

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:

  • 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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.