Skip to content

/AWS1/CL_STGDESCRSMBSTGSOUTPUT

DescribeSMBSettingsOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

GatewayARN

iv_domainname TYPE /AWS1/STGDOMAINNAME /AWS1/STGDOMAINNAME

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

iv_activedirectorystatus TYPE /AWS1/STGACTIVEDIRECTORYSTATUS /AWS1/STGACTIVEDIRECTORYSTATUS

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

This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds.

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

iv_smbguestpasswordset TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

iv_smbsecuritystrategy TYPE /AWS1/STGSMBSECURITYSTRATEGY /AWS1/STGSMBSECURITYSTRATEGY

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.

iv_filesharesvisible TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

io_smblocalgroups TYPE REF TO /AWS1/CL_STGSMBLOCALGROUPS /AWS1/CL_STGSMBLOCALGROUPS

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

Queryable Attributes

GatewayARN

GatewayARN

Accessible with the following methods

Method Description
GET_GATEWAYARN() Getter for GATEWAYARN, with configurable default
ASK_GATEWAYARN() Getter for GATEWAYARN w/ exceptions if field has no value
HAS_GATEWAYARN() Determine if GATEWAYARN has a value

DomainName

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

Accessible with the following methods

Method Description
GET_DOMAINNAME() Getter for DOMAINNAME, with configurable default
ASK_DOMAINNAME() Getter for DOMAINNAME w/ exceptions if field has no value
HAS_DOMAINNAME() Determine if DOMAINNAME has a value

ActiveDirectoryStatus

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

This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds.

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

Accessible with the following methods

Method Description
GET_ACTIVEDIRECTORYSTATUS() Getter for ACTIVEDIRECTORYSTATUS, with configurable default
ASK_ACTIVEDIRECTORYSTATUS() Getter for ACTIVEDIRECTORYSTATUS w/ exceptions if field has
HAS_ACTIVEDIRECTORYSTATUS() Determine if ACTIVEDIRECTORYSTATUS has a value

SMBGuestPasswordSet

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

Accessible with the following methods

Method Description
GET_SMBGUESTPASSWORDSET() Getter for SMBGUESTPASSWORDSET, with configurable default
ASK_SMBGUESTPASSWORDSET() Getter for SMBGUESTPASSWORDSET w/ exceptions if field has no
HAS_SMBGUESTPASSWORDSET() Determine if SMBGUESTPASSWORDSET has a value

SMBSecurityStrategy

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.

Accessible with the following methods

Method Description
GET_SMBSECURITYSTRATEGY() Getter for SMBSECURITYSTRATEGY, with configurable default
ASK_SMBSECURITYSTRATEGY() Getter for SMBSECURITYSTRATEGY w/ exceptions if field has no
HAS_SMBSECURITYSTRATEGY() Determine if SMBSECURITYSTRATEGY has a value

FileSharesVisible

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

Accessible with the following methods

Method Description
GET_FILESHARESVISIBLE() Getter for FILESHARESVISIBLE, with configurable default
ASK_FILESHARESVISIBLE() Getter for FILESHARESVISIBLE w/ exceptions if field has no v
HAS_FILESHARESVISIBLE() Determine if FILESHARESVISIBLE has a value

SMBLocalGroups

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

Accessible with the following methods

Method Description
GET_SMBLOCALGROUPS() Getter for SMBLOCALGROUPS