fmgr_dvmdb_device – Device table, most attributes are read-only and can only be changed internally.

Added in version 1.0.0.

Warning

Most attributes are read-only and can only be changed internally. Please use fmgr_dvm_cmd_add_device/fmgr_dvm_cmd_del_device to add/delete a device. Use fmgr_dvm_cmd_add_devlist/fmgr_dvm_cmd_del_devlist to add/delete multiple devices.

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.

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.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

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
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • 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
  • adom - The parameter in requested url type: str required: true
  • device - The parameter in requested url type: str required: true
  • dvmdb_device - Device table, most attributes are read-only and can only be changed internally. type: dict
    • adm_pass type: list more...
    • adm_usr type: str more...
    • app_ver type: str more...
    • av_ver type: str more...
    • beta type: int more...
    • branch_pt type: int more...
    • build type: int more...
    • checksum type: str more...
    • conf_status type: str choices: [unknown, insync, outofsync] default: unknown more...
    • conn_mode type: str choices: [active, passive] default: passive more...
    • conn_status type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
    • db_status type: str choices: [unknown, nomod, mod] default: unknown more...
    • desc type: str more...
    • 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...
    • fap_cnt type: int more...
    • faz_full_act (Alias name: faz.full_act) type: int more...
    • faz_perm (Alias name: faz.perm) type: int more...
    • faz_quota (Alias name: faz.quota) type: int more...
    • faz_used (Alias name: faz.used) type: int more...
    • fex_cnt type: int more...
    • 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] 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 type: list choices: [fw, av, ips, app, url, utm, fwb] more...
    • fsw_cnt type: int more...
    • ha_group_id type: int more...
    • ha_group_name 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 type: list more...
      • idx type: int more...
      • name type: str more...
      • prio type: int more...
      • role type: str choices: [slave, master] default: slave more...
      • sn type: str more...
      • status type: int more...
      • conf_status type: int more...
    • hdisk_size type: int more...
    • hostname type: str more...
    • hw_rev_major type: int more...
    • hw_rev_minor type: int more...
    • ip type: str more...
    • ips_ext type: int more...
    • ips_ver type: str more...
    • last_checked type: int more...
    • last_resync type: int more...
    • latitude type: str more...
    • lic_flags type: int more...
    • lic_region type: str more...
    • location_from type: str more...
    • logdisk_size type: int more...
    • longitude type: str more...
    • maxvdom type: int default: 10 more...
    • meta_fields (Alias name: meta fields) type: dict more...
    • mgmt_id type: int more...
    • mgmt_if type: str more...
    • mgmt_mode type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
    • mgt_vdom type: str more...
    • mr type: int default: -1 more...
    • name Unique name for the device. type: str more...
    • 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] default: unknown more...
    • 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...
    • patch type: int more...
    • platform_str type: str more...
    • psk type: str more...
    • sn Unique value for each device. type: str more...
    • vdom type: list more...
      • comments type: str more...
      • name type: str more...
      • opmode type: str choices: [nat, transparent] default: nat more...
      • rtm_prof_id type: int more...
      • status type: str more...
      • vpn_id type: int more...
      • meta_fields (Alias name: meta fields) type: dict more...
      • vdom_type type: str choices: [traffic, admin] default: traffic more...
    • version type: int more...
    • vm_cpu type: int more...
    • vm_cpu_limit type: int more...
    • vm_lic_expire type: int more...
    • vm_mem type: int more...
    • vm_mem_limit type: int more...
    • 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...
    • module_sn type: str more...
    • prefer_img_ver type: str more...
    • prio type: int more...
    • role type: str choices: [master, ha-slave, autoscale-slave] default: master more...
    • hyperscale type: int more...
    • nsxt_service_name type: str more...
    • private_key type: str more...
    • private_key_status type: int more...
    • vm_lic_overdue_since type: int more...
    • first_tunnel_up type: int more...
    • eip type: str more...
    • mgmt_uuid type: str more...
    • hw_generation type: int 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

- name: Delete first FOS devices from FMG In a specific adom
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
    device_adom: "root"
  tasks:
    - name: Fetch all devices
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "dvmdb_device"
          params:
            adom: "{{ device_adom }}"
            device: "your_value"
      register: alldevices
    - name: No name
      when: alldevices.meta.response_data != []
      ansible.builtin.debug:
        msg:
          - "We are going to delete device: {{ alldevices.meta.response_data[0].name }}"
          - "IP of the device is: {{ alldevices.meta.response_data[0].ip }}"
    - name: Create The Task To Delete The Device
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_dvm_cmd_del_device:
        dvm_cmd_del_device:
          device: "{{ alldevices.meta.response_data[0].name }}"
          adom: "{{ device_adom }}"
          flags:
            - "create_task"
            - "nonblocking"
      register: uninstalling_task
    - name: Poll the task
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ uninstalling_task.meta.response_data.taskid }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
      failed_when: taskinfo.meta.response_data.state == 'error'

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