describe_smb_settings

StorageGateway.Client.describe_smb_settings(**kwargs)

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

response = client.describe_smb_settings(
    GatewayARN='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.

Return type

dict

Returns

Response Syntax

{
    'GatewayARN': 'string',
    'DomainName': 'string',
    'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR',
    'SMBGuestPasswordSet': True|False,
    'SMBSecurityStrategy': 'ClientSpecified'|'MandatorySigning'|'MandatoryEncryption',
    '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 use 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. Only supported for S3 File Gateways.
    • MandatorySigning : If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
    • MandatoryEncryption : If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
  • 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) --

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException
• StorageGateway.Client.exceptions.InternalServerError