chillancezen.fortimanager.fmgr_system_admin_user_dashboard (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

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - hosts: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Custom dashboard widgets.
      fmgr_system_admin_user_dashboard:
         bypass_validation: False
         user: ansible-test
         state: present
         system_admin_user_dashboard:
            column: 1
            diskio-content-type: util #<value in [util, iops, blks]>
            diskio-period: 1hour #<value in [1hour, 8hour, 24hour]>
            log-rate-period: 1hour #<value in [2min , 1hour, 6hours]>
            log-rate-topn: 5 #<value in [1, 2, 3, ...]>
            log-rate-type: device #<value in [log, device]>
            moduleid: 10
            name: ansible-test-dashboard
            num-entries: 10
            refresh-interval: 0
            res-cpu-display: 'each' #<value in [average , each]>
            res-period: 10min #<value in [10min , hour, day]>
            res-view-type: history #<value in [real-time , history]>
            status: open #<value in [close, open]>
            tabid: 1
            time-period: 1hour #<value in [1hour, 8hour, 24hour]>
            widget-type: sysres #<value in [top-lograte, sysres, sysinfo, ...]>
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: gathering fortimanager facts
   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
   tasks:
    - name: retrieve all the dashboard widgets
      fmgr_fact:
        facts:
            selector: 'system_admin_user_dashboard'
            params:
                user: 'ansible-test'
                dashboard: 'your_value'

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