Skip to content

/AWS1/IF_DSY=>CREATELOCATIONSMB()

About CreateLocationSmb

Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see Providing DataSync access to SMB file servers.

Method Signature

METHODS /AWS1/IF_DSY~CREATELOCATIONSMB
  IMPORTING
    !IV_SUBDIRECTORY TYPE /AWS1/DSYSMBSUBDIRECTORY OPTIONAL
    !IV_SERVERHOSTNAME TYPE /AWS1/DSYSERVERHOSTNAME OPTIONAL
    !IV_USER TYPE /AWS1/DSYSMBUSER OPTIONAL
    !IV_DOMAIN TYPE /AWS1/DSYSMBDOMAIN OPTIONAL
    !IV_PASSWORD TYPE /AWS1/DSYSMBPASSWORD OPTIONAL
    !IT_AGENTARNS TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST OPTIONAL
    !IO_MOUNTOPTIONS TYPE REF TO /AWS1/CL_DSYSMBMOUNTOPTIONS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST OPTIONAL
    !IV_AUTHENTICATIONTYPE TYPE /AWS1/DSYSMBAUTHENTICATIONTYPE OPTIONAL
    !IT_DNSIPADDRESSES TYPE /AWS1/CL_DSYDNSIPLIST_W=>TT_DNSIPLIST OPTIONAL
    !IV_KERBEROSPRINCIPAL TYPE /AWS1/DSYKERBEROSPRINCIPAL OPTIONAL
    !IV_KERBEROSKEYTAB TYPE /AWS1/DSYKERBEROSKEYTABFILE OPTIONAL
    !IV_KERBEROSKRB5CONF TYPE /AWS1/DSYKERBEROSKRB5CONFFILE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsycreatelocsmbrsp
  RAISING
    /AWS1/CX_DSYINTERNALEXCEPTION
    /AWS1/CX_DSYINVALIDREQUESTEX
    /AWS1/CX_DSYCLIENTEXC
    /AWS1/CX_DSYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_subdirectory TYPE /AWS1/DSYSMBSUBDIRECTORY /AWS1/DSYSMBSUBDIRECTORY

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.

iv_serverhostname TYPE /AWS1/DSYSERVERHOSTNAME /AWS1/DSYSERVERHOSTNAME

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

If you're using Kerberos authentication, you must specify a domain name.

it_agentarns TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST TT_AGENTARNLIST

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

Optional arguments:

iv_user TYPE /AWS1/DSYSMBUSER /AWS1/DSYSMBUSER

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType is set to NTLM.

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

iv_domain TYPE /AWS1/DSYSMBDOMAIN /AWS1/DSYSMBDOMAIN

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

iv_password TYPE /AWS1/DSYSMBPASSWORD /AWS1/DSYSMBPASSWORD

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

io_mountoptions TYPE REF TO /AWS1/CL_DSYSMBMOUNTOPTIONS /AWS1/CL_DSYSMBMOUNTOPTIONS

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

it_tags TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

iv_authenticationtype TYPE /AWS1/DSYSMBAUTHENTICATIONTYPE /AWS1/DSYSMBAUTHENTICATIONTYPE

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

For more information, see Providing DataSync access to SMB file servers.

it_dnsipaddresses TYPE /AWS1/CL_DSYDNSIPLIST_W=>TT_DNSIPLIST TT_DNSIPLIST

Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

iv_kerberosprincipal TYPE /AWS1/DSYKERBEROSPRINCIPAL /AWS1/DSYKERBEROSPRINCIPAL

Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

iv_kerberoskeytab TYPE /AWS1/DSYKERBEROSKEYTABFILE /AWS1/DSYKERBEROSKEYTABFILE

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.

iv_kerberoskrb5conf TYPE /AWS1/DSYKERBEROSKRB5CONFFILE /AWS1/DSYKERBEROSKRB5CONFFILE

Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsycreatelocsmbrsp /AWS1/CL_DSYCREATELOCSMBRSP

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->createlocationsmb(
  io_mountoptions = new /aws1/cl_dsysmbmountoptions( |string| )
  it_agentarns = VALUE /aws1/cl_dsyagentarnlist_w=>tt_agentarnlist(
    ( new /aws1/cl_dsyagentarnlist_w( |string| ) )
  )
  it_dnsipaddresses = VALUE /aws1/cl_dsydnsiplist_w=>tt_dnsiplist(
    ( new /aws1/cl_dsydnsiplist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_dsytaglistentry=>tt_inputtaglist(
    (
      new /aws1/cl_dsytaglistentry(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_authenticationtype = |string|
  iv_domain = |string|
  iv_kerberoskeytab = '5347567362473873563239796247513D'
  iv_kerberoskrb5conf = '5347567362473873563239796247513D'
  iv_kerberosprincipal = |string|
  iv_password = |string|
  iv_serverhostname = |string|
  iv_subdirectory = |string|
  iv_user = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_locationarn = lo_result->get_locationarn( ).
ENDIF.