blob: 34babf16bd646fcbe2563245bedd61c45e65d15b [file] [log] [blame]
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05001description: >
2 Implement to update LDAP mandatory properties.
3
4properties:
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05005 - name: LDAPServerURI
6 type: string
7 description: >
8 Specifies the LDAP URI of the server to connect to.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -05009 errors:
10 - xyz.openbmc_project.Common.Error.InternalFailure
11 - xyz.openbmc_project.Common.Error.InvalidArgument
Ratan Guptaa3338fa2018-10-24 23:34:55 +053012 - xyz.openbmc_project.Common.Error.NoCACertificate
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050013 - name: LDAPBindDN
14 type: string
15 description: >
16 Specifies the distinguished name with which to bind to the directory
17 server for lookups.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050018 errors:
19 - xyz.openbmc_project.Common.Error.InternalFailure
20 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050021 - name: LDAPBaseDN
22 type: string
23 description: >
24 Specifies the base distinguished name to use as search base.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050025 errors:
26 - xyz.openbmc_project.Common.Error.InternalFailure
27 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050028 - name: LDAPSearchScope
29 type: enum[self.SearchScope]
30 description: >
31 Specifies the search scope:subtree, one level or base object.
32 default: 0
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050033 errors:
34 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050035 - name: LDAPType
36 type: enum[self.Type]
37 description: >
38 Specifies the the configured server is ActiveDirectory(AD) or
39 OpenLdap. It's just an indication for the LDAP stack running on
40 the BMC, in case the app is implemented in such a way that it has
41 to react differently for AD vs openldap.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050042 errors:
43 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050044
45enumerations:
46 - name: SearchScope
47 description: >
48 Possible base scopes.
49 values:
50 - name: sub
51 - name: one
52 - name: base
53
54 - name: Type
55 description: >
56 Possible LDAP Types.
57 values:
58 - name: ActiveDirectory
59 - name: OpenLdap
60
61# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4