addLicense

The addLicense operation handles configuration related to License model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
count True integer A mandatory Integer object, must be 1, specifies the number of Licenses for a particular License Type.
Field level constraints: cannot be null, must be between 1 and 1 (inclusive). (Note: Additional constraints might exist)
compliant False boolean A read only Boolean object, TRUE or FALSE. The value TRUE indicates if the license exists in the account. The value FALSE indicates if the license is expired or there are not enough of that license type in the account.
licenseType True string A mandatory enum that specifies the type of Licensing. The values can be one of the following. You can use any of the AnyConnect Licenses: PLUS, APEX or VPNOnly for enabling RA VPN.
BASE - Default license that comes with the device and all features not covered by the optional term licenses.
MALWARE - Enables the file policies that check for malware.
THREAT - Enables Intrusion detection and prevention.
URLFILTERING - Enables Category and reputation-based URL filtering.
APEX - Enables licensing for RAVPN.
PLUS - Enables licensing for RAVPN.
VPNOnly - Enables licensing for RAVPN.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.
Field level constraints: cannot be null. (Note: Additional constraints might exist)

Example

- name: Execute 'addLicense' operation
  ftd_configuration:
    operation: "addLicense"
    data:
        count: "{{ count }}"
        compliant: "{{ compliant }}"
        licenseType: "{{ license_type }}"
        type: "{{ type }}"