CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($ldapObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getLdapConnectorObj ()
  getSessionObj ()
  save ()

Member Function Documentation

LdapConnector::__get ( varName  ) 

Get member.

member

description

name

the Ldap connector name

hostUrl

the Ldap host URL (deprecated)

bindDN

the distinguished name for binding

bindPass

the password for binding

searchBase

the formatted string with the base where to search for the user (deprecated)

searchPattern

the formatted string with the user search pattern (deprecated)

passwordField

the name of the field containing the password (deprecated)

axigenHostField

the name of the field containing the Axigen server hostname

useFirst

the first returned field to be used if more are found (deprecated)

ldapURI1

the first URI to use

ldapURI2

the second URI to use

ldapURI3

the third URI to use

ldapURI4

the fourth URI to use

ldapURI5

the fifth URI to use

synchronizationDirection

possible values: axigenToLdap | ldapToAxigen | bothWays

synchronizationConflictResolution

possible values: axigenWins | ldapWins | noChange

serverType

possible values: OpenLdap | ActiveDirectory

timeout

the connection timeout

accountBaseDN

the account base DN

groupBaseDN

the group base DN

useCustomSchema

the enable/disable usage of a custom schema

customSchemaFile

path to the custom schema file

pollingInterval

the interval to check for changes in Ldap

transientErrorRetryInterval

retry interval for temporary errors

ignoreLDAPDeletes

enabled/disabled the LDAP deletes to be synchronized in axigen

clusteredSetup

enabled/disabled clustered setup

searchDomainAliases

enabled/disabled domain aliases ldap search

replicaID

id of replica (0-999); must be unique between axigen servers

LdapConnector::__set ( varName,
varValue  
)

Set member.

member

description

name

the Ldap connector name

hostUrl

the Ldap host URL (deprecated)

bindDN

the distinguished name for binding

bindPass

the password for binding

searchBase

the formatted string with the base where to search for the user (deprecated)

searchPattern

the formatted string with the user search pattern (deprecated)

passwordField

the name of the field containing the password (deprecated)

axigenHostField

the name of the field containing the Axigen server hostname

useFirst

the first returned field to be used if more are found (deprecated)

ldapURI1

the first URI to use

ldapURI2

the second URI to use

ldapURI3

the third URI to use

ldapURI4

the fourth URI to use

ldapURI5

the fifth URI to use

synchronizationDirection

possible values: axigenToLdap | ldapToAxigen | bothWays

synchronizationConflictResolution

possible values: axigenWins | ldapWins | noChange

serverType

possible values: OpenLdap | ActiveDirectory

timeout

the connection timeout

accountBaseDN

the account base DN

groupBaseDN

the group base DN

useCustomSchema

the enable/disable usage of a custom schema

customSchemaFile

path to the custom schema file

pollingInterval

the interval to check for changes in Ldap

transientErrorRetryInterval

retry interval for temporary errors

ignoreLDAPDeletes

enabled/disabled the LDAP deletes to be synchronized in axigen

clusteredSetup

enabled/disabled clustered setup

searchDomainAliases

enabled/disabled domain aliases ldap search

replicaID

id of replica (0-999); must be unique between axigen servers

LdapConnector::save (  ) 

this method must be called if one of the members has been changed

Returns:
bool