Install-SCStorageFileServer

Module:

VirtualMachineManager Module

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

Syntax

UseBareMetalMachines

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

AddNodesUsingBareMetalMachines

Install-SCStorageFileServer
    -PhysicalComputerConfig <PhysicalComputerConfig[]>
    -StorageFileServer <StorageFileServer>
    [-SkipClusterValidation]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

AddNodesUsingExistingServers

Install-SCStorageFileServer
    -AddExistingComputer <String[]>
    -StorageFileServer <StorageFileServer>
    [-SkipClusterValidation]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

UseExistingServers

Install-SCStorageFileServer
    -AddExistingComputer <String[]>
    -ClusterName <String>
    -ScaleoutFileServerName <String>
    -RunAsAccount <RunAsAccount>
    [-ClusterIPAddress <String[]>]
    [-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.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AddNodesUsingExistingServers

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UseExistingServers

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClusterIPAddress

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

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseBareMetalMachines

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UseExistingServers

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClusterName

Specifies the name for the cluster.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseBareMetalMachines

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UseExistingServers

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-EnableS2D

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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseBareMetalMachines

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UseExistingServers

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-JobVariable

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

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

-PhysicalComputerConfig

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

Parameter properties

Type:	PhysicalComputerConfig[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseBareMetalMachines

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

AddNodesUsingBareMetalMachines

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	Guid
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

-RunAsAccount

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

Parameter properties

Type:	RunAsAccount
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseExistingServers

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RunAsynchronously

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

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

-ScaleoutFileServerName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UseBareMetalMachines

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UseExistingServers

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SkipClusterValidation

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

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

-StorageFileServer

Specifies a storage file server object.

Parameter properties

Type:	StorageFileServer
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AddNodesUsingBareMetalMachines

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

AddNodesUsingExistingServers

Position:	Named
Mandatory:	True
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.

Outputs

StorageFileServer

This cmdlet returns a StorageFileServer object.

Related Links

• Get-SCStorageFileServer
• Set-SCStorageFileServer
• Uninstall-SCStorageFileServer