View API


Data Object - LicenseInfo

Class
VMware.Hv.LicenseInfo
Returned by
License_Get
Since
Horizon View 6.0

Data Object Description

Information describing the View cluster license.
  • This data object must be updated as a whole.

Data Object Properties

Properties

Name Type Description
licensedxsd:boolean

Whether the View instance is licensed.
licenseKeyxsd:string

The License Key in partially redacted form

Since Horizon View 6.2
  • This property need not be set.
expirationTimexsd:dateTime

The expiration date of the View instance.
  • This property need not be set.
viewComposerEnabledxsd:booleanDeprecated. This is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

Whether View Composer is enabled.
desktopLaunchingEnabledxsd:boolean

Whether Desktop launching is enabled.
applicationLaunchingEnabledxsd:boolean

Whether Application launching is enabled.
instantCloneEnabledxsd:boolean

Whether Instant Clone is enabled.

Since Horizon 7.0
helpDeskEnabledxsd:boolean

Whether Help Desk is enabled.

Since Horizon 7.3
collaborationEnabledxsd:boolean

Whether Session Collaboration is enabled.

Since Horizon 7.4
agentAutoUpgradeEnabledxsd:boolean

Whether Agent Auto Upgrade is enabled.

Since Horizon 8.8
licenseEditionxsd:string

The license edition.

Since Horizon 7.9
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "HORIZON_STANDARD_CONCURRENT_USER"VMware Horizon Standard for View (Concurrent User).
    "HORIZON_ADVANCED_NAMED_USER"VMware Horizon Advanced for View (Named User)
    "HORIZON_ADVANCED_CONCURRENT_USER"VMware Horizon Advanced for View (Concurrent User).
    "HORIZON_ENTERPRISE_NAMED_USER"Horizon Enterprise (Named User).
    "HORIZON_ENTERPRISE_CONCURRENT_USER"Horizon Enterprise (Concurrent User).
    "ENTERPRISE_CONCURRENT_USER"VMware View Enterprise.
    "HORIZON_APPS_STANDARD_NAMED_USER"VMware Horizon Apps 7 Standard for View (Named User).
    "HORIZON_APPS_STANDARD_CONCURRENT_USER"VMware Horizon Apps 7 Standard for View (Concurrent User).
    "HORIZON_APPS_ADVANCED_NAMED_USER"VMware Horizon Apps 7 Advanced for View (Named User).
    "HORIZON_APPS_ADVANCED_CONCURRENT_USER"VMware Horizon Apps 7 Advanced for View (Concurrent User).
    "WS1_ENTERPRISE_NAMED_USER"Workspace ONE Enterprise.
    "WS1_ENTERPRISE_WITH_VDI_NAMED_USER"Workspace ONE Enterprise with VDI.
usageModelxsd:string

The usage model for this license.
  • This property need not be set.
  • This property will be one of:
    Value Description
    "CONCURRENT_USER"The is the license usage model for a standalone install.
    "NAMED_USER"This is the license mode for an install as part of a suite.
licenseModexsd:string

The license mode used.

Since Horizon 7.6
  • This property will be one of:
    Value Description
    "DEFAULT"Perpetual license is in use.
    "SUBSCRIPTION"Cloud subscription license is in use.
    "PERPETUAL_ONLY"Perpetual license is in use.
gracePeriodDaysxsd:int

Set only when licenseMode is set to SUBSCRIPTION value. The grace period in days for subscription slice.

Since Horizon 7.6
  • This property need not be set.
  • This property cannot be updated.
subscriptionSliceExpiryxsd:dateTime

Set only when licenseMode is set to SUBSCRIPTION value. The expiry of subscription slice.

Since Horizon 7.6
  • This property need not be set.
  • This property cannot be updated.
licenseHealthxsd:string

Set only when licenseMode is set to SUBSCRIPTION value. The license health.

Since Horizon 7.6
  • This property need not be set.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "RED"License is expired.
    "GREEN"License is not expired and License update is missed but not more than 7 days.
    "YELLOW"License is not expired and License update is missed for more than 7 days.