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-ClusterFileServerRole

Add-ClusterFileServerRole

microsoft.failoverclusters.powershell.dll

Synopsis

Creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users).

Syntax

Add-ClusterFileServerRole [-Name] [-Cluster] [-IgnoreNetwork] [-InputObject] [-StaticAddress] [-Wait] [-Storage] [<CommonParameters>]

Detailed Description

The Add-ClusterFileServerRole cmdlet creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users).

When adding a clustered file server, specify a name for the file server, any IP address information that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the clustered file server should use.

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

-IgnoreNetwork <StringCollection>

Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.

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 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 file server to create.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-StaticAddress <StringCollection>

Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Storage <StringCollection>

Specifies the cluster disk resource to be added to the created highly available file server.

Aliases

None

Required?

true

Position

named

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 clustered file server using Cluster Disk 8, and assigns a default name.

PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8"
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS                 node1                              Online 

Example 2

This example creates a clustered file server using Cluster Disk 6, and assigns the name cluster1FS12.

PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 6" -Name cluster1FS12
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS12               node1                              Online 

Example 3

This example creates a clustered file server using Cluster Disk 8, and assigns a default name. The cmdlet completes without waiting for all resources to come online.

PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Wait 0
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS                 node1                             Pending 

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