AWS Storage Gateway

{'ActiveDirectoryStatus': {'INSUFFICIENT_PERMISSIONS'}}

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

See also: AWS API Documentation

Request Syntax

client.describe_smb_settings(
    GatewayARN='string'
)

type GatewayARN:

string

param GatewayARN:

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

rtype:

dict

returns:

Response Syntax

{
    'GatewayARN': 'string',
    'DomainName': 'string',
    'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR'|'INSUFFICIENT_PERMISSIONS',
    'SMBGuestPasswordSet': True|False,
    'SMBSecurityStrategy': 'ClientSpecified'|'MandatorySigning'|'MandatoryEncryption'|'MandatoryEncryptionNoAes128',
    'FileSharesVisible': True|False,
    'SMBLocalGroups': {
        'GatewayAdmins': [
            'string',
        ]
    }
}

Response Structure

• (dict) --

  • GatewayARN (string) --

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

    The name of the domain that the gateway is joined to.

  • ActiveDirectoryStatus (string) --

    Indicates the status of a gateway that is 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.

  • SMBGuestPasswordSet (boolean) --

    This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

    Valid Values: true | false

  • SMBSecurityStrategy (string) --

    The type of security strategy that was specified for file gateway.

    • ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.

    • MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.

    • MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

    • MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

  • FileSharesVisible (boolean) --

    The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

  • SMBLocalGroups (dict) --

    A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

    • GatewayAdmins (list) --

      A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1, and group1.

      Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.

      • (string) --

{'ActiveDirectoryStatus': {'INSUFFICIENT_PERMISSIONS'}}

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

See also: AWS API Documentation

Request Syntax

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

type GatewayARN:

string

param GatewayARN:

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

type DomainName:

string

param DomainName:

[REQUIRED]

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

type OrganizationalUnit:

string

param OrganizationalUnit:

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.

type DomainControllers:

list

param DomainControllers:

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

type TimeoutInSeconds:

integer

param TimeoutInSeconds:

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

type UserName:

string

param UserName:

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

type Password:

string

param Password:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

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

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.

    • INSUFFICIENT_PERMISSIONS: Indicates that the JoinDomain operation failed because the specified user lacks the necessary permissions to join the domain.

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