fortiflexvm_entitlements_update - Update an existing entitlement.
Added in version 1.0.0.
Synopsis
This module updates an existing entitlement.
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
- serialNumber The serial number of the entitlement to update.type: strrequired: True
- configId The ID of the configuration.type: int
- description The description of the entitlement.type: str
- endDate The end date of the entitlement's validity. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html) is accepted. Recommended format is "YYYY-MM-DDThh:mm:ss".type: str
- status The status of the entitlement.type: strchoices: ['ACTIVE', 'STOPPED']
Examples
- name: Update entitlement
hosts: localhost
vars:
username: "<your_own_value>"
password: "<your_own_value>"
config_id: 12345
tasks:
- name: Update an entitlement.
fortinet.fortiflexvm.fortiflexvm_entitlements_update:
username: "{{ username }}"
password: "{{ password }}"
serialNumber: "FGVMXXXX00000000"
# Please specify configId if you want to update configId, description or endDate
configId: "{{ config_id }}"
# description: "Modify through Ansible" # Optional.
# endDate: "2024-12-12T00:00:00" # Optional. If not set, it will use the program end date automatically.
# status: "ACTIVE" # Optional. ACTIVE or STOPPED
register: result
- name: Display response
ansible.builtin.debug:
var: result.entitlements
Return Values
- entitlements The entitlement you update. This list only contains one entitlement.type: listreturned: always
- accountId The ID of the account associated with the program.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 VM. 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