How To: Install and Use a Protect Cloud Agent

Version 8



    This document provides a walk-through on how to install and use a Shavlik Protect Cloud Agent.




    Below are the requirements that must be met to be able to successfully install a Protect Cloud Agent:

    • The client machine must have Internet access.
    • The Shavlik Protect console must be registered with Protect Cloud
    • Outgoing TCP ports 80 (http) and 443 (https) must be available when communicating with Protect Cloud.
    • The URL must be accessible when communicating with Protect Cloud.
    • There must be at least one agent policy that is configured to allow synchronization with Protect Cloud.
    • You cannot install a cloud-based agent on a Shavlik Protect console machine.
    • The user that installs an agent must have local administrator access on the machine.


    Installation Procedure


    1. Ensure that you have registered the console with Protect Cloud.
    2. You will need to make sure the agent policy you intend to use is enabled to sync with the Protect Cloud.
      This is done via the agent policy > General > check the box, 'Sync with the Protect Cloud'.
    3. After updating the agent policy, make sure to go back to Tools > Operations > Protect Cloud Sync, and run 'Force full update now.'
      This will make it so the policy shows as available on the Protect Cloud site for the next steps.
    4. Go to
    5. Log in. If you haven't registered yet, you will need to do so by clicking on Register Now.
    6. Go to the 'Agent Keys' section.
    7. Click 'New'.
    8. You'll be prompted with the 'Create New Agent Key' options.
      • You need to choose:
        • Console name - the console system this agent key is associated with.
        • Policy - the agent policy that any agents installed with this agent key will use.
        • Max number of installations - The maximum number of times this agent key can be used to install an agent.
        • Expires in (hours) - The amount of time this agent key will be valid for installing an agent.
        • Send the agent key and activation instructions to one or more email addresses - list of anyone you want to send the agent key to for installation.
          You can also just send to yourself, and then forward the email on to anyone you want to receive it.
    9. You'll now see the agent key in the list below.
      • Details about the information provided here:
        • Agent Key - The agent key that will be used during installation of the agent to associate the agent.
        • Console Name - The name of the Protect console that the agent key is associated with.
        • Console Version - Version of the Protect console that the agent key is associated with.
        • Policy - The agent policy that the agent key is associated with.
        • Status - Lists the number of installations remaining with this agent key, based upon the 'Max number of installations'.
        • Created by - Shows the protect cloud user who created the agent key.
        • Actions
          • Resend Key (Mail Icon) - Allows you to send the agent key to additional recipients.
          • Download Agent (Download Icon) - Allows you to download the agent installer.
    10. If an email was sent, this is an example of what it will look like. It does provide the full set of directions so a user can easily install the agent.
    11. The actual installation of the agent is pretty straightforward. Download and run the stplatformupdater.exe.
    12. When prompted with 'Select the method you want to use to register this agent, choose 'I connect tot he console through the cloud'.
    13. When prompted for the Activation Key, enter the agent key which can be copy/pasted from the email.
    14. You should be prompted with 'Registration Succeeded. Click Done.
    15. If you open the agent just after installing you will see that it shows the agent is provisionally registered.
      This means the agent will be functional shortly. Be aware it may take some time for the registration process to complete.
      (It has to trickle down the registration through the Protect cloud site to your Protect console and back.)
    16. It is also possible to install cloud agents using an installation script.
      An example:
      STPlatformUpdater.exe /wi:"/qn /l*v install.log ACTIVATIONKEY=e034a812-c071-49b8-9256-a2ef199527a6"

    Using Cloud Agents


    Cloud agents can be used the same as any other agents. Everything is based on what's set within the agent policy.


    The main thing to keep in mind is that changes to agent policies and seeing reported information from the cloud agents show up in the console can take a longer period of time than agents installed with a direct connection to the console.


    Additional Information


    Additional information and resources about Cloud Agent functionality:


    Affected Product(s)


    Shavlik Protect 9.x