Add-ClusterScaleOutFileServerRole
Creates a clustered file server for scale-out application data.
Syntax
Default (Default)
Add-ClusterScaleOutFileServerRole
[[-Name] <String>]
[-Wait <Int32>]
[-Infrastructure]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
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.
Examples
Example 1
PS C:\> Add-ClusterScaleOutFileServerRole
Name OwnerNode State
---- --------- -----
clusterSOFS CLUSTER-N2 Online
This example creates a highly available scale-out file server role.
Example 2
PS C:\> Add-ClusterScaleOutFileServerRole -Wait 0
Name OwnerNode State
---- --------- -----
clusterSOFS CLUSTER-N2 Pending
This example creates a highly available scale-out file server role. The cmdlet completes without waiting for all resources to come online.
Example 3
Add-ClusterScaleOutFileServerRole -Cluster MyCluster -Infrastructure -Name InfraSOFSName
This example creates an infrastructure file server scale-out file server role. It automatically creates a single namespace share for the CSV drive (such as \\InfraSOFSName\Volume1). In hyper-converged configurations, an infrastructure scale-out file server allows an SMB client (Hyper-V host) to communicate with guaranteed continuous availability with the infrastructure scale-out SMB file server. There can be at most only one infrastructure scale-out file server cluster role on a failover cluster.
Parameters
-Cluster
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.
Parameter properties
| Type: | String |
| 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 |
-Infrastructure
Specifies whether to create an infrastructure file server scale-out file server role.
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 |
-InputObject
Specifies the cluster on which to create the highly available scale-out file server.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the highly available scale-out file server being created.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Wait
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.
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.