Export (0) Print
Expand All

MSFT_SmbWitnessClient class

Represents an SMB witness client.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

class MSFT_SmbWitnessClient
{
  string ClientName;
  string WitnessNodeName;
  string FileServerNodeName;
  string NetworkName;
  string ShareName;
  string IpAddress;
  string State;
  uint32 Flags;
  uint32 ResourcesMonitored;
  uint32 NotificationsSent;
  uint32 NotificationsCancelled;
  uint32 QueuedNotifications;
};

Members

The MSFT_SmbWitnessClient class has these types of members:

Methods

The MSFT_SmbWitnessClient class has these methods.

MethodDescription
MoveClient

Moves an SMB witness client that is connected to a scale-out cluster node to a different scale-out cluster node.

 

Properties

The MSFT_SmbWitnessClient class has these properties.

ClientName
Data type: string
Access type: Read-only
Qualifiers: Key

The fully qualified domain name of the SMB witness client.

FileServerNodeName
Data type: string
Access type: Read-only

The file server node name.

Flags
Data type: uint32
Access type: Read-only
Qualifiers: BitMap ("1","2","3") , BitValues ("7","8","9")

The flags for the client.

Windows Server 2012 and Windows 8:  This property is not supported before Windows Server 2012 R2 and Windows 8.1.

IpAddress
Data type: string
Access type: Read-only

The IP address for which the client needs to receive notifications.

NetworkName
Data type: string
Access type: Read-only

The network name.

NotificationsCancelled
Data type: uint32
Access type: Read-only

The number of notifications that have been canceled.

NotificationsSent
Data type: uint32
Access type: Read-only

The number of notifications that have been sent to the client.

QueuedNotifications
Data type: uint32
Access type: Read-only

The number of notifications that are currently queued for the client.

ResourcesMonitored
Data type: uint32
Access type: Read-only

The number of resources that are currently being monitored for the client.

ShareName
Data type: string
Access type: Read-only

The share name.

Windows Server 2012 and Windows 8:  This property is not supported before Windows Server 2012 R2 and Windows 8.1.

State
Data type: string
Access type: Read-only

The state of this witness registration.

"Unknown" (0)
"Connected" (1)
"Registered" (2)
"Requested notification" (3)
"Cancelled" (4)
"Disconnected" (5)
WitnessNodeName
Data type: string
Access type: Read-only

The witness node name.

Remarks

SMB witness is a feature that does the following:

  • Accelerates recovery from an unplanned failure by alerting SMB clients that have registered for notification when a failure has occurred, rather than forcing the client to wait for a timeout.
  • Enables the system administrator to redirect a client from one cluster node to another in a SMB Scale-Out file server cluster to a different scale-out cluster node for load balancing or other administrative purposes.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

\root\Microsoft\Windows\SmbWitness

MOF

SmbWitnessWmiv2Provider.mof

DLL

SmbWitnessWmiv2Provider.dll

See also

SMB Management API

 

 

Show:
© 2014 Microsoft