| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 1 | description: > |
| 2 | Implement to update LDAP mandatory properties. |
| 3 | |
| 4 | properties: |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 5 | - name: LDAPServerURI |
| 6 | type: string |
| 7 | description: > |
| 8 | Specifies the LDAP URI of the server to connect to. |
| Nagaraju Goruganti | 95fafa8 | 2018-09-30 23:25:42 -0500 | [diff] [blame] | 9 | errors: |
| 10 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 11 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| Ratan Gupta | a3338fa | 2018-10-24 23:34:55 +0530 | [diff] [blame] | 12 | - xyz.openbmc_project.Common.Error.NoCACertificate |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 13 | - name: LDAPBindDN |
| 14 | type: string |
| 15 | description: > |
| 16 | Specifies the distinguished name with which to bind to the directory |
| 17 | server for lookups. |
| Nagaraju Goruganti | 95fafa8 | 2018-09-30 23:25:42 -0500 | [diff] [blame] | 18 | errors: |
| 19 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 20 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 21 | - name: LDAPBaseDN |
| 22 | type: string |
| 23 | description: > |
| 24 | Specifies the base distinguished name to use as search base. |
| Nagaraju Goruganti | 95fafa8 | 2018-09-30 23:25:42 -0500 | [diff] [blame] | 25 | errors: |
| 26 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 27 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 28 | - name: LDAPSearchScope |
| 29 | type: enum[self.SearchScope] |
| 30 | description: > |
| 31 | Specifies the search scope:subtree, one level or base object. |
| Lei YU | cb1d059 | 2019-01-09 10:25:49 +0800 | [diff] [blame] | 32 | default: sub |
| Nagaraju Goruganti | 95fafa8 | 2018-09-30 23:25:42 -0500 | [diff] [blame] | 33 | errors: |
| 34 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 35 | - 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 Goruganti | 95fafa8 | 2018-09-30 23:25:42 -0500 | [diff] [blame] | 42 | errors: |
| 43 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Ratan Gupta | 910b0d9 | 2019-03-08 20:40:49 +0530 | [diff] [blame^] | 44 | - name: GroupNameAttribute |
| 45 | type: string |
| 46 | description: > |
| 47 | The value of this property shall be the attribute name |
| 48 | that contains the name of the Group in the LDAP server. |
| 49 | - name: UserNameAttribute |
| 50 | type: string |
| 51 | description: > |
| 52 | The value of this property shall be the attribute name |
| 53 | that contains the username in the LDAP server. |
| Nagaraju Goruganti | c6cfd2c | 2018-08-10 00:57:41 -0500 | [diff] [blame] | 54 | enumerations: |
| 55 | - name: SearchScope |
| 56 | description: > |
| 57 | Possible base scopes. |
| 58 | values: |
| 59 | - name: sub |
| 60 | - name: one |
| 61 | - name: base |
| 62 | |
| 63 | - name: Type |
| 64 | description: > |
| 65 | Possible LDAP Types. |
| 66 | values: |
| 67 | - name: ActiveDirectory |
| 68 | - name: OpenLdap |
| 69 | |
| 70 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |