COMMAND EVERYTHING.

Get-TargetPortal

Returns a TargetPortal object.

Windows Server · Risk: Low · Documentation Verified

Last verified: 2026-10-26

Microsoft Storage reference: Returns a TargetPortal object. 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.

Get-TargetPortal [-UniqueId <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Get-TargetPortal. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / Storage · 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.
-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.
-IPv4Address: Represents a TCP/IP v4 address in xxx.xxx.xxx.xxx format.
-IPv6Address: Represents a TCP/IP v6 address.
-StorageSubsystem: Specifies a storage subsystem, as a CimInstance object. The cmdlet gets target portals exposed by the storage subsystem that you specify. To obtain a storage subsystem object, use the Get-StorageSubSystem cmdlet.
-TargetPort: Accepts a TargetPort object as input. The Target Port CIM object is exposed by the Get-TargetPort cmdlet.
-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.
-UniqueId: Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

Prerequisites

Windows with the Storage 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-TargetPortal

This example gets all target portals. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/Storage/Get-TargetPortal.md

https://learn.microsoft.com/powershell/module/storage/get-targetportal?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer