fortiflexvm_entitlements_cloud_create - Create one cloud entitlement based on a FortiFlex Configuration.

Added in version 2.1.0.

Synopsis

Create one cloud entitlement on a FortiFlex Configuration. This API is only used to create one cloud entitlement. 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
  • 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 cloud entitlement.
  hosts: localhost
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
    config_id: 12345
  tasks:
    - name: Create Cloud Entitlement.
      fortinet.fortiflexvm.fortiflexvm_entitlements_cloud_create:
        username: "{{ username }}"
        password: "{{ password }}"
        configId: "{{ config_id }}"
        # endDate: "2024-02-12T00: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 virtual machine 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 virtual machine configuration.type: intreturned: always
    • description The description of the virtual machine.type: strreturned: always
    • endDate The end date of the virtual machine's validity.type: strreturned: always
    • serialNumber The serial number of the virtual machine.type: strreturned: always
    • startDate The start date of the virtual machine's validity.type: strreturned: always
    • status The status of the virtual machine.type: strreturned: always
    • token The token assigned to the virtual machine.type: strreturned: always
    • tokenStatus The status of the token assigned to the virtual machine.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.