Share via

Install-SCStorageFileServer

  • Reference
Module:
VirtualMachineManager

Installs failover clustering and a file server on a set of computers.

Syntax

Install-SCStorageFileServer
       -PhysicalComputerConfig <PhysicalComputerConfig[]>
       -ClusterName <String>
       -ScaleoutFileServerName <String>
       [-ClusterIPAddress <String[]>]
       [-SkipClusterValidation]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]
Install-SCStorageFileServer
       -PhysicalComputerConfig <PhysicalComputerConfig[]>
       -StorageFileServer <StorageFileServer>
       [-SkipClusterValidation]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]
Install-SCStorageFileServer
       -AddExistingComputer <String[]>
       -StorageFileServer <StorageFileServer>
       [-SkipClusterValidation]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]
Install-SCStorageFileServer
       -AddExistingComputer <String[]>
       -ClusterName <String>
       -ScaleoutFileServerName <String>
       [-ClusterIPAddress <String[]>]
       -RunAsAccount <RunAsAccount>
       [-SkipClusterValidation]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Description

The Install-SCStorageFileServer cmdlet installs failover clustering and a file server on a set of computers. The computers can be provisioned by Virtual Machine Manager (VMM) by using an Open Software Descriptor (OSD) or they can already have an operating system installed.

Examples

Example 1: Create file server with shared storage

PS C:\> $RunAsAcct = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> Install-SCStorageFileServer -ClusterName "Cluster01" -ScaleoutFileServerName "SOFS01" -RunAsAccount $RunAsAcct -AddExistingComputer @("node1", "node2") -RunAsynchronously

The first command gets the Run As account named RunAsAccount01, and then stores it in the $RunAsAcct variable.

The second command creates file server with the cluster named Cluster01 and file server role SOFS01.

Example 2: Create file server with storage spaces direct

PS C:\> $RunAsAcct = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> Install-SCStorageFileServer -ClusterName "Cluster01" -ScaleoutFileServerName "SOFS01" -RunAsAccount $RunAsAcct -AddExistingComputer @("node1", "node2") -RunAsynchronously -EnableS2D

The first command gets the Run As account named RunAsAccount01, and then stores it in the $RunAsAcct variable.

The second command creates a file server with the cluster named Cluster01 and file server role SOFS01. The command includes the EnableS2D parameter.

Parameters

-AddExistingComputer

Specifies an array of computers that this cmdlet adds. Specify the fully qualified domain names (FQDN), NetBIOS names, or IP addresses of servers on the network that have an operating system.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ClusterIPAddress

Specifies an array of IP addresses to use as a cluster IP address.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClusterName

Specifies the name for the cluster.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EnableS2D

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies a variable in which job progress is tracked and stored.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PhysicalComputerConfig

Specifies an array of host configuration objects. For information about host configuration objects, see the New-SCVMHostConfig cmdlet.

Type:PhysicalComputerConfig[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsAccount

Specifies a Run As account that contains credentials with permission to perform this action.

Type:RunAsAccount
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScaleoutFileServerName

Specifies the name of a scale-out file server role.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SkipClusterValidation

Indicates that this cmdlet skips cluster validation tests when it creates a cluster.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageFileServer

Specifies a storage file server object.

Type:StorageFileServer
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

StorageFileServer

This cmdlet returns a StorageFileServer object.