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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to UpdateChapCredentialsAsync.

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

Syntax

C#
public abstract UpdateChapCredentialsResponse UpdateChapCredentials(
         UpdateChapCredentialsRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.UpdateChapCredentialsRequest

Container for the necessary parameters to execute the UpdateChapCredentials service method.

Return Value
The response from the UpdateChapCredentials service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

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 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

See Also