Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-IscsiTargetPortal

Last Updated: 3/8/2017

SYNOPSIS

Gets iSCSI target portals.

SYNTAX

ByTargetPortalAddress (Default)

Get-IscsiTargetPortal [-InitiatorPortalAddress <String[]>] [[-TargetPortalAddress] <String[]>]
 [-InitiatorInstanceName <String[]>] [-TargetPortalPortNumber <UInt16[]>] [-IsHeaderDigest <Boolean[]>]
 [-IsDataDigest <Boolean[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [<CommonParameters>]

ByiSCSISession

Get-IscsiTargetPortal [-iSCSISession <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

ByiSCSIConnection

Get-IscsiTargetPortal [-iSCSIConnection <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

ByiSCSITarget

Get-IscsiTargetPortal [-iSCSITarget <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-IscsiTargetPortal cmdlet gets information about iSCSI target portals.

EXAMPLES

Example 1: Get information about an iSCSI target portal

PS C:\> Get-IscsiTargetPortal -TargetPortalAddress "testIscsi"
InitiatorInstanceName      : 
InitiatorNodeAddress       : 
InitiatorPortalAddress     : 
InititorIPAdressListNumber : 4294967295 
IsDataDigest               : False 
IsHeaderDigest             : False 
TargetPortalAddress        : testIscsi 
TargetPortalPortNumber     : 3260

This command gets information about the iSCSI target portal named testiSCSI.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InitiatorInstanceName

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.

Type: String[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InitiatorPortalAddress

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

Type: String[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsDataDigest

Indicates whether this cmdlet enables data digest when the initiator logs into the target portal. If you do not specify this parameter, the digest setting is determined by the initiator kernel mode driver.

Type: Boolean[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsHeaderDigest

Indicates whether this cmdlet enables header digest when the initiator logs into the target portal. If you do not specify this parameter, the digest setting is determined by the initiator kernel mode driver.

Type: Boolean[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetPortalAddress

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

Type: String[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetPortalPortNumber

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

Type: UInt16[]
Parameter Sets: ByTargetPortalAddress
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-iSCSIConnection

Accepts a MSFT iSCSI connection object as an input. The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet.

Type: CimInstance
Parameter Sets: ByiSCSIConnection
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-iSCSISession

Accepts a MSFT iSCSI session object as an input. The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet.

Type: CimInstance
Parameter Sets: ByiSCSISession
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-iSCSITarget

Accepts a MSFT iSCSI target object as an input. The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet.

Type: CimInstance
Parameter Sets: ByiSCSITarget
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiConnection

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiSession

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiTarget

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

OUTPUTS

Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiTargetPortal

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

NOTES

iSCSI on TechNet

Storage on TechNet

Get-IscsiConnection

Get-IscsiSession

Get-IscsiTarget

© 2017 Microsoft