StorageGateway / Client / join_domain

join_domain#

StorageGateway.Client.join_domain(**kwargs)#

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

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.join_domain(
    GatewayARN='string',
    DomainName='string',
    OrganizationalUnit='string',
    DomainControllers=[
        'string',
    ],
    TimeoutInSeconds=123,
    UserName='string',
    Password='string'
)
Parameters:

  • GatewayARN (string) –

    [REQUIRED]

    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.

  • DomainName (string) –

    [REQUIRED]

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

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

  • DomainControllers (list) –

    List of IPv4 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.

    • (string) –

  • TimeoutInSeconds (integer) – Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

  • UserName (string) –

    [REQUIRED]

    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.

  • Password (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR'
}

Response Structure

  • (dict) –

    JoinDomainOutput

    • GatewayARN (string) –

      The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

    • ActiveDirectoryStatus (string) –

      Indicates the status of the gateway as a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn’t complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Exceptions