New-IscsiTargetPortal
Configures an iSCSI target portal.
Syntax
New-IscsiTargetPortal
-TargetPortalAddress <String>
[-TargetPortalPortNumber <UInt16>]
[-InitiatorPortalAddress <String>]
[-IsHeaderDigest <Boolean>]
[-IsDataDigest <Boolean>]
[-AuthenticationType <String>]
[-InitiatorInstanceName <String>]
[-ChapUsername <String>]
[-ChapSecret <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The New-IscsiTargetPortal cmdlet connects a new iSCSI target portal.
Examples
Example 1: Add an iSCSI target portal
PS C:\> New-IscsiTargetPortal -TargetPortalAddress "testIscsi"
InitiatorInstanceName :
InitiatorNodeAddress :
InitiatorPortalAddress :
InititorIPAdressListNumber : 4294967295
IsDataDigest : False
IsHeaderDigest : False
TargetPortalAddress : testIscsi
TargetPortalPortNumber : 3260This command adds a new iSCSI target portal named testIscsi to perform discovery.
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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AuthenticationType
Specifies the type of authentication to use when logging into the target. The acceptable values for this parameter are:
- NONE
- ONEWAYCHAP
- MUTUALCHAP
Note: These values are case sensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InitiatorPortalAddress
Specifies the IP address or DNS name that is associated with the portal.
| Type: | String |
| Aliases: | IA |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetPortalAddress
Specifies the IP address or DNS name of the target portal.
| Type: | String |
| Aliases: | TA |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
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.