/AWS1/IF_NWM=>CREATEDEVICE()

About CreateDevice

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Method Signature

METHODS /AWS1/IF_NWM~CREATEDEVICE
  IMPORTING
    !IV_GLOBALNETWORKID TYPE /AWS1/NWMGLOBALNETWORKID OPTIONAL
    !IO_AWSLOCATION TYPE REF TO /AWS1/CL_NWMAWSLOCATION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_TYPE TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_VENDOR TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_MODEL TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_SERIALNUMBER TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IO_LOCATION TYPE REF TO /AWS1/CL_NWMLOCATION OPTIONAL
    !IV_SITEID TYPE /AWS1/NWMSITEID OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_NWMTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwmcreatedevicersp
  RAISING
    /AWS1/CX_NWMACCESSDENIEDEX
    /AWS1/CX_NWMCONFLICTEXCEPTION
    /AWS1/CX_NWMINTERNALSERVEREX
    /AWS1/CX_NWMRESOURCENOTFOUNDEX
    /AWS1/CX_NWMSERVICEQUOTAEXCDEX
    /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.

Optional arguments:

io_awslocation TYPE REF TO /AWS1/CL_NWMAWSLOCATION /AWS1/CL_NWMAWSLOCATION

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

iv_description TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

A description of the device.

Constraints: Maximum length of 256 characters.

iv_type TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The type of the device.

iv_vendor TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The vendor of the device.

Constraints: Maximum length of 128 characters.

iv_model TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The model of the device.

Constraints: Maximum length of 128 characters.

iv_serialnumber TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The serial number of the device.

Constraints: Maximum length of 128 characters.

io_location TYPE REF TO /AWS1/CL_NWMLOCATION /AWS1/CL_NWMLOCATION

The location of the device.

iv_siteid TYPE /AWS1/NWMSITEID /AWS1/NWMSITEID

The ID of the site.

it_tags TYPE /AWS1/CL_NWMTAG=>TT_TAGLIST TT_TAGLIST

The tags to apply to the resource during creation.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwmcreatedevicersp /AWS1/CL_NWMCREATEDEVICERSP

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->createdevice(
  io_awslocation = new /aws1/cl_nwmawslocation(
    iv_subnetarn = |string|
    iv_zone = |string|
  )
  io_location = new /aws1/cl_nwmlocation(
    iv_address = |string|
    iv_latitude = |string|
    iv_longitude = |string|
  )
  it_tags = VALUE /aws1/cl_nwmtag=>tt_taglist(
    (
      new /aws1/cl_nwmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_globalnetworkid = |string|
  iv_model = |string|
  iv_serialnumber = |string|
  iv_siteid = |string|
  iv_type = |string|
  iv_vendor = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_device = lo_result->get_device( ).
  IF lo_device IS NOT INITIAL.
    lv_deviceid = lo_device->get_deviceid( ).
    lv_devicearn = lo_device->get_devicearn( ).
    lv_globalnetworkid = lo_device->get_globalnetworkid( ).
    lo_awslocation = lo_device->get_awslocation( ).
    IF lo_awslocation IS NOT INITIAL.
      lv_constrainedstring = lo_awslocation->get_zone( ).
      lv_subnetarn = lo_awslocation->get_subnetarn( ).
    ENDIF.
    lv_constrainedstring = lo_device->get_description( ).
    lv_constrainedstring = lo_device->get_type( ).
    lv_constrainedstring = lo_device->get_vendor( ).
    lv_constrainedstring = lo_device->get_model( ).
    lv_constrainedstring = lo_device->get_serialnumber( ).
    lo_location = lo_device->get_location( ).
    IF lo_location IS NOT INITIAL.
      lv_constrainedstring = lo_location->get_address( ).
      lv_constrainedstring = lo_location->get_latitude( ).
      lv_constrainedstring = lo_location->get_longitude( ).
    ENDIF.
    lv_siteid = lo_device->get_siteid( ).
    lv_datetime = lo_device->get_createdat( ).
    lv_devicestate = lo_device->get_state( ).
    LOOP AT lo_device->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.