AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateChapCredentials operation. Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.UpdateChapCredentialsRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateChapCredentialsRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The UpdateChapCredentialsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property InitiatorName System.String

Gets and sets the property InitiatorName.

The iSCSI initiator that connects to the target.

Public Property SecretToAuthenticateInitiator System.String

Gets and sets the property SecretToAuthenticateInitiator.

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

Public Property SecretToAuthenticateTarget System.String

Gets and sets the property SecretToAuthenticateTarget.

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

Public Property TargetARN System.String

Gets and sets the property TargetARN.

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

Examples

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.

To update CHAP credentials for an iSCSI target


var response = client.UpdateChapCredentials(new UpdateChapCredentialsRequest 
{
    InitiatorName = "iqn.1991-05.com.microsoft:computername.domain.example.com",
    SecretToAuthenticateInitiator = "111111111111",
    SecretToAuthenticateTarget = "222222222222",
    TargetARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
});

string initiatorName = response.InitiatorName;
string targetARN = response.TargetARN;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms