This topic covers the licensing of the VOSS Automate software product. License enforcement is enabled on all Automate deployments, including production and lab environments.

Starting with Automate 21.4, a 7-day temporary license is issued for new installs or upgrades to allow administrators to carry out the required licensing. You must replace the temporary license with your new license token (license key) within 7 days from install or upgrade.

Each VOSS Automate deployment ships with a unique Deployment or Platform ID. The Platform ID is required to generate a license token. A license token is only valid for a deployment with the related Platform ID.

Automate sends alerts to Provider administrators in the Automate Admin Portal to notify these users that the system license will expire. The alert type depends on the number of days before the license expires:

This topic describes the ways in which you can access and view the status of your product license.

View your Product License in the Automate GUI

You can access and view your product license in the Automate GUI via the Login screen, via alerts sent from the system, via the Licensing menu, and via the Dashboard link (as sysadmin user):

Login screen

You won't be able to log in to the system and access the Admin Portal GUI once your license expires. It is recommended that you renew and apply your new license before the expiry date. Your system administrator may log in via the CLI to update the license. Once the new license is applied, log in via the GUI is re-enabled. See the Product Licensing topic in the Platform Guide.
Alerts

When logging in during the license expiry notification period (up to 120 days prior to license expiry), Provider admins (and above) are shown license expiry notices.

Once logged in, Provider admins (and above) can view pending license expiry notices via the toolbar Notifications icon. These alerts are also posted via the Notifications icon when Automate is unable to communicate with the license service.

Alerts are generated if a license is within 120 days of expiry. The image shows an example of a license expiry warning:

Example of license service error message:
```
"alert_id": "AUTOMATE_LICENSE",
"alert_severity": "ERROR",
"alert_category": "Automate License Service Error",
"alert_message": "Automate License Service communication error since <date-time>"
```
Note
- Alerts can also be configured to send email messages - see the notify command in the Platform Guide.
- SNMP traps are also generated - see the License section under Notification Messages in the Platform Guide.
Menu for sysadmin user

The sysadmin user can view license expiry details via (default menus) Administration Menu > Licensing > Manage License.
Dashboard link for sysadmin user

The sysadmin user can view license expiry details via the Manage License link on their Dashboard.

View your Product License in the Platform CLI

You can access your product license details via the Automate platform CLI:

Login display, health display - only on unified nodes in a unified node topology and application nodes in a modular cluster topology.
Use CLI command license token list, and view the output of this command. See further details in the Product Licensing topic in the Platform Guide.

Renew a License

You won't be able to log in to the system via the Admin Portal GUI once your license expires. It is recommended that you renew and apply your license before the current license expires.

Your system administrator will need to contact VOSS to renew the license. Provide the platform ID which is shown on the Manage License form.

Model Details: view/AboutLicense

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title	Description	Details
Platform UUID	Application or platform deployment UUID.	Field Name: platform_uuid Type: String
License status	Current status of the license for this platform.	Field Name: status Type: String
Expiry date	Date/time when the current license will expire.	Field Name: exp Type: String Format: date-time

Platform ID	<platform ID> - The ID to submit when renewing a license.
Licensed Application Name	The name of your application, for example, "Automate".
License Status	The status of your license. On install or upgrade, a 7-day temporary license is provided. It is important that you apply your new license before the expiry date. When a valid license exists, and is outside of the expiry alert period, the status is Licensed.
Sync Status Last Changed	<date-time>
License Last Checked	<date-time> - The last time the license was checked. Refer to the Product Licensing topic in the Platform Guide for details on the use of the `voss check-license` command, which is used to check your license with VOSS.
License Sync Message	The status messages of communication with the License service.
License Token Identifier	<token ID> - Used by VOSS Support.
License Expiry	<date-time>
Current License Token	The <token string> for your current license (the license that will expire or is due to expire).
New License Token	The <token string> for the new license that you obtain from VOSS. Once you paste the new license token into this field and save, it overwrites your current (expired) license.

Alert type	When sent?
Info	120 days prior to license expiry
Info	90 days prior to license expiry
Warning	60 days prior to license expiry
Warning	30 days prior to license expiry
Warning	Daily, from two weeks prior to license expiry

Model: view/AboutLicense

Manage License

View your Product License in the Automate GUI

View your Product License in the Platform CLI

Model Details: view/AboutLicense