Breadcrumbs

Add Lansweeper Cloud to SaaS Agent

Task List

Task #

Task

Performed by

1

Prepare Lansweeper Cloud for use with CI Sync

Lansweeper Cloud Admin

2

Add Lansweeper Cloud as a Source System using the CI Sync SaaS UI

CI Sync Admin

3

Check status of new Lansweeper Cloud Source System connection

CI Sync Admin

4

Perform Updates in ServiceNow (if required)

ServiceNow Admin

5

Do Not Synchronize Installed Software from two different source systems

CI Sync Admin

Task 1: Prepare Lansweeper Cloud for use with CI Sync

This task explains how to prepare Lansweeper Cloud for use with your customer specific instance of CI Sync.

Doing this allows your CI Sync SaaS Agent to authenticate to your Lansweeper Cloud so you can run CI Sync jobs between Lansweeper Cloud and your CMDB.


Click to expand Guidance Notes for customers with Multiple Sites in their Lansweeper Cloud environment

Lansweeper Cloud supports the concept of “Sites”. Sites provide a way of segmenting your Lansweeper Discovery data in Lansweeper Cloud.

Sites are often used by customers that historically had more than one Installation (SQL Database) for their Lansweeper on-premise topology.

If you are not familiar with Lansweeper Sites, visit the various Lansweeper documentation and knowledge articles.

In terms of this relates to your CI Sync setup steps …

The API Client (and API Token) created in the steps will be scoped to one Single Site, Multiple Sites, or all Sites within your Lansweeper Cloud.

After creating the API Client via these instructions you will return to the CI Sync SaaS UI and paste the associated API Token into a new CI Sync Source System Connection. Syncfish recommend naming the Lansweeper API Client and the CI Sync Source System Connection in a way that represents the scope of Sites offered by the API Client you created.


  1. Go to Lansweeper Cloud and log in with your Lansweeper credentials.

  2. Use the Change Site button to select the specific Lansweeper Cloud Site that you want to use as a source system connection within CI Sync.

  3. Click your Login Profile button in the bottom-left corner, then select Developer Tools.

  4. Select All API Clients > Add new API client.

  5. Complete the fields using these instructions

    1. Select Personal Access Token (PAT) as the API Authentication method.

    2. Enter a meaningful name for the API Client Name (see guidance notes above for recommendations on naming).

    3. Enter a Description (one that sets further context).

    4. Select ServiceNow - CI Sync for the Integration.

    5. Finally click the Continue button when ready.

CleanShot 2025-09-12 at 12.15.58@2x-20250912-021632.png

  1. Complete the next page using these instructions

    1. Choose the Token expiration time according to your security standards.

      1. Note: When the token expires you will need to generate a new one in Lansweeper Cloud and copy/update the token in your CI Sync SaaS UI (i.e. update the source connection in CI Sync with the new token value).

    2. Set the scope of sites you would like this API Client to grant access to CI Sync.

    3. Finally click the Allow button.

CleanShot 2025-06-26 at 16.49.47@2x-20250626-065025.png

  1. Use the final page (the API Token Identify Code page) to take a copy the generated API Token value and then click Done. Note: Once you leave this page you cannot obtain the token value again (you will need to regenerate a new token if you don’t copy the token value now).

CleanShot 2025-06-26 at 16.53.45@2x-20250626-065410.png

Data Capture Summary

As a reminder, you should have captured the following information when completing the above steps.

  1. The value of the API Token (from Step 7 above). This is the API Token for the CI Sync API Client in Lansweeper Cloud.

These values will be used later by the person following the instructions in Task 2 immediately below.

Task 2: Add Lansweeper Cloud as a Source System using the CI Sync SaaS UI

  1. Login to your CI Sync SaaS instance at https://YourCo.syncfish.app

  2. In the CI Sync UI, navigate to Settings > Connections.

  3. Find the “SaaS Agent” sub-heading under the Source Connections section. If you don’t see “SaaS Agent” it means your CI Sync instance hasn’t been configured for this feature. Please contact your Sync representative to discuss.

  4. On the right hand side of the form, click the +Add button.

CleanShot 2025-06-25 at 18.03.19@2x-20250625-080339.png

  1. The New Connection form now appears. Use the Connection Type drop down list to select the source system you wish to add (in this case Lansweeper Cloud).

CleanShot 2025-08-09 at 14.23.18@2x-20250809-043039.png

  1. Update the fields using these instructions

    1. Connection name

      1. This is a friendly name that represents the source system connection.

      2. The name you enter here will appear when you create a new sync job and are selecting from the available source system list.

      3. Note: Syncfish recommend using a textual suffix on the connection name if you have multiple Lansweeper Sites in your Lansweeper Cloud environment.

    2. Alias: Please ingore this field (it is not used for the CI Sync Cloud Agent and is being deprecated).

    3. Environments

      1. Select from the available choices Production, Test, or Production/Test (the latter being both).

      2. The selection you make for this field affects which source systems appear when you create a new sync job (i.e. when you are selecting the source system list based on the “Environment” you have chosen for the sync job). See this page for more details on creating a CI Sync job: Run a Small Initial Sync Job (then run more).

      3. FYI: CI Sync allows a source system to be both Production/Test because CI Sync only reads from a source system (it doesn’t write to it). Destination systems can only be Test or Production (not both).

    4. API Token

      1. Paste the API Token for the CI Sync API Client (sometimes called a “PAT Token”) captured by your Lansweeper Admin in Task 1 above.

    5. The click the Consent to update fields checkbox.

    6. Finally click the Create connection button.

You will be returned to the main settings screen and your new source system connection will appear in the list as shown below.

image-20260210-061749.png

Task 3: Check status of new Lansweeper Cloud Source System connection

  1. To check the status of the newly added Lansweeper Cloud Source System connection click the green Check Status link. This will test whether your CI Sync Lansweeper Cloud connection can successfully reach and authenticate to the Azure Entra ID defined in the connection itself.

  2. image-20260210-061922.png

    If the connection is successful, you will see a green dot next to the source connection name.

  3. image-20260210-062301.png

    To test again in the future, you can click the green Refresh Status button.

  4. If the test is unsuccessful, you will see a red dot next to the source connection name and an error message underneath. If you need assistance resolving an error, please contact Syncfish support.

This means you are ready to run a sync job using the new source connection using these high-level instructions: Run a Small Initial Sync Job (then run more).

Task 4: Perform Updates in ServiceNow (if required)

Guidance Note

Syncfish recommend the person setting up the source system described in this guide discusses this particular task with their ServiceNow system administrator. 

A ServiceNow administrator will need to perform these steps.

Syncfish recommend following these instructions in your non-production ServiceNow environment for testing synchronization jobs.

Only once exhaustive testing in non-production is complete, repeat this process in your ServiceNow production environment.

In this section your ServiceNow SME will assess various updates to ServiceNow to support this CI Sync connector:

  • Task 4a: Assess if the CMDB CI Class Models plug-in is required

  • Task 4b: Assess if additional permissions are required

  • Task 4c: (Optional though recommended) Assess your ServiceNow CI forms and update to include additional Related Lists

Task 4a: Assess if the CMDB CI Class Models plug-in is required

Context

A number of record sets (asset types/resource types) available to sync using the Lansweeper Cloud Connector rely upon CMDB CI Classes that are only available via the CMDB CI Class Models plug-in. 

You therefore need to install the CMDB CI Class Models plug-in to your ServiceNow instance.

If you already have the plug-in you may want to upgrade it to the latest version (as ServiceNow occasionally updates the plug-in to include extra CI Classes/tables).

Source System

Specific Record Sets that require the CMDB CI Class Models plug-in

Lansweeper

  • IP Cameras

Lansweeper OT
(from Lansweeper Cloud)

  • OT PLC

  • OT Field Device

  • OT Human Machine Interface

  • OT Industrial Device

  • OT Industrial Sensor

  • OT Module

  • OT OPC Server

Instructions

Follow these steps to add this plug-in (and similar steps to locate it and upgrade it if required):

  1. Assess the use/inclusion of this plug-in within your ServiceNow (ensure you are comfortable installing this plug-in).

  2. Search for Plugins via the ServiceNow navigation menu.

  3. Locate the CMDB CI Class Models plug-in.

  4. Click Add -> Install and follow the instructions provided.

image-20250328-005325.png

Task 4b: Assess if additional permissions are required

Use Case - If you are planning to use CI Sync to create Application Service Mapping relationships in ServiceNow

Context

CI Sync needs additional permissions to create/update Application Service relationships in ServiceNow.

The ServiceNow out-of-the-box role described in the instructions below provides the required permissions and therefore this role needs to be applied to your CI Sync Integration User if you intended to use CI Sync’s Application Service Mapping feature.

Please contact Syncfish if a custom role is preferred over this out-of-the-box role.

Instructions

  1. Navigate to the cisync user account (e.g. “cisync.integration” or the name you used earlier in this page).

  2. Select the Roles tab and click the Edit… button

  3. Filter/Select the roles below and click the Save button

    1. app_service_admin

  4. Click Save. Then use the “Roles” tab to check the above role has been applied.

Context

CI Sync populates various child tables (related lists) associated with parent CIs. The following table shows the Related Lists (per CI Class) populated by the CI Sync Lansweeper Cloud Connector.

CI Class

Related List
(i.e. friendly name)

Related List Name as it appears in the ServiceNow UI when adding it to a CI Form

Apple Macs

Memory Modules

Memory Module->Configuration Item

Network Adapters

Network Adapter->Configuration Item

Windows PC

Memory Modules

Memory Module->Configuration Item

Network Adapters

Network Adapter->Configuration Item

Physical Disks

Storage Device-> Computer

File Systems

File System-> Computer

Mapped Network Drives

File System->Computer

Software Installations

Software Installed

Patches

Patch->Configuration Item

Windows Services

Windows Service->Configuration Item

Registry Entries

Tracked Configuration File->Related CI

Licence Entitlements

Licence Entitlement→Allocated to

Android

Software (via Airwatch)

Software Installed

iPad

Software (via Airwatch)

Software Installed

iPhone

Software (via Airwatch)

Software Installed

Windows Server

Memory Modules

Memory Module->Configuration Item

Network Adapters

Network Adapter->Configuration Item

IP Addresses

CI IPs

Physical Disks

Storage Device-> Computer

File Systems

File System-> Computer

Mapped Network Drives

File System->Computer

Software Installations

Software Installed

Patches

Patch->Configuration Item

Windows Services

Windows Service->Configuration Item

Registry Entries

Tracked Configuration File->Related CI

Licence Entitlements

Licence Entitlement→Allocated to

Linux Server

Memory Modules

Memory Module->Configuration Item

Network Adapters

Network Adapter->Configuration Item

IP Addresses

CI IPs

Physical Disks

Storage Device-> Computer

File Systems

File System-> Computer

Software Installations

Software Installed

VMWare ESXI Server

Network Adapters

Network Adapter->Configuration Item

IP Addresses

CI IPs

Associated Datastores

VMware vCenter Datastore->vCenter Reference

VMs

VMs

VMWare vCenter

Clusters

VMware vCenter Cluster->vCenter Reference

Datacentres

VMware vCenter Datacenter->vCenter Reference

Datastores

VMware vCenter Datastore->vCenter Reference

vCenter Network

VMware vCenter Network->vCenter Reference

Virtual Machine Instances

VMware Virtual Machine Instance->vCenter Reference

Hyper-V Server

Hyper-V Instances

Hyper-V Virtual Machine Instance->Server

Hyper-V Networks

Hyper-V Virtual Network->Server

IP Switch

Switch Ports

Switch Port -> CMDB CI

The following two related lists are only applicable if the CI Sync Default Rule has been override to Synchronize Software Product Models as Master Data in ServiceNow.

For more details See Lansweeper On-Prem Rule: Rule 12 – Synchronization of Software Product Models as Master Data in ServiceNow for Lansweeper On-Prem)

Software Model

Model ID

Software → Model ID

Software Package

Model ID

Model ID

The following two related lists are only required if the customer will be synchronizing Software Licence Keys from Lansweeper.

Windows PC

Licence Entitlements

Licence Entitlement→Allocated to

Windows Server

Licence Entitlements

Licence Entitlement→Allocated to

Instructions

Below are the steps to modify a ServiceNow CI form to expose a new Related List.

  1. Login to your ServiceNow instance with Admin permissions.

  2. Navigate to any CI in the relevant CI Class (i.e. one/all of those listed in the table in the Context section above). For example, navigate to a Windows Server CI).

  3. Right-click in the heading area of the form, then click Configure and then Related Lists from the sub-menus.

image-20250402-073451.png


  1. Identify the Related List you want to expose on the CI form using the table in the Context section above.

  2. Find the Related List in the left hand column which lists all Available Related Lists.

  3. Click the Related List and then click add (the selection arrow) to move the item to the Selected column and then click Save.

image-20250402-073539.png

  1. Repeat for each additional CI Class listed in the table in the Context section above.

Task 5: Do Not Synchronize Installed Software from two different source systems

Customers should be aware that if you synchronize Installed Software (i.e. the installed software applications for the same IT asset) from two different source systems (e.g. from Intune and Defender, or from Lansweeper and Defender, or InTune and SCCM, etc etc) for the same device you will end up with duplicate software instance records in your CMDB.

The cause of this issue is the naming convention of Installed Software is inconsistent between different source systems, and therefore CI Sync cannot reliably correlate the Installed Software per CI within the CMDB. By way of example:

  • In InTune, “Microsoft Teams” is stored as “MSTeams” (and there is no Manufacturer attribute in InTune).

  • However, in Defender for Endpoint, “Microsoft Teams” is stored as “Teams”.

Important Recommendation from Syncfish

Syncfish do NOT recommend synchronizing Installed Software from two different source systems.

Below are some notes to action this in advice in the CI Sync Web UI:

  • When you are creating a sync job via the CI Sync UI and reach the Selections page, do not select “Software” or “Software Installs” from a given source system if you have already selected Installed Software on another source system sync job.

The screen shot below shows a sample of the Selection page for InTune as the source system for a CI Sync job. If you have selected Software Installs for InTune you should not select Software Installs for a Microsoft Defender for Endpoint sync job (as shown on the subsequent screen shot below)

CleanShot 2025-06-12 at 11.53.59@2x-20250612-015416.png

The screen shot shows the Selection page for Microsoft Defender for Endpoint as the source system for a CI Sync job. You should NOT select Software Installs via Microsoft Defender for Endpoint because you have selected Software Installs via the InTune source system.

CleanShot 2025-06-12 at 11.47.31@2x-20250612-014745.png

The same logic/approach applies to any other source system that offers Installed Software, such as SCCM or Lansweeper. The key message is: do NOT recommend synchronizing Installed Software from two different source systems.