STARTROUTEANALYSIS()`¶

About StartRouteAnalysis¶

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Method Signature¶

METHODS /AWS1/IF_NWM~STARTROUTEANALYSIS
  IMPORTING
    !IV_GLOBALNETWORKID TYPE /AWS1/NWMGLOBALNETWORKID OPTIONAL
    !IO_SOURCE TYPE REF TO /AWS1/CL_NWMROUTEALYENDPTOPT00 OPTIONAL
    !IO_DESTINATION TYPE REF TO /AWS1/CL_NWMROUTEALYENDPTOPT00 OPTIONAL
    !IV_INCLUDERETURNPATH TYPE /AWS1/NWMBOOLEAN OPTIONAL
    !IV_USEMIDDLEBOXES TYPE /AWS1/NWMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwmstartroutealyrsp
  RAISING
    /AWS1/CX_NWMACCESSDENIEDEX
    /AWS1/CX_NWMCONFLICTEXCEPTION
    /AWS1/CX_NWMINTERNALSERVEREX
    /AWS1/CX_NWMRESOURCENOTFOUNDEX
    /AWS1/CX_NWMTHROTTLINGEX
    /AWS1/CX_NWMVALIDATIONEX
    /AWS1/CX_NWMCLIENTEXC
    /AWS1/CX_NWMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_globalnetworkid` `TYPE /AWS1/NWMGLOBALNETWORKID` `/AWS1/NWMGLOBALNETWORKID`¶

The ID of the global network.

`io_source` `TYPE REF TO /AWS1/CL_NWMROUTEALYENDPTOPT00` `/AWS1/CL_NWMROUTEALYENDPTOPT00`¶

The source from which traffic originates.

`io_destination` `TYPE REF TO /AWS1/CL_NWMROUTEALYENDPTOPT00` `/AWS1/CL_NWMROUTEALYENDPTOPT00`¶

The destination.

Optional arguments:¶

`iv_includereturnpath` `TYPE /AWS1/NWMBOOLEAN` `/AWS1/NWMBOOLEAN`¶

Indicates whether to analyze the return path. The default is false.

`iv_usemiddleboxes` `TYPE /AWS1/NWMBOOLEAN` `/AWS1/NWMBOOLEAN`¶

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nwmstartroutealyrsp` `/AWS1/CL_NWMSTARTROUTEALYRSP`¶

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->startrouteanalysis(
  io_destination = new /aws1/cl_nwmroutealyendptopt00(
    iv_ipaddress = |string|
    iv_tgwattachmentarn = |string|
  )
  io_source = new /aws1/cl_nwmroutealyendptopt00(
    iv_ipaddress = |string|
    iv_tgwattachmentarn = |string|
  )
  iv_globalnetworkid = |string|
  iv_includereturnpath = ABAP_TRUE
  iv_usemiddleboxes = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_routeanalysis = lo_result->get_routeanalysis( ).
  IF lo_routeanalysis IS NOT INITIAL.
    lv_globalnetworkid = lo_routeanalysis->get_globalnetworkid( ).
    lv_awsaccountid = lo_routeanalysis->get_owneraccountid( ).
    lv_constrainedstring = lo_routeanalysis->get_routeanalysisid( ).
    lv_datetime = lo_routeanalysis->get_starttimestamp( ).
    lv_routeanalysisstatus = lo_routeanalysis->get_status( ).
    lo_routeanalysisendpointop = lo_routeanalysis->get_source( ).
    IF lo_routeanalysisendpointop IS NOT INITIAL.
      lv_transitgatewayattachmen = lo_routeanalysisendpointop->get_tgwattachmentarn( ).
      lv_transitgatewayarn = lo_routeanalysisendpointop->get_transitgatewayarn( ).
      lv_ipaddress = lo_routeanalysisendpointop->get_ipaddress( ).
    ENDIF.
    lo_routeanalysisendpointop = lo_routeanalysis->get_destination( ).
    IF lo_routeanalysisendpointop IS NOT INITIAL.
      lv_transitgatewayattachmen = lo_routeanalysisendpointop->get_tgwattachmentarn( ).
      lv_transitgatewayarn = lo_routeanalysisendpointop->get_transitgatewayarn( ).
      lv_ipaddress = lo_routeanalysisendpointop->get_ipaddress( ).
    ENDIF.
    lv_boolean = lo_routeanalysis->get_includereturnpath( ).
    lv_boolean = lo_routeanalysis->get_usemiddleboxes( ).
    lo_routeanalysispath = lo_routeanalysis->get_forwardpath( ).
    IF lo_routeanalysispath IS NOT INITIAL.
      lo_routeanalysiscompletion = lo_routeanalysispath->get_completionstatus( ).
      IF lo_routeanalysiscompletion IS NOT INITIAL.
        lv_routeanalysiscompletion_1 = lo_routeanalysiscompletion->get_resultcode( ).
        lv_routeanalysiscompletion_2 = lo_routeanalysiscompletion->get_reasoncode( ).
        LOOP AT lo_routeanalysiscompletion->get_reasoncontext( ) into ls_row.
          lv_key = ls_row-key.
          lo_value = ls_row-value.
          IF lo_value IS NOT INITIAL.
            lv_reasoncontextvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      LOOP AT lo_routeanalysispath->get_path( ) into lo_row_1.
        lo_row_2 = lo_row_1.
        IF lo_row_2 IS NOT INITIAL.
          lv_integer = lo_row_2->get_sequence( ).
          lo_networkresourcesummary = lo_row_2->get_resource( ).
          IF lo_networkresourcesummary IS NOT INITIAL.
            lv_resourcearn = lo_networkresourcesummary->get_registeredgatewayarn( ).
            lv_resourcearn = lo_networkresourcesummary->get_resourcearn( ).
            lv_constrainedstring = lo_networkresourcesummary->get_resourcetype( ).
            lv_constrainedstring = lo_networkresourcesummary->get_definition( ).
            lv_constrainedstring = lo_networkresourcesummary->get_nametag( ).
            lv_boolean = lo_networkresourcesummary->get_ismiddlebox( ).
          ENDIF.
          lv_constrainedstring = lo_row_2->get_destinationcidrblock( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_routeanalysispath = lo_routeanalysis->get_returnpath( ).
    IF lo_routeanalysispath IS NOT INITIAL.
      lo_routeanalysiscompletion = lo_routeanalysispath->get_completionstatus( ).
      IF lo_routeanalysiscompletion IS NOT INITIAL.
        lv_routeanalysiscompletion_1 = lo_routeanalysiscompletion->get_resultcode( ).
        lv_routeanalysiscompletion_2 = lo_routeanalysiscompletion->get_reasoncode( ).
        LOOP AT lo_routeanalysiscompletion->get_reasoncontext( ) into ls_row.
          lv_key = ls_row-key.
          lo_value = ls_row-value.
          IF lo_value IS NOT INITIAL.
            lv_reasoncontextvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      LOOP AT lo_routeanalysispath->get_path( ) into lo_row_1.
        lo_row_2 = lo_row_1.
        IF lo_row_2 IS NOT INITIAL.
          lv_integer = lo_row_2->get_sequence( ).
          lo_networkresourcesummary = lo_row_2->get_resource( ).
          IF lo_networkresourcesummary IS NOT INITIAL.
            lv_resourcearn = lo_networkresourcesummary->get_registeredgatewayarn( ).
            lv_resourcearn = lo_networkresourcesummary->get_resourcearn( ).
            lv_constrainedstring = lo_networkresourcesummary->get_resourcetype( ).
            lv_constrainedstring = lo_networkresourcesummary->get_definition( ).
            lv_constrainedstring = lo_networkresourcesummary->get_nametag( ).
            lv_boolean = lo_networkresourcesummary->get_ismiddlebox( ).
          ENDIF.
          lv_constrainedstring = lo_row_2->get_destinationcidrblock( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_NWM=>STARTROUTEANALYSIS()¶