user_channel:Change fun ret&cmd cc as per New Std
Modified ipmi function return status code and
command completion codes as per new standard.
Tested:
verified using ipmitool commands.
1. create new user
Command : ipmitool user set name 5 user5
Response: //user created successfully
Command: ipmitool user set password 5 0penBmc\' //set password
Response: Set User Password command successful (user 5)
2. Set password
Command : ipmitool user set password 5 0penBmc\'
Response: Set User Password command successful (user 5)
3. set channel access
Command: ipmitool channel setaccess 1 5 callin=on ipmi=on link=on
privilege=4
Response: Set User Access (channel 1 id 5) successful.
4. get channel access
Command: ipmitool channel getaccess 1 5
Response:
Maximum User IDs : 15
Enabled User IDs : 5
User ID : 5
User Name : user5
Fixed Name : No
Access Available : call-in / callback
Link Authentication : enabled
IPMI Messaging : enabled
Privilege Level : ADMINISTRATOR
Enable Status : disabled
5. User list
Command: ipmitool user list 1
Response:
ID Name Callin Link Auth IPMI Msg Channel Priv Limit
1 root false true true ADMINISTRATOR
2 putty_operator true true true OPERATOR
3 ipmi_admin true true true ADMINISTRATOR
4 user2 false true true OPERATOR
5 user5 true true true ADMINISTRATOR
6 true false false NO ACCESS
7 true false false NO ACCESS
8 true false false NO ACCESS
9 true false false NO ACCESS
10 true false false NO ACCESS
11 true false false NO ACCESS
12 true false false NO ACCESS
13 true false false NO ACCESS
14 true false false NO ACCESS
15 true false false NO ACCESS
Signed-off-by: jayaprakash Mutyala <mutyalax.jayaprakash@intel.com>
Signed-off-by: NITIN SHARMA <nitin1x.sharma@intel.com>
Change-Id: I5f2c32f50edc2de204ac361364e21a61a4bcf237
diff --git a/user_channel/user_mgmt.hpp b/user_channel/user_mgmt.hpp
index 159b15c..d77317a 100644
--- a/user_channel/user_mgmt.hpp
+++ b/user_channel/user_mgmt.hpp
@@ -202,47 +202,46 @@
* @param[in] userId - user id
* @param[out] userName - user name
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t getUserName(const uint8_t userId, std::string& userName);
+ Cc getUserName(const uint8_t userId, std::string& userName);
/** @brief to set user name
*
* @param[in] userId - user id
- * @param[in] userNameInChar - user name
+ * @param[in] userName - user name
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setUserName(const uint8_t userId, const char* userNameInChar);
+ Cc setUserName(const uint8_t userId, const char* userNameInChar);
/** @brief to set user enabled state
*
* @param[in] userId - user id
* @param[in] enabledState - enabled state of the user
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setUserEnabledState(const uint8_t userId,
- const bool& enabledState);
+ Cc setUserEnabledState(const uint8_t userId, const bool& enabledState);
/** @brief to set user password
*
* @param[in] userId - user id
* @param[in] userPassword - new password of the user
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setUserPassword(const uint8_t userId, const char* userPassword);
+ Cc setUserPassword(const uint8_t userId, const char* userPassword);
/** @brief to set special user password
*
* @param[in] userName - user name
* @param[in] userPassword - new password of the user
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setSpecialUserPassword(const std::string& userName,
- const std::string& userPassword);
+ Cc setSpecialUserPassword(const std::string& userName,
+ const std::string& userPassword);
/** @brief to set user privilege and access details
*
@@ -252,11 +251,11 @@
* @param[in] otherPrivUpdates - other privilege update flag to update ipmi
* enable, link authentication and access callback
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setUserPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
- const UserPrivAccess& privAccess,
- const bool& otherPrivUpdates);
+ Cc setUserPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
+ const UserPrivAccess& privAccess,
+ const bool& otherPrivUpdates);
/** @brief to get user payload access details from userInfo entry.
*
@@ -301,12 +300,11 @@
* @param[in] userId - user id
* @param[in] payloadAccess - payload access
*
- * @return IPMI_CC_OK for success, others for failure.
+ * @return ccSuccess for success, others for failure.
*/
- ipmi_ret_t setUserPayloadAccess(const uint8_t chNum,
- const uint8_t operation,
- const uint8_t userId,
- const PayloadAccess& payloadAccess);
+ Cc setUserPayloadAccess(const uint8_t chNum, const uint8_t operation,
+ const uint8_t userId,
+ const PayloadAccess& payloadAccess);
/** @brief reads user management related data from configuration file
*