MSFT_FileServer class

Models the Windows operating system's concept of a file server.

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

Syntax

class MSFT_FileServer : MSFT_StorageObject
{
  String  FriendlyName;
  String  HostNames[];
  UInt16  HealthStatus;
  UInt16  OperationalStatus[];
  String  OtherOperationalStatusDescription;
  Boolean SupportsFileShareCreation;
  Boolean SupportsContinuouslyAvailableFileShare;
  UInt16  FileSharingProtocols[];
  String  FileSharingProtocolVersions[];
};

Members

The MSFT_FileServer class has these types of members:

Methods

The MSFT_FileServer class has these methods.

Method Description
CreateFileShare Creates a file share on the file server.
DeleteObject Deletes the file server.
SetFriendlyName Allows the file server to be renamed.

Properties

The MSFT_FileServer class has these properties.

FileSharingProtocols

Data type: UInt16 array

Access type: Read-only

The file sharing protocols supported by the file server.

NFS (2)

SMB (3)

FileSharingProtocolVersions

Data type: String array

Access type: Read-only

Specifies the file sharing protocol versions supported.

FriendlyName

Data type: String

Access type: Read-only

Qualifiers: Required

A user-friendly string representing the name of the file server. Some servers may assign a default friendly name which cannot be modified by the user.

HealthStatus

Data type: UInt16

Access type: Read-only

Qualifiers: Required

Denotes the current health status of the file server.

Healthy (0)

Warning (1)

Unhealthy (2)

Unknown (5)

HostNames

Data type: String array

Access type: Read-only

Qualifiers: Required

Host names are semi-unique (scoped to the owning storage subsystem), human-readable strings used to identify a file server. There is a separate host name element per file sharing protocol.

OperationalStatus

Data type: UInt16 array

Access type: Read-only

Qualifiers: Required

An array of values that denote the current operational status of the file server. Unlike HealthStatus, this field indicates the status of hardware, software, and infrastructure issues related to this server, and can contain multiple values.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

Predictive Failure (5)

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

In Service (11)

No Contact (12)

Lost Communication (13)

Aborted (14)

Dormant (15)

Supporting Entity in Error (16)

Completed (17)

Power Mode (18 )

Relocating (19 )

Microsoft Reserved (..)

Read-only (0xD000)

Incomplete (0xD001)

Microsoft Reserved (0xD001..)

OtherOperationalStatusDescription

Data type: String

Access type: Read-only

A string representation of the vendor-defined operational status. This field should only be set if the OperationalStatus array contains 1 ("Other").

SupportsContinuouslyAvailableFileShare

Data type: Boolean

Access type: Read-only

If TRUE, the file server will support continuously available file shares.

SupportsFileShareCreation

Data type: Boolean

Access type: Read-only

If TRUE, the server supports file share creation.

Requirements

Minimum supported client
Windows 10 [desktop apps only]
Minimum supported server
Windows Server 2016 [desktop apps only]
Namespace
Root\Microsoft\Windows\Storage
MOF
Storagewmi.mof

See also

MSFT_StorageObject