NAME

Add-DcsAccessToken

SYNOPSIS

Creates an access token for an iSCSI target port to authenticate communication from the designated initiator port.

SYNTAX

Add-DcsAccessToken   [ -Server <String> ]   -Port <Object>   -InitiatorNodeName <String>   -TargetPassword <String>   -TargetUser <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsAccessToken   [ -Server <String> ]   -Port <Object>   -InitiatorNodeName <String>   -InitiatorPassword <String>   [ -InitiatorUser <String> ]   -TargetPassword <String>   -TargetUser <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates an access token for an iSCSI target port to authenticate communication from the designated initiator port. The access token will be created using CHAP authentication. When using mutual authentication, set the initiator secret before creating an access token for target secrets, see Set-DcsiSCSIInitiatorSecret. Before creating an access token for target secrets, the target should be logged out, see Disconnect-DcsiSCSITarget.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<Object>
The name or ID of the iSCSI target port. In order to uniquely identify the port by name, the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-InitiatorNodeName<String>
Name of the initiator node that will be used in the session.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetPassword<String>
Secret of the iSCSI target port. Secrets are 12-16 characters. Use caution when entering the secret, it will appear as typed on the display.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetUser<String>
User Name for the iSCSI target port.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorPassword<String>
Secret for the iSCSI initiator port. Secrets are 12-16 characters. This parameter value should be specified if using Mutual Authentication.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorUser<String>
User name of the Microsoft iSCSI Initiator port. This parameter value should be specified if using Mutual Authentication.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ServerScsiPortData : Object that identifies and describes the port.

NOTES

Also see Remove-DcsAccessToken, Set-DcsAccessTokenProperties, Set-DcsiSCSIInitiatorSecret.

EXAMPLES


-------------- Example 1 Adds access token for Mutual Authentication --------------
Add-DcsAccessToken -Server SSV1 -Port "Server iSCSI Port 1" -InitiatorNodeName "Microsoft iSCSI Initiator" -InitiatorPassword initsecret12 -InitiatorUser inithandshk -TargetPassword targetsecret1 -TargetUser targethandshk
			

Creates an access token for the port named "Server iSCSI Port 1" on the server named "SSV1" with target and initiator CHAP settings for mutual authentication.

IdInfo:DataCore.Executive.iSCSI.iScsiPortIdInfo
PortConfigInfo:DataCore.Executive.iSCSI.PortConfigInfo
IScsiPortStateInfo:DataCore.Executive.iSCSI.iScsiPortStateInfo
iSCSINodes:{iqn.1991-05.com.microsoft:ssv2.datacoresoftware.com}
CapabilityInfo:DataCore.Executive.iSCSI.iScsiPortCapabilityInfo
PresenceStatus:Present
PhysicalName:MAC:00-15-5D-11-E9-0F
ServerPortProperties:DataCore.Executive.ServeriScsiPortPropertiesData
RoleCapability:Frontend, Mirror
PortName:iqn.2000-08.com.datacore:ssv1-1
Alias:Server iSCSI Port 1
Description:
PortType:iSCSI
PortMode:Target
HostId:74EDD1B3-6682-46A7-943C-2F0168CEC699
Connected:True
Id:74EDD1B3-6682-46A7-943C-2F0168CEC699:MAC:00-15-5D-11-E9-0F
Caption:Server iSCSI Port 1
ExtendedCaption:Server iSCSI Port 1 on SSV1
Internal:False