Skip to content

/AWS1/CL_STG=>UPDATECHAPCREDENTIALS()

About UpdateChapCredentials

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. This operation is supported in the volume and tape gateway types.

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

Method Signature

IMPORTING

Required arguments:

IV_TARGETARN TYPE /AWS1/STGTARGETARN /AWS1/STGTARGETARN

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

IV_SECRETTOAUTHNTCTINITIATOR TYPE /AWS1/STGCHAPSECRET /AWS1/STGCHAPSECRET

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.

IV_INITIATORNAME TYPE /AWS1/STGIQNNAME /AWS1/STGIQNNAME

The iSCSI initiator that connects to the target.

Optional arguments:

IV_SECRETTOAUTHNTCTTARGET TYPE /AWS1/STGCHAPSECRET /AWS1/STGCHAPSECRET

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_STGUPDCHAPCREDSOUTPUT /AWS1/CL_STGUPDCHAPCREDSOUTPUT