Installing DNS connectors

Installation requirements

To install a DNS connector, the following requirements must be satisfied:

  • An SCM account and MRAO administrator permissions

  • Microsoft Windows Server 2016, 2019, or 2022 (64-bit) and local admin permissions to install the DNS connector

  • Hardware:

    • CPU — 1.4GHz 64-bit or 32-bit (minimum)

    • RAM — 2 GB (minimum)

  • Internet access:

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

    • 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

DNS provider requirements

In addition to the general prerequisites, there are requirements that must be met depending on which DNS provider you are using.

  • Cloudflare

  • Amazon Route 53

  • Azure DNS

  • GoDaddy DNS

  • Akamai Edge DNS

  • DNSimple

  • OVHcloud

The following requirements must be met before using a DNS connector with Cloudflare:

  • You have an active Cloudflare account.

  • You have outbound network access to the Cloudflare API endpoint.

  • You have created a Cloudflare API token provided with at least the following permissions:

    • Zone.Zone:Read

    • Zone.DNS:Edit

      For information about Cloudflare API tokens, see Create an API token.
Requires connector version 1.1 or later. For instructions on updating to the latest version, see Update a DNS connector.

The following requirements must be met before using a DNS connector with Amazon Route 53:

  • You have an active AWS account.

  • You have outbound network access to the Amazon Route 53 API endpoint.

  • You have an IAM user provided with at least the following permissions:

    • route53:ChangeResourceRecordSets

    • route53:ListHostedZones

    • route53:GetChange

  • You have generated the Access Key ID and Secret Access Key for the IAM user.

For more information on Amazon Route 53, see Amazon Route 53 Developer Guide.
Requires connector version 1.1 or later. For instructions on updating to the latest version, see Update a DNS connector.

The following requirements must be met before using a DNS connector with Azure DNS:

  • You have an active Azure account.

  • You have configured DNS zones.

  • You have outbound network access to the Azure REST API endpoint.

  • You have registered an application in Azure with at least the following permission.

    • DNS Zone Contributor

For more information on Azure DNS, see What is Azure DNS?.
Requires connector version 1.1 or later. For instructions on updating to the latest version, see Update a DNS connector.

The following requirements must be met before using a DNS connector with GoDaddy DNS:

  • You have an active GoDaddy account with access to the DNS API.

  • You have outbound network access to the GoDaddy DNS API endpoint.

  • You have created an API Key and Secret.

For more information on GoDaddy DNS, see Getting Started with GoDaddy API.
Requires connector version 1.1 or later. For instructions on updating to the latest version, see Update a DNS connector.

The following requirements must be met before using a DNS connector with the Akamai Edge DNS:

  • You have an active Akamai account.

  • You have outbound network access to the Akamai API endpoint.

  • You have created an API client with at least the following permission.

    • DNS—Zone Record Management with READ-WRITE

For more information on Akamai Edge DNS, see Welcome to Edge DNS.
Requires connector version 1.1 or later. For instructions on updating to the latest version, see Update a DNS connector.

The following requirements must be met before using a DNS connector with DNSimple:

  • You have an active DNSimple account.

  • You have outbound network access to the DNSimple API endpoint.

  • You have generated an API access token with at least the following permission:

    • Zones:Full Access

For more information about DNSsimple, see DNSimple Developer Documentation.

The following requirements must be met before using a DNS connector with OVHcloud:

  • You have an active OVHcloud account.

  • You have outbound network access to the OVHcloud API endpoint.

  • You have registered an application in OVHcloud and created a Consumer Key with permission to access all appropriate endpoints.

For information about OVHcloud APIs, see First Steps with the OVHcloud APIs.

Add a DNS connector to SCM

  1. Navigate to Integrations  DNS Connectors and click the Add icon.

  2. In the Add DNS Connector dialog, provide a name to help identify the connector.

  3. (Optional) Provide comments with additional details about the connector.

  4. Specify the Delegation Mode based on the information in the following table.

    Field Description

    General

    When selected, the DNS connector is available for all organizations and departments.

    Customized

    When selected, the DNS connector is available for only the selected organizations and departments.

  5. Click Next.

  6. Copy the installation token for use during installation.

    If your installation fails, subsequent attempts require the use of a new registration token.

  7. Click the Windows installation package link.

  8. Click Save.

The connector should now be listed on the DNS Connectors page with a status of Pending.

Install a DNS connector

  • Windows

  • Windows ( CLI )

  1. (Optional) If required, move the SectigoDCS.msi file to the DNS connector machine.

  2. Right-click SectigoDCS.msi and click Install.

  3. In the setup wizard, click Next.

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

  5. (Optional) Specify an installation location.

    If no destination folder is selected, the DNS connector and library will be installed in C:\Program Files\Sectigo Limited\SectigoDCS.

  6. Click Next, and paste the connector installation token.

    If needed, you can retrieve the installation token from the Edit DNS Connector dialog for your connector.

  7. Click Next.

  8. In the Proxy Settings window, select Direct Internet connection (no proxy), or select Manual proxy configuration and enter your configuration details based on the information provided in the following table.

    Field Description

    Address

    The IP address or the DNS name of the proxy server.

    Port

    The listening port of the proxy server.

    Username

    The username used to connect to the proxy server.

    Password

    The password used to connect to the proxy server.
    Click Test Connection to confirm your connection.

  9. Click Install.

  10. Click Yes to allow the installation to complete on the server.

  11. Click Finish.

The application’s configuration and log files are stored in C:\ProgramData\Sectigo Limited\SectigoDCS.

The connector should now be listed on the DNS Connectors page with a status of Connected.

Once installed, the DNS connector must be configured to connect to your DNS provider. For more information, see Configure a DNS connector.
To be notified in the event that a connector is disconnected, add the DNS Connector 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 installation package.

  3. Modify the installation command as needed.

    msiexec.exe /i /q SectigoDCS.msi TOKEN= PROXY_TYPE= PROXY_ADDR= PROXY_PORT= PROXY_USER= PROXY_PASSWORD=
    Unused options must be removed from the command.

    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.

    TOKEN

    The mandatory installation token.

    PROXY_TYPE

    Indicates whether you are using a proxy server.

    • 1 (Yes)

    • 0 (No)

    PROXY_ADDR

    The hostname or IP address of your proxy server.

    This option is required if you are using a proxy server.

    PROXY_PORT

    The port number used by your proxy server.

    This option is required if you are using a proxy server.

    PROXY_USER

    The username for accessing the proxy server.

    This option is required if your proxy server is configured to use credentials.

    PROXY_PASSWORD

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

    This option is required if your proxy server is configured to use credentials.

  4. Run the modified installation command.

The application’s configuration and log files are stored in C:\ProgramData\Sectigo Limited\SectigoDCS.

The connector should now be listed on the DNS Connectors page with a status of Connected.

Once installed, the DNS connector must be configured to connect to your DNS provider. For more information, see Configure a DNS connector.
To be notified in the event that a connector is disconnected, add the DNS Connector Disconnected notification. For more information, see Adding notifications.