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

Get-TargetPortal

Last Updated: 3/8/2017

SYNOPSIS

Returns a TargetPortal object.

SYNTAX

ByUniqueId (Default)

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

ByIPv4Address

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

ByIPv6Address

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

ByTargetPort

Get-TargetPortal [-TargetPort <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [<CommonParameters>]

BySubsystem

Get-TargetPortal [-StorageSubsystem <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-TargetPortal cmdlet returns a TargetPortal object.

EXAMPLES

EXAMPLE 1

PS C:\>Get-TargetPortal

This example gets all target portals.

EXAMPLE 2

PS C:\>Get-TargetPortal -IPv4Address 192.168.0.1

This example gets the target portal with the IPv4 address of 192.168.0.1.

PARAMETERS

-AsJob

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

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

-IPv4Address

Represents a TCP/IP v4 address in xxx.xxx.xxx.xxx format.

Type: String[]
Parameter Sets: ByIPv4Address
Aliases: 

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

-IPv6Address

Represents a TCP/IP v6 address.

Type: String[]
Parameter Sets: ByIPv6Address
Aliases: 

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

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

Type: CimInstance
Parameter Sets: BySubsystem
Aliases: 

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

-TargetPort

Accepts a TargetPort object as input. The Target Port CIM object is exposed by the Get-TargetPort cmdlet.

Type: CimInstance
Parameter Sets: ByTargetPort
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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

-UniqueId

Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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#ROOT/Microsoft/Windows/Storage/MSFT_TargetPort

You can use the pipeline operator to pass a TargetPort object to the TargetPort parameter to get the TargetPortal object associated with the specified target port.

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetPortal

This cmdlet returns an object that represents the target portal.

NOTES

Get-TargetPort

© 2017 Microsoft