Merge branch 'development' into 'master'

Development to Master

Closes #6 and #10

See merge request sanderstad/PSDatabaseClone!3

Author: sanderstad

PSDatabasClone.psd1 renamed to PSDatabaseClone.psd1

@@ -1,6 +1,6 @@
 @{
     # Script module or binary module file associated with this manifest
-    ModuleToProcess   = 'PSDatabasClone.psm1'
+    ModuleToProcess   = 'PSDatabaseClone.psm1'
 
     # Version number of this module.
     ModuleVersion     = '1.0.0.0'
@@ -63,14 +63,15 @@
     # NestedModules = @()
 
     # Functions to export from this module
-    FunctionsToExport = 'Initialize-PdcVhdDisk',
-    'Invoke-PdcRepairClone',
-    'New-PdcDatabaseClone',
-    'New-PdcDatabaseImage',
-    'New-PdcVhdDisk',
-    'Remove-PdcDatabaseClone',
-	'Remove-PdcDatabaseImage',
-    'Set-PdcConfiguration'
+    FunctionsToExport = 'Initialize-PDCVhdDisk',
+    'Invoke-PDCRepairClone',
+    'New-PDCClone',
+    'New-PDCImage',
+    'New-PDCVhdDisk',
+    'Remove-PDCClone',
+	'Remove-PDCImage',
+    'Set-PDCConfiguration',
+    'Get-PDCClone'
 
     # Cmdlets to export from this module
     CmdletsToExport   = ''

PSDatabasClone.psm1 renamed to PSDatabaseClone.psm1

@@ -6,27 +6,27 @@ function Import-ModuleFile
 	<#
 		.SYNOPSIS
 			Loads files into the module on module import.
-		
+
 		.DESCRIPTION
 			This helper function is used during module initialization.
 			It should always be dotsourced itself, in order to proper function.
-			
+
 			This provides a central location to react to files being imported, if later desired
-		
+
 		.PARAMETER Path
 			The path to the file to load
-		
+
 		.EXAMPLE
 			PS C:\> . Import-ModuleFile -File $function.FullName
-	
+
 			Imports the file stored in $function according to import policy
 	#>
 	[CmdletBinding()]
 	Param (
 		[string]
 		$Path
 	)
-	
+
 	if ($doDotSource) { . $Path }
 	else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($Path))), $null, $null) }
 }

functions/Get-PDCClone.ps1

@@ -0,0 +1,143 @@
+function Get-PDCClone {
+<#
+.SYNOPSIS
+    Get-PDCClone get on or more clones
+
+.DESCRIPTION
+    Get-PDCClone will retrieve the clones and apply filters if needed.
+    By default all the clones are returned
+
+.PARAMETER HostName
+    Filter based on the hostname
+
+.PARAMETER Database
+    Filter based on the database
+
+.PARAMETER ImageID
+    Filter based on the image id
+
+.PARAMETER ImageName
+    Filter based on the image name
+
+.PARAMETER ImageLocation
+    Filter based on the image location
+
+.NOTES
+    Author: Sander Stad (@sqlstad, sqlstad.nl)
+
+    Website: https://psdatabaseclone.io
+    Copyright: (C) Sander Stad, [email protected]
+    License: MIT https://opensource.org/licenses/MIT
+
+.LINK
+    https://psdatabaseclone.io/
+
+.EXAMPLE
+    Get-PDCClone -HostName host1, host2
+
+    Retrieve the clones for host1 and host2
+
+.EXAMPLE
+    Get-PDCClone -Database DB1
+
+    Get all the clones that have the name DB1
+
+.EXAMPLE
+    Get-PDCClone -ImageName DB1_20180703085917
+
+    Get all the clones that were made with image "DB1_20180703085917"
+#>
+
+    [CmdLetBinding()]
+
+    param(
+        [string[]]$HostName,
+        [string[]]$Database,
+        [int[]]$ImageID,
+        [string[]]$ImageName,
+        [string[]]$ImageLocation
+    )
+
+    begin {
+
+        # Test the module database setup
+        try {
+            Test-PDCConfiguration -EnableException
+        }
+        catch {
+            Stop-PSFFunction -Message "Something is wrong in the module configuration" -ErrorRecord $_ -Continue
+        }
+
+        $pdcSqlInstance = Get-PSFConfigValue -FullName psdatabaseclone.database.server
+        $pdcDatabase = Get-PSFConfigValue -FullName psdatabaseclone.database.name
+
+    }
+
+    process {
+
+        # Test if there are any errors
+        if (Test-PSFFunctionInterrupt) { return }
+
+        $query = "
+            SELECT c.CloneID,
+                c.CloneLocation,
+                c.AccessPath,
+                c.SqlInstance,
+                c.DatabaseName,
+                c.IsEnabled,
+                i.ImageID,
+                i.ImageName,
+                i.ImageLocation,
+                h.HostName
+            FROM dbo.Clone AS c
+                INNER JOIN dbo.Host AS h
+                    ON h.HostID = c.HostID
+                INNER JOIN dbo.Image AS i
+                    ON i.ImageID = c.ImageID;
+            "
+
+        try {
+            $results = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query -As PSObject
+        }
+        catch {
+            Stop-PSFFunction -Message "Could not execute query" -ErrorRecord $_ -Target $query
+        }
+
+        # Filter host name
+        if($HostName){
+            $results = $results | Where-Object {$_.HostName -in $HostName}
+        }
+
+        # Filter image id
+        if($Database){
+            $results = $results | Where-Object {$_.DatabaseName -in $Database}
+        }
+
+        # Filter image id
+        if($ImageID){
+            $results = $results | Where-Object {$_.ImageID -in $ImageID}
+        }
+
+        # Filter image name
+        if($ImageName){
+            $results = $results | Where-Object {$_.ImageName -in $ImageName}
+        }
+
+        # Filter image location
+        if($ImageLocation){
+            $results = $results | Where-Object {$_.ImageLocation -in $ImageLocation}
+        }
+
+        return $results
+    }
+
+    end {
+
+        # Test if there are any errors
+        if (Test-PSFFunctionInterrupt) { return }
+
+        Write-PSFMessage -Message "Finished retrieving clone(s)" -Level Verbose
+
+    }
+
+}

functions/Initialize-PdcVhdDisk.ps1 renamed to functions/Initialize-PDCVhdDisk.ps1

@@ -1,10 +1,10 @@
-function Initialize-PdcVhdDisk {
+function Initialize-PDCVhdDisk {
 <#
 .SYNOPSIS
-    Initialize-PdcVhdDisk initialized the VHD
+    Initialize-PDCVhdDisk initialized the VHD
 
 .DESCRIPTION
-    Initialize-PdcVhdDisk will initialize the VHD.
+    Initialize-PDCVhdDisk will initialize the VHD.
     It mounts the disk, creates a volume, creates the partition and sets it to active
 
 .PARAMETER Path
@@ -15,6 +15,17 @@ function Initialize-PdcVhdDisk {
 
     $scred = Get-Credential, then pass $scred object to the -Credential parameter.
 
+.PARAMETER EnableException
+    By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
+    This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
+    Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
+
+.PARAMETER WhatIf
+    If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
+
+.PARAMETER Confirm
+    If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
+
 .NOTES
     Author: Sander Stad (@sqlstad, sqlstad.nl)
 
@@ -26,12 +37,12 @@ function Initialize-PdcVhdDisk {
     https://psdatabaseclone.io/
 
 .EXAMPLE
-    Initialize-PdcVhdDisk -Path $path
+    Initialize-PDCVhdDisk -Path $path
 
     Initialize the disk pointing to the path with all default settings
 
 .EXAMPLE
-    Initialize-PdcVhdDisk -Path $path -AllocationUnitSize 4KB
+    Initialize-PDCVhdDisk -Path $path -AllocationUnitSize 4KB
 
     Initialize the disk and format the partition with a 4Kb allocation unit size
 
@@ -46,7 +57,8 @@ function Initialize-PdcVhdDisk {
         $Credential,
         [ValidateSet('GPT', 'MBR')]
         [string]$PartitionStyle = 'GPT',
-        [int]$AllocationUnitSize = 64KB
+        [int]$AllocationUnitSize = 64KB,
+        [switch]$EnableException
     )
 
     begin {
@@ -106,7 +118,6 @@ function Initialize-PdcVhdDisk {
 
         # Add the results to the custom object
         [PSCustomObject]@{
-            DiskNumber = $disk.DiskNumber
             Disk       = $disk
             Partition  = (Get-Partition -Disk $disk)
             Volume     = $volume

functions/Invoke-PdcRepairClone.ps1 renamed to functions/Invoke-PDCRepairClone.ps1

@@ -1,10 +1,10 @@
-function Invoke-PdcRepairClone {
+function Invoke-PDCRepairClone {
 <#
 .SYNOPSIS
-    Invoke-PdcRepairClone repairs the clones
+    Invoke-PDCRepairClone repairs the clones
 
 .DESCRIPTION
-    Invoke-PdcRepairClone has the ability to repair the clones when they have gotten disconnected from the image.
+    Invoke-PDCRepairClone has the ability to repair the clones when they have gotten disconnected from the image.
     In such a case the clone is no longer available for the database server and the database will either not show
     any information or the database will have the status (Recovery Pending).
 
@@ -21,6 +21,17 @@ function Invoke-PdcRepairClone {
     Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
     To connect as a different Windows user, run PowerShell as that user.
 
+.PARAMETER EnableException
+    By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
+    This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
+    Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
+
+.PARAMETER WhatIf
+    If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
+
+.PARAMETER Confirm
+    If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
+
 .NOTES
     Author: Sander Stad (@sqlstad, sqlstad.nl)
 
@@ -32,7 +43,7 @@ function Invoke-PdcRepairClone {
     https://psdatabaseclone.io/
 
 .EXAMPLE
-    Invoke-PdcRepairClone -Hostname Host1
+    Invoke-PDCRepairClone -Hostname Host1
 
     Repair the clones for Host1
 
@@ -42,20 +53,23 @@ function Invoke-PdcRepairClone {
     param(
         [Parameter(Mandatory = $true)]
         [string[]]$HostName,
-
         [System.Management.Automation.PSCredential]
-        $SqlCredential
+        $SqlCredential,
+        [switch]$EnableException
     )
 
     begin {
         # Test the module database setup
-        $result = Test-PdcConfiguration
-
-        if(-not $result.Check){
-            Stop-PSFFunction -Message $result.Message -Target $result -Continue
-            return
+        try {
+            Test-PDCConfiguration -EnableException
+        }
+        catch {
+            Stop-PSFFunction -Message "Something is wrong in the module configuration" -ErrorRecord $_ -Continue
         }
 
+        $pdcSqlInstance = Get-PSFConfigValue -FullName psdatabaseclone.database.server
+        $pdcDatabase = Get-PSFConfigValue -FullName psdatabaseclone.database.name
+
     }
 
     process {
@@ -84,10 +98,10 @@ function Invoke-PdcRepairClone {
             # Get the clones registered for the host
             try {
                 Write-PSFMessage -Message "Get the clones for host $hst" -Level Verbose
-                $results = Invoke-DbaSqlQuery -SqlInstance $ecDatabaseServer -Database $ecDatabaseName -Query $query
+                $results = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query
             }
             catch {
-                Stop-PSFFunction -Message "Couldn't get the clones for $hst" -Target $ecDatabaseServer -ErrorRecord $_ -Continue
+                Stop-PSFFunction -Message "Couldn't get the clones for $hst" -Target $pdcSqlInstance -ErrorRecord $_ -Continue
             }
 
             # Loop through the results