Share via

Set-SCStorageFileServer

Module:
VirtualMachineManager Module

Adds or removes a storage file share from VMM management.

Syntax

ManageFileShares (Default) 

Set-SCStorageFileServer
    -StorageFileServer <StorageFileServer>
    [-JobGroup <Guid>]
    [-Description <String>]
    [-RemoveStorageFileShareFromManagement <StorageFileShare[]>]
    [-AddDiskWitnessFromStoragePool <StoragePool>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

AddFileServerToCluster 

Set-SCStorageFileServer
    -AddExistingComputer <String[]>
    -StorageFileServer <StorageFileServer>
    [-JobGroup <Guid>]
    [-Description <String>]
    [-SkipClusterValidation]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

RemoveFileServerFromCluster 

Set-SCStorageFileServer
    -RemoveExistingComputer <StorageFileServerNode[]>
    -StorageFileServer <StorageFileServer>
    [-JobGroup <Guid>]
    [-CleanupDisks]
    [-Description <String>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

EnableFileShareManagement 

Set-SCStorageFileServer
    -StorageFileServer <StorageFileServer>
    -AddStorageFileShareToManagement <StorageFileShare[]>
    [-JobGroup <Guid>]
    [-Description <String>]
    [-StorageClassificationAssociation <StorageClassification[]>]
    [-RemoveStorageFileShareFromManagement <StorageFileShare[]>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

SetFileServer 

Set-SCStorageFileServer
    -StorageFileServer <StorageFileServer>
    [-JobGroup <Guid>]
    [-Description <String>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Set-SCStorageFileServer cmdlet adds or removes a storage file share from Virtual Machine Manager (VMM) management.

Examples

Example 1: Add a storage file share to VMM management

PS C:\> $FileServer = Get-SCStorageFileServer -Name "FileServer01.Contoso.com"
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> Set-SCStorageFileServer -StorageFileServer $FileServer -AddStorageFileShareToManagement $FileShare

The first command gets the storage file server object named FileServer01 by using the Get-SCStorageFileServer cmdlet. The command stores that object in the $FileServer variable.

The second command gets the storage file share object named FileShare01 by using the Get-SCStorageFileShare cmdlet. The command stores that object in the $FileShare variable.

The last command brings FileShare01 under VMM management.

Example 2: Remove a storage file share from VMM management

PS C:\> $FileServer = Get-SCStorageFileServer -Name "FileServer01.Contoso.com"
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> Set-SCStorageFileServer -StorageFileServer $FileServer -RemoveStorageFileShareFromManagement $FileShare

The first command gets the storage file server object named FileServer01, and then stores that object in the $FileServer variable.

The second command gets the storage file share object named FileShare01, and then stores that object in the $FileShare variable.

The last command removes FileShare01 from VMM management.

Parameters

-AddDiskWitnessFromStoragePool

Specifies a storage pool object.

Parameter properties

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

Parameter sets

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

-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

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

-AddStorageFileShareToManagement

Enables management of the specified storage file share through VMM.

Parameter properties

Type:

StorageFileShare[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-CleanupDisks

{{Fill CleanupDisks Description}}

Parameter properties

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

Parameter sets

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

-DCBSettings

Specifies the DCB settings configured on the cluster.

Parameter properties

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

Parameter sets

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

-Description

Specifies a description for the storage file server.

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

-JobGroup

Specifies an identifier for a series of commands that run as a set just before the final command that includes the same job group identifier runs.

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

-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

-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

-RemoveExistingComputer

Specifies an array of computers that this cmdlet removes. Specify FQDNs, NetBios names, or IP addresses of servers on the network that have an operating system.

Parameter properties

Type:

StorageFileServerNode[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-RemoveStorageFileShareFromManagement

Specifies an array of storage file shares that this cmdlet removes from VMM management.

Parameter properties

Type:

StorageFileShare[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-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

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

-StorageClassificationAssociation

Specifies an array of storage classification objects that is associated with a storage pool.

Parameter properties

Type:

StorageClassification[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableFileShareManagement
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

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