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