|
APIs in Category: ldap |
API version 5.0 |
ldap-server-add |
DFM LDAP related APIs to specify the configuration for authentication with LDAP servers. More than one LDAP server may be specified for redundancy. LDAP server is used for authentication of centralized users. For example: Consider the case where users are added in LDAP server and DFM is configured for authentication with the LDAP server. When a user tries to login to DFM UI to view reports, the credentials of the user are checked with the LDAP server and if it matches only then will DFM allow the user to view the reports. |
| ldap-server-add | [top] |
Add LDAP server to DFM.
Input Name Range Type Description ldap-server ldap-server
IP address and port details of LDAP server to be added to DFM.
Errno Description EINTERNALERROR EINVALIDINPUT EAPIERROR EACCESSDENIED EDATABASEERROR
| ldap-server-delete | [top] |
Delete LDAP server from DFM.
Input Name Range Type Description ldap-server ldap-server
IP address and port details of an LDAP server in DFM to be deleted.
Errno Description EINTERNALERROR EINVALIDINPUT EAPIERROR EACCESSDENIED EDATABASEERROR
| ldap-server-list-info | [top] |
Returns list of LDAP servers known to DFM.
Input Name Range Type Description ldap-server ldap-server
optional
IP address and port details of the LDAP server whose information will be listed. If no input was provided then all the LDAP server added in DFM will be listed. Output Name Range Type Description ldap-servers ldap-server-info[]
The list of LDAP servers.
Errno Description EINTERNALERROR EINVALIDINPUT EAPIERROR EACCESSDENIED EDATABASEERROR
| Element definition: ldap-server | [top] |
Information of one LDAP server contains ip address and port number. This uniquely identifies the LDAP server in DFM.
Name Range Type Description ldap-server-addr network-address
Address of the LDAP server. ldap-server-port integer
optional
Represents port number on which LDAP server will be listening. The default port number is 389. Range : [1..2^16-1]
| Element definition: ldap-server-info | [top] |
Information of one LDAP server.
Name Range Type Description last-failed-time timestamp
optional
Represents the last time when DFM communication with LDAP server failed. Absent if DFM communication with LDAP server has not failed. last-used-time timestamp
Represents the last time when LDAP server was used. ldap-server ldap-server
IP address and port details of the LDAP server.
| Element definition: ldap-server | [top] |
Information of one LDAP server contains ip address and port number. This uniquely identifies the LDAP server in DFM.
Name Range Type Description ldap-server-addr network-address
Address of the LDAP server. ldap-server-port integer
optional
Represents port number on which LDAP server will be listening. The default port number is 389. Range : [1..2^16-1]
| Element definition: network-address | [top] |
IP address of the network or host
[none]
| Element definition: timestamp | [top] |
Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].
[none]