fortiflexvm_entitlements_list_info - Get entitlements information.
Added in version 2.0.0.
Synopsis
This module retrieves information of target entitlements. 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 Filter option. Account ID.type: int
- configId The ID of the configuration for which to retrieve the list of VMs.type: int
- description Filter option. Description.type: str
- serialNumber Filter option. Serial number.type: str
- status Filter option. "ACTIVE", "STOPPED", "PENDDING" or "EXPIRED".type: str
- tokenStatus Filter option. Token status. "NOTUSED" or "USED".type: str
- programSerialNumber Filter option. The serial number of your FortiFlex Program.type: str
Examples
- name: Get information of target entitlements.
hosts: localhost
vars:
username: "<your_own_value>"
password: "<your_own_value>"
tasks:
- name: Get entitlements list
fortinet.fortiflexvm.fortiflexvm_entitlements_list_info:
username: "{{ username }}"
password: "{{ password }}"
# Either configId or (accountId and programSerialNumber) should be provided.
configId: 22
# accountId: 12345
# programSerialNumber: "ELAVMS00XXXXX"
# Optional filter options
# description: "you can use description to distinguish entitlements"
# serialNumber: "XXXXXX0000000000"
# status: "PENDING"
# tokenStatus: "NOTUSED"
register: result
- name: Display response
ansible.builtin.debug:
var: result.entitlements
Return Values
- entitlements List of entitlements associated with the specified config ID.type: listreturned: always
- accountId Account ID.type: intreturned: always
- configId The config ID of the entitlement.type: intreturned: always
- description The description of the entitlement.type: strreturned: always
- endDate The end date of the entitlement.type: strreturned: always
- serialNumber The serial number of the entitlement.type: strreturned: always
- startDate The start date of the entitlement.type: strreturned: always
- status The status of the entitlement. Possible values are "PENDING", "ACTIVE", "STOPPED" or "EXPIRED".type: strreturned: always
- token The token of the entitlement.type: strreturned: always
- tokenStatus The token status of the entitlement. Possible values are "NOTUSED" or "USED".type: strreturned: always