/ home / chillancezen / chillancezen.fortimanager / 2.1.6 / module / fmgr_user_adgrp

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

 - hosts: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure FSSO groups via fmgr_generic module.
      fmgr_generic:
         method: 'set'
         params:
             - url: '/pm/config/adom/ansible/obj/user/adgrp'
               data:
                 - name: 'ansible-test-adgrp'

    - name: Configure FSSO groups.
      when: false
      fmgr_user_adgrp:
         bypass_validation: True
         adom: ansible
         state: present
         user_adgrp:
            name: ansible-test-adgrp
            server-name: ansible-fsso # need a valid server name

Scanned by Steampunk Spotter

 - 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 FSSO groups
      fmgr_fact:
        facts:
            selector: 'user_adgrp'
            params:
                adom: 'ansible'
                adgrp: '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