< Back

Remove-MaskingSet

Wed Jan 30, 2019 6:03 pm

NAME Remove-MaskingSet



SYNOPSIS

Removes a masking set.





SYNTAX

Remove-MaskingSet [-FriendlyName] <String[]> [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-MaskingSet [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -UniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-MaskingSet [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-MaskingSet cmdlet removes a masking set.



Note: Removal of a masking set, will remove access to all virtual disks defined in the masking set for all initiator IDs, and target ports defined in

the 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 be removed.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

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 remove.



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: Remove a masking set



PS C:\\>Remove-MaskingSet -FriendlyName "MaskingSet01"



This example removes the masking set named MaskingSet01. The virtual disks that were defined in this masking set are no longer accessible to any

initiators defined in this masking set. A new masking set must be created to restore access to the virtual disks from a Windows computer acting as a

client to the storage subsystem.







RELATED LINKS

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

Get-MaskingSet

New-MaskingSet

Rename-MaskingSet