Microsoft iSCSI reference: Gets iSCSI target portals. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Get-IscsiTargetPortal. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / iSCSI · Windows Server 2025 documentation; feature/module prerequisites apply
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.
-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.
-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.
-InitiatorPortalAddress
Specifies the IP address or DNS name that is associated with the portal.
-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.
-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.
-TargetPortalAddress
Specifies the IP address or DNS name of the target portal.
-TargetPortalPortNumber
Specifies the TCP/IP port number for the target portal. By default, the port number is 3260.
-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.
-iSCSIConnection
Accepts a MSFT iSCSI connection object as an input. The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet.
-iSCSISession
Accepts a MSFT iSCSI session object as an input. The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet.
-iSCSITarget
Accepts a MSFT iSCSI target object as an input. The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet.
Prerequisites
Windows with the iSCSI module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.
Examples
Example 1: Get information about an iSCSI target portal
This command gets information about the iSCSI target portal named testiSCSI. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.