Get a list of existing entitlements for a FortiFlex configuration

Use the fortiflexvm_entitlements_list_info module to get a list of entitlements for a FortiFlex configuration.

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.

Example

The following is an example use of this module:

- name: Get list of entitlements for a specific config ID
  hosts: localhost
  collections:
    - fortinet.fortiflexvm
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Get entitlements list
      fortinet.fortiflexvm.fortiflexvm_entitlements_list_info:
        username: "{{ username }}"
        password: "{{ password }}"
        configId: 22
      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 associated with the specified configuration ID.

The entitlements list includes:

Parameter	Type Returned	Description
serialNumber	String	The serial number of the entitlement.
description	String	The description of the entitlement.
configId	Integer	The configuration ID of the entitlement.
startDate	String	The start date of the entitlement.
endDate	String	The end date of the entitlement.
status	String	The status of the entitlement. Possible values for the status are "PENDING", "ACTIVE", "STOPPED", or "EXPIRED".
token	String	The token of the entitlement.
tokenStatus	String	The token status of the entitlement. Possible values are "NOTUSED" or "USED".