Get-DbaFilestream

Stuart Moore (@napalmgram) , Chrissy LeMaire (@cl)

Windows, Linux, macOS

Synopsis

Retrieves FileStream configuration status at both the SQL Server service and instance levels.

Retrieves FileStream configuration status by checking both the SQL Server service configuration and the instance-level sp_configure settings. This function helps DBAs quickly identify FileStream configuration mismatches between service and instance levels, which are common causes of FileStream functionality issues. The function returns detailed access levels, share names, and indicates whether a restart is pending to apply configuration changes.

Syntax

Get-DbaFilestream
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Credential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaFilestream -SqlInstance server1\instance2

Will return the status of Filestream configuration for the service and instance server1\instance2

Example: 2

PS C:\> Get-DbaFilestream -SqlInstance server1\instance2 -SqlCredential sqladmin

Prompts for the password to the SQL Login “sqladmin” then returns the status of Filestream configuration for the service and instance server1\instance2

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Property	Value
Alias
Required	False
Pipeline	true (ByValue)
Default Value

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

Property	Value
Alias
Required	False
Pipeline	false
Default Value

-Credential

Property	Value
Alias
Required	False
Pipeline	false
Default Value

-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.

Property	Value
Alias
Required	False
Pipeline	false
Default Value	False

Outputs

PSCustomObject

Returns one object per instance queried, containing both service-level and instance-level FileStream configuration status.

Default display properties (via Select-DefaultView):

ComputerName: The name of the computer hosting the SQL Server instance
InstanceName: The SQL Server instance name
SqlInstance: The full SQL Server instance name (computer\instance)
InstanceAccess: Human-readable description of instance-level FileStream access (Disabled, T-SQL access enabled, or Full access enabled)
ServiceAccess: Human-readable description of service-level FileStream access (Disabled, FileStream enabled for T-SQL access, FileStream enabled for T-SQL and IO streaming access, or FileStream enabled for T-SQL, IO streaming, and remote clients)
ServiceShareName: The Windows file share name used for FileStream when service-level access is enabled

*Additional properties available (via Select-Object ):

InstanceAccessLevel: Numeric code for instance-level FileStream access (0-2)
ServiceAccessLevel: Numeric code for service-level FileStream access (0-3)
Credential: The Windows credentials used for service-level queries (passed from -Credential parameter)
SqlCredential: The SQL Server credentials used for instance-level queries (passed from -SqlCredential parameter)