SinePro

Sine Pro is an easy to use cloud-based visitor management platform. When visitors arrive, Sine makes it easy for them to Check-In and Check-Out, presents them with relevant forms where they can provide their information, sign documents (NDAs) and it optionally notifies the person they are visiting of their arrival.

Introduction

This guide covers the setup, configuration, and monitoring of the ClearPass extension for Sine Pro and the configuration of a webhook in Sine Pro for the Integration.

Sine Pro is an easy to use cloud-based visitor management platform. When visitors arrive, Sine makes it easy for them to Check-In and Check-Out, presents them with relevant forms where they can provide their information, sign documents (NDAs) and it optionally notifies the person they are visiting of their arrival.

ClearPass is an industry leading Guest Management solution that delivers secure, automated guest access workflows. It’s very useful for an enterprise to combine these two applications to get a seamless visitor management system that automates visitor’s Wi-Fi requirements.

This Extension serves two primary use-cases

  1. Guest account creation upon Visitor Check In

  2. Guest account deletion upon Visitor Check Out

With Sine hosted in the cloud and ClearPass sitting primarily on-prem, there are challenges in making these two applications communicate in real time so that a visitor gets guest WiFi credentials from ClearPass as soon as he registers using Sine application. Traditionally the apps would communicate using APIs where an application would request information which is usually followed by a response. Hence in order to get real-time information you have to poll or request as often as possible which is not scalable. The answer or the solution is a webhook which does not wait for a request to send information but sends the data as soon as it’s available.

Before we proceed with the flow, we need to understand the concept of webhooks and skyhook.

What is a webhook?

A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.

What is skyhook?

Skyhook was developed to overcome the inability for Cloud based applications to send events [webhooks] directly into a ClearPass that was typically deployed on the Trust side of a corporate firewall. In short, it is a service that runs in AWS. ClearPass nodes running on-prem, use extensions to open a persistent connection into Skyhook to receive the events originally sent from a 3rd party cloud application specific for that customer/tenant.

As an overview, Sine Pro running in the cloud will send a webhook upon a Visitor check-in (signin_after) or a check-out (signout_after) event. This will communicate with Skyhook. The ClearPass extension configured and installed will maintain a persistent connection with Skyhook awaiting an event (Check In/ Check Out).

Software Requirements

The minimum software version required for CPPM is 6.11.0 . At the time of writing, version 6.11.10 is available as the long supported release and 6.12.4 is available as the short supported release. CPPM runs on hardware appliances with pre-installed software or as a Virtual Machine under the following hypervisors. Hypervisors that run on a client computer such as VMware Player are not supported.

  • VMware vSphere Hypervisor (ESXi) 7.0 U3c and 8.0

  • Windows Server 2019 with Hyper‑V and Windows Server 2022 with Hyper‑V.

  • KVM on CentOS Stream 8, CentOS Stream 9, Ubuntu 20.04 LTS, and Ubuntu 22.04 LTS.

ClearPass Installation and Deployment Guide

This document assumes your ClearPass environment is already configured and operational. If you require assistance with basic deployment, refer to the following deployment guide:

https://arubanetworking.hpe.com/techdocs/ClearPass/6.11/Installation-Guide/Default.htm

ClearPass Extensions

The integration between ClearPass Policy Manager and external systems is driven through a ClearPass capability known as Extensions, a sub-component of the ClearPass Exchange Integration framework. ClearPass Extensions are micro-services running on top of the base ClearPass platform. These micro-services enable HPE Aruba Networking to deliver new features outside of the main software release cycle and facilitate a faster time to market for specific features and integrations. Configuration and control of ClearPass Extensions is accomplished through the ClearPass Guest GUI, as covered later in this document.

Installing Extension

ClearPass Extensions are easy to install from the ClearPass Extensions Store. In a cluster, ClearPass Extensions can be installed on a subscriber independently of the publisher. Multiple copies of the same extension can be installed if needed as well.

INFO

Internet access is required for ClearPass Policy Manager to install the ClearPass Extensions from the Extension Store. Starting with ClearPass 6.12, extensions can be can be installed offline as well. Offline ClearPass Extension images are available on HPE networking support portal.

Access to the extension store

Access the Extension Store to download and install ClearPass extensions. The Extension store utilizes the same HPE Passport account credentials used to validate support entitlement in the Software Updates Por- tal. This is configured under Administration > Agents and Software Updates > Software Updates as shown below. Ensure that valid HPE Passport credentials have been entered in these fields to enable Ex- tension download capabilities.





