Add-ClusterFileServerRole

  • Article

Add-ClusterFileServerRole

Create a clustered file server (resource group that includes one or more disks, on which you can create shared folders for users).

Syntax

Add-ClusterFileServerRole [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [-IgnoreNetwork <StringCollection>] [-StaticAddress <StringCollection>] [-Storage <StringCollection>] [-Wait <int>] [<CommonParameters>]

  • InputObject

  • Name

  • Cluster

  • IgnoreNetwork

  • StaticAddress

  • Storage

  • Wait

Detailed Description

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.

Parameters

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

IgnoreNetwork

Specifies which networks to ignore during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster to create the highly available file server on.

Default Value: **

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the name of the cluster highly available file server to create.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

StaticAddress

Specifies the static address(es) to use during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Storage

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

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Wait

Specifies the time in seconds to wait for the operation. If this parameter is not specified the operation waits for completion. If "-Wait 0" is specified the call is initiated and the cmdlet returns right away.

Default Value: **

Data Type: int

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterFileServerRole -Storage "Cluster Disk 8" 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS                 node1                              Online

Description

-----------

This command creates a clustered file server using Cluster Disk 8, and assigns a default name.

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterFileServerRole -Storage "Cluster Disk 6" -Name cluster1FS12 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS12               node1                              Online

Description

-----------

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

 

-------------------------- EXAMPLE 3 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Wait 0 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1FS                 node1                             Pending

Description

-----------

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

See Also

Reference

Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup

Other Resources

Online version: