fortinet.fortiflexvm.fortiflexvm_entitlements_points_info (2.2.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortiflexvm:==2.2.0

Add to requirements.yml

  collections:
    - name: fortinet.fortiflexvm
      version: 2.2.0

Description

Returns total points consumed by one or more entitlements in a date range.

Either configId or (accountId and programSerialNumber) should be provided.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get point usage for entitlementss
  hosts: localhost
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Get entitlements points
      fortinet.fortiflexvm.fortiflexvm_entitlements_points_info:
        username: "{{ username }}"
        password: "{{ password }}"
        # Either configId or (accountId and programSerialNumber) should be provided.
        # configId: 3196
        accountId: 12345
        programSerialNumber: "ELAVMS0XXXXXX"
        # Instead of configId you can pass serialNumber to get results for one VM only.
        serialNumber: "FZVMMLTMXXXXXX"
        startDate: "2020-10-01"
        endDate: "2020-10-25"
      register: result

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

Inputs

    
endDate:
    description:
    - The end date of the date range to query. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html)
      is accepted.
    - Recommended format is YYYY-MM-DD.
    required: true
    type: str

configId:
    description:
    - The ID of the configuration.
    type: int

password:
    description:
    - The password to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_PASSWORD.
    type: str

username:
    description:
    - The username to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_USERNAME.
    type: str

accountId:
    description: Account ID.
    type: int

startDate:
    description:
    - The start date of the date range to query. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html)
      is accepted.
    - Recommended format is YYYY-MM-DD.
    required: true
    type: str

serialNumber:
    description:
    - The entitlement serial number.
    - Instead of configId you can pass serialNumber to get results for one VM only.
    type: str

programSerialNumber:
    description:
    - The serial number of your FortiFlex Program.
    type: str

Outputs

entitlements:
  contains:
    accountId:
      description: The ID of the account associated with the program.
      returned: always
      sample: 12345
      type: int
    points:
      description: The total points consumed by the entitlement in the specified date
        range.
      returned: always
      sample: 425
      type: int
    serialNumber:
      description: The serial number of the entitlement.
      returned: always
      sample: FGVMELTM20000029
      type: str
  description: List of entitlements and their consumed points in the specified date
    range.
  returned: always
  type: list