fortiflexvm_entitlements_points_info - Get point usage for entitlements.
Added in version 2.0.0.
Synopsis
Returns total points consumed by one or more entitlements in a date range. Either configId or (accountId and programSerialNumber) should be provided.
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: int
- configId The ID of the configuration.type: int
- endDate The end date of the date range to query. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html) is accepted. Recommended format is YYYY-MM-DD.type: strrequired: True
- programSerialNumber The serial number of your FortiFlex Program.type: str
- serialNumber The entitlement serial number. Instead of configId you can pass serialNumber to get results for one VM only.type: str
- startDate The start date of the date range to query. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html) is accepted. Recommended format is YYYY-MM-DD.type: strrequired: True
Examples
- name: Get point usage for entitlementss
hosts: localhost
vars:
username: "<your_own_value>"
password: "<your_own_value>"
tasks:
- name: Get entitlements points
fortinet.fortiflexvm.fortiflexvm_entitlements_points_info:
username: "{{ username }}"
password: "{{ password }}"
# Either configId or (accountId and programSerialNumber) should be provided.
# configId: 3196
accountId: 12345
programSerialNumber: "ELAVMS0XXXXXX"
# Instead of configId you can pass serialNumber to get results for one VM only.
serialNumber: "FZVMMLTMXXXXXX"
startDate: "2020-10-01"
endDate: "2020-10-25"
register: result
- name: Display response
ansible.builtin.debug:
var: result.entitlements
Return Values
- entitlements List of entitlements and their consumed points in the specified date range.type: listreturned: always
- accountId The ID of the account associated with the program.type: intreturned: always
- points The total points consumed by the entitlement in the specified date range.type: intreturned: always
- serialNumber The serial number of the entitlement.type: strreturned: always