/ home / chillancezen / chillancezen.fortimanager / 2.1.6 / module / fmgr_dvmdb_device

chillancezen.fortimanager.fmgr_dvmdb_device (2.1.6) — module

no description

| "added in version" 1.0.0 of chillancezen.fortimanager"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install chillancezen.fortimanager:==2.1.6

Add to requirements.yml

  collections:
    - name: chillancezen.fortimanager
      version: 2.1.6

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

 - name: Delete first FOS devices from FMG In a specific adom
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
     device_adom: 'root'
   tasks:
     - name: fetch all devices
       fmgr_fact:
         facts:
             selector: 'dvmdb_device'
             params:
                 adom: '{{ device_adom }}'
                 device: 'your_value'
       register: alldevices
     - when: alldevices.meta.response_data != []
       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 }}'
     - when: alldevices.meta.response_data != [] and False
       name: Create The Task To Delete The Device
       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
     - when: alldevices.meta.response_data != [] and False
       name: poll the task
       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'

Outputs

request_url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str
response_code:
  description: The status of api request
  returned: always
  sample: 0
  type: int
response_message:
  description: The descriptive message of the api response
  returned: always
  sample: OK.
  type: str