Skip to content

/AWS1/IF_CWN=>UPDATEPROBE()

About UpdateProbe

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

You can update the following para create a monitor with probes using this command. For each probe, you define the following:

  • state—The state of the probe.

  • destination— The target destination IP address for the probe.

  • destinationPort—Required only if the protocol is TCP.

  • protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

  • packetSize—The size of the packets. This must be a number between 56 and 8500.

  • (Optional) tags —Key-value pairs created and assigned to the probe.

Method Signature

METHODS /AWS1/IF_CWN~UPDATEPROBE
  IMPORTING
    !IV_MONITORNAME TYPE /AWS1/CWNRESOURCENAME OPTIONAL
    !IV_PROBEID TYPE /AWS1/CWNPROBEID OPTIONAL
    !IV_STATE TYPE /AWS1/CWNPROBESTATE OPTIONAL
    !IV_DESTINATION TYPE /AWS1/CWNDESTINATION OPTIONAL
    !IV_DESTINATIONPORT TYPE /AWS1/CWNPORT OPTIONAL
    !IV_PROTOCOL TYPE /AWS1/CWNPROTOCOL OPTIONAL
    !IV_PACKETSIZE TYPE /AWS1/CWNPACKETSIZE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwnupdateprobeoutput
  RAISING
    /AWS1/CX_CWNACCESSDENIEDEX
    /AWS1/CX_CWNINTERNALSERVEREX
    /AWS1/CX_CWNRESOURCENOTFOUNDEX
    /AWS1/CX_CWNSERVICEQUOTAEXCDEX
    /AWS1/CX_CWNTHROTTLINGEX
    /AWS1/CX_CWNVALIDATIONEX
    /AWS1/CX_CWNCLIENTEXC
    /AWS1/CX_CWNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_monitorname TYPE /AWS1/CWNRESOURCENAME /AWS1/CWNRESOURCENAME

The name of the monitor that the probe was updated for.

iv_probeid TYPE /AWS1/CWNPROBEID /AWS1/CWNPROBEID

The ID of the probe to update.

Optional arguments:

iv_state TYPE /AWS1/CWNPROBESTATE /AWS1/CWNPROBESTATE

The state of the probe update.

iv_destination TYPE /AWS1/CWNDESTINATION /AWS1/CWNDESTINATION

The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.

iv_destinationport TYPE /AWS1/CWNPORT /AWS1/CWNPORT

The updated port for the probe destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

iv_protocol TYPE /AWS1/CWNPROTOCOL /AWS1/CWNPROTOCOL

The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

iv_packetsize TYPE /AWS1/CWNPACKETSIZE /AWS1/CWNPACKETSIZE

he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwnupdateprobeoutput /AWS1/CL_CWNUPDATEPROBEOUTPUT

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->updateprobe(
  iv_destination = |string|
  iv_destinationport = 123
  iv_monitorname = |string|
  iv_packetsize = 123
  iv_probeid = |string|
  iv_protocol = |string|
  iv_state = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_probeid = lo_result->get_probeid( ).
  lv_arn = lo_result->get_probearn( ).
  lv_arn = lo_result->get_sourcearn( ).
  lv_destination = lo_result->get_destination( ).
  lv_port = lo_result->get_destinationport( ).
  lv_protocol = lo_result->get_protocol( ).
  lv_packetsize = lo_result->get_packetsize( ).
  lv_addressfamily = lo_result->get_addressfamily( ).
  lv_vpcid = lo_result->get_vpcid( ).
  lv_probestate = lo_result->get_state( ).
  lv_iso8601timestamp = lo_result->get_createdat( ).
  lv_iso8601timestamp = lo_result->get_modifiedat( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.