Skip to content

/AWS1/CL_STGJOINDOMAINOUTPUT

JoinDomainOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

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

iv_activedirectorystatus TYPE /AWS1/STGACTIVEDIRECTORYSTATUS /AWS1/STGACTIVEDIRECTORYSTATUS

Indicates the status of the gateway as 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.

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

Queryable Attributes

GatewayARN

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

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

ActiveDirectoryStatus

Indicates the status of the gateway as 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.

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

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