phosphor-host-ipmid/user_channel/user_layer.hpp

8 //      http://www.apache.org/licenses/LICENSE-2.0
47  *  User privilege related access data as per IPMI specification.(refer spec
71  *  given user and channel. (refer spec sec 24.6)
81 /** @brief initializes user management
87 /** @brief The ipmi get user password layer call
89  *  @param[in] userName - user name
98  *  @param[in] userName - user name to be removed
100  *  @return 0 on success, non-zero otherwise.
104 /** @brief The IPMI call to reuse password entry for the renamed user
107  *  @param[in] userName - user name which has to be renamed
108  *  @param[in] newUserName - new user name
110  *  @return 0 on success, non-zero otherwise.
117  *  @param[in] userId - user id
125  *  @param[in] priv - privilege level
131 /** @brief get user id corresponding to the user name
133  *  @param[in] userName - user name
135  *  @return userid. Will return 0xff if no user id found
139 /** @brief set's user name
145 /** @brief set's user name
147  *  @param[in] userId - user id
148  *  @param[in] userName - user name
154 /** @brief set user password
156  *  @param[in] userId - user id
157  *  @param[in] userPassword - New Password
163 /** @brief set special user password (non-ipmi accounts)
165  *  @param[in] userName - user name
166  *  @param[in] userPassword - New Password
173 /** @brief get user name
175  *  @param[in] userId - user id
176  *  @param[out] userName - user name
182 /** @brief provides available fixed, max, and enabled user counts
184  *  @param[out] maxChUsers - max channel users
185  *  @param[out] enabledUsers - enabled user count
186  *  @param[out] fixedUsers - fixed user count
193 /** @brief function to update user enabled state
195  *  @param[in] userId - user id
196  *..@param[in] state - state of the user to be updated, true - user enabled.
202 /** @brief determines whether user is enabled
204  *  @param[in] userId - user id
205  *..@param[out] state - state of the user
211 /** @brief provides user privilege access data
213  *  @param[in] userId - user id
214  *  @param[in] chNum - channel number
215  *  @param[out] privAccess - privilege access data
222 /** @brief sets user privilege access data
224  *  @param[in] userId - user id
225  *  @param[in] chNum - channel number
226  *  @param[in] privAccess - privilege access data
227  *  @param[in] otherPrivUpdate - flags to indicate other fields update
235 /** @brief check for user pam authentication. This is to determine, whether user
238  *  @param[in] username - username
239  *  @param[in] password - password
246 /** @brief sets user payload access data
248  *  @param[in] chNum - channel number
249  *  @param[in] operation - ENABLE / DISABLE operation
250  *  @param[in] userId - user id
251  *  @param[in] payloadAccess - payload access data
259 /** @brief provides user payload access data
261  *  @param[in] chNum - channel number
262  *  @param[in] userId - user id
263  *  @param[out] payloadAccess - payload access data