Table of Contents

nimbleclient.v1.api.ldap_domains

LdapDomain

class LdapDomain(Resource)

Manages the storage array's membership with LDAP servers.

Parameters

  • id : Identifier for the LDAP Domain.
  • domain_name : Domain name.
  • domain_description : Description of the domain.
  • domain_enabled : Indicates whether the LDAP domain is currently active or not.
  • server_uri_list : A set of up to 3 LDAP URIs.
  • bind_user : Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.
  • bind_password : Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.
  • base_dn : The Distinguished Name of the base object from which to start all searches.
  • user_search_filter : Limit the results returned based on specific search criteria.
  • user_search_base_list : A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.
  • group_search_filter : Limit the results returned based on specific search criteria.
  • group_search_base_list : A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.
  • schema_type : Enum values are OpenLDAP or AD.

test_user

 | test_user(user, **kwargs)

Tests whether the user exist in the given LDAP Domain.

Parameters

  • id : Unique identifier for the LDAP Domain.
  • user : Name of the LDAP Domain user.

test_group

 | test_group(group, **kwargs)

Tests whether the user group exist in the given LDAP Domain.

Parameters

  • id : Unique identifier for the LDAP Domain.
  • group : Name of the group.

report_status

 | report_status(**kwargs)

Reports the LDAP connectivity status of the given LDAP ID.

Parameters

  • id : Unique identifier for the LDAP Domain.

LdapDomainList

class LdapDomainList(Collection)

test_user

 | test_user(id, user, **kwargs)

Tests whether the user exist in the given LDAP Domain.

Parameters

  • id : Unique identifier for the LDAP Domain.
  • user : Name of the LDAP Domain user.

test_group

 | test_group(id, group, **kwargs)

Tests whether the user group exist in the given LDAP Domain.

Parameters

  • id : Unique identifier for the LDAP Domain.
  • group : Name of the group.

report_status

 | report_status(id, **kwargs)

Reports the LDAP connectivity status of the given LDAP ID.

Parameters

  • id : Unique identifier for the LDAP Domain.