fortiflexvm_programs_list_info - Get list of FortiFlex Programs for the account.

Added in version 1.0.0.

Synopsis

This module retrieves a list of FortiFlex Programs using the provided credentials.

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

Examples

- name: Get list of programs for the account
  hosts: localhost
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Get programs list
      fortinet.fortiflexvm.fortiflexvm_programs_list_info:
        username: "{{ username }}"
        password: "{{ password }}"
      register: result

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

Return Values

  • programs List of programs associated with the specified user.type: listreturned: always
    • accountId The ID of the account associated with the program.type: intreturned: always
    • endDate The end date of the program.type: strreturned: always
    • hasSupportCoverage A flag indicating whether the program has support coverage.type: boolreturned: always
    • serialNumber The serial number of the program.type: strreturned: always
    • startDate The start date of the program.type: strreturned: always

Authors

  • Xinwei Du (@dux-fortinet)

Hint

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