Step 3: Installing the Jamf AD CS Connector for Outbound Communication Mode

Technical Paper: Integrating with Active Directory Certificate Services (AD CS) Using Jamf Pro

Solution
Application
Content Type
Technical Documentation
Utilities & Services
Jamf AD CS Connector
ft:locale
en-US

To integrate Jamf Pro with AD CS, you must install the Jamf AD CS Connector on a Windows server. The connector runs as a service that allows Jamf Pro to communicate with the AD CS certificate authority server.

Note:

PowerShell has a security setting that does not allow the execution of scripts if they are not digitally signed. You can get the setting by executing the following command from the PowerShell prompt:

Get-ExecutionPolicy

If the returned value is RemoteSigned, scripts must be signed before they can be run. You can temporarily change this setting by executing the following command:

Set-ExecutionPolicy unrestricted
  1. Log in to the Windows server that will host the Jamf AD CS Connector as a user with administrator privileges.
  2. Click the following link to the Products area of Jamf Account, and then click Download: https://account.jamf.com/products/other/ad-cs-connector/download.
  3. Extract the downloaded file.
  4. Open a PowerShell console as an administrator and change the directory to the unzipped "ADCS Connector" folder (e.g., C:\Users\administrator\Downloads\adcs-connector-x.x.x\ADCS Connector).
  5. View the configuration options by running the following command:
    # display outbound connector installation options 
    .\install-adcs-connector.ps1 -outbound -help 
    
  6. Review the necessary configuration parameters and defaults and determine any necessary configuration changes. It is not recommended to modify the polling or publish batch sizes or intervals.
    ParameterDescriptionDefault Value
    clientIdThe API client ID intended to be used with the AD CS connection which was determined in a preceding stepN/A
    clientSecretThe API client secret associated with the client ID which was determined in a preceding stepN/A
    jamfProUrlThe URL of your Jamf Pro serverN/A
    adcsIdThe ID associated with the specific AD CS integration which was determined in preceding stepN/A
    pollingIntervalRequest polling interval in seconds10 seconds
    jobBatchSizeRequest job batch size100 certificate requests
    publishIntervalResults publishing interval back to Jamf Pro in seconds3 seconds
    publishBatchSizeResults publishing batch size back to Jamf Pro100 certificates
    outboundDirBaseBase directory for installation${env:programfiles(x86)}\adcs-connector\outbound
    serviceDisplayNameDisplay name for the serviceAdcsConnectorOutbound
    Note:
    If you want to run the Jamf AD CS Connector as a service user (e.g., for a regular service account or a group managed service account), do the following:
    1. Provide the -serviceUser property with your user in DOMAIN\userName format.

    2. If your service user requires a password, provide it using the -servicePassword parameter.

    3. Provide your service user with filesystem read/write access to the following directories:

      • %PROGRAMDATA%\Jamf\AdcsConnector\Logs\Jamf-ADCS-Connector\AdcsConnectorOutbound_.log—This is the log file location.

      • C:\Program Files (x86)\adcs-connector (or the value supplied for outboundDirBase if you are not using the default)

  7. Run the install-adcs-connector.ps1 PowerShell script, including any custom parameter values that you determined in the preceding steps.
    The following example shows the minimum required parameters needed to run the installation script:
    # install the outbound connector 
    .\install-adcs-connector.ps1 -outbound -install -clientId API_client_ID -clientSecret API_client_secret -jamfProUrl JAMF_PRO_URL -adcsId adcsid
    The completed example below uses the following values:
    • clientId: adf5ba29-f805-4bd1-862f-1b8b19e02071

    • clientSecret: tCaxEHWGq9OYXsje0nDUBZlChnSJxRie-EeML2l4iFNkik5ENAJNWszMXwm8BgMs

    • jamfProURL: https://jamf_pro_url.jamfcloud.com/

    • adcsId: 3

    # install the outbound connector 
    .\install-adcs-connector.ps1 -outbound -install -clientId adf5ba29-f805-4bd1-862f-1b8b19e02071 -clientSecret tCaxEHWGq9OYXsje0nDUBZlChnSJxRie-EeML2l4iFNkik5ENAJNWszMXwm8BgMs -jamfProUrl https://jamf_pro_url.jamfcloud.com/ -adcsId 3

The Jamf AD CS Connector installs in outbound communication mode with the provided parameters and values.

If you want to change any configuration parameters, you must re-run the PowerShell installation script with all necessary configuration values. If you want to change the serviceDisplayName, you will need to uninstall the previous connector.