fortinet.fortiflexvm.fortiflexvm_groups_list_info (2.2.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortiflexvm:==2.2.0

Add to requirements.yml

  collections:
    - name: fortinet.fortiflexvm
      version: 2.2.0

Description

This module returns list of FortiFlex groups (asset folders that have FortiFlex products in them).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get list of FortiFlex groups
  hosts: localhost
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Get groups list
      fortinet.fortiflexvm.fortiflexvm_groups_list_info:
        username: "{{ username }}"
        password: "{{ password }}"
        # accountId: 12345 # optional
      register: result

    - name: Display response
      ansible.builtin.debug:
        var: result.groups

Inputs

    
password:
    description:
    - The password to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_PASSWORD.
    type: str

username:
    description:
    - The username to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_USERNAME.
    type: str

accountId:
    description: Account ID.
    type: str

Outputs

groups:
  contains:
    accountId:
      description: Account ID.
      returned: if specified account ID in the argument
      sample: 12345
      type: int
    availableTokens:
      description: The number of available tokens for the FortiFlex group.
      returned: always
      sample: 5
      type: int
    folderPath:
      description: The folder path of the FortiFlex group.
      returned: always
      sample: My Assets/Department A/Group 1
      type: str
    usedTokens:
      description: The number of used tokens for the FortiFlex group.
      returned: always
      sample: 22
      type: int
  description: List of groups associated with the specified user.
  returned: always
  type: list