NAME
Set-DcsAccessTokenProperties
SYNOPSIS
Sets the access token properties for an iSCSI connection.
SYNTAX
Set-DcsAccessTokenProperties [ -Server <String> ] -Port <String> -AccessToken <Object> [ -InitiatorPassword <String> ] [ -InitiatorUser <String> ] [ -TargetPassword <String> ] [ -TargetUser <String> ] [ -UseMutualAuthentication <Boolean> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Sets the access token properties for an iSCSI connection. Specify the parameters to set or change. If a parameter is not specified it will not be changed from the current setting.
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<String>
- 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: false
- Accept wildcard characters: false
-
- -AccessToken<Object>
- The initiator node name that the access token belongs to. The access token can be retrieved from the AccessTokenData object or the SCSIPortData object for the iSCSI target (Server iSCSI Port Data). See Get-DcsPorts for the iSCSI target. (Refer to the field iSCSINodes, each node has an access token and each accesstoken has an initiatornodename. See the example for more information.)
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -InitiatorPassword<String>
- Use this parameter to set or change the secret for the iSCSI initiator port when using Mutual Authentication. Secrets are 12-16 characters.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -InitiatorUser<String>
- Use this parameter to set or change the user name of the Microsoft iSCSI Initiator port when using Mutual Authentication.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -TargetPassword<String>
- Use this parameter to set or change the secret of the iSCSI target port. Secrets are 12-16 characters.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -TargetUser<String>
- Use this parameter to set or change the user name for the iSCSI target port.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -UseMutualAuthentication<Boolean>
- Use this parameter to designate whether or not Mutual Authentication should be used. Specify $true to specify Mutual Authentication or $false to specify no Mutual Authentication.
-
- Required: false
- 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 will be 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
-
INPUTS
AccessToken : Object that identifies the access token.
OUTPUTS
ScsiPortData : Object that identifies and describes the port.
NOTES
Also see Remove-DcsAccessToken, Add-DcsAccessToken.
EXAMPLES
$targetport = Get-DcsPort -Machine SSV1 -Port "Server iSCSI Port 1" $targetport.iSCSINodes[0].accesstoken.initiatornodename | Set-DcsAccessTokenProperties -Port "Server iSCSI Port 1 on SSV1" -UseMutualAuthentication $false
The cmdlet Get-DcsPort is invoked to obtain the ScsiPortData object for the port named "Server iSCSI Port 1" on the server named "SSV1". The object is stored in the variable named $targetport. The variable $targetport is used to obtain the accesstoken and the access token is used to obtain the initiatornodename of the target port ($targetport.iSCSINodes[0].accesstoken.initiatornodename). This object is piped to the cmdlet Set-DcsAccessTokenProperties to disable the Mutual Authentication for the access token on the target port named (extended caption) "Server iSCSI Port 1 on SSV1".
| IdInfo | : | DataCore.Executive.iSCSI.iScsiPortIdInfo |
| PortConfigInfo | : | DataCore.Executive.iSCSI.PortConfigInfo |
| IScsiPortStateInfo | : | DataCore.Executive.iSCSI.iScsiPortStateInfo |
| iSCSINodes | : | {microsoft iscsi initiator, 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 | : | 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4 |
| Connected | : | True |
| Id | : | 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MAC:00-15-5D-11-E9-0F |
| Caption | : | Server iSCSI Port 1 |
| ExtendedCaption | : | Server iSCSI Port 1 on SSV1 |
| Internal | : | False |