fortinet.fortimanager.fmgr_dvmdb_group_obj – Device group table.

From Get docs
Ansible/docs/2.10/collections/fortinet/fortimanager/fmgr dvmdb group obj module


fortinet.fortimanager.fmgr_dvmdb_group_obj – Device group table.

Note

This plugin is part of the fortinet.fortimanager collection (version 1.0.5).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvmdb_group_obj.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • This module is able to configure a FortiManager device by allowing the user to [ delete get set update add ] the following apis.
  • /dvmdb/adom/{adom}/group/{group}
  • /dvmdb/group/{group}
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments

loose_validation

boolean

  • no
  • yes

Do parameter validation in a loose way

method

string / required

  • delete
  • get
  • set
  • update
  • add

The method in request

params

list / elements=string

The parameters for each method

url_params

dictionary

The parameters for each API request URL

workspace_locking_adom

string

the adom name to lock in case FortiManager running in workspace mode

it can be global or any other custom adom names

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • There are only three top-level parameters where ‘method’ is always required while other two ‘params’ and ‘url_params’ can be optional
  • Due to the complexity of fortimanager api schema, the validation is done out of Ansible native parameter validation procedure.
  • The syntax of OPTIONS doen not comply with the standard Ansible argument specification, but with the structure of fortimanager API schema, we need a trivial transformation when we are filling the ansible playbook


Examples

- 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/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [delete]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        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]>
           group: <value of string>
        params:
           -
              option: <value in [object member, chksum]>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        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]>
           group: <value of string>
        params:
           -
              data:
                 desc: <value of string>
                 meta fields: <value of string>
                 name: <value of string>
                 os_type: <value in [unknown, fos, fsw, ...]>
                 type: <value in [normal, default, auto]>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        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]>
           group: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

data

dictionary

always

The payload returned in the request


status

dictionary

always

The status of api request


url

string

always

The full url requested


Sample:

/sys/login/user




Authors

  • Frank Shen (@fshen01)
  • Link Zheng (@zhengl)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_dvmdb_group_obj_module.html