Get-SmbWitnessClient
Retrieves information about the SMB clients connected to the SMB witness servers in a cluster.
Syntax
Default (Default)
Get-SmbWitnessClient
[[-ClientName] <String[]>]
[-State <State[]>]
[-Flags <Flags[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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.
Examples
Example 1: Get information about all the SMB clients for the witness servers in a cluster
PS C:\> Get-SmbWitnessClient
Client Computer Name Witness Node Name File Server Node Name Network Name Share Name
-------------------- ----------------- --------------------- ------------ ----------
Server01 FileServer1 FileServer2 FSCluster Share
Server02 FileServer2 FileServer1 FSCluster Share
Server02 FileServer2 FileServer1 FSCluster
This example retrieves information about the all of the SMB clients connected to the SMB witness servers in a cluster.
Example 2: Get information about a named SMB client
PS C:\>Get-SmbWitnessClient -ClientName "Server01"
Client Computer Name Witness Node Name File Server Node Name Network Name Share Name
-------------------- ----------------- --------------------- ------------ ----------
Server01 FileServer1 FileServer2 FSCluster Share
This example retrieves information about the SMB client named Server01 connected to the SMB witness servers in a cluster.
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 |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ClientName
Specifies one or more SMB clients by name.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Flags
Specifies an array of flags.
Parameter properties
| Type: | Flags[] |
| Default value: | None |
| Accepted values: | Invalid, NetworkName, ShareName, MultiChannel |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-State
Specifies that the output is filtered based on the state of the SMB witness client registrations with SMB witness servers in a failover cluster. The acceptable values for this parameter are:
- Connected
- Registered
- RequestedNotifications
- Cancelled
- Disconnected
- Unknown
Parameter properties
| Type: | State[] |
| Default value: | None |
| Accepted values: | Unknown, Connected, Registered, RequestedNotifications, Cancelled, Disconnected |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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 |
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.