drmofu / drmofu.fortiflexvm / 2.0.0 / module / fortiflexvm_entitlements_list_info Get list of existing entitlements for a FlexVM Configuration. | "added in version" 2.0.0 of drmofu.fortiflexvm" Authors: Xinwei Du (@DrMofu)drmofu.fortiflexvm.fortiflexvm_entitlements_list_info (2.0.0) — module
Install with ansible-galaxy collection install drmofu.fortiflexvm:==2.0.0
collections: - name: drmofu.fortiflexvm version: 2.0.0
This module retrieves a list of entitlements associated with a specific config ID from FortiFlexVM API using the provided credentials.
- 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
configId: description: - The ID of the configuration for which to retrieve the list of VMs. required: true type: int password: description: - The password to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_PASSWORD. required: false type: str username: description: - The username to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_USERNAME. required: false type: str
entitlements: contains: configId: description: The config ID of the entitlement. returned: always sample: 22 type: int description: description: The description of the entitlement. returned: always sample: VM created for department X type: str endDate: description: The end date of the entitlement. returned: always sample: '2020-09-12 12:13:37' type: str serialNumber: description: The serial number of the entitlement. returned: always sample: FGVMELTM20000004 type: str startDate: description: The start date of the entitlement. returned: always sample: '2020-08-25 10:12:25' type: str status: description: The status of the entitlement. Possible values are "PENDING", "ACTIVE", "STOPPED" or "EXPIRED". returned: always sample: STOPPED type: str token: description: The token of the entitlement. returned: always type: str tokenStatus: description: The token status of the entitlement. Possible values are "NOTUSED" or "USED". returned: always sample: USED type: str description: List of entitlements associated with the specified config ID. returned: always type: list