Operation: | Add Active Directory Server / Test Active Directory Server / Edit Active Directory Server
Description: | To Create/Edit/Test Active Directory Server. It is used by the appliance for authenticating users against an Active Directory.

Sample Configuration
    	<AuthenticationServer>
    		<ActiveDirectory>
    	<!-- For Active Directory -->
    		<ServerName>name</ServerName>
    		<ServerAddress>ipaddress</ServerAddress>
    		<Port>port</Port>
    		<NetBIOSDomain>name</NetBIOSDomain>
    		<ADSUsername>username</ADSUsername>
    		<Password>password</Password>
    		<ConnectionSecurity>Simple/SSL/StartTLS</ConnectionSecurity>
    		<ValidCertReq>Enable/Disable</ValidCertReq>
    		<IntegrationType>LooseIntegration/TightIntegration</IntegrationType>
    		<!-- Only for tight integration -->
    		<DisplayNameAttribute>Text</DisplayNameAttribute>
    		<EmailAddressAttribute>Text</EmailAddressAttribute>

    		<DomainName>name</DomainName>
    		<SearchQueries>
    			<Query>Text</Query>
    			:
    		</SearchQueries>
    	</ActiveDirectory>
    	</AuthenticationServer>

Attribute/Parameter Information :

Parameter | Mandatory | Default | Description
--- | --- | --- | ---
ServerName | Yes |  | Description: Specify a name for identifying the Server. ServerName confines to: Type is 'SCALAR'. Datatype is 'STRING'. Comma (,) is not allowed. Maximum characters allowed are 50. UTF-8 character(s) are allowed.
ServerAddress/ServerIpDomain | Yes |  | Description: Specify IP Address of the Server. ServerAddress/ServerIpDomain confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS','IPADDRESS6'. Maximum characters allowed are 255. IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST', 'LINKLOCAL' is allowed.
Port | Yes | 389 | Description: Specify port number through which the Server communicates. Port confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Allowed numbers: 1 to 65535.
NetBIOSDomain/ServerName | Yes |  | Description: Specify NetBIOS Domain name. NetBIOSDomain/ServerName confines to: Type is 'SCALAR'. Datatype is 'STRING'. Comma (,) is not allowed. Maximum characters allowed are 100. UTF-8 character(s) are allowed.
Administrator/Username/ADSUsername | Yes |  | Description: Specify admin username to access ADS. Administrator/Username/ADSUsername confines to: Type is 'SCALAR'. Datatype is 'STRING'. Comma (,) is not allowed. Maximum characters allowed are 100. UTF-8 character(s) are allowed.
Password | No |  | Description: Specify admin password to access ADS. Password confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 50.
ConnectionSecurity | Yes |  | Description: Select the type of Connection Security for sending the Username and Password to the external Server from the available options: Simple, SSL or STARTTLS. ConnectionSecurity confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '1', '2', '3' are allowed.
ValidCertReq/ValidateServerCertificate | No |  | Description: Select to validate the certificate of the external Server. ValidCertReq/ValidateServerCertificate confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'y', 'n' are allowed.
IntegrationType | No |  | Description: Select integration type which is used in setting the user group membership from the available options: Loose Integration or Tight Integration. IntegrationType confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '1' are allowed.
DisplayNameAttribute | No |  | Description: Specify the name to be displayed to the user for the ADS. DisplayNameAttribute confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 30.
EmailAddressAttribute | No | mail | Description: Specify the name to be displayed to the user for the configured Email Address. EmailAddressAttribute confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 30.
DomainName | Yes |  | Description: Specify Domain name to which the query is to be added. DomainName confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 50.
Query | No |  | Description: Specify Search Query. Query confines to: Type is 'ARRAY'. Datatype is 'STRING'. Maximum characters allowed are 255. Multiple values are allowed.
ServerType | Yes |  | Description: Select Server type from the available options: LDAP Server, Active Directory or RADIUS Server. ServerType confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '1' are allowed.

Status Message Information :

Operation | Status | Message
--- | --- | ---
Edit Active Directory Server | 200 |
Edit Active Directory Server | 500 |
Edit Active Directory Server | 503 |
Test Active Directory Server | 200 |
Test Active Directory Server | 500 |
Test Active Directory Server | 541 |
Test Active Directory Server | 542 |
Test Active Directory Server | 543 |
Add Active Directory Server | 200 |
Add Active Directory Server | 500 |
Add Active Directory Server | 502 |
Add Active Directory Server | 503 |

) Copyright 2017 Sophos Limited. All rights reserved.
Sophos is registered trademarks of Sophos Limited and Sophos Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.