:source: fmgr_dvmdb_device.py :orphan: .. _fmgr_dvmdb_device: fmgr_dvmdb_device -- Device table, most attributes are read-only and can only be changed internally. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 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. .. 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: 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 of deleting device 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: .. raw:: html 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)