truenas.entitlements.info

Return the entitlement decision for every gated feature.

Type: object

Type: array
No Additional Items

EntitlementsInfo

Type: object

Entitlement decisions for all license-gated features on this system.

 No Additional Properties

Features

Type: object

Entitlement decision for every license-gated feature known to this system, keyed by feature identifier. Identifiers are added over time: ignore keys you do not recognize, and treat an absent key as not gated.

Each additional property must conform to the following schema

EntitlementEntry

Type: object

Decision for a single license-gated feature.

 No Additional Properties

Entitled

Type: boolean

Whether this system is entitled to use the feature.

Reason

Type: enum (of string)

Machine-readable classification of the decision:

  • ENTITLED: the feature is available
  • NO_LICENSE: no license is installed and the feature requires one
  • KEY_MISSING: a license is installed but does not carry this feature
  • WRONG_HARDWARE: this hardware can never provide the feature
  • TIER_INSUFFICIENT: the support tier does not cover the feature
  • WRONG_LICENSE_TYPE: the license type does not cover the feature
  • NOT_GATED: nothing on this system restricts the feature

New values may be added; treat an unrecognized value as a generic denial.

Must be one of:
  • "ENTITLED"
  • "NO_LICENSE"
  • "KEY_MISSING"
  • "WRONG_HARDWARE"
  • "TIER_INSUFFICIENT"
  • "WRONG_LICENSE_TYPE"
  • "NOT_GATED"

Message

Type: string

Human-readable explanation of the decision. Empty when entitled.


Required roles: SYSTEM_PRODUCT_READ