< Back

Rename-MaskingSet

Wed Jan 30, 2019 6:03 pm

NAME Rename-MaskingSet



SYNOPSIS

Renames an existing masking set.





SYNTAX

Rename-MaskingSet [-FriendlyName] <String[]> [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewFriendlyName <String> [-Confirm]

[-WhatIf] [<CommonParameters>]



Rename-MaskingSet [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewFriendlyName <String> -UniqueId <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Rename-MaskingSet [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewFriendlyName <String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Rename-MaskingSet cmdlet renames an existing masking set.



ps_storage_spacesubsystem_not_remark





PARAMETERS

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or

Get-CimSession cmdlet. The default is the current session on the local computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FriendlyName <String[]>

Specifies the friendly name for the masking set to rename.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-NewFriendlyName <String>

Specifies the new name of the masking set



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.





To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is

entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the

computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-UniqueId <String[]>

Specifies the UniqueID of the masking set to rename



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

http://msdn.microsoft.com/library/windo ... 30509.aspx





You can pipe a MaskingSet object to the InputObject parameter.





OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

http://msdn.microsoft.com/library/windo ... 30509.aspx





If you use the PassThru parameter, this cmdlet returns an object representing the masking set that you removed.





Example 1: Rename a masking set



PS C:\\>Rename-MaskingSet -FriendlyName "MaskingSet" -NewFriendlyName "Server1A-MaskingSet"



This example renames the friendly name of the existing masking set to make it more descriptive.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816467

Get-MaskingSet

New-MaskingSet

Remove-MaskingSet