fortinet.fortiflexvm.fortiflexvm_programs_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 retrieves a list of FortiFlex Programs using the provided credentials.

Usage examples

Scanned by Steampunk Spotter

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

- 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

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

Outputs

programs:
  contains:
    accountId:
      description: The ID of the account associated with the program.
      returned: always
      sample: 12345
      type: int
    endDate:
      description: The end date of the program.
      returned: always
      sample: '2021-05-15 00:00:00'
      type: str
    hasSupportCoverage:
      description: A flag indicating whether the program has support coverage.
      returned: always
      sample: true
      type: bool
    serialNumber:
      description: The serial number of the program.
      returned: always
      sample: ELAVMR0000000101
      type: str
    startDate:
      description: The start date of the program.
      returned: always
      sample: '2020-05-16 00:00:00'
      type: str
  description: List of programs associated with the specified user.
  returned: always
  type: list