| external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|
InitiatorId.cdxml-help.xml |
Storage |
10/29/2017 |
2.0.0 |
Remove-InitiatorId |
Removes an initiator identifier (ID).
Remove-InitiatorId [-InitiatorAddress] <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
[-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-InitiatorId -UniqueId <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-InitiatorId -InputObject <CimInstance[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
The Remove-InitiatorId cmdlet removes an initiator identifier (ID).
PS C:\>Remove-InitiatorID -InitiatorAddress $SomeiSCSIIQN
This example removes the iSCSI IQN previously stored in the variable $SomeIscsiIQN from the list of Initiator IDs.
ps_cimcommon_asjob
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the address of the InitiatorID object you want to remove.
Type: String[]
Parameter Sets: ByAddress
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the InitiatorID object to remove. Enter an InitiatorID CIM object, which is returned by the Get-InitiatorId cmdlet.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSends 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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the UniqueID(s) of the InitiatorID(s) you want to remove. Separate multiple UniqueIDs with commas, and enclose brackets in quotation marks.
Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
You can pipe an InitiatorID object to the InputObject parameter.
This cmdlet returns an object that represents an initiator ID.