LicenseInfo

LicenseInfo
LicenseInfo

Information about a license.

JSON Example
{
    "application_pool_launch_enabled": false,
    "desktop_pool_launch_enabled": false,
    "expiration_time": 1656527400000,
    "grace_period_days": 100,
    "help_desk_enabled": false,
    "instant_clone_enabled": true,
    "license_edition": "HORIZON_STANDARD_CONCURRENT_USER",
    "license_health": "GREEN",
    "license_key": "KHJL-XXXXX-XXXXX-XXXXX-E3HNJ",
    "license_mode": "SUBSCRIPTION",
    "licensed": true,
    "session_collaboration_enabled": true,
    "subscription_slice_expiry": 1465711500000,
    "usage_model": "NAMED_USER"
}
boolean
application_pool_launch_enabled
Optional

Whether application pool launch is enabled.

boolean
desktop_pool_launch_enabled
Optional

Whether desktop pool launch is enabled.

integer As int64 As int64
expiration_time
Optional

The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

integer As int32 As int32
grace_period_days
Optional

The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

boolean
help_desk_enabled
Optional

Whether help desk is enabled.

boolean
instant_clone_enabled
Optional

Whether instant clone is enabled.

string
license_edition
Optional

The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

  • ENTERPRISE_CONCURRENT_USER: VMware Enterprise.
  • HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).
  • HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).
  • HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).
  • HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).
  • HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard (Concurrent User).
  • HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).
  • HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).
  • HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).
  • HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard (Concurrent User).
  • WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.
  • WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.
Possible values are : ENTERPRISE_CONCURRENT_USER, HORIZON_ADVANCED_CONCURRENT_USER, HORIZON_ADVANCED_NAMED_USER, HORIZON_APPS_ADVANCED_CONCURRENT_USER, HORIZON_APPS_ADVANCED_NAMED_USER, HORIZON_APPS_STANDARD_CONCURRENT_USER, HORIZON_APPS_STANDARD_NAMED_USER, HORIZON_ENTERPRISE_CONCURRENT_USER, HORIZON_ENTERPRISE_NAMED_USER, HORIZON_STANDARD_CONCURRENT_USER, WS1_ENTERPRISE_NAMED_USER, WS1_ENTERPRISE_WITH_VDI_NAMED_USER,
string
license_health
Optional

The license health. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

  • GREEN: License is not expired and license update is missed but not more than 7 days.
  • RED: License is expired.
  • YELLOW: License is not expired and license update is missed for more than 7 days.
Possible values are : GREEN, RED, YELLOW,
string
license_key
Optional

The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

string
license_mode
Optional

The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

  • DEFAULT: Perpetual license is in use.
  • PERPETUAL_ONLY: Perpetual license is in use.
  • SUBSCRIPTION: Cloud subscription license is in use.
Possible values are : DEFAULT, PERPETUAL_ONLY, SUBSCRIPTION,
boolean
licensed
Optional

Whether the horizon is licensed.

boolean
session_collaboration_enabled
Optional

Whether session collaboration is enabled.

integer As int64 As int64
subscription_slice_expiry
Optional

The expiry of subscription slice. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.

string
usage_model
Optional

TThe usage model for this license.

  • CONCURRENT_USER: The is the license usage model for a standalone install.
  • NAMED_USER: This is the license usage model for an install as part of a suite.
Possible values are : CONCURRENT_USER, NAMED_USER,