Listing LDAP server users

Use the ldap_user_list command to list LDAP server users.

ldap_user_list role=Category [ domain=DomainName ]

Parameters

Name Type Description Mandatory Default
role Enumeration The role of the users to be retrieved from the LDAP server. The available roles are: storageadmin and readonly. Y N/A
domain Object name The domain name. N All Domains

This command retrieves a list of users from the LDAP server by a specific role.

Field ID Field output Default position
user_name User Name 1
user_role Role 2

Example: 

ldap_user_list role=storageadmin

Output: 


User Name       Role
--------------- -----------
readonly_user   Read Only
restldapread    Read Only
test_readonly   Read Only
xivreadonly     Read Only

Access control

User Category Permission
Storage administrator Allowed
Storage integration administrator Disallowed
Application administrator Disallowed
Security administrator Allowed
Read-only users Disallowed
Technicians Disallowed

Return codes

  • LDAP_AUTHENTICATION_IS_NOT_ACTIVE

    LDAP authentication is not active.

  • LDAP_IS_NOT_FULLY_CONFIGURED

    LDAP is not fully configured.

    Troubleshooting: Check LDAP settings.

  • NO_LDAP_SERVERS_ARE_DEFINED

    No LDAP servers are defined in the system

  • NO_LDAP_SERVERS_WITH_CERTIFICATE_ARE_DEFINED

    No LDAP servers with an LDAP certificate are defined in the system.

  • LOGIN_FAILURE_XIV_USER_NOT_AUTHENTICATED_BY_LDAP_SERVER

    XIV User 'XIV User' was not authenticated by LDAP server 'Server FQDN'.

  • LOGIN_FAILURE_LDAP_SERVER_UNREACHABLE

    No LDAP server can be reached.

  • LOGIN_FAILURE_INVALID_BASE_DN

    The base dn of server 'Server FQDN' is invalid.