In This Article:
- What are Some of the Things I Should Know Before I Upgrade
- How Do I Upgrade my Endpoints?
- Updating the Endpoint
- Using the Console to Upgrade Endpoints
- What to do When my Upgrade Fails
What Are Some Things I Should Know Before I Upgrade?
- NEVER upgrade your endpoints first.
- NEVER upgrade your endpoints to a higher version of Spirion than the console.
- ALWAYS build a new MSI or PKG each time you attempt to upgrade.
- ALWAYS obtain the most current license from your my Spirion portal.
- ALWAYS obtain a new clientsettings.reg file as your console location may have changed since your last upgrade.
- ALWAYS manually install the .msi or .pkg on one endpoint BEFORE pushing an update through the console or through a software distributor such as JAMF or SCCM.
- BEFORE YOU ATTEMPT TO UPGRADE check this console setting: Console\CheckInstallationLocation and set that value to 2 which will have the Client update check to see if an endpoint can be upgraded. If it cannot be upgraded at this time the installation will fail. The reason you want to enable this setting instead of the default value of 1 which will check and proceed is because allowing the upgrade to proceed with a locked file will cause an unstable upgrade. Therefore, it is best to let it fail and remediate the locked file than having an unstable upgrade.
- Endpoints AUTOMATICALLY poll into the console. You can check this in the status tab of the console. If you are sure you built your .msi or .pkg correctly and do not see the endpoint in the console STOP and contact firstname.lastname@example.org, provide a gathered data from the console and the endpoint and support will be happy to help you get that endpoint polling again.
- If you plan to upgrade a large number of machines, consider staggering your upgrade process by department or in groups/tags to ensure that any issues can be handled in better timing than the chaos of upgrading a large pool of machines at once
How Do I Upgrade my Endpoints?
To upgrade your endpoints, you have two options. You can either manually distribute and install the .msi/.pkg or you can push an update through the console. In any event you must manually build the .msi/.pkg package first. We recommend you test your .msi/.pkg package on at least one endpoint manually first to ensure that the .msi/.pkg installation is successful before pushing it out through the console or a software distributor.
Updating the Endpoint
- Build your .msi for windows
You can find the guide for this here: https://support.spirion.com/hc/en-us/articles/115000019892
- Build your .pkg for mac.
- You can find the guide for this here: https://support.spirion.com/hc/en-us/articles/115000019832
- Manually test each type of .msi and .pkg on AT LEAST ONE endpoint MANUALLY to ensure that there will be no bugs in upgrading the wider pool of machines
- If end user will have access to the client make sure the client opens
- Make sure the client polls in the status tab of the console
- Send a test scheduled task scan using test data on the test machine to make sure that performance is not compromised. You can find test data here: https://support.spirion.com/hc/en-us/articles/115000019252-Test-Sample-Data
- Decide which method of pushing your new .msi and/or .pkg is best for your organization. We have organizations that push out through a software distributor and/or through a console. It really does depend on what works best for your organization.
- Note: Spirion does not support pushing out through SCCM or JAMF. However, we can help by providing documentation from those providers in case you get stuck.
Using the Console to Update Endpoints
Endpoints can be updated through the console. However, we can not stress enough the need to manually test on at least one endpoint before pushing the installer through this method. If you have tested your .msi/.pkg and are ready to proceed follow these steps:
- Open your console and navigate to the Admin Tab.
- At the Admin tab file down to Endpoint updates.
- The Pane below will be displayed:
- The first time you initiate updates you will need to click the Green “Add” button to get the Endpoint Panels by type to appear.
- Each tab supports only one kind of update please be careful that you are loading the correct type of package for the correct type of endpoint
- Fill out the following fields
- Name: Name of the installer
- Endpoint Installation Package Location: Either URL or Local File path. Note: This author recommends always using the Local File Path as the URL can sometimes fail.
- Apply Updates to: Select either all endpoints or a specific tag. Remember, if you are planning to upgrade many machines roll out the upgrade by tag staggering out the tags over a few sessions to ensure that you do not run into a snow ball of end user issues if any occur.
- We recommend rebooting the endpoints after an upgrade.
- After the roll out check the status tab of the console to confirm version now reflects the version you were upgrading to. If it does not preform a gathered data of the affected endpoint and contact support for further assistance.
What to do if an Upgrade Fails
When an endpoint does not upgrade after receiving the MSI or pkg from the Console, the Endpoint Service Logs can be reviewed to determine what the cause of the issue.
- Log into the Console.
- Save the .xml file attached to this article to the local machine where you are logged into the Console.
- Select the affected Endpoints on the Console's Status screen.
- Right Click on the selected Endpoint/s and select Support Mode>Enable/Update.
- Select the xml file you saved in step #2.
- Wait for the Task status of the endpoint to be shown as Task Acknowledged on the endpoint's Status screen on the Console.
- Reapply Policy to the endpoint and wait for the upgrade to fail or not run after several polling cycles after the update Policy is shown as Up to Date for the endpoint. Select the endpoint on the endpoint list on the right side of the Status screen on the Console and then right click and select Policy>Reapply Policy.
- Review the most recent endpoint service log to determine the reason the upgrade did not run. There should be an entry in the log indicating the reason in plain text.
The Endpoint Service (EPS) logs are located in the following location for the various Client platforms:
Windows: C:\ProgramData\Identity Finder\Logs\EPS
*This is typically a hidden folder. To open the folder in Finder, Start Terminal and run this command.