fortiflexvm_entitlements_hardware_create - Create hardware entitlements based on a FortiFlex Configuration.

Added in version 2.0.0.

Synopsis

Create hardware entitlements based on a FortiFlex Configuration. This API is only used to create one or more hardware entitlements. To modify an entitlement, please refer to fortiflexvm_entitlements_update.

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
• configId The ID of a FortiFlex Configuration.type: intrequired: True
• serialNumbers List of hardware serial numbers.type: listrequired: True
• endDate VM(s) end date. It can not be before today's date or after the program's end date. 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". If not specify, it will use the program's end date automatically.type: str

Examples

- name: Create hardware entitlements
  hosts: localhost
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Create hardware entitlements
      fortinet.fortiflexvm.fortiflexvm_entitlements_hardware_create:
        username: "{{ username }}"
        password: "{{ password }}"
        configId: 42
        serialNumbers:
          - "FGT60FTK00000000"
          - "FGT60FTK00000001"
        # endDate: "2023-11-11T00:00:00" # Optional. If not set, it will use the program end date automatically.
      register: result

    - name: Display response
      ansible.builtin.debug:
        var: result.entitlements

Return Values

• entitlements A list of hardware entitlements and their details.type: listreturned: always
• accountId The ID of the account associated with the program.type: intreturned: always
• configId The ID of the entitlement configuration.type: intreturned: always
• description The description of the hardware entitlement.type: strreturned: always
• endDate The end date of the hardware entitlement.type: strreturned: always
• serialNumber The serial number of the hardware.type: strreturned: always
• startDate The start date of the hardware entitlement.type: strreturned: always
• status The status of the hardware entitlement.type: strreturned: always
• token The token assigned to the hardware entitlement.type: strreturned: always
• tokenStatus The status of the token assigned to the hardware entitlement.type: strreturned: always

Authors

• Xinwei Du (@dux-fortinet)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.