addTestDirectory

The addTestDirectory operation handles configuration related to TestDirectory model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
realmUUID	False	string	A unique string identifier assigned to the realm object by the system when the object is created. This ID is required to retrieve directory password when test connections is triggered from an edit view.
hostname	True	string	A mandatory Unicode string containing the hostname or IP address of the directory server. Field level constraints: cannot be null, must be a valid host (FQDN or IP) or a list of valid hosts. (Note: Additional constraints might exist)
directoryUsername	True	string	A mandatory Unicode string containing the distinguished username for a user with appropriate rights to retrieve directory user and group information. Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
directoryPassword	True	string	A mandatory password for a user with appropriate rights to retrieve directory user and group information. Field level constraints: cannot be null. (Note: Additional constraints might exist)
port	True	integer	The port number used for communications with the server. The default is 389. Use port 636 if you select LDAPS as the encryption method. Field level constraints: cannot be null. (Note: Additional constraints might exist)
protocol	False	string	An enum value that specifies the encryption protocol used to connect and download users and group information. Values can be one of the following. NONE - Do not use encryption, users and group information will be downloaded in clear text. STARTTLS - Use the strongest encryption method supported by the directory server. This option is not supported when using relam for remote access VPN. LDAPS - Use LDAP over SSL.
sslCertUUID	False	string	UUID of an external certificate, Certificate Authority (CA) certificate required to enable a trusted connection between the system and the directory server.
sslCertString	False	string	For Internal use.
baseDN	True	string	A mandatory Unicode string containing the directory tree, common parent, for searching and querying user and group information. For example, cn=users,dc=example,dc=com Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
statusCode	False	string	The authentication connection test error or success code returned by the ADI process.
statusMessage	False	string	The authentication connection test error or success message returned by the ADI process.
linaStatusMessage	False	string	The authentication connection test error or success message returned by the configuration CLI.
linaStatusCode	False	integer	The authentication connection test error or success code returned by the configuration CLI.
interface	False	object	The interface object through which the traffic needs to be routed. Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addTestDirectory' operation
  ftd_configuration:
    operation: "addTestDirectory"
    data:
        realmUUID: "{{ realm_uuid }}"
        hostname: "{{ hostname }}"
        directoryUsername: "{{ directory_username }}"
        directoryPassword: "{{ directory_password }}"
        port: "{{ port }}"
        protocol: "{{ protocol }}"
        sslCertUUID: "{{ ssl_cert_uuid }}"
        sslCertString: "{{ ssl_cert_string }}"
        baseDN: "{{ base_dn }}"
        statusCode: "{{ status_code }}"
        statusMessage: "{{ status_message }}"
        linaStatusMessage: "{{ lina_status_message }}"
        linaStatusCode: "{{ lina_status_code }}"
        interface: "{{ interface }}"
        type: "{{ type }}"