fortiflexvm_groups_list_info - Get list of FortiFlex groups (asset folders).

Added in version 1.0.0.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15

Parameters

  • username The username to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_USERNAME.type: str
  • password The password to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_PASSWORD.type: str
  • accountId Account ID.type: str

Examples

- 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

Return Values

  • groups List of groups associated with the specified user.type: listreturned: always
    • accountId Account ID.type: intreturned: if specified account ID in the argument
    • availableTokens The number of available tokens for the FortiFlex group.type: intreturned: always
    • folderPath The folder path of the FortiFlex group.type: strreturned: always
    • usedTokens The number of used tokens for the FortiFlex group.type: intreturned: always

Authors

  • Xinwei Du (@dux-fortinet)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.