Agent Task - Licensing

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, Unactivate and Update licenses 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.

  • Refer to Agent Tasks for some more useful tips with this section.

For clarity, each screenshot is identified with either a Controller or Agent label in the header so it's clear which machine you are working on.

Activate License

  1. On your Agent, go to the Configure tab and select Licensing. You can see that no license is currently installed.

    images/download/attachments/6035438/EAM_Agent_License_-_Agent_No_License_1.png

  2. Activating a license on an Agent must be done from the Controller. Go to your Controller and select Configure > Enterprise Administration > Agent Tasks. Click on the 'Create new Gateway Task' link.

    images/download/attachments/6035438/EAM_Agent_License_-_Activate_GW_Tasks_2.png

  3. Activating a License key is one of several tasks you can perform under Gateway Tasks. Click the Activate License button and press Next. The EAM wizard will walk you through each step of the activation process.

    images/download/attachments/6035438/EAM_Agent_License_-_Add_GW_Task_Choose_Type_3.png

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

    images/download/attachments/6035438/EAM_Agent_License_-_Activate_License_by_Task_Schedule_4.png

  5. Now, select the Agent you want to activate the license on and press Next. In this example, Agent133 was selected.

    images/download/attachments/6035438/EAM_Agent_License_-_Activate_License_Agent133_5.png

  6. Enter your license key. You can enter it one of two ways: type it in the License Key field if you know it, or press Auto Assign the License and the license key will auto populate. Press Next.

    images/download/attachments/6035438/EAM_Agent_License_-_Enter_or_Auto_Assign_License_6.png

  7. The Activate License page will refresh so you can validate your licensing information. Press Finish.

    images/download/attachments/6035438/EAM_Agent_License_-_Finsih_Activating_License_7.png

    The screen will refresh to the Gateway Tasks window. A message will be displayed stating that the license was activated successfully.

    images/download/attachments/6035438/EAM_Agent_License_-_License_Successfully_Activated_8.png

  8. Now 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. Don't panic! Click on the 'Return to home page' link to refresh the Ignition Home page on your Agent.

  9. Click on Configure > 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.

    images/download/attachments/6035438/EAM_Agent_License_-_Validate_Agent_License_Key_10.png

    A Note About Trial Mode

    If you are running Ignition in Trial Mode on your Agent, there is a chance that the trial timer expired, and the license activation will fail. If this happens, reset the trial timer and resume the activation for the Agent. You can check the status of the installed modules by going to Configure > Modules. Modules you are licensed for will not expire, only the modules that are being used in Trial Mode.

  10. It's a good idea to check to see if all your modules are Activated. Go to your Configure tab and select Modules. If any are still in trial mode, that means your license key either didn't include those modules or they are a newer version than your license allows.

    images/download/attachments/6035438/EAM_Agent_License_-_Check_Modules_Activation_15.png

Update a License

In the event you need to reload or update a license on your Agent, go to the Controller, navigate to Configure > Enterprise Administration > Agent Tasks. Click the 'Create new Gateway' link.

Select Update License and press Next. The wizard will guide you through the license update steps. Refer to steps 4 through 10.

images/download/attachments/6035438/EAM_Agent_License_-_Update_a_Agent_License_11.png

Unactivate a License

If you need to unactivate a license, go to your Controller, navigate to Configure > Enterprise Administration > Agent Tasks. Click the 'Create new Gateway Task' link.

Select Unactivate License and press Next. Once again, the wizard will guide you through the unactivate license steps. Refer to steps 4 through 9.

images/download/attachments/6035438/EAM_Agent_License_-_Unactivate_an_Agent_License_12.png