TestimoX

API Reference

Command

Get-CxSmbShareDiagnostic

Namespace ComputerX.PowerShell
Inputs
System.String System.String[]
Outputs
ComputerX.Smb.SmbShareDiagnosticResult

Returns end-to-end SMB share diagnostics including share permissions, NTFS share-root permissions, and optional open-file evidence.

Examples

Authored help example

Example 1: Diagnoses all non-administrative shares on the local computer.

PS>


Get-CxSmbShareDiagnostic
        

Example 2: Diagnoses a single share on a remote file server and includes open-file evidence.

PS>


Get-CxSmbShareDiagnostic -ComputerName FS01 -ShareName Finance -IncludeOpenFiles
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-CxSmbShareDiagnostic [-ComputerName <string>] [-ShareName <string[]>] [-IncludeOpenFiles] [-IncludeSpecialShares] [-Provider <Auto|Native|Wmi>] [-SkipNtfsAcl] [<CommonParameters>]
#

Parameters

ComputerName string optionalposition: 0pipeline: true (ByValue, ByPropertyName)
Target computer name. Use . for the local machine or provide a DNS/NetBIOS name.
ShareName string[] optionalposition: 1pipeline: true (ByPropertyName)
Optional share-name filter. When omitted, all non-special shares are diagnosed.
IncludeOpenFiles SwitchParameter optionalposition: namedpipeline: false
Includes current open files reported by the SMB server service.
IncludeSpecialShares SwitchParameter optionalposition: namedpipeline: false
Includes hidden administrative and special shares when no share-name filter is supplied.
Provider SmbShareCollectionProvider optionalposition: namedpipeline: falsevalues: 3
Provider used for share metadata and share ACL collection. Possible values: Auto, Native, Wmi
Possible values: Auto, Native, Wmi
SkipNtfsAcl SwitchParameter optionalposition: namedpipeline: false
Skips NTFS share-root ACL collection.

Outputs

ComputerX.Smb.SmbShareDiagnosticResult