Edit

Share via


Debug-FileShare

Finds problems with a file share and recommends solutions.

Syntax

ByName (Default)

Debug-FileShare
    [-Name] <String[]>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByUniqueId

Debug-FileShare
    -UniqueId <String[]>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

InputObject

Debug-FileShare
    -InputObject <CimInstance>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Debug-FileShare cmdlet finds problems with a file share and recommends solutions.

Examples

Example 1: Debug a file share by using the pipeline

PS C:\>Get-FileShare | Debug-FileShare
EventTime                 :
FaultId                   : 0ef62dbe-657a-483e-a248-7c5c1dc82477
FaultingObject            :
FaultingObjectDescription : Storage appliance server '{ac906082-8b7e-44fc-b9e5-7bd8aa749958}:SN:GalenB-VM6'.
FaultingObjectLocation    :
FaultType                 : ServerDownFault
PerceivedSeverity         : Minor
Reason                    : The server cannot be reached.
RecommendedActions        : {Start or replace storage server.}
PSComputerName            :

This command gets any faults and remediation actions associated with all file shares local to the Windows PowerShell session.

Example 2: Debug a file share by name

PS C:\>Debug-FileShare -Name "ContosoShare"
EventTime                 :
FaultId                   : 0ef62dbe-657a-483e-a248-7c5c1dc82477
FaultingObject            :
FaultingObjectDescription : Storage appliance server '{ac906082-8b7e-44fc-b9e5-7bd8aa749958}:SN:GalenB-VM6'.
FaultingObjectLocation    :
FaultType                 : ServerDownFault
PerceivedSeverity         : Minor
Reason                    : The server cannot be reached.
RecommendedActions        : {Start or replace storage server.}
PSComputerName            :

This command gets any faults and remediation actions associated the file share named ContosoShare.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Parameter properties

Type:CimSession
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the input object that is used in a pipeline command.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the file share about which you want to get information.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UniqueId

Specifies the ID of the file share about which you want to get information.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByUniqueId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CimInstance

Outputs

CimInstance

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).