Get-SmbWitnessClient
Get-SmbWitnessClient
Retrieves information about the Server Message Block (SMB) clients connected to the SMB witness servers in a cluster.
Syntax
Parameter Set: Query (cdxml)
Get-SmbWitnessClient [[-ClientName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-State <State[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-SmbWitnessClient cmdlet retrieves information about Server Message Block (SMB) witness client registrations with SMB witness servers in a failover cluster. SMB witness clients can register for notification for multiple resources in the failover cluster, so there may be multiple entries for the same SMB witness client.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ClientName<String[]>
Specifies one or more SMB clients by name.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-State<State[]>
Specifies that the output is filtered based on the state of the Server Message Block (SMB) witness client registrations with SMB witness servers in a failover cluster.
The acceptable values for this parameter are: Connected, Registered, RequestedNotifications, Cancelled, Disconnected or Unknown.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example retrieves information about the all of the SMB clients connected to the SMB witness servers in a cluster.
PS C:\> Get-SmbWitnessClient
EXAMPLE 2
This example retrieves information about the SMB client named Server1 connected to the SMB witness servers in a cluster.
PS C:\> Get-SmbWitnessClient -ClientName Server1