How To Use the Dreamhost DNS Plugin

This plugin works against the Dreamhost API. It is assumed that you already have web hosting through Dreamhost and are using Dreamhost to manage DNS for your domain(s).

Setup

We need to generate the API key that will be used to update DNS records. Open the Web Panel API page, and generate a new API key with dns-add_record, and dns-remove_record permissions. It is recommended to name this API key something memorable like "Posh-ACME" by entering this in the "Comment for this key" field. Take note of your new API key.

Using the Plugin

You will use the previously generated API key with the DreamhostApiKeySecure SecureString parameter.

Warning

The DreamhostApiKey parameter is deprecated and will be removed in the next major module version. If you are using it, please migrate to the Secure parameter set.

$pArgs = @{
    DreamhostApiKeySecure = (Read-Host 'Key' -AsSecureString)
}
New-PACertificate example.com -Plugin Dreamhost -PluginArgs $pArgs