fortinet.fortimanager.fmgr_dvmdb_device (1.0.5) — module

Device table, most attributes are read-only and can only be changed internally. Refer to Device Manager Command module for API to add, d...

| "added in version" 2.10 of fortinet.fortimanager"

Authors: Frank Shen (@fshen01), Link Zheng (@zhengl)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==1.0.5


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 1.0.5

Description

This module is able to configure a FortiManager device by allowing the user to [ get set update ] the following apis.

/dvmdb/adom/{adom}/device

/dvmdb/device

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:

    - name: REQUESTING /DVMDB/DEVICE
      fmgr_dvmdb_device:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [get]>
         url_params:
            adom: <value in [none, global, custom dom]>
         params:
            -
               expand member: <value of string>
               fields:
                 -
                    - <value in [adm_pass, adm_usr, app_ver, ...]>
               filter:
                 - <value of string>
               loadsub: <value of integer>
               meta fields:
                 - <value of string>
               option: <value in [count, object member, syntax]>
               range:
                 - <value of integer>
               sortings:
                 -
                     varidic.attr_name: <value in [1, -1]>

    - name: REQUESTING /DVMDB/DEVICE
      fmgr_dvmdb_device:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [set, update]>
         url_params:
            adom: <value in [none, global, custom dom]>
         params:
            -
               data:
                 -
                     adm_pass:
                       - <value of string>
                     adm_usr: <value of string>
                     app_ver: <value of string>
                     av_ver: <value of string>
                     beta: <value of integer>
                     branch_pt: <value of integer>
                     build: <value of integer>
                     checksum: <value of string>
                     conf_status: <value in [unknown, insync, outofsync]>
                     conn_mode: <value in [active, passive]>
                     conn_status: <value in [UNKNOWN, up, down]>
                     db_status: <value in [unknown, nomod, mod]>
                     desc: <value of string>
                     dev_status: <value in [none, unknown, checkedin, ...]>
                     fap_cnt: <value of integer>
                     faz.full_act: <value of integer>
                     faz.perm: <value of integer>
                     faz.quota: <value of integer>
                     faz.used: <value of integer>
                     fex_cnt: <value of integer>
                     flags:
                       - <value in [has_hdd, vdom_enabled, discover, ...]>
                     foslic_cpu: <value of integer>
                     foslic_dr_site: <value in [disable, enable]>
                     foslic_inst_time: <value of integer>
                     foslic_last_sync: <value of integer>
                     foslic_ram: <value of integer>
                     foslic_type: <value in [temporary, trial, regular, ...]>
                     foslic_utm:
                       - <value in [fw, av, ips, ...]>
                     fsw_cnt: <value of integer>
                     ha_group_id: <value of integer>
                     ha_group_name: <value of string>
                     ha_mode: <value in [standalone, AP, AA, ...]>
                     hdisk_size: <value of integer>
                     hostname: <value of string>
                     hw_rev_major: <value of integer>
                     hw_rev_minor: <value of integer>
                     ip: <value of string>
                     ips_ext: <value of integer>
                     ips_ver: <value of string>
                     last_checked: <value of integer>
                     last_resync: <value of integer>
                     latitude: <value of string>
                     lic_flags: <value of integer>
                     lic_region: <value of string>
                     location_from: <value of string>
                     logdisk_size: <value of integer>
                     longitude: <value of string>
                     maxvdom: <value of integer>
                     meta fields: <value of string>
                     mgmt_id: <value of integer>
                     mgmt_if: <value of string>
                     mgmt_mode: <value in [unreg, fmg, faz, ...]>
                     mgt_vdom: <value of string>
                     mr: <value of integer>
                     name: <value of string>
                     os_type: <value in [unknown, fos, fsw, ...]>
                     os_ver: <value in [unknown, 0.0, 1.0, ...]>
                     patch: <value of integer>
                     platform_str: <value of string>
                     psk: <value of string>
                     sn: <value of string>
                     vdom:
                       -
                           comments: <value of string>
                           name: <value of string>
                           opmode: <value in [nat, transparent]>
                           rtm_prof_id: <value of integer>
                           status: <value of string>
                     version: <value of integer>
                     vm_cpu: <value of integer>
                     vm_cpu_limit: <value of integer>
                     vm_lic_expire: <value of integer>
                     vm_mem: <value of integer>
                     vm_mem_limit: <value of integer>
                     vm_status: <value of integer>

Inputs

    
method:
    choices:
    - get
    - set
    - update
    description:
    - The method in request
    required: true
    type: str

params:
    description:
    - The parameters for each method
    - See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: list

url_params:
    description:
    - The parameters for each API request URL
    - Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: dict

loose_validation:
    description:
    - Do parameter validation in a loose way
    required: false
    type: bool

workspace_locking_adom:
    description:
    - the adom name to lock in case FortiManager running in workspace mode
    - it can be global or any other custom adom names
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description:
    - the maximum time in seconds to wait for other user to release the workspace lock
    required: false
    type: int

Outputs

data:
  description: The payload returned in the request
  returned: always
  type: dict
status:
  description: The status of api request
  returned: always
  type: dict
url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str