Installing the Extension from Store

Extensions are installed from the extension page in ClearPass Guest, as shown below. Access it from Guest > Administration > Extensions





From here, click on ‘Install Extension’, and the search box below appears.





Enter “Intune” and click on ‘Search’, see the example below.

INFO

Here we are using Intune as an example. The installation steps are the same for all the extensions. For your deployment, please search for the appropriate extension like Jamf, Mosyle, Crowdstrike, etc.

All currently available extensions are listed in the page: https://www.arubanetworks.com/techdocs/NAC/clearpass/integrations/clearpass-extension/extensions-list/





Click on the extension name and then click “Install.”





In the “Install Extension” dialog box, set the IP address if necessary, as described in section “Extensions and IP address configuration support” below. Do not check the box to start the extension at this time. Click the “Install” button.





In this example, we’ve not entered an IP address for the extension to use, if there is intent to use the extension as an authorization source set this value and ensure its set the same on all nodes where the Extension is deployed.

The extension will download and appear in a “Stopped” state. Notice the options to Start, Delete, Reinstall, Show Logs, and view Configuration. Click on “Configuration” to view settings.

After the extension has been installed, proceed to configure the extension





A copy of the default Extension configuration is shown above, this will need to be modified for your deployment.

INFO

Password and sensitive configuration items are obfuscated when presented in both the Extension GUI or in the Explorer configuration.

WARNING

The configuration attributes are case sensitive. It is recommended to refer the default configuration sample while editing your configuration.

Extensions and web proxy support

Extensions support communications with 3rd parties via a web proxy. This adds incremental proxy functionality. If a proxy is defined in ClearPass Policy Manager, then an extension will inherit that configuration. See later in the document on how to disable the proxy inherited configuration.

INFO

Note that the Policy Manger web proxy configuration is ONLY read by the extension at installation time. If the web proxy configuration is changed in Policy Manager, then the extension must be re-installed so the new settings are re-read and bonded to the extension.

Extensions and IP address configuration support

ClearPass uses a non-externally routed IP address range to communicate with the Extension. The default is 172.17.0.0/16. You may configure a different range, if desired. This is especially useful when deploying extensions across nodes within a cluster where there is the requirement for a fixed consistent IP address for the extension across the cluster.

Changing the “Extensions Network Address” range is only necessary if either the ClearPass MGMT or DATA interface are using an IP address in the extension default range of 172.17.x.x/12, or if ClearPass needs to communicate with some external device in that range.

To Configure the base Extension IP subnet within Policy Manager navigate to Administration > Server Manager > Server Configuration [chose your node] Service Parameters [ClearPass system service].

INFO

The subnet defined here for the extension framework must fall within the following subnet range 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 as defined by RFC1918. For best results, set the network address range to a subnet that does not exist in your enterprise, and restart the extension service for this change to take effect.

Never set the DATA or MGMT IP address to use an address that matches the Extension Network



Defining the base IP SUBNET and LOCALHOST for the Extensions Framework
Defining the base IP SUBNET and LOCALHOST for the Extensions Framework



INFO

Note that changing the extension base IP address will require the extension service to be restarted.

Pictorial View of the Integration

The diagram below shows a pictorial overview of the components and how they interact with each other.



Pictorial view of ClearPass Policy Manager integration with Sine Pro
Pictorial view of ClearPass Policy Manager integration with Sine Pro


Configuration Steps

There are primarily 3 steps involved in getting this integration configured.

  1. Register and request for a Skyhook tenant

  2. Configuration of Sine Pro for Integration

  3. Installation and Configuration of the Sine Pro extension using GUI in ClearPass 6.7.X

It is assumed you have SMTP and SMS configured to allow ClearPass Guest to send visitor account details to the Visitor/Guest.

Step I: Register and Request for a Skyhook Tenant ID

Skyhook Tenant ID’s can be registered in the skyhook self-service portal by accessing the following link https://clearpass.arubanetworks.com/webhooks/skyhook and instructions on using the skyhook self-service portal is available here: https://arubanetworking.hpe.com/techdocs/NAC/clearpass/integrations/clearpass-extension/skyhook-self-service-portal/

Step II: Configuring Sine Pro for ClearPass Integration

INFO

Setup and Configuration of Sine Pro is beyond the scope of this guide. Here we specify the steps necessary to configure the integration.

The “Email Required” field must be enabled in Sine Pro. This can be accessed from Passes > Check-In Requirements under Settings for individual sites. This email field is mapped to the Guest account username created in ClearPass.

Below are the configuration steps to follow:

Click on Sites. Select a Site and go to Settings. Navigate to Integrations and add (+) a WebHook.



*Webhook Integrations in Sine Pro*
*Webhook Integrations in Sine Pro*


The screen capture above covers the configuration required in the Sine Pro environment. Following are the values required for the configuration.

  1. URL: This is the Skyhook Posting URL. The SkyHook Tenant is obtained from the sample email as shown in previous step. Replace the <SKYHOOK TENANT> below to create the URL.

https://skyhook.clearpassbeta.com/api/skyhook/sine**/<SKYHOOK TENANT>**

  1. API Key: This is a shared key for communication between ClearPass and Sine.

INFO

We recommend using a GUID value or a large random value as the key. You can generate a GUID value here: https://www.guidgenerator.com/ OR a random value here: https://www.random.org/bytes/

  1. External ID: This can be left blank as it is not used currently. It will automatically pick the default value.

  2. Visitor Types: You could choose these based on your requirement however, in current versions of ClearPass all Visitor Types will be mapped to a Guest role on ClearPass by default.

  3. Events: “signin_after” is a mandatory event that has to be selected. It is strongly recommended to select both the events “signin_after” and “signout_after” to complete the guest sign in workflow.

  4. Status: Ensure the status is enabled.

Step III: Sine Pro Extension Installation and Configuration

The default configuration used for extension is below

{

“skyhookTenant”: “27f80f8aaaea8974d9c7ca43e69xxxxb5xxxx85910”,

“dbAccessToken”: “********”,

“sineApiKey”: “********”,

“cppmDefaultExpiryHrs”: 8,

“cppmGuestRoleName”: “[Guest]”,

“cppmGuestRoleId”: 2,

“cppmGuestSmsReceipt”: true,

“cppmGuestEmailReceipt”: true,

“dbLogging”: false,

“logLevel”: “INFO”

}

A copy of the Sine Pro Extension with the desired configuration is shown below, this will need to be modified for your deployment. Include the skyhookTenant, dbAccessToken and sineApiKey that will be specific to your environment. Change any other default values if necessary. Select ‘Restart’ and click on Save Changes to restart the extension.



*GUI Review and Setting the Extension configuration*
*GUI Review and Setting the Extension configuration*


The table on the next page explains each option with the values and examples required for configuration.

Extension Configuration options

Configuration attribute Description Example/Values
skyhookTenant The Skyhook tenant ID received in the registration email. 27f80f8aaaea8974d9c7ca43e69xxxxb5xxxx85910
dbAccessToken The access token for Skyhook received in the registration email. Long Random string like 7INXYr1YUixxxxxv...
sineApiKey The API key configured in the sine integrations configuration. 4a348197-cc57-4cf7-a339-5a4c3f76b2b0
cppmDefaultExpiryHrs The default number of hours for an account to be active. 8
cppmGuestRoleName The role name to be used in ClearPass Guest when creating the account. This value should match with the cppmGuestRoleId [Guest], [Contractor], [Employee], Custom Role
cppmGuestRoleId This value sets the role id to use when creating guest accounts 1 - [Guest], 2 - [Contractor], 3 - [Employee], 4 - Custom Role
cppmGuestSmsReceipt Sets the value of auto_send_sms for ClearPass to send the Guest credentials receipt via SMS true/false
cppmGuestEmailReceipt Sets the value of auto_send_smtp for ClearPass to send the Guest credentials receipt via SMTP true/false
dbLogging Enables advanced logging of skyhook db connection true/false
logLevel Logging level for troubleshooting "DEBUG", "INFO", "WARN", "ERROR"

After the configuration and the restart of the extension, click on Show Logs. You should see the following.



*Log Validation*
*Log Validation*


The above log shows the License Agreement and also states that the extension is now ready to process events for Sine Pro.

You can change the logLevel to DEBUG under configuration for detailed logs. These are very useful for troubleshooting and should be included before raising a support case if necessary.

Migration Steps from Sine Pro v1 to Sine Pro v2

Sine Pro v1 was available as a ClearPass extension prior to writing this guide. Customers who already have v1 installed are recommended to move to v2 for performance enhancements.

INFO

Note the Sine Pro v1 is denoted as version 0.3 in ClearPass Extension UI.

Following are the migration steps.

  1. Request for a new SkyHook Tenant ID for Sine Pro v2 integration. The steps for the same are specified in the section “Step I: Register and Request for a Skyhook Tenant ID”.

  2. Disable the WebHook created for v1 Integration. Do not delete this. The idea is to keep the v1 integration in a disabled state so that we can move back to v1, if the v2 migration fails.

You can also rename this to WebHook-v1 or WebHook-OLD to avoid confusion.



*Disable WebHook*
*Disable WebHook*


  1. The next step is to create another WebHook for v2 integration. Follow the steps in the section “Step II: Configuring Sine Pro for ClearPass Integration”.

  2. Stop the Sine Pro v0.3 extension installed on your ClearPass server. Navigate to ClearPass Guest and go to Administration > Extensions. Click on the Sine Extension to Stop it as shown below.



*Stop extension*
*Stop extension*


  1. Follow the section “Step III: Sine Pro Extension Installation and Configuration” to install the new Sine Pro v2 extension.

  2. Test the functionality for few days to ensure it works. If yes, the old extension and the WebHook can be deleted. If no, they can be re-enabled to ensure no service interruption. Contact HPE Aruba Networking support for any further assistance with troubleshooting.

Testing/Demo

Now that the components are all configured and ready to use, let’s walk through the experience from the user and administrator perspective. In order to do so, the first step for a visitor is to register using the Sine Pro app running on an iPad at a reception in the customer setup.

Configuring an iPad or any other device to assist customers with registration at front desk is beyond the scope of this document. Essentially, you download the SinePoint Pro app from the appstore and use the registered account to login with this device to your Sine Pro tenant. Detailed steps are available on Sine’s website here

https://www.sine.co/sinepointsetup/

  1. Visitor walks up to a tablet used for Registration. Every company can have a different skin for the Registration page. A simple Registration Check-In page configured for our demo is shown below.

Visitor clicks Check-In.



*Visitor Check In*
*Visitor Check In*


  1. A first-time visitor is asked to fill all the forms with his details as shown below. A site location in Sine is recognized using the Google Maps. This will default the country code to that region. For example, 0414 will automatically be converted to +61414 for sites in Australia. Visitors from outside the region can manually enter the country code when checking-in.

We have used basic forms here for demo. These forms are customizable and can be created as per customer requirements. As you can see below, the email field should be available in the Check-In form. This field is mapped to the username of the Guest account created in ClearPass.



*Visitor Details*
*Visitor Details*


  1. The next steps will ask the visitor to click a picture if configured and then make them digitally sign the required forms like NDA etc.

  2. As a final step, the application asks the visitor to select the host. A notification about the visitor’s arrival will be sent to this host via SMS, email and/or push notification, as configured within Sine Pro.

  3. Once done, you will see a successful check-In. This finishes the registration from the user perspective.



*Visitor Check In*
*Visitor Check In*


  1. User should receive an email as well as an SMS with his credentials. Following is the snapshot of the email. Notice the account expiry time is set to 8 hours by default.


*Visitor Email Receipt*
*Visitor Email Receipt*


You can change the Receipt Template (Guest Manager Receipt) under Configuration > Receipts > Templates.

  1. After the visit, user can Check Out at the registration desk using the same Tablet. Type you email, mobile or you can also scan the QR code to check-out. Click Next.


*Visitor Check Out*
*Visitor Check Out*


Now let’s see what happens in the backend from an administrator perspective.

  1. Login to ClearPass Guest and go to Manage Accounts under Guest.


*ClearPass Guest Account Creation*
*ClearPass Guest Account Creation*


The new account has been created upon registration. Note the Expiration time, this should match with the Sine Pro extension configuration setting for cppmDefaultExpiryHrs. By default, it is set to 8 hours. Another thing to note is the Role which is set to [Guest]. This depends on the extension configuration settings for cppmGuestRoleName and cppmGuestRoleId. This could also be set to a custom Role value if required. The configuration for the same is beyond the scope of this guide.

  1. If you enable DEBUG and Click on Show Logs under Extension, you should see the following details as a part of the Check In event.

[2018-08-14T15:08:18.168] [DEBUG] sine - New event received (43ef9b54-e4b1-4f56-b8c0-690db430e96a).

[2018-08-14T15:08:18.178] [DEBUG] sine - The Sine API Key is a match. Processing message…

[2018-08-14T15:08:18.178] [DEBUG] sine - [Sign In] Looking up guest “peter@webworks.com” in CPPM.

Attmepting to call https://172.17.0.1/api/guest/username/peter@webworks.com with token of Bearer aabbcc13d3a5bfab48e3890d3937046f1aaabbcc

[2018-08-14T15:08:18.482] [DEBUG] sine - [Sign In] Creating guest “peter@webworks.com” in CPPM.

Attmepting to call https://172.17.0.1/api/guest with token of Bearer 0df7cf13d3a5bfab48e3890d3937046f1a35659d

[2018-08-14T15:08:19.136] [INFO] sine - [Sign In] The following guest signed in: Peter Parker (peter@webworks.com)

[2018-08-14T15:08:19.136] [DEBUG] sine - Removing event from skyhook (43ef9b54-e4b1-4f56-b8c0-690db430e96a)…

[2018-08-14T15:08:19.405] [DEBUG] sine - Event removed (43ef9b54-e4b1-4f56-b8c0-690db430e96a).

  1. Upon Check Out, the User account will be disabled, see this under Manage Accounts in ClearPass Guest


*ClearPass Guest Account Disabled*
*ClearPass Guest Account Disabled*


  1. The user’s WiFi session should also get disconnected automatically upon Check Out. This depends on the Policy configured for the Guest SSID. This configuration is beyond the scope of this document.

  2. You would see a similar Check Out event in the DEBUG logs.


Appendix A – Troubleshooting and Support

Here we list some basic troubleshooting steps. If you need any help beyond this, please reach out to HPE Aruba Networking Support.

Check API Access Application Control restrictions

If you’ve previously hardened your ClearPass deployment with Application Access Controls, it’s possible that the Extension will not work. Reviewing the Extension Log might show something like the following after immediately starting the Extension. This likely indicates the ClearPass Application API’s are in place.

Example of Extension authorization failure due to Policy Manager Application Control:

[2020-03-16T15:42:21.083] [INFO] Intune - Server listening on port 80.

[2020-03-16T15:42:21.243] [DEBUG] Intune - Request “GET ‘https://172.17.0.1/api/server/version’” took 51.91ms.

[2020-03-16T15:42:21.245] [DEBUG] Intune - <!DOCTYPE html><html>

<head>

<title>

Error 403 (Forbidden)

</title>

<script language=“javascript”>

function reloadPage() {

var locHref = window.location.protocol + “//” + window.location.hostname;

window.location.href = locHref;

}

</script>

To resolve this issue, add the IP address of the Extension to the list of nodes permitted to access the API by navigating to Administration > Server Manager > Server Configuration {choose your node} > Network





INFO

For this reason its good practice to fix the IP address of the extension at installation time such that it doesn’t change over time and break the application controls.

Checking on the Extension Service

The ClearPass Extensions are supported by a system service which must be running.

Restarting this service will affect all deployed and running extensions.

To check on the state of the Extension Service, or to restart the service, go to Administration > Server Manager > Server Configuration > [SERVER] > Service Control. By default this service is automatically started.



Services Control
Services Control


Extensions and web proxy / firewall whitelisting

If ClearPass Policy Manager has been configured with a proxy, it’s still possible that domain whitelists are required, the same for some datacenter firewall to allow the installation of Extensions. Some enterprise customers maintain a whitelist of domain that are allowed to transit the proxy/firewall. The underlying docker configuration process uses standard docker registry access to pull images (hosted in docker hub). In general, the following hosts are used:

INFO

  • extensions.clearpassbeta.com

  • registry-1.docker.io

  • index.docker.io

  • auth.docker.io

  • production.cloudflare.docker.com

This is all also geo dependent to some degree and based on various AWS services, so AWS redirects and geo location services will vary. Finally, this all runs via standard HTTPS (port 443).

Extension Logs/Enable Debugging

If you have a requirement to access and view the logs from the Extension, you can turn on different logging levels from the Extension GUI. Adjust the logLevel to ‘DEBUG’ and restart the extension as shown below.

Logs can then be viewed from the ‘Show Logs’.





Remember after changing the logging level, as with any extension configuration change the extension will need to be restarted for this change to take effect.

Accessing the extension logs using ‘Collect Logs’ system function

In addition to viewing the logs as shown above, logs can also be collected and examined via the Policy Manager Collect Logs system function (Administration > Server Manager > Server Configuration > [Select SERVER] > Collect Logs). This is extremely useful should you have a need to call for technical assistance.

If the support team needs to investigate a system issue, one of the items they regularly ask for is the system logs to aid with their diagnostic investigation. By default the “logLevel” is set to INFO, but TRACE, DEBUG, INFO, WARN, ERROR, FATAL can also be set as required. Any of the levels will display the information for the selected state and lower; if INFO is selected, it will show messages for INFO, WARN, ERROR, FATAL.

After the logs have been collected, downloaded and expanded, you can locate the extension logs in the following location in the folder structure PolicyManagerLogs > extension > your-extension-id as shown below. Note the file-name is the same as the running instance ID of the extension.





Monitoring extension statistics

There is a way to monitor extension’s critical resource statistics with the configurable parameter added as part of the extension’s configuration. To enable extension statistics set the “enableStats” parameter to true. Remember a restart of the extension is need to activate the change anytime the config is modified.





To navigate to statistics page, click Show Details.









This will show statistics similar to the following:













Monitoring authorization performance

Since we are authorizing against an external system, it could be relevant to monitor the performance of these transactions as you setup and deploy. If you suspect there is a performance issue, ClearPass provides a way to monitor the authorization processing time. The graph below shows an example of this data, navigate to Monitoring > Live Monitor > System Monitor [click on ClearPass Tab, then select [Authorization]….





Appendix B – Considerations for Installing in a Cluster

Extensions are not synced between ClearPass cluster members, and thus must be installed on each member separately.

Some Extensions can run in two modes: Periodic Sync Mode and Authorization Source Mode.

Periodic Sync Mode

If you are configuring the extension to poll external system periodically and utilize the resulting ClearPass Endpoint database during endpoint Authorization, then you only need to install the extension on one cluster member, often the publisher.

You may wish to install the extension on a second cluster member as a backup, but remember that both extensions will individually be updating the endpoint database. You may want to stagger the updates between the two extensions, for example, Subscriber1 updates at the top of the hour and Subscriber2 updates at 30 minutes after the hour.

Also, in this mode there is no need to explicitly enter an IP address during installation. The defaults will suffice and ClearPass will select an IP in the range specified in the server configuration.

HTTP Authorization Source Mode

In this mode we configure an HTTP Auth source that results in a HTTPS call to external system during endpoint authorization. In this deployment model the extension must be installed on every cluster node that process authentications. Also in this scenario every cluster member’s extension must be set to the exact same IP address during installation time, as the HTTP Auth source configuration is propagated globally across all cluster members.

For example, if the extension IP range is 172.17.0.0/16, we would set the extension to 172.17.0.5 on every cluster member during installation of the extension.

While we normally want to avoid duplicate IP addresses in a network, this is not a concern with ClearPass extensions. Each ClearPass node communicates internally only with its own extension, and this traffic is not routed outside of ClearPass.

Subscriber nodes support the same ability as publishers to install an Extension from the Extension store.

Appendix C – endpoint sync schedule settings

The syncSchedule and similar scheduling parameters sets how often ClearPass executes certain actions like syncing or pushing endpoints. This setting is based on a slightly modified version of the CRON job scheduler found in Unix-like operating systems. It can be used to schedule jobs to run periodically at fixed times, dates or intervals.

A ‘cron’ is a job scheduler. Any scheduled task is called a ‘cron job’. The syntax for a cron job schedule is as follows:





In our use of the cron scheduler, we’ve dropped the use of the last instruction ≤command to execute> and use only the time/date functions, see below for a number of examples of scheduling a sync process.

  • Schedule a sync to run at 2am daily:- 0 2 * * *

  • Schedule a sync to run twice a day at 5am and 5pm:- 0 5,17 * * *

  • Schedule a sync to run on every Sunday at 5pm:- 0 17 * * sun

  • Schedule a sync to run every 30 minutes:- */30 * * * *

  • Schedule a sync to run at 5pm on selected days:- 0 17 * * sun,fri

You can see from the above that the scheduling process is extremely flexible, alternatively https://crontab.guru/ is a great page for learning more about CRON scheduling.

Appendix D – Extension performance optimizations

Extensions are a critical part of ClearPass deployments today and with the increased dependency on extension interactions that involve periodic polling or real-time lookups, here are some of the best practice recommendations around optimizing overall performance when using extensions:

  • If the extension is used to periodically poll external systems and populate endpoint repository, ensure that it is not installed in all the nodes in the cluster. Ideally these type of extensions should only be installed on the publisher node since only publisher node can add endpoint entries to the database. For redundancy, it can be installed on another additional node but it is recommended to stagger the polling interval so that both do not attempt to poll and update endpoint database at the same time.

    Example: 0 * * * *, This cron job runs at minute 0 of every hour (e.g., 00:00, 01:00, 02:00, etc.).

      30 * * * *, This cron job runs at minute 30 of every hour (e.g., 00:30, 01:30, 02:30, etc.).
    
  • If the extension is used for looking up attributes from external systems in real time during authentication, it should be installed in all the nodes handling authentication. Note that the context server config is replicated from the publisher. When using extension for real time lookup, ensure that the extension has the same IP address in all the cluster nodes.

  • If the extension is expected to do both real-time lookup and periodic polling, ensure that polling is enabled only on the publisher while the extension in subscribers can have the polling disabled by setting the “enableSyncAll” attribute to false.

       "enableSyncAll": false,
    

WARNING

Having the extension installed on all the cluster nodes with enableSyncAll set to true would cause each cluster node to independently poll the external system and update endpoint repository. This could impact the performance of ClearPass. Hence it is strongly recommended to enable endpoint sync only on the extension installed on the publisher and on another cluster node for redundancy.

  • Some 3rd party systems support fetching delta updates vs fetching all of the device information every polling cycle. The extensions that support fetching delta updates are: Workspace ONE Crowdstrike Falcon Microsoft Intune Mosyle SentinelOne Service Now

    For these extensions, the syncUpdatedOnly attribute should be set to true in extension config so that the number of DB updates in ClearPass is minimized

      "syncUpdatedOnly": true,
    

    For extensions that do not support syncUpdatedOnly, ensure that the sync interval is not aggressive. We recommend syncing at most twice a day and that too during off peak hours whenever a full sync is performed.

  • Some 3rd party systems can be very noisy in terms of attribute updates. There could be certain attributes that keep changing every sync interval like “Free Memory in Bytes”, “Last Check in Time” etc. There is no value in updating endpoints when such trivial attributes change for the device. Hence it is recommended to use “ignoreEndpointDifferences” attribute in extension configuration to ignore change in attributes that you do not care about in terms of ClearPass policies.

    You can review the Audit Viewer in ClearPass under Monitoring > Audit Viewer to see what attributes are being updated for endpoints to check if there are unnecessary updates.

    Sample for JAMF extension:

      "ignoreEndpointDifferences": "Last Update, Report Date UTC, Last Contact Time UTC, Last Inventory Update UTC, Last Reported IP, IP Address",
    

    Default for Microsoft Intune extension:

      "ignoreEndpointDifferences": "Last Sync Date Time, Free Storage Space in Bytes",
    
  • To further optimize the number of endpoints being updated in ClearPass, you can specify which attributes are being used in the ClearPass policies so that only changes to those attributes would trigger an update to the endpoint. This is done by listing out the specific attributes under endpointAttributes in extension configuration.

    Sample for JAMF extension:

      "endpointAttributes": "Group names, MDM Enabled, Managed, Remote Managed, Supervised, Serial Number",
    
  • Setup extension to restart unless it was intentionally stopped. A restart policy can be defined in extension configuration to ensure that the extension starts up automatically after server reboots and such. Restart policy of “unless-stopped” would ensure the extension always starts up unless it was manually stopped.

    “restartPolicy”: “no” — The extension will not be automatically restarted after the server is restarted.

    “restartPolicy”: “always” — The extension will always be restarted after the server is restarted.

    “restartPolicy”: “unless-stopped” — The extension will be restarted unless it was stopped prior to the server restart, in which case it will maintain that state.

    “restartPolicy”: “on-failure:N” — If the extension fails to restart, the value for “N” specifies the number of times the extension should try to restart. If you do not provide a value for “N”, the default value will be “0”.

    The “restartPolicy” parameter is not present by default in extension configurations. When it is not present, if the system is restarted a default policy is applied to the extension to maintain the state it was in before the restart. If the “restartPolicy” parameter is added to the configuration but later removed, the extension will then revert to the default restart policy.


Last modified: May 6, 2025 (51708780)