Get a list of the point usage for entitlements

Use the fortiflexvm_entitlements_points_info module to get a list of total point consumption for entitlements.

Parameters

The following parameters are included:

Parameter	Type	Description
username	String (Optional)	The username to authenticate. If not declared, the code will read the environment variable FLEXVM_ACCESS_USERNAME.
password	String (Optional)	The password to authenticate. If not declared, the code will read the environment variable FLEXVM_ACCESS_PASSWORD.
configId	Integer	The ID of the configuration for which to retrieve the list of virtual machines.
startDate	String	The start date of the date range to check. Any format that satisfies ISO 8601 is accepted but the recommended format is YYYY-MM-DD.
endDate	String	The end date of the date range to check. Any format that satisfies ISO 8601 is accepted but the recommended format is YYYY-MM-DD.

Example

The following is an example use of this module:

- name: Get point usage for entitlementss
  hosts: localhost
  collections:
    - fortinet.fortiflexvm
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Get entitlements points
      fortinet.fortiflexvm.fortiflexvm_entitlements_points_info:
        username: "{{ username }}"
        password: "{{ password }}"
        configId: 25
        startDate: "2020-10-01"
        endDate: "2020-10-25"
      register: result

    - name: Display response
      debug:
        var: result.entitlements

Return values

The following parameters are returned:

Parameter	Type Returned	Description
entitlements	List	The list of entitlements and their consumed points in the specified range.

The entitlements list includes:

Parameter	Type Returned	Description
serialNumber	String	The serial number of the entitlement.
points	Integer	The total points consumed by the entitlement in the specified date range.