Share via

Set-SCStorageFileShare

Module:
VirtualMachineManager Module

Modifies a storage file share.

Syntax

Default (Default) 

Set-SCStorageFileShare
    [-StorageClassification <StorageClassification>]
    [-StorageFileShare] <StorageFileShare>
    [-Description <String>]
    [-DedupMode <DedupMode>]
    [-IsAvailableForPlacement <Boolean>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Set-SCStorageFileShare cmdlet modifies a storage file share.

Examples

Example 1: Update the storage classification for a storage file share

PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> $StorageClass = Get-SCStorageClassification -Name "StorageClassification02"
PS C:\> Set-SCStorageFileShare -StorageFileShare $FileShare -StorageClassification $StorageClass

The first command gets the storage file share object named FileShare01 and stores the object in the $FileShare variable.

The second command gets the storage classification object named StorageClassification02 and stores the object in the $StorageClass variable.

The last command changes the storage classification on FileShare01 to StorageClassification02.

Parameters

-DedupMode

Apply deduplication on the volume or file share based on the workload. The acceptable values for this parameter are:

  • 0 - Disabled
  • 1 - GeneralPurpose
  • 2 - Hyper-V
  • 3 - Backup

Parameter properties

Type:DedupMode
Default value:None
Accepted values:Disabled, GeneralPurpose, HyperV, Backup, NotAvailable
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

-Description

Specifies a description for the storage file share.

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

-IsAvailableForPlacement

The Set-SCStorageFileShare cmdlet modifies a storage file share.

Parameter properties

Type:Boolean
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 that job progress is tracked and stored in the variable named by this parameter.

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

-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

-StorageClassification

Specifies a storage classification object.

Parameter properties

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

-StorageFileShare

Specifies a storage file share.

Parameter properties

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

Parameter sets

(All)
Position:0
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.