1b1b4d261SWilliam A. Kennington IIIdescription: > 2b1b4d261SWilliam A. Kennington III Implement to create LDAP name service daemon configuration file. 3b1b4d261SWilliam A. Kennington III 4b1b4d261SWilliam A. Kennington IIImethods: 5b1b4d261SWilliam A. Kennington III - name: CreateConfig 6b1b4d261SWilliam A. Kennington III description: > 7*a1347418SPatrick Williams This method always creates a new config file as well as a D-Bus object 8*a1347418SPatrick Williams to represent the config, it will destroy an existing one, if found. In 9*a1347418SPatrick Williams other words, this is not an update API. Individual properties can be 10*a1347418SPatrick Williams updated as per the 11b1b4d261SWilliam A. Kennington III xyz/openbmc_project/User/Ldap/Config.interface.yaml. 12b1b4d261SWilliam A. Kennington III parameters: 13b1b4d261SWilliam A. Kennington III - name: LDAPServerURI 14b1b4d261SWilliam A. Kennington III type: string 15b1b4d261SWilliam A. Kennington III description: > 16b1b4d261SWilliam A. Kennington III Specifies the LDAP URI of the server to connect to. 17b1b4d261SWilliam A. Kennington III - name: LDAPBindDN 18b1b4d261SWilliam A. Kennington III type: string 19b1b4d261SWilliam A. Kennington III description: > 20b1b4d261SWilliam A. Kennington III Specifies the distinguished name with which to bind to the 21b1b4d261SWilliam A. Kennington III directory server for lookups. 22b1b4d261SWilliam A. Kennington III - name: LDAPBaseDN 23b1b4d261SWilliam A. Kennington III type: string 24b1b4d261SWilliam A. Kennington III description: > 25b1b4d261SWilliam A. Kennington III Specifies the base distinguished name to use as search base. 26b1b4d261SWilliam A. Kennington III - name: LDAPBINDDNpassword 27b1b4d261SWilliam A. Kennington III type: string 28b1b4d261SWilliam A. Kennington III description: > 29b1b4d261SWilliam A. Kennington III Specifies the clear text credentials with which to bind. This 30b1b4d261SWilliam A. Kennington III option is only applicable when used with LDAPBindDN. 31b1b4d261SWilliam A. Kennington III - name: LDAPSearchScope 32b1b4d261SWilliam A. Kennington III type: enum[self.SearchScope] 33b1b4d261SWilliam A. Kennington III description: > 34b1b4d261SWilliam A. Kennington III Specifies the search scope:subtree, one level or base object. 35b1b4d261SWilliam A. Kennington III - name: LDAPType 36b1b4d261SWilliam A. Kennington III type: enum[self.Type] 37b1b4d261SWilliam A. Kennington III description: > 38b1b4d261SWilliam A. Kennington III Specifies the the configured server is ActiveDirectory(AD) or 39b1b4d261SWilliam A. Kennington III OpenLdap. It's just an indication for the LDAP stack running on 40*a1347418SPatrick Williams the BMC, in case the app is implemented in such a way that it 41*a1347418SPatrick Williams has to react differently for AD vs openldap. 42b1b4d261SWilliam A. Kennington III - name: GroupNameAttribute 43b1b4d261SWilliam A. Kennington III type: string 44b1b4d261SWilliam A. Kennington III description: > 45*a1347418SPatrick Williams Specifies the attribute name that contains the name of the Group 46*a1347418SPatrick Williams in the LDAP server. 47b1b4d261SWilliam A. Kennington III - name: UsernameAttribute 48b1b4d261SWilliam A. Kennington III type: string 49b1b4d261SWilliam A. Kennington III description: > 50*a1347418SPatrick Williams Specifies the attribute name that contains the username in the 51*a1347418SPatrick Williams LDAP server. 52b1b4d261SWilliam A. Kennington III returns: 53b1b4d261SWilliam A. Kennington III - name: path 54b1b4d261SWilliam A. Kennington III type: string 55b1b4d261SWilliam A. Kennington III description: > 56b1b4d261SWilliam A. Kennington III The object path of the D-Bus object representing the config. 57b1b4d261SWilliam A. Kennington III 58b1b4d261SWilliam A. Kennington III errors: 59b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 60b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InvalidArgument 61b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.NoCACertificate 62b1b4d261SWilliam A. Kennington III 63b1b4d261SWilliam A. Kennington IIIenumerations: 64b1b4d261SWilliam A. Kennington III - name: SearchScope 65b1b4d261SWilliam A. Kennington III description: > 66b1b4d261SWilliam A. Kennington III Possible base scopes. 67b1b4d261SWilliam A. Kennington III values: 68b1b4d261SWilliam A. Kennington III - name: sub 69b1b4d261SWilliam A. Kennington III - name: one 70b1b4d261SWilliam A. Kennington III - name: base 71b1b4d261SWilliam A. Kennington III 72b1b4d261SWilliam A. Kennington III - name: Type 73b1b4d261SWilliam A. Kennington III description: > 74b1b4d261SWilliam A. Kennington III Possible LDAP Types. 75b1b4d261SWilliam A. Kennington III values: 76b1b4d261SWilliam A. Kennington III - name: ActiveDirectory 77b1b4d261SWilliam A. Kennington III - name: OpenLdap 78