Agent Task - Licensing

Agent Task - Licensing

Watch the video

Three of the many tasks that the Enterprise Administration module (EAM) allows you to perform are License Activations, License Updates, and License Unactivations. This section demonstrates how to activate, update, and unactivate a license from the Controller.

Before Activating a License

• This section assumes you already have your Controller and Agent created.
• Make sure you know your License Key serial number.

note

If you are using an eight-digit leased license, make sure you also have your Activation Token.

• Refer to Agent Tasks for some more useful tips with this section. For clarity, each Gateway Webpage is identified with either a Controller or Agent label in the header (top left) so it's clear which machine you are working on.

Activate License

1. On your Agent Gateway, select Platform > System > Licensing. You can see that no license is currently installed.

   

2. Activating a license on an Agent must be done from the Controller. On your Controller Gateway, select Network > Enterprise > Agent Tasks.

3. Click Create Agent Task +.

4. Select Activate License and click Next. The Create Agent Task form will walk you through each step of the license activation process.

   

5. The Activate License task has several scheduling options. For this example, select Execute Immediately and click Next.

6. Select the Agent you want to activate the license on and click Next.

   

7. Enter your license key in the License Key field. Click Next.

   • If required, an Add Activations Token field will appear. After you have entered your Activation Token, click Next.

8. Review the Task Summary and click Create Agent Task. A message will be displayed stating that the license was activated successfully.

9. Go to the Agent to validate that the Agent license was activated. You may see an Access Denied message. This is because the page was automatically updated. Simply refresh the page on your Agent.

   note

   If you are running Ignition in Trial Mode on your Agent and the trial timer expired, the license activation will fail. If this happens, reset the trial timer and resume the activation for the Agent.

10. Click on Platform > System > Licensing and verify your License Key on the Agent. This page shows all the modules on your license as well as the versions they are licensed for.

11. It's a good idea to check to see if all your modules are activated. You can check the status of your modules by going to the Gateway webpage and selecting either Platform > System > Modules. If any modules are still in Trial Mode, that means your license key didn't include those modules, or there is a newer version than your license allows.

Update a License

In the event you need to reload or update a license on your Agent, go to the Controller

1. Navigate to Network > Enterprise > Agent Tasks.

2. Click Create Agent Task +.

3. Select Update License and click Next. The Create Agent Task form will guide you through the license update steps.

   

Unactivate a License

⚠️ 8.3 Known Issue

The Unactivate License EAM agent task can provide incorrect status when attempting to deactivate a license. For a full list of known issues, click here to learn more.

If you need to unactivate a license, go to the Controller's Gateway Webpage.

1. Navigate to Network > Enterprise > Agent Tasks.

2. Click Create Agent Task +.

3. Select Unactivate License and click Next. The Create Agent Task form will guide you through the unactivate license steps.