summaryrefslogtreecommitdiffstats
path: root/ansible_collections/lowlydba/sqlserver/plugins/modules/restore.ps1
blob: 57d352b5be81efb8197616816bb433b60fa5a9a7 (plain)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#!powershell
# -*- coding: utf-8 -*-

# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

#AnsibleRequires -CSharpUtil Ansible.Basic
#AnsibleRequires -PowerShell ansible_collections.lowlydba.sqlserver.plugins.module_utils._SqlServerUtils
#Requires -Modules @{ ModuleName="dbatools"; ModuleVersion="2.0.0" }

$ErrorActionPreference = "Stop"

$spec = @{
    supports_check_mode = $true
    options = @{
        database = @{type = 'str'; required = $false }
        path = @{type = 'str'; required = $true }
        destination_data_directory = @{type = 'str'; required = $false }
        destination_log_directory = @{type = 'str'; required = $false }
        destination_filestream_directory = @{type = 'str'; required = $false }
        restore_time = @{type = 'str'; required = $false }
        with_replace = @{type = 'bool'; required = $false; default = $false }
        keep_replication = @{type = 'bool'; required = $false; default = $false }
        xp_dirtree = @{type = 'bool'; required = $false }
        no_xp_dir_recurse = @{type = 'bool'; required = $false; default = $false }
        verify_only = @{type = 'bool'; required = $false; default = $false }
        maintenance_solution_backup = @{type = 'bool'; required = $false; default = $false }
        ignore_log_backup = @{type = 'bool'; required = $false; default = $false }
        ignore_diff_backup = @{type = 'bool'; required = $false; default = $false }
        use_destination_default_directories = @{type = 'bool'; required = $false }
        reuse_source_folder_structure = @{type = 'bool'; required = $false }
        destination_file_prefix = @{type = 'str'; required = $false }
        restored_database_name_prefix = @{type = 'str'; required = $false }
        directory_recurse = @{type = 'bool'; required = $false; default = $false }
        standby_directory = @{type = 'str'; required = $false }
        replace_db_name_in_file = @{type = 'bool'; required = $false }
        destination_file_suffix = @{type = 'str'; required = $false }
        keep_cdc = @{type = 'bool'; required = $false }
        stop_before = @{type = 'bool'; required = $false; default = $false }
        stop_mark = @{type = 'str'; required = $false }
        stop_after_date = @{type = 'str'; required = $false }
        no_recovery = @{type = 'bool'; required = $false; default = $false }
        max_transfer_size = @{type = 'int'; required = $false; default = 0 }
        block_size = @{type = 'str'; required = $false; choices = @('0.5kb', '1kb', '2kb', '4kb', '8kb', '16kb', '32kb', '64kb') }
        buffer_count = @{type = 'int'; required = $false; default = 0 }
        azure_credential = @{type = 'str'; required = $false }
    }
}

$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec, @(Get-LowlyDbaSqlServerAuthSpec))
$sqlInstance, $sqlCredential = Get-SqlCredential -Module $module
$database = $module.Params.database
$path = $module.Params.path
$destinationDataDirectory = $module.Params.destination_data_directory
$destinationLogDirectory = $module.Params.destination_log_directory
$destinationFilestreamDirectory = $module.Params.destination_filestream_directory
$restoreTime = $module.Params.restore_time
$withReplace = $module.Params.with_replace
$keepReplication = $module.Params.keep_replication
$xpDirTree = $module.Params.xp_dirtree
$noXpDirRecurse = $module.Params.no_xp_dir_recurse
$verifyOnly = $module.Params.verify_only
$maintenanceSolutionBackup = $module.Params.maintenance_solution_backup
$ignoreLogBackup = $module.Params.ignore_log_backup
$ignoreDiffBackup = $module.Params.ignore_diff_backup
$useDestinationDefaultDirectories = $module.Params.use_destination_default_directories
$reuseSourceFolderStructure = $module.Params.reuse_source_folder_structure
$destinationFilePrefix = $module.Params.destination_file_prefix
$restoredDatabaseNamePrefix = $module.Params.restored_database_name_prefix
$directoryRecurse = $module.Params.directory_recurse
$standbyDirectory = $module.Params.standby_directory
$replaceDbNameInFile = $module.Params.replace_db_name_in_file
$destinationFileSuffix = $module.Params.destination_file_suffix
$keepCDC = $module.Params.keep_cdc
$stopBefore = $module.Params.stop_before
$stopMark = $module.Params.stop_mark
$stopAfterDate = $module.Params.stop_after_date
$noRecovery = $module.Params.no_recovery
$maxTransferSize = $module.Params.max_transfer_size
$blockSize = $module.Params.block_size
$bufferCount = $module.Params.buffer_count
$azureCredential = $modules.Param.azure_credential
$checkMode = $module.CheckMode
$module.Result.changed = $false
$PSDefaultParameterValues = @{ "*:EnableException" = $true; "*:Confirm" = $false; "*:WhatIf" = $checkMode }

try {
    $restoreSplat = @{
        SqlInstance = $sqlInstance
        SqlCredential = $sqlCredential
        Path = $path
        WithReplace = $withReplace
        KeepReplication = $keepReplication
        NoXpDirRecurse = $noXpDirRecurse
        VerifyOnly = $verifyOnly
        MaintenanceSolutionBackup = $maintenanceSolutionBackup
        IgnoreLogBackup = $ignoreLogBackup
        IgnoreDiffBackup = $ignoreDiffBackup
        DirectoryRecurse = $directoryRecurse
        StopBefore = $stopBefore
        NoRecovery = $noRecovery
        MaxTransferSize = $maxTransferSize
        BufferCount = $bufferCount
    }
    if ($null -ne $database) {
        $restoreSplat.Add("DatabaseName", $database)
    }
    if ($null -ne $destinationDataDirectory) {
        $restoreSplat.Add("DestinationDataDirectory", $destinationDataDirectory)
    }
    if ($null -ne $destinationLogDirectory) {
        $restoreSplat.Add("DestinationLogDirectory", $destinationLogDirectory)
    }
    if ($null -ne $destinationFilestreamDirectory) {
        $restoreSplat.Add("DestinationFilestreamDirectory", $destinationFilestreamDirectory)
    }
    if ($null -ne $restoreTime) {
        $restoreSplat.Add("RestoreTime", $restoreTime)
    }
    if ($null -ne $destinationFilePrefix) {
        $restoreSplat.Add("DestinationFilePrefix", $destinationFilePrefix)
    }
    if ($null -ne $restoredDatabaseNamePrefix) {
        $restoreSplat.Add("RestoredDatabaseNamePrefix", $restoredDatabaseNamePrefix)
    }
    if ($null -ne $standbyDirectory) {
        $restoreSplat.Add("StandbyDirectory", $standbyDirectory)
    }
    if ($null -ne $destinationFileSuffix) {
        $restoreSplat.Add("DestinationFileSuffix", $destinationFileSuffix)
    }
    if ($null -ne $stopAfterDate) {
        $restoreSplat.Add("StopAfterDate", $stopAfterDate)
    }
    if ($null -ne $stopMark) {
        $restoreSplat.Add("StopMark", $stopMark)
    }
    if ($null -ne $blockSize) {
        $restoreSplat.Add("BlockSize", ($blockSize / 1))
    }
    if ($null -ne $azureCredential) {
        $restoreSplat.Add("AzureCredential", $azureCredential)
    }
    if ($null -ne $xpDirTree) {
        $restoreSplat.Add("xpDirTree", $xpDirTree)
    }
    if ($null -ne $reuseSourceFolderStructure) {
        $restoreSplat.Add("reuseSourceFolderStructure", $reuseSourceFolderStructure)
    }
    if ($null -ne $replaceDbNameInFile) {
        $restoreSplat.Add("replaceDbNameInFile", $replaceDbNameInFile)
    }
    if ($null -ne $useDestinationDefaultDirectories) {
        $restoreSplat.Add("useDestinationDefaultDirectories", $useDestinationDefaultDirectories)
    }
    if ($null -ne $keepCDC) {
        $restoreSplat.Add("KeepCDC", $keepCDC)
    }
    $output = Restore-DbaDatabase @restoreSplat

    if ($null -ne $output) {
        $resultData = ConvertTo-SerializableObject -InputObject $output
        $module.Result.data = $resultData
        $module.Result.changed = $true
    }
    $module.ExitJson()
}
catch {
    $module.FailJson("Error restoring database: $($_.Exception.Message).", $_)
}