storagegateway_join_domain: Adds a file gateway to an Active Directory domain

View source: R/storagegateway_operations.R

storagegateway_join_domainR Documentation

Adds a file gateway to an Active Directory domain

Description

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

See https://www.paws-r-sdk.com/docs/storagegateway_join_domain/ for full documentation.

Usage

storagegateway_join_domain(
  GatewayARN,
  DomainName,
  OrganizationalUnit = NULL,
  DomainControllers = NULL,
  TimeoutInSeconds = NULL,
  UserName,
  Password
)

Arguments

GatewayARN

[required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

DomainName

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

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.

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.

TimeoutInSeconds

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

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.

Password

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


paws.storage documentation built on Sept. 12, 2024, 6:16 a.m.