Skip to content

/AWS1/IF_STG=>JOINDOMAIN()

About JoinDomain

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.

To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.

Method Signature

METHODS /AWS1/IF_STG~JOINDOMAIN
  IMPORTING
    !IV_GATEWAYARN TYPE /AWS1/STGGATEWAYARN OPTIONAL
    !IV_DOMAINNAME TYPE /AWS1/STGDOMAINNAME OPTIONAL
    !IV_ORGANIZATIONALUNIT TYPE /AWS1/STGORGANIZATIONALUNIT OPTIONAL
    !IT_DOMAINCONTROLLERS TYPE /AWS1/CL_STGHOSTS_W=>TT_HOSTS OPTIONAL
    !IV_TIMEOUTINSECONDS TYPE /AWS1/STGTIMEOUTINSECONDS OPTIONAL
    !IV_USERNAME TYPE /AWS1/STGDOMAINUSERNAME OPTIONAL
    !IV_PASSWORD TYPE /AWS1/STGDOMAINUSERPASSWORD OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgjoindomainoutput
  RAISING
    /AWS1/CX_STGINTERNALSERVERERR
    /AWS1/CX_STGINVALIDGWREQUESTEX
    /AWS1/CX_STGCLIENTEXC
    /AWS1/CX_STGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

iv_domainname TYPE /AWS1/STGDOMAINNAME /AWS1/STGDOMAINNAME

The name of the domain that you want the gateway to join.

iv_username TYPE /AWS1/STGDOMAINUSERNAME /AWS1/STGDOMAINUSERNAME

Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.

iv_password TYPE /AWS1/STGDOMAINUSERPASSWORD /AWS1/STGDOMAINUSERPASSWORD

Sets the password of the user who has permission to add the gateway to the Active Directory domain.

Optional arguments:

iv_organizationalunit TYPE /AWS1/STGORGANIZATIONALUNIT /AWS1/STGORGANIZATIONALUNIT

The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

it_domaincontrollers TYPE /AWS1/CL_STGHOSTS_W=>TT_HOSTS TT_HOSTS

List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.

FSx File Gateway does not support IPv6.

iv_timeoutinseconds TYPE /AWS1/STGTIMEOUTINSECONDS /AWS1/STGTIMEOUTINSECONDS

Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgjoindomainoutput /AWS1/CL_STGJOINDOMAINOUTPUT

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->joindomain(
  it_domaincontrollers = VALUE /aws1/cl_stghosts_w=>tt_hosts(
    ( new /aws1/cl_stghosts_w( |string| ) )
  )
  iv_domainname = |string|
  iv_gatewayarn = |string|
  iv_organizationalunit = |string|
  iv_password = |string|
  iv_timeoutinseconds = 123
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_gatewayarn = lo_result->get_gatewayarn( ).
  lv_activedirectorystatus = lo_result->get_activedirectorystatus( ).
ENDIF.