phosphor-host-ipmid/user_channel/channel_mgmt.hpp

8 //      http://www.apache.org/licenses/LICENSE-2.0
19 #include "ipmid/api-types.hpp"
45  *  Structure to store both non-volatile and volatile channel access information
56  *  Structure for channel information - base structure to get all information
88      *  @param[in] chNum - channel number
96      *  @param[in] chNum - channel number
97      *  @param[in] authType - authentication type
105      *  @param[in] chNum - channel number index
113      *  @param[in] chName - channel name
125      *  @param[in] chNum - channel number
127      *  @return EChannelSessSupported - supported session type
133      *  @param[in] chNum - channel number
141      *  @param[in] chNum - channel number
149      *  @param[in] chNum - channel number
150      *  @param[out] chInfo - channel info details
158      *  @param[in] chNum - channel number
159      *  @param[out] chAccessData - channel access data
167      *  @param[in] chNum - channel number
168      *  @param[in] chAccessData - channel access data
169      *  @param[in] setFlag - flag to indicate updatable fields
177     /** @brief to get channel access data persistent data
179      *  @param[in] chNum - channel number
180      *  @param[out] chAccessData - channel access data
187     /** @brief to set channel access data persistent data
189      *  @param[in] chNum - channel number
190      *  @param[in] chAccessData - channel access data
191      *  @param[in] setFlag - flag to indicate updatable fields
201      *  @param[in] chNum - channel number
202      *  @param[out] authTypeSupported - supported authentication type
211      *  @param[in] chNum - channel number
212      *  @param[in] priv - privilege
213      *  @param[out] authType - enabled authentication type
222      *  @param[in] value - privilege value
228     /** @brief function to write persistent channel configuration to config file
230      *  @return 0 for success, -errno for failure.
236      *  @return 0 for success, -errno for failure.
241      * changes to phosphor-user-manager. Any channel access changes made on
260     /** @brief function to initialize persistent channel configuration
268      *  @param[in] chNum - channel number
269      *  @param[in] chName - channel name
276      *  @return 0 for success, -errno for failure.
280     /** @brief function to read persistent channel data
282      *  @return 0 for success, -errno for failure.
288      *  @return 0 for success, -errno for failure.
292     /** @brief function to check and reload persistent channel data
294      *  @return 0 for success, -errno for failure.
300      *  @return 0 for success, -errno for failure.
307      *  @return 0 for success, -errno for failure.
311     /** @brief function to set D-Bus property value
313      *  @param[in] service - service name
314      *  @param[in] objPath - object path
315      *  @param[in] interface - interface
316      *  @param[in] property - property name
317      *  @param[in] value - property value
319      *  @return 0 for success, -errno for failure.
327      *  @param[in] configFile - configuration file name
335      *  @param[in] configFile - configuration file name
336      *  @param[in] jsonData - json object
338      *  @return 0 for success, -errno for failure.
345      *  @param[in] mode - access mode in string
353      *  @param[in] value - acess mode value
361      *  @param[in] value - privilege value
369      *  @param[in] value - session support type in string
378      *  @param[in] value - medium type in string
386      *  @param[in] value - protocol type in string
394      *  @param[in] chName - the channel name defined in the JSON input file
402      * D-Bus handler.
404      *  @param[in] path - D-Bus path to the network element (i.e. eth0)
405      *  @param[in] chProperties - D-Bus channel properties
412      *  @param[in] fileName - the name of the file for which to acquire
421      *  @param[in] path - The DBus path to the device