truenas.entitlements.check

Return the entitlement for feature computed from current system facts.

POLICY is keyed by StrEnum members, so a plain feature name looks up the same rule.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: feature

feature

Type: string

Feature identifier to evaluate. A feature this system does not gate is reported as NOT_GATED, the same as its absence from the truenas.entitlements.info map.

Must be at least 1 characters long

Return value

EntitlementEntry

Type: object

Entitlement decision for the requested feature.

No Additional Properties

entitled Required

Entitled

Type: boolean

Whether this system is entitled to use the feature.

reason Required

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 Required

Message

Type: string

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

Required roles: SYSTEM_PRODUCT_READ