functions/Enable-DbaFilestream.ps1
|
#ValidationTags#CodeStyle,Messaging,FlowControl,Pipeline# function Enable-DbaFilestream { <# .SYNOPSIS Enables FileStream on specified SQL Server instances .DESCRIPTION Connects to the specified SQL Server instances, and Enables the FileStream feature to the required value To perform the action, the SQL Server instance must be restarted. By default we will prompt for confirmation for this action, this can be overridden with the -Force switch .PARAMETER SqlInstance The target SQL Server instance or instances. Defaults to localhost. .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Credential Login to the target server using alternative credentials. .PARAMETER FileStreamLevel The level to of FileStream to be enabled: 1 or TSql - T-Sql Access Only 2 or TSqlIoStreaming - T-Sql and Win32 access enabled 3 or TSqlIoStreamingRemoteClient T-Sql, Win32 and Remote access enabled .PARAMETER ShareName Specifies the Windows file share name to be used for storing the FILESTREAM data. .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 Force Restart SQL Instance after changes. Use this parameter with care as it overrides whatif. .PARAMETER WhatIf Shows what would happen if the command runs. The command is not run unless Force is specified. .PARAMETER Confirm Prompts you for confirmation before running the command. .NOTES Tags: Filestream Author: Stuart Moore ( @napalmgram ) | Chrissy LeMaire ( @cl ) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .EXAMPLE PS C:\> Enable-DbaFilestream -SqlInstance server1\instance2 -FileStreamLevel TSql PS C:\> Enable-DbaFilestream -SqlInstance server1\instance2 -FileStreamLevel 1 These commands are functionally equivalent, both will set Filestream level on server1\instance2 to T-Sql Only .EXAMPLE PS C:\> Get-DbaFilestream -SqlInstance server1\instance2, server5\instance5, prod\hr | Where-Object InstanceAccessLevel -eq 0 | Enable-DbaFilestream -FileStreamLevel TSqlIoStreamingRemoteClient -Force Using this pipeline you can scan a range of SQL instances and enable filestream on only those on which it's disabled. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = "Medium")] param ( [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [DbaInstance[]]$SqlInstance, [Parameter(ValueFromPipelineByPropertyName)] [PSCredential]$SqlCredential, [Parameter(ValueFromPipelineByPropertyName)] [PSCredential]$Credential, [ValidateSet("TSql", "TSqlIoStreaming", "TSqlIoStreamingRemoteClient", 1, 2, 3)] [string]$FileStreamLevel = 1, [string]$ShareName, [switch]$Force, [switch]$EnableException ) begin { if ($FileStreamLevel -notin (1, 2, 3)) { $FileStreamLevel = switch ($FileStreamLevel) { "TSql" { 1 } "TSqlIoStreaming" { 2 } "TSqlIoStreamingRemoteClient" { 3 } } } # = $finallevel removed as it was identified as a unused variable $level = [int]$FileStreamLevel $OutputLookup = @{ 0 = 'Disabled' 1 = 'FileStream enabled for T-Sql access' 2 = 'FileStream enabled for T-Sql and IO streaming access' 3 = 'FileStream enabled for T-Sql, IO streaming, and remote clients' } } process { if ($ShareName -and $level -lt 2) { Stop-Function -Message "Filestream must be at least level 2 when using ShareName" return } foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential } catch { Stop-Function -Message "Failure connecting to $computer" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue } $filestreamstate = [int]$server.Configuration.FilestreamAccessLevel.ConfigValue if ($Force -or $PSCmdlet.ShouldProcess($instance, "Changing from '$($OutputLookup[$filestreamstate])' to '$($OutputLookup[$level])' at the instance level")) { # Server level if ($server.IsClustered) { $nodes = Get-DbaWsfcNode -ComputerName $instance foreach ($node in $nodes.Name) { $result = Set-FileSystemSetting -Instance $node -Credential $Credential -ShareName $ShareName -FilestreamLevel $level } } else { $result = Set-FileSystemSetting -Instance $instance -Credential $Credential -ShareName $ShareName -FilestreamLevel $level } # Instance level if ($level -eq 3) { $level = 2 } try { $null = Set-DbaSpConfigure -SqlInstance $server -Name FilestreamAccessLevel -Value $level -EnableException } catch { Stop-Function -Message "Failure" -ErrorRecord $_ -Continue } if ($Force) { #$restart replaced with $null as it was identified as a unused variable $null = Restart-DbaService -ComputerName $server.ComputerName -InstanceName $server.ServiceName -Type Engine -Force } Get-DbaFilestream -SqlInstance $instance -SqlCredential $SqlCredential -Credential $Credential if ($filestreamstate -ne $level -and -not $Force) { Write-Message -Level Warning -Message "[$instance] $result" } } } } } |