blob: 26b146532a4811c8b23b0c9736adbe9ab2817411 [file] [log] [blame]
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05001description: >
2 Implement to update LDAP mandatory properties.
3
4properties:
5 - name: SecureLDAP
6 type: boolean
7 description: >
8 Specifies whether to use SSL or not.
9 default: false
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050010 errors:
11 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Goruganti8d656132018-10-17 03:08:21 -050012 - xyz.openbmc_project.Common.Error.NoCACertificate
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050013 - name: LDAPServerURI
14 type: string
15 description: >
16 Specifies the LDAP URI of the server to connect to.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050017 errors:
18 - xyz.openbmc_project.Common.Error.InternalFailure
19 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050020 - name: LDAPBindDN
21 type: string
22 description: >
23 Specifies the distinguished name with which to bind to the directory
24 server for lookups.
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: LDAPBaseDN
29 type: string
30 description: >
31 Specifies the base distinguished name to use as search base.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050032 errors:
33 - xyz.openbmc_project.Common.Error.InternalFailure
34 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050035 - name: LDAPSearchScope
36 type: enum[self.SearchScope]
37 description: >
38 Specifies the search scope:subtree, one level or base object.
39 default: 0
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050040 errors:
41 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050042 - name: LDAPType
43 type: enum[self.Type]
44 description: >
45 Specifies the the configured server is ActiveDirectory(AD) or
46 OpenLdap. It's just an indication for the LDAP stack running on
47 the BMC, in case the app is implemented in such a way that it has
48 to react differently for AD vs openldap.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050049 errors:
50 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050051
52enumerations:
53 - name: SearchScope
54 description: >
55 Possible base scopes.
56 values:
57 - name: sub
58 - name: one
59 - name: base
60
61 - name: Type
62 description: >
63 Possible LDAP Types.
64 values:
65 - name: ActiveDirectory
66 - name: OpenLdap
67
68# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4