Feedback Edit

ActiveDirectory Class

  • Reference

Active Directory.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
Model
ActiveDirectory

Constructor

ActiveDirectory(*, active_directory_id: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, domain: Optional[str] = None, dns: Optional[str] = None, smb_server_name: Optional[str] = None, organizational_unit: Optional[str] = 'CN=Computers', site: Optional[str] = None, backup_operators: Optional[List[str]] = None, administrators: Optional[List[str]] = None, kdc_ip: Optional[str] = None, ad_name: Optional[str] = None, server_root_ca_certificate: Optional[str] = None, aes_encryption: Optional[bool] = None, ldap_signing: Optional[bool] = None, security_operators: Optional[List[str]] = None, ldap_over_tls: Optional[bool] = None, allow_local_nfs_users_with_ldap: Optional[bool] = None, **kwargs)

Parameters

active_directory_id
str
Required

Id of the Active Directory.

username
str
Required

Username of Active Directory domain administrator.

password
str
Required

Plain text password of Active Directory domain administrator, value is masked in the response.

domain
str
Required

Name of the Active Directory domain.

dns
str
Required

Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain.

smb_server_name
str
Required

NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.

organizational_unit
str
Required

The Organizational Unit (OU) within the Windows Active Directory.

site
str
Required

The Active Directory site the service will limit Domain Controller discovery to.

backup_operators
list[str]
Required

Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.

administrators
list[str]
Required

Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.

kdc_ip
str
Required

kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.

ad_name
str
Required

Name of the active directory machine. This optional parameter is used only while creating kerberos volume.

server_root_ca_certificate
str
Required

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.

aes_encryption
bool
Required

If enabled, AES encryption will be enabled for SMB communication.

ldap_signing
bool
Required

Specifies whether or not the LDAP traffic needs to be signed.

security_operators
list[str]
Required

Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier.

ldap_over_tls
bool
Required

Specifies whether or not the LDAP traffic needs to be secured via TLS.

allow_local_nfs_users_with_ldap
bool
Required

If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.

Variables

status
str or ActiveDirectoryStatus

Status of the Active Directory. Possible values include: "Created", "InUse", "Deleted", "Error", "Updating".

status_details
str

Any details in regards to the Status of the Active Directory.