Installing MS agents

Installation requirements

To install an MS agent, the following requirements must be satisfied:

  • Supported Windows server platform (2012, 2016, 2019, 2022)

  • MS Active Directory (AD)

    As of version 4.0, the agent no longer automatically installs the required AD CS role. You must manually install the AD CS role on the target server before installing the agent.

  • Hardware:

    • CPU — 1.4GHz 64-bit (minimum)

    • RAM — 4 GB (minimum)

    • Storage — 60 GB (minimum)

  • Internet access:

    • Outbound network access to https://dist.sectigo.com on TCP port 443

    • Outbound network access to the appropriate SCM instance on TCP port 443:

      • https://cert-manager.com

      • https://hard.cert-manager.com

      • https://eu.cert-manager.com

    • Inbound ports for certificate enrollment:

      • Kerberos UDP/TCP port 88 — Used for authentication between clients and the domain controller

      • LDAP TCP port 389 — Used for directory services, including querying for certificate templates and other directory information

      • LDAPS TCP port 636 — Enables secure LDAP communication between clients, the domain controller, and the certificate server with MS AD certificate templates

      • RPC TCP port 135 — Essential for various Windows networking functions, including autoenrollment and communication between clients and the certificate server with MS AD certificate templates

      • Dynamic RPC TCP port >1023 and >49151 — Ephemeral ports used for RPC communication between clients, the domain controller, and CA servers on Windows OS’s later than Windows Vista/2008

Add an MS agent to SCM

  1. Navigate to Integrations  MS Agents and click the Add icon.

  2. In the Add MS Agent dialog, provide a name to help identify the agent.

  3. Select the organization and department to use for default enrollment requests.

  4. Click Next.

  5. Copy the installation token for use during installation.

  6. Initiate the agent download with the Windows installation package link.

  7. Click Save.

The agent should now be listed on the MS Agents page with a status of Pending.

Install an MS agent

  • Windows

  • Windows ( CLI )

  1. Run the bootstrap application.

    The bootstrap application will download the Windows Installer package files (MSI) from https://dist.sectigo.com as necessary. If you’re using an HTTP proxy, ensure that your OS proxy settings have been configured to allow access to https://dist.sectigo.com.

  2. Read the EULA, select I agree to the license terms and conditions, and click Install.

  3. Click Next.

  4. Read the EULA, select I accept the terms in the License Agreement, and click Next.

  5. (Optional) Specify an install location.

  6. (Optional) Select the Proxy MS Enrollment Protocols to SCM feature.

  7. Click Next, and paste the agent installation token.

    If needed, you can retrieve the installation token from the Edit MS Agent dialog for your agent. This token is no longer available once the agent connects to SCM for the first time.

  8. Click Next.

  9. (Optional) Select Use Proxy and enter your proxy details based on the information provided in the following table.

    Field Description

    Proxy Host

    The hostname or IP address of your proxy server.

    Proxy Port

    The port number used by your proxy server.

    Proxy User

    The username for accessing the proxy server, if configured to use credentials.

    Proxy Password

    The password for accessing the proxy server, if configured to use credentials.

  10. Click Next.

  11. (Optional) Disable Enable Auto Update if you do not want the agent to automatically update to new versions.

  12. Click Next, Install, Finish, and then Close.

The agent should now be listed on the MS Agents page with a status of Connected.

To be notified in the event that an agent is disconnected, add the MS Agent Disconnected notification. For more information, see Adding notifications.

  1. Open the Windows command prompt.

  2. In the command line, navigate to the download location of the bootstrap application.

    The bootstrap application will download the Windows Installer package files (MSI) from https://dist.sectigo.com as necessary. If you’re using an HTTP proxy, ensure that your OS proxy settings have been configured to allow access to https://dist.sectigo.com.

  3. Modify the installation command as needed.

    .\Sectigo_MS_Agent.exe /i /q PROPERTY_AUTOUPDATE=1 PROPERTY_TOKEN= PROPERTY_CA_PROXY= PROPERTY_USE_PROXY= PROPERTY_PROXY_PAC_URL= PROPERTY_PROXY_HOST= PROPERTY_PROXY_PORT= PROPERTY_PROXY_USER= PROPERTY_PROXY_PASSWORD=

    Options without an included value are ignored. The command options are outlined in the following table.

    Option Description

    /i

    Initiates installation of the agent through the bootstrap application.

    /q

    Runs the installation in silent mode so no interaction is required.

    PROPERTY_AUTOUPDATE

    Indicates whether the agent should automatically update.

    The possible values are:

    • 1 (Yes)

    • Empty (No)

    PROPERTY_TOKEN

    The mandatory installation token.

    PROPERTY_CA_PROXY

    Indicates whether the agent should act as a CA proxy.

    The possible values are:

    • 1 (Yes)

    • Empty (No)

    PROPERTY_USE_PROXY

    Indicates whether you are using a proxy server.

    • 1 (Yes)

    • Empty (No)

    PROPERTY_PROXY_PAC_URL

    The address of your proxy auto-config (PAC).

    This file contains your proxy configuration details and can be used instead of specifying values for the PROPERTY_PROXY_HOST, PROPERTY_PROXY_PORT, PROPERTY_PROXY_USER, and PROPERTY_PROXY_PASSWORD options.

    PROPERTY_PROXY_HOST

    The hostname or IP address of your proxy server.

    PROPERTY_PROXY_PORT

    The port number used by your proxy server.

    PROPERTY_PROXY_USER

    The username for accessing the proxy server, if configured to use credentials.

    PROPERTY_PROXY_PASSWORD

    The password for accessing the proxy server, if configured to use credentials.

  4. Run the modified installation command.

The agent should now be listed on the MS Agents page with a status of Connected.

To be notified in the event that an agent is disconnected, add the MS Agent Disconnected notification. For more information, see Adding notifications.