blob: d644eef0c61d194445b2719784a4239603b46601 [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 Gorugantic6cfd2c2018-08-10 00:57:41 -050012 - name: LDAPServerURI
13 type: string
14 description: >
15 Specifies the LDAP URI of the server to connect to.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050016 errors:
17 - xyz.openbmc_project.Common.Error.InternalFailure
18 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050019 - name: LDAPBindDN
20 type: string
21 description: >
22 Specifies the distinguished name with which to bind to the directory
23 server for lookups.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050024 errors:
25 - xyz.openbmc_project.Common.Error.InternalFailure
26 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050027 - name: LDAPBaseDN
28 type: string
29 description: >
30 Specifies the base distinguished name to use as search base.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050031 errors:
32 - xyz.openbmc_project.Common.Error.InternalFailure
33 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050034 - name: LDAPBINDDNpassword
35 type: string
36 description: >
37 Specifies the clear text credentials with which to bind. This option
38 is only applicable when used with LDAPBindDN.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050039 errors:
40 - xyz.openbmc_project.Common.Error.InternalFailure
41 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050042 - name: LDAPSearchScope
43 type: enum[self.SearchScope]
44 description: >
45 Specifies the search scope:subtree, one level or base object.
46 default: 0
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050047 errors:
48 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050049 - name: LDAPType
50 type: enum[self.Type]
51 description: >
52 Specifies the the configured server is ActiveDirectory(AD) or
53 OpenLdap. It's just an indication for the LDAP stack running on
54 the BMC, in case the app is implemented in such a way that it has
55 to react differently for AD vs openldap.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050056 errors:
57 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050058
59enumerations:
60 - name: SearchScope
61 description: >
62 Possible base scopes.
63 values:
64 - name: sub
65 - name: one
66 - name: base
67
68 - name: Type
69 description: >
70 Possible LDAP Types.
71 values:
72 - name: ActiveDirectory
73 - name: OpenLdap
74
75# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4