Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-ClusterScaleOutFileServerRole

Add-ClusterScaleOutFileServerRole

microsoft.failoverclusters.powershell.dll

Synopsis

Creates a clustered file server for scale-out application data.

Syntax

Add-ClusterScaleOutFileServerRole [-Name] [-Cluster] [-InputObject] [-Wait] [<CommonParameters>]

Detailed Description

The Add-ClusterScaleOutFileServerRole cmdlet creates a clustered file server for scale-out application data. A file server for scale-out application data provides storage for applications or virtual machines that leave files open for extended periods of time. Client connections are distributed across nodes for better throughput. This type of file server supports the Server Message Block (SMB) protocol. It does not support the Network File System (NFS) protocol, or certain role services such as File Server Resource Manager (FSRM) or Distributed File System (DFS) Replication.

Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.

Parameters

-Cluster <String>

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the cluster on which to create the highly available scale-out file server.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the highly available scale-out file server being created.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Wait <Int32>

Specifies the time in seconds to wait for the cmdlet. If the Wait parameter is not specified, then the cmdlet waits for completion. If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Notes

None

Examples

Example 1

This example creates a highly available Scale-out file server role.

PS C:\>Add-ClusterScaleOutFileServerRole
Name                                    OwnerNode                               State 
----                                    ---------                               ----- 
clusterSOFS                             CLUSTER-N2                              Online 

Example 2

This example creates a highly available scale out file server role. The cmdlet completes without waiting for all resources to come online.

PS C:\>Add-ClusterScaleOutFileServerRole -Wait 0
Name                                    OwnerNode                               State 
----                                    ---------                               ----- 
clusterSOFS                             CLUSTER-N2                              Pending 

Online Version
Add-ClusterFileServerRole
Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup