Class ActiveDirectory


  • public final class ActiveDirectory
    extends Object
    Active Directory.
    • Constructor Detail

      • ActiveDirectory

        public ActiveDirectory()
    • Method Detail

      • activeDirectoryId

        public String activeDirectoryId()
        Get the activeDirectoryId property: Id of the Active Directory.
        Returns:
        the activeDirectoryId value.
      • withActiveDirectoryId

        public ActiveDirectory withActiveDirectoryId​(String activeDirectoryId)
        Set the activeDirectoryId property: Id of the Active Directory.
        Parameters:
        activeDirectoryId - the activeDirectoryId value to set.
        Returns:
        the ActiveDirectory object itself.
      • username

        public String username()
        Get the username property: Username of Active Directory domain administrator.
        Returns:
        the username value.
      • withUsername

        public ActiveDirectory withUsername​(String username)
        Set the username property: Username of Active Directory domain administrator.
        Parameters:
        username - the username value to set.
        Returns:
        the ActiveDirectory object itself.
      • password

        public String password()
        Get the password property: Plain text password of Active Directory domain administrator, value is masked in the response.
        Returns:
        the password value.
      • withPassword

        public ActiveDirectory withPassword​(String password)
        Set the password property: Plain text password of Active Directory domain administrator, value is masked in the response.
        Parameters:
        password - the password value to set.
        Returns:
        the ActiveDirectory object itself.
      • domain

        public String domain()
        Get the domain property: Name of the Active Directory domain.
        Returns:
        the domain value.
      • withDomain

        public ActiveDirectory withDomain​(String domain)
        Set the domain property: Name of the Active Directory domain.
        Parameters:
        domain - the domain value to set.
        Returns:
        the ActiveDirectory object itself.
      • dns

        public String dns()
        Get the dns property: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain.
        Returns:
        the dns value.
      • withDns

        public ActiveDirectory withDns​(String dns)
        Set the dns property: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain.
        Parameters:
        dns - the dns value to set.
        Returns:
        the ActiveDirectory object itself.
      • status

        public ActiveDirectoryStatus status()
        Get the status property: Status of the Active Directory.
        Returns:
        the status value.
      • statusDetails

        public String statusDetails()
        Get the statusDetails property: Any details in regards to the Status of the Active Directory.
        Returns:
        the statusDetails value.
      • smbServerName

        public String smbServerName()
        Get the smbServerName property: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.
        Returns:
        the smbServerName value.
      • withSmbServerName

        public ActiveDirectory withSmbServerName​(String smbServerName)
        Set the smbServerName property: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.
        Parameters:
        smbServerName - the smbServerName value to set.
        Returns:
        the ActiveDirectory object itself.
      • organizationalUnit

        public String organizationalUnit()
        Get the organizationalUnit property: The Organizational Unit (OU) within the Windows Active Directory.
        Returns:
        the organizationalUnit value.
      • withOrganizationalUnit

        public ActiveDirectory withOrganizationalUnit​(String organizationalUnit)
        Set the organizationalUnit property: The Organizational Unit (OU) within the Windows Active Directory.
        Parameters:
        organizationalUnit - the organizationalUnit value to set.
        Returns:
        the ActiveDirectory object itself.
      • site

        public String site()
        Get the site property: The Active Directory site the service will limit Domain Controller discovery to.
        Returns:
        the site value.
      • withSite

        public ActiveDirectory withSite​(String site)
        Set the site property: The Active Directory site the service will limit Domain Controller discovery to.
        Parameters:
        site - the site value to set.
        Returns:
        the ActiveDirectory object itself.
      • backupOperators

        public List<String> backupOperators()
        Get the backupOperators property: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.
        Returns:
        the backupOperators value.
      • withBackupOperators

        public ActiveDirectory withBackupOperators​(List<String> backupOperators)
        Set the backupOperators property: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.
        Parameters:
        backupOperators - the backupOperators value to set.
        Returns:
        the ActiveDirectory object itself.
      • administrators

        public List<String> administrators()
        Get the administrators property: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.
        Returns:
        the administrators value.
      • withAdministrators

        public ActiveDirectory withAdministrators​(List<String> administrators)
        Set the administrators property: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.
        Parameters:
        administrators - the administrators value to set.
        Returns:
        the ActiveDirectory object itself.
      • kdcIp

        public String kdcIp()
        Get the kdcIp property: kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.
        Returns:
        the kdcIp value.
      • withKdcIp

        public ActiveDirectory withKdcIp​(String kdcIp)
        Set the kdcIp property: kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.
        Parameters:
        kdcIp - the kdcIp value to set.
        Returns:
        the ActiveDirectory object itself.
      • adName

        public String adName()
        Get the adName property: Name of the active directory machine. This optional parameter is used only while creating kerberos volume.
        Returns:
        the adName value.
      • withAdName

        public ActiveDirectory withAdName​(String adName)
        Set the adName property: Name of the active directory machine. This optional parameter is used only while creating kerberos volume.
        Parameters:
        adName - the adName value to set.
        Returns:
        the ActiveDirectory object itself.
      • serverRootCACertificate

        public String serverRootCACertificate()
        Get the serverRootCACertificate property: 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.
        Returns:
        the serverRootCACertificate value.
      • withServerRootCACertificate

        public ActiveDirectory withServerRootCACertificate​(String serverRootCACertificate)
        Set the serverRootCACertificate property: 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.
        Parameters:
        serverRootCACertificate - the serverRootCACertificate value to set.
        Returns:
        the ActiveDirectory object itself.
      • aesEncryption

        public Boolean aesEncryption()
        Get the aesEncryption property: If enabled, AES encryption will be enabled for SMB communication.
        Returns:
        the aesEncryption value.
      • withAesEncryption

        public ActiveDirectory withAesEncryption​(Boolean aesEncryption)
        Set the aesEncryption property: If enabled, AES encryption will be enabled for SMB communication.
        Parameters:
        aesEncryption - the aesEncryption value to set.
        Returns:
        the ActiveDirectory object itself.
      • ldapSigning

        public Boolean ldapSigning()
        Get the ldapSigning property: Specifies whether or not the LDAP traffic needs to be signed.
        Returns:
        the ldapSigning value.
      • withLdapSigning

        public ActiveDirectory withLdapSigning​(Boolean ldapSigning)
        Set the ldapSigning property: Specifies whether or not the LDAP traffic needs to be signed.
        Parameters:
        ldapSigning - the ldapSigning value to set.
        Returns:
        the ActiveDirectory object itself.
      • securityOperators

        public List<String> securityOperators()
        Get the securityOperators property: 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.
        Returns:
        the securityOperators value.
      • withSecurityOperators

        public ActiveDirectory withSecurityOperators​(List<String> securityOperators)
        Set the securityOperators property: 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.
        Parameters:
        securityOperators - the securityOperators value to set.
        Returns:
        the ActiveDirectory object itself.
      • ldapOverTls

        public Boolean ldapOverTls()
        Get the ldapOverTls property: Specifies whether or not the LDAP traffic needs to be secured via TLS.
        Returns:
        the ldapOverTls value.
      • withLdapOverTls

        public ActiveDirectory withLdapOverTls​(Boolean ldapOverTls)
        Set the ldapOverTls property: Specifies whether or not the LDAP traffic needs to be secured via TLS.
        Parameters:
        ldapOverTls - the ldapOverTls value to set.
        Returns:
        the ActiveDirectory object itself.
      • allowLocalNfsUsersWithLdap

        public Boolean allowLocalNfsUsersWithLdap()
        Get the allowLocalNfsUsersWithLdap property: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.
        Returns:
        the allowLocalNfsUsersWithLdap value.
      • withAllowLocalNfsUsersWithLdap

        public ActiveDirectory withAllowLocalNfsUsersWithLdap​(Boolean allowLocalNfsUsersWithLdap)
        Set the allowLocalNfsUsersWithLdap property: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.
        Parameters:
        allowLocalNfsUsersWithLdap - the allowLocalNfsUsersWithLdap value to set.
        Returns:
        the ActiveDirectory object itself.
      • encryptDCConnections

        public Boolean encryptDCConnections()
        Get the encryptDCConnections property: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
        Returns:
        the encryptDCConnections value.
      • withEncryptDCConnections

        public ActiveDirectory withEncryptDCConnections​(Boolean encryptDCConnections)
        Set the encryptDCConnections property: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
        Parameters:
        encryptDCConnections - the encryptDCConnections value to set.
        Returns:
        the ActiveDirectory object itself.
      • ldapSearchScope

        public LdapSearchScopeOpt ldapSearchScope()
        Get the ldapSearchScope property: LDAP Search scope options.
        Returns:
        the ldapSearchScope value.
      • withLdapSearchScope

        public ActiveDirectory withLdapSearchScope​(LdapSearchScopeOpt ldapSearchScope)
        Set the ldapSearchScope property: LDAP Search scope options.
        Parameters:
        ldapSearchScope - the ldapSearchScope value to set.
        Returns:
        the ActiveDirectory object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.