< Back

Remove-IscsiTargetPortal

Tue Jan 29, 2019 10:17 pm

NAME Remove-IscsiTargetPortal



SYNOPSIS

Removes the specified iSCSI target portal.





SYNTAX

Remove-IscsiTargetPortal [-CimSession <CimSession[]>] [-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-PassThru]

[-TargetPortalPortNumber <Int32>] [-ThrottleLimit <Int32>] -TargetPortalAddress <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-IscsiTargetPortal [-CimSession <CimSession[]>] [-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-PassThru]

[-TargetPortalPortNumber <Int32>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-IscsiTargetPortal cmdlet removes an existing iSCSI target portal connection.





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



-InitiatorInstanceName [<String>]

Specifies the name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal. If no

instance name is specified, the iSCSI initiator service chooses the initiator instance.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-InitiatorPortalAddress [<String>]

Specifies the IP address or DNS name that is associated with the initiator portal.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-TargetPortalAddress <String[]>

Specifies the IP address or DNS name of the target portal.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TargetPortalPortNumber [<Int32>]

Specifies the TCP/IP port number for the target portal. By default, the port number 3260.



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



-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 (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

None







Example 1: Remove a target portal



PS C:\\> Get-IscsiTargetPortal

InitiatorInstanceName :

InitiatorNodeAddress :

InitiatorPortalAddress :

InititorIPAdressListNumber : 4294967295

IsDataDigest : False

IsHeaderDigest : False

TargetPortalAddress : testIscsi

TargetPortalPortNumber : 3260PS C:\\> Remove-IscsiTargetPortal -TargetPortalAddress "testIscsi"



This example removes a target portal.



The first command displays target portals by using the Get-IscsiTargetPortal cmdlet. The target portal has an address of testIscsi.



The second command removes the target portal that has the address testIscsi.







RELATED LINKS

iSCSI on TechNet

Storage on TechNet

Get-IscsiTargetPortal