DnsPlugins/Dreamhost.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
function Add-DnsTxtDreamhost {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$DreamhostApiKey,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    Write-Verbose "Adding $RecordName with value $TxtValue on Dreamhost"
    $uri = "https://api.dreamhost.com/?cmd=dns-add_record&type=TXT&format=json&key=$DreamhostApiKey&record=$RecordName&value=$TxtValue"
    $response = Invoke-RestMethod -Method Get -Uri $uri @script:UseBasic
    Write-Verbose "Result=$($response.result), Data=$($response.data)"
    
    if ($response.result -ne 'success' -and !([string]$response.data).StartsWith('record_already_exists')) {
        throw "Failed to add Dreamhost DNS record; Result=$($response.result), Data=$($response.data)"
    }
    
    <#
    .SYNOPSIS
        Add a DNS TXT record to Dreamhost DNS

    .DESCRIPTION
        Add a DNS TXT record to Dreamhost DNS

    .PARAMETER RecordName
        The fully qualified name of the TXT record.

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER ApiKey
        A Dreamhost API key with minimum function access of dns-add_record and dns-remove_record. See related links for URI to Dreamhost panel for API key generation.

    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.

    .EXAMPLE
        Add-DnsTxtDreamhost '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'ABCDEFGH12345678'

        Adds a TXT record for the specified site with the specified value using the default account associated with the given API key.

    .LINK
        https://panel.dreamhost.com/?tree=home.api
    #>

}

function Remove-DnsTxtDreamhost {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$DreamhostApiKey,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    Write-Verbose "Removing $RecordName with value $TxtValue on Dreamhost"
    $uri = "https://api.dreamhost.com/?cmd=dns-remove_record&type=TXT&format=json&key=$DreamhostApiKey&record=$RecordName&value=$TxtValue"
    $response = Invoke-RestMethod -Method Get -Uri $uri @script:UseBasic
    Write-Verbose "Result=$($response.result), Data=$($response.data)"
    
    if ($response.result -ne 'success' -and !([string]$response.data).StartsWith('no_such_')) {
        throw "Failed to remove Dreamhost DNS record; Result=$($response.result), Data=$($response.data)"
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from Dreamhost DNS

    .DESCRIPTION
        Remove a DNS TXT record from Dreamhost DNS

    .PARAMETER RecordName
        The fully qualified name of the TXT record.

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER ApiKey
        A Dreamhost API key with minimum function access of dns-add_record and dns-remove_record. See related links for URI to Dreamhost panel for API key generation.

    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.

    .EXAMPLE
        Remove-DnsTxtDreamhost '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'ABCDEFGH12345678'

        Removes a TXT record for the specified site with the specified value using the default account associated with the given API key.
    #>

}

function Save-DnsTxtDreamhost {
    [CmdletBinding()]
    param(
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )    

    <#
    .SYNOPSIS
        Not required.

    .DESCRIPTION
        This provider does not require calling this function to commit changes to DNS records.

    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
    #>

}