Skip to content

/AWS1/CL_STG=>DESCRIBECHAPCREDENTIALS()

About DescribeChapCredentials

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

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 to retrieve the TargetARN for specified VolumeARN.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgdescrchapcredsout /AWS1/CL_STGDESCRCHAPCREDSOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_stg~describechapcredentials( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_chapcredentials( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_targetarn = lo_row_1->get_targetarn( ).
      lv_chapsecret = lo_row_1->get_secrettoauthntctinitia00( ).
      lv_iqnname = lo_row_1->get_initiatorname( ).
      lv_chapsecret = lo_row_1->get_secrettoauthntcttarget( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe CHAP credetnitals for an iSCSI

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

DATA(lo_result) = lo_client->/aws1/if_stg~describechapcredentials( |arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume| ).