DataSync / Client / update_location_smb

update_location_smb#

DataSync.Client.update_location_smb(**kwargs)#

Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you’re using with DataSync.

For more information, see Configuring DataSync transfers with an SMB file server.

See also: AWS API Documentation

Request Syntax

response = client.update_location_smb(
    LocationArn='string',
    Subdirectory='string',
    User='string',
    Domain='string',
    Password='string',
    AgentArns=[
        'string',
    ],
    MountOptions={
        'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
    },
    AuthenticationType='NTLM'|'KERBEROS',
    DnsIpAddresses=[
        'string',
    ],
    KerberosPrincipal='string',
    KerberosKeytab=b'bytes',
    KerberosKrb5Conf=b'bytes'
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

    Specifies the ARN of the SMB location that you want to update.

  • Subdirectory (string) –

    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 specified 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.

  • User (string) –

    Specifies the user name that 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.

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

  • Domain (string) –

    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.

  • Password (string) – 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.

  • AgentArns (list) –

    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).

    • (string) –

  • MountOptions (dict) –

    Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

    • Version (string) –

      By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

      These are the following options for configuring the SMB version:

      • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.

      • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

      • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

      • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

      • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

      Note

      The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location.

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

  • DnsIpAddresses (list) –

    Specifies the IPv4 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.

    • (string) –

  • KerberosPrincipal (string) –

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

    SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM.

    Your task execution will fail if the SPN that you provide for this parameter doesn’t match what’s exactly in your keytab or krb5.conf files.

  • KerberosKeytab (bytes) –

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

    You can specify the keytab using a file path (for example, file://path/to/file.keytab). The file must be base64 encoded. If you’re using the CLI, the encoding is done for you.

    To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.

  • KerberosKrb5Conf (bytes) –

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

    You can specify the krb5.conf using a file path (for example, file://path/to/krb5.conf). The file must be base64 encoded. If you’re using the CLI, the encoding is done for you.

    To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions