Class: Aws::StorageGateway::Types::DescribeSMBSettingsOutput

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::DescribeSMBSettingsOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-storagegateway/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_directory_status ⇒ String

  Indicates the status of a gateway that is a member of the Active Directory domain.

• #domain_name ⇒ String

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

• #file_shares_visible ⇒ Boolean

  The shares on this gateway appear when listing shares.

• #gateway_arn ⇒ String

  The Amazon Resource Name (ARN) of the gateway.

• #smb_guest_password_set ⇒ Boolean

  This value is ‘true` if a password for the guest user `smbguest` is set, otherwise `false`.

• #smb_security_strategy ⇒ String

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

Instance Attribute Details

#active_directory_status ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end

#file_shares_visible ⇒ Boolean

The shares on this gateway appear when listing shares.

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arn ⇒ String

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end

#smb_guest_password_set ⇒ Boolean

This value is ‘true` if a password for the guest user `smbguest` is set, otherwise `false`.

Valid Values: ‘true` | `false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end

#smb_security_strategy ⇒ 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.

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 3310

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible)
  SENSITIVE = []
  include Aws::Structure
end