Skip to content

Latest commit

 

History

History
247 lines (195 loc) · 5.85 KB

New-IscsiTargetPortal.md

File metadata and controls

247 lines (195 loc) · 5.85 KB
external help file Module Name online version schema
Iscsi_Cmdlets.xml
iSCSI
2.0.0

New-IscsiTargetPortal

SYNOPSIS

Configures an iSCSI target portal.

SYNTAX

New-IscsiTargetPortal [-AsJob] [-AuthenticationType <String>] [-ChapSecret <String>] [-ChapUsername <String>]
 [-CimSession <CimSession[]>] [-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>]
 [-IsDataDigest <Boolean>] [-IsHeaderDigest <Boolean>] [-TargetPortalPortNumber <UInt16>]
 [-ThrottleLimit <Int32>] -TargetPortalAddress <String>

DESCRIPTION

The New-IscsiTargetPortal cmdlet connects a new iSCSI target portal.

EXAMPLES

EXAMPLE 1

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

This example adds a new iSCSI target portal with the name testIscsi to perform discovery

PARAMETERS

-AsJob

ps_cimcommon_asjob

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-AuthenticationType

Specifies the type of authentication to use when logging into the target. Valid values are None, OneWayCHAP, and MutualCHAP.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ChapSecret

Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ChapUsername

Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.

Type: String
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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

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: (All)
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 associated with the portal.

Type: String
Parameter Sets: (All)
Aliases: IA

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

-IsDataDigest

Enables data digest when the initiator logs into the target portal. By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-IsHeaderDigest

Enables header digest when the initiator logs into the target portal. By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-TargetPortalAddress

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

Type: String
Parameter Sets: (All)
Aliases: TA

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

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

INPUTS

None

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

RELATED LINKS

iSCSI Target Server Overview