Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_LOGIN_SIZE 65 /** Login session username buffer size */ |
enum OPEN_ACCESS_LEVEL_t |
OpEN uses this enumeration to define access levels.
Enumerator | |
---|---|
OPEN_ACCESS_LEVEL_UNKNOWN |
Unknown Access Level. |
OPEN_ACCESS_LEVEL_LOGIN |
Login Access Level. |
OPEN_ACCESS_LEVEL_ENABLE |
Enable Access Level. |
Definition at line 52 of file openapi_user_manager.h.
enum OPEN_AUTHOR_METHOD_t |
OpEN uses this enumeration to define Authorization methods.
Definition at line 83 of file openapi_user_manager.h.
OpEN uses this enumeration to define Login Access Permissions.
Enumerator | |
---|---|
OPEN_LOGIN_ACCESS_NONE |
No Login Access. |
OPEN_LOGIN_ACCESS_READ_ONLY |
Read-only Login Access. |
OPEN_LOGIN_ACCESS_READ_WRITE |
Read-write Login Access. |
Definition at line 44 of file openapi_user_manager.h.
enum OPEN_LOGIN_TYPE_t |
OpEN Session ID list which use to specify the login type.
Definition at line 122 of file openapi_user_manager.h.
OpEN uses this enumeration to define Accounting Methods.
Definition at line 113 of file openapi_user_manager.h.
OpEN uses this enumeration to define Accounting Types.
Definition at line 94 of file openapi_user_manager.h.
OpEN uses this enumeration to define Authentication method types.
Definition at line 60 of file openapi_user_manager.h.
OpEN uses this enumeration to define Authorization types.
Definition at line 74 of file openapi_user_manager.h.
OpEN uses this enumeration to define Accounting Record types.
Definition at line 103 of file openapi_user_manager.h.
open_error_t openapiAccountingListCreate | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
OPEN_USER_MGR_RECORD_TYPES_t | recordType, | ||
open_buffdesc * | acctListName | ||
) |
Create an Accounting List.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | recordType | Accounting record type: OPEN_USER_MGR_RECORD_TYPES_t |
[in] | acctListName | Accounting list name |
OPEN_E_NONE | if Accounting List is created successfully. |
OPEN_E_FAIL | if failed to create Accounting List or if failed to set record type. |
OPEN_E_EXISTS | if Accounting List already exists. |
OPEN_E_FULL | if maximum number of Accounting Lists have been reached. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName | ||
) |
Delete an Accounting List.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | acctListName | Buff descriptor to Accounting List name |
OPEN_E_NONE | if Accounting List is deleted. |
OPEN_E_FAIL | if invalid Accounting List name is passed or if the Accounting List name is not found or if Accounting List is in use by Console/Telnet/SSH access lines. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListFirstGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName | ||
) |
Get the first Accounting List name.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[out] | acctListName | Buff descriptor to Accounting List name |
OPEN_E_NONE | if first Accounting List name is returned. |
OPEN_E_FAIL | if Accounting List name does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListLineDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_ACCT_TYPES_t | acctType | ||
) |
Delete Accounting List from an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | acctType | Accounting type OPEN_USER_MGR_ACCT_TYPES_t |
OPEN_E_NONE | if the Accounting is deleted from access line. |
OPEN_E_FAIL | if Accounting List is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListLineGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName | ||
) |
Get the Accounting list assigned to an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[out] | acctListName | Buff descriptor to Accounting List name |
OPEN_E_NONE | if Accounting List assigned to access line is returned. |
OPEN_E_FAIL | if Accounting List is not assigned to the access line. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListLineSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName | ||
) |
Set Accounting List to an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | acctListName | Buff descriptor to Accounting List name |
OPEN_E_NONE | if Accounting List is applied to access line. |
OPEN_E_FAIL | if Accounting List name is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | acctListNameSize | ||
) |
Get the maximum size of Accounting List name.
[in] | client_handle | Client handle from registration API |
[out] | acctListNameSize | Maximum size of Accounting List name |
OPEN_E_NONE | if maximum size of Accounting list name is returned. |
OPEN_E_FAIL | if failed to return Accounting List name size. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListNameValidate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | acctListName | ||
) |
Validate Accounting list name.
[in] | client_handle | Client handle from registration API |
[in] | acctListName | Accounting list name. |
OPEN_E_NONE | if Accounting list name is valid. |
OPEN_E_FAIL | if the validation fails. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListNextGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | prevAcctListName, | ||
open_buffdesc * | nextAcctListName | ||
) |
Get the next Accounting List name.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | prevAcctListName | Buff descriptor to previous Accounting List name |
[out] | nextAcctListName | Buff descriptor to next Accounting List name |
OPEN_E_NONE | if next Accounting List name is returned. |
OPEN_E_FAIL | if previous Accounting List name does not exist or if no more Accounting List names exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingListRecordTypeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName, | ||
OPEN_USER_MGR_RECORD_TYPES_t * | recordType | ||
) |
Get the record type assigned to the Accounting List.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | acctListName | Buff descriptor to Accounting List name |
[out] | recordType | Record type associated with Accounting list: OPEN_USER_MGR_RECORD_TYPES_t |
OPEN_E_NONE | if Accounting record type is returned. |
OPEN_E_FAIL | if the Accounting List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingMethodListGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName, | ||
open_buffdesc * | methodList | ||
) |
Get the method(s) assigned to the Accounting List.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | acctListName | Buff descriptor to Accounting List name |
[out] | methodList | Order of the methods assigned to the Accounting List. |
OPEN_E_NONE | if method list is returned |
OPEN_E_FAIL | if the Accounting List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingMethodsAdd | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_ACCT_TYPES_t | acctType, | ||
open_buffdesc * | acctListName, | ||
open_buffdesc * | acctMethod | ||
) |
Add methods to Accounting List.
[in] | client_handle | Client handle from registration API |
[in] | acctType | Accounting type: OPEN_USER_MGR_ACCT_TYPES_t |
[in] | acctListName | Accounting list name |
[in] | acctMethod | Accounting method |
OPEN_E_NONE | if methods are added to the Accounting List. |
OPEN_E_FAIL | if failed to add methods or if invalid methods are passed. |
OPEN_E_EXISTS | if the methods are already configured or if duplicate methods are configured. |
OPEN_E_NOT_FOUND | if the Accounting List name is not found. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAccountingMethodsMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxAcctMethods | ||
) |
Get the maximum Accounting Methods supported.
[in] | client_handle | Client handle from registration API |
[out] | maxAcctMethods | Maximum Accounting methods supported |
OPEN_E_NONE | if maximum number of Accounting methods is returned successfully. |
OPEN_E_FAIL | if failed to return maximum Accounting methods. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticateUser | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
open_buffdesc * | password, | ||
OPEN_LOGIN_ACCESS_LEVELS_t * | accessLevel | ||
) |
Authenticate Login User.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name to authenticate |
[in] | password | Password for the user |
[out] | accessLevel | Access level of the user: read-write/read-only |
OPEN_E_NONE | if user is authenticated. |
OPEN_E_FAIL | if user is not authenticated due to invalid username/password or if the user is configured with blocked access level |
OPEN_E_ERROR | if all configured Authentication methods failed to provide response due to timeout, etc. |
OPEN_E_INTERNAL | if internal error has occurred. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListCreate | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
open_buffdesc * | authListName | ||
) |
Create an Authentication List.
[in] | client_handle | Client handle from registration API |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | authListName | Authentication list name buff descriptor |
OPEN_E_NONE | if Authentication List is created. |
OPEN_E_FAIL | if failed to create Authentication List. |
OPEN_E_FULL | if maximum number of Authentication Lists have been reached. |
OPEN_E_EXISTS | if the Authentication List already exists. |
OPEN_E_INTERNAL | if internal error has occurred. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
open_buffdesc * | authListName | ||
) |
Delete an Authentication List.
[in] | client_handle | Client handle from registration API |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | authListName | Authentication list name buff descriptor |
OPEN_E_NONE | if Authentication List is deleted successfully. |
OPEN_E_NOT_FOUND | if Authentication List does not exist. |
OPEN_E_FAIL | if Authentication List is in use by Console/Telnet/SSH access lines. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListFirstGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | authLevel, | ||
open_buffdesc * | authListName | ||
) |
Get the first Authentication List name.
[in] | client_handle | Client handle from registration API |
[in] | authLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[out] | authListName | First Authentication List name |
OPEN_E_NONE | if the first Authentication List name is returned. |
OPEN_E_FAIL | if failed to return first Authentication List name. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListLineDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_ACCESS_LEVEL_t | accessLevel | ||
) |
Delete Authentication List from an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
OPEN_E_NONE | if the Authentication List is deleted from access line. |
OPEN_E_FAIL | if Authentication List is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListLineGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
open_buffdesc * | authListName | ||
) |
Get Authentication List assigned to an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[out] | authListName | Authentication list name buff descriptor |
OPEN_E_NONE | if Authentication List assigned to access line is returned. |
OPEN_E_FAIL | if failed to return Authentication List of an access level. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListLineSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
open_buffdesc * | authListName | ||
) |
Set Authentication List to an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | authListName | Authentication list name buff descriptor |
OPEN_E_NONE | if Authentication List is applied to access line. |
OPEN_E_NOT_FOUND | if Authentication List does not exist. |
OPEN_E_ERROR | if Authentication List being configured to line Console does not have enable/local methods. |
OPEN_E_FAIL | if Authentication List is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | authListNameSize | ||
) |
Get the maximum size of Authentication List name.
[in] | client_handle | Client handle from registration API |
[out] | authListNameSize | Authentication list name maximum size |
OPEN_E_NONE | if maximum size of Authentication List name is returned successfully. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListNameValidate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | authListName | ||
) |
Validate Authentication list name.
[in] | client_handle | Client handle from registration API |
[in] | authListName | Authentication list name. |
OPEN_E_NONE | if Authentication list name is valid. |
OPEN_E_FAIL | if the validation fails. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationListNextGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | authLevel, | ||
open_buffdesc * | prevAuthListName, | ||
open_buffdesc * | nextAuthListName | ||
) |
Get the next Authentication List name.
[in] | client_handle | Client handle from registration API |
[in] | authLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | prevAuthListName | Previous Authentication List name |
[out] | nextAuthListName | Next Authentication List name |
OPEN_E_NONE | if the next Authentication List name is returned. |
OPEN_E_FAIL | if the previous Authentication List name does not exist or if no more Authentication List names exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationMethodListGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | authLevel, | ||
open_buffdesc * | authListName, | ||
open_buffdesc * | methodList | ||
) |
Get the method(s) assigned to Authentication List.
[in] | client_handle | Client handle from registration API |
[in] | authLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | authListName | Buff descriptor to Accounting List name |
[out] | methodList | Order of the methods assigned to the Accounting List. |
OPEN_E_NONE | if method list is returned |
OPEN_E_FAIL | if the Authentication List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationMethodsAdd | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
open_buffdesc * | authListName, | ||
open_buffdesc * | authMethod | ||
) |
Add methods to the Authentication list.
[in] | client_handle | Client handle from registration API |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[in] | authListName | Authentication list name buff descriptor |
[in] | authMethod | Authentication method |
OPEN_E_NONE | if methods are added to the Authentication List. |
OPEN_E_FAIL | if failed to add methods to Authentication List. |
OPEN_E_NOT_FOUND | if Authentication List is not found. |
OPEN_E_ERROR | if invalid methods are passed or if duplicate methods are passed or if the Login and Enable methods are being removed during reconfiguration of the methods of an Authentication list while it is in use by access line Console. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthenticationMethodsMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxAuthMethods | ||
) |
Get the maximum Authentication Methods supported.
[in] | client_handle | Client handle from registration API |
[out] | maxAuthMethods | Maximum Authentication methods supported |
OPEN_E_NONE | if maximum number of Authentication methods is returned successfully. |
OPEN_E_FAIL | if failed to return maximum Authentication methods. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListCreate | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName | ||
) |
Create an Authorization List.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | authorListName | Buff descriptor to Authorization list name |
OPEN_E_NONE | if Authorization List name is created successfully. |
OPEN_E_FAIL | if failed to create Authorization List name. |
OPEN_E_EXISTS | if Authorization List name already exists. |
OPEN_E_FULL | if maximum number of Authorization Lists have been reached. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName | ||
) |
Delete an Authorization List.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | authorListName | Buff descriptor to Authorization List name |
OPEN_E_NONE | if Authorization List is deleted successfully. |
OPEN_E_NOT_FOUND | if Authorization List does not exist or invalid. |
OPEN_E_FAIL | if Authorization List is in use by Console/Telnet/SSH access lines. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListFirstGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName | ||
) |
Get the first Authorization List name.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[out] | authorListName | Buff descriptor to Authorization List name |
OPEN_E_NONE | if first Authorization List is returned successfully. |
OPEN_E_FAIL | if Authorization List name does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListLineDelete | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_AUTHOR_TYPES_t | type | ||
) |
Delete Authorization List from an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
OPEN_E_NONE | if the Authorization is deleted from access line. |
OPEN_E_FAIL | if Authorization List is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListLineGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName | ||
) |
Get the Authorization List name assigned to an access level.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[out] | authorListName | Buff descriptor to Authorization List name |
OPEN_E_NONE | if the Authorization List assigned to access line is returned. |
OPEN_E_FAIL | if the Authorization List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListLineSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName | ||
) |
Set Authorization List to an access line.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | authorListName | Buff descriptor to Authorization List name |
OPEN_E_NONE | if Authorization List is applied to access line. |
OPEN_E_FAIL | if Authorization List is not configured. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | authorListNameSize | ||
) |
Get the maximum and minimum size of Authorization List name.
[in] | client_handle | Client handle from registration API |
[out] | authorListNameSize | Maximum size of the Authorization List name |
OPEN_E_NONE | if Authorization List name size is returned successfully. |
OPEN_E_FAIL | if failed to return Authorization List name size. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListNameValidate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | authorListName | ||
) |
Validate Authorization list name.
[in] | client_handle | Client handle from registration API |
[in] | authorListName | Authorization list name. |
OPEN_E_NONE | if Authorization list name is valid. |
OPEN_E_FAIL | if the validation fails. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationListNextGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | prevAuthorListName, | ||
open_buffdesc * | nextAuthorListName | ||
) |
Get the next Authorization List name.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type: OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | prevAuthorListName | Buff descriptor to previous Authorization List name |
[out] | nextAuthorListName | Buff descriptor to next Authorization List name |
OPEN_E_NONE | if next Authorization List is returned successfully. |
OPEN_E_FAIL | if the previous Authorization List name does not exist or if no more Authorization List names exist. |
OPEN_E_UNAVAIL | if the Authorization feature is not supported. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationMethodListGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName, | ||
open_buffdesc * | authorMethodList | ||
) |
Get the method(s) assigned to Authorization List.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | authorListName | Buff descriptor to Authorization List name |
[out] | authorMethodList | Order of the methods assigned to Authorization List |
OPEN_E_NONE | if method list associated with Authorization List is returned. |
OPEN_E_FAIL | if Authorization List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationMethodsAdd | ( | openapiClientHandle_t * | client_handle, |
OPEN_USER_MGR_AUTHOR_TYPES_t | type, | ||
open_buffdesc * | authorListName, | ||
open_buffdesc * | authorMethod | ||
) |
Add methods to Authorization List.
[in] | client_handle | Client handle from registration API |
[in] | type | Authorization type OPEN_USER_MGR_AUTHOR_TYPES_t |
[in] | authorListName | Buff descriptor to Authorization list name |
[in] | authorMethod | Authorization method |
OPEN_E_NONE | if methods are added to the Authorization List. |
OPEN_E_FAIL | if failed to add methods. |
OPEN_E_ERROR | if duplicate methods are passed. |
OPEN_E_NOT_FOUND | if Authorization List does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiAuthorizationMethodsMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxAuthorMethods | ||
) |
Get maximum Authorization Methods supported.
[in] | client_handle | Client handle from registration API |
[out] | maxAuthorMethods | Maximum Authorization methods supported. |
OPEN_E_NONE | if maximum number of Authorization methods is returned successfully. |
OPEN_E_FAIL | if failed to return maximum Authorization methods. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiEnablePasswordRemove | ( | openapiClientHandle_t * | client_handle | ) |
Delete enable password.
[in] | client_handle | Client handle from registration API |
OPEN_E_NONE | if enable password is deleted successfully. |
OPEN_E_FAIL | if failed to delete enable password. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiEnablePasswordSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | enablePswd | ||
) |
Set enable password.
[in] | client_handle | Client handle from registration API |
[in] | enablePswd | Enable password. |
OPEN_E_NONE | if enable password is set successfully. |
OPEN_E_FAIL | if password is invalid. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiIsAuthenticationRequiredGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACCESS_LINE_t | accessLine, | ||
OPEN_ACCESS_LEVEL_t | accessLevel, | ||
OPEN_BOOL_t * | authStatus | ||
) |
Get whether Authentication is required.
[in] | client_handle | Client handle from registration API |
[in] | accessLine | Access line: OPEN_ACCESS_LINE_t |
[in] | accessLevel | Access levels: OPEN_ACCESS_LEVEL_t |
[out] | authStatus | Authentication Status: OPEN_BOOL_t |
OPEN_E_NONE | if Authentication requirement status is returned. |
OPEN_E_FAIL | if failed to return Authentication requirement status. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiLoginSessionIdleTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | id, | ||
uint32_t * | timeVal | ||
) |
Get the login session idle time.
[in] | client_handle | Client handle from registration API |
[in] | id | Session ID |
[out] | timeVal | Idle time in seconds. |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid parameter was passed. |
OpEN API Version: 1.18
open_error_t openapiLoginSessionRemoteIpAddrGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | id, | ||
open_inet_addr_t * | addr | ||
) |
Get the login session remote IP address.
[in] | client_handle | Client handle from registration API |
[in] | id | Session ID |
[out] | addr | IP address |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid parameter was passed. |
OpEN API Version: 1.18
open_error_t openapiLoginSessionTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | id, | ||
uint32_t * | timeVal | ||
) |
Get the login session time.
[in] | client_handle | Client handle from registration API |
[in] | id | Session ID |
[out] | timeVal | Session time in seconds. |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid parameter was passed. |
OpEN API Version: 1.18
open_error_t openapiLoginSessionTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | id, | ||
OPEN_LOGIN_TYPE_t * | type | ||
) |
Get the login session type.
[in] | client_handle | Client handle from registration API |
[in] | id | Session ID |
[out] | type | Session type |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid parameter was passed. |
OpEN API Version: 1.18
open_error_t openapiLoginSessionUserGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | id, | ||
open_buffdesc * | name | ||
) |
Get the login session username.
[in] | client_handle | Client handle from registration API |
[in] | id | Session ID |
[out] | name | User name |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid parameter was passed. |
OpEN API Version: 1.18
open_error_t openapiMaxUsersSupportedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxUsers | ||
) |
Get the maximum number of users supported.
[in] | client_handle | Client handle from registration API |
[out] | maxUsers | Maximum number of users |
OPEN_E_NONE | if maximum number of login users is returned successfully. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiPasswordSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | passwordMinSize, | ||
uint32_t * | passwordMaxSize | ||
) |
Get the minimum and maximum supported sizes of password.
[in] | client_handle | Client handle from registration API |
[out] | passwordMinSize | Minimum size of password |
[out] | passwordMaxSize | Maximum size of password |
OPEN_E_NONE | Maximum and minimum size of the password is returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiSessionIDNextValidGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_LOGIN_TYPE_t | sessionType, | ||
uint32_t * | prevSessionID | ||
) |
Search the next valid ID of SSH session.
[in] | client_handle | Client handle from registration API |
[in] | sessionType | The session type which need to be returned |
[in,out] | prevSessionID | Previous ID of session |
OPEN_E_NONE | if the next ID of session is returned successfully |
OPEN_E_NOT_FOUND | if the valid next ID wasn't found |
OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiSessionLogout | ( | openapiClientHandle_t * | client_handle, |
uint32_t | sessionID | ||
) |
Closes the session by ID.
[in] | client_handle | Client handle from registration API |
[in] | sessionID | ID of session |
OPEN_E_NONE | if the logout of session was successful |
OPEN_E_FAIL | if the logout wasn't done |
OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiUserDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName | ||
) |
Delete user.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name buff descriptor |
OPEN_E_NONE | if the user is deleted. |
OPEN_E_FAIL | if failed to delete user or if user is "admin". |
OPEN_E_NOT_FOUND | if user does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserFirstGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | username | ||
) |
Get the first user.
[in] | client_handle | Client handle from registration API |
[out] | username | First User name. |
OPEN_E_NONE | if the user is returned successfully. |
OPEN_E_FAIL | if failed to get first user. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserLevelGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
OPEN_LOGIN_ACCESS_LEVELS_t * | level | ||
) |
Get the access level of a user.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name |
[out] | level | Access level of the user. |
OPEN_E_NONE | if the user level is returned successfully. |
OPEN_E_FAIL | if failed to get user access level. |
OPEN_E_ERROR | if user does not exist. |
OPEN_E_INTERNAL | if internal error has occurred. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserLevelSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
OPEN_LOGIN_ACCESS_LEVELS_t | level | ||
) |
Set the access level for an existing user.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name buff descriptor |
[in] | level | Access level: OPEN_LOGIN_ACCESS_LEVELS_t |
OPEN_E_NONE | if the level is set successfully for the user. |
OPEN_E_FAIL | if failed to set user level. |
OPEN_E_NOT_FOUND | if the user does not exist. |
OPEN_E_INTERNAL | if internal error has occurred. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | userNameSize | ||
) |
Get the maximum supported size of username.
[in] | client_handle | Client handle from registration API |
[out] | userNameSize | Maximum size of username. |
OPEN_E_NONE | Maximum size of username returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiUserNameValidate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName | ||
) |
Validate the username string.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name to validate |
OPEN_E_NONE | if username contains valid characters. |
OPEN_E_FAIL | if username contains invalid characters. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | prevUserName, | ||
open_buffdesc * | nextUserName | ||
) |
Get next user name.
[in] | client_handle | Client handle from registration API |
[in] | prevUserName | Previous user name |
[out] | nextUserName | Next user name |
OPEN_E_NONE | if the next user is returned successfully. |
OPEN_E_FAIL | if no more users exist. |
OPEN_E_NOT_FOUND | if previous user does not exist. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserPasswordGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
open_buffdesc * | userPassword | ||
) |
Get the password for specified user.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name |
[out] | userPassword | Password for the user |
OPEN_E_NONE | if user password can be get successfully. |
OPEN_E_FAIL | if user password get fail. |
OPEN_E_NOT_FOUND | if user is not found. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiUserSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
open_buffdesc * | password | ||
) |
Set the user name and password.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name buff descriptor |
[in] | password | Password buff descriptor |
OPEN_E_NONE | if user name and password are set successfully. |
OPEN_E_FAIL | if failed to set username and password. |
OPEN_E_FULL | if no more users can be added. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiWebSessionLogout | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sessionId | ||
) |
End session for an existing user.
[in] | client_handle | Client handle from registration API |
[in] | sessionId | Session ID of the login. |
OPEN_E_NONE | if session is valid. |
OPEN_E_FAIL | if session is not valid. |
OpEN API Version: 1.6
open_error_t openapiWebSessionUserLogin | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | userName, | ||
open_buffdesc * | password, | ||
open_buffdesc * | logintype, | ||
open_buffdesc * | inetaddr, | ||
uint32_t * | accessLevel, | ||
open_buffdesc * | sessionId | ||
) |
Create session for an existing user.
[in] | client_handle | Client handle from registration API |
[in] | userName | User name to authenticate |
[in] | password | Password for the user |
[in] | logintype | Login protocol HTTP/HTTPS |
[in] | inetaddr | Client IP address |
[out] | accessLevel | Access level of the user |
[out] | sessionId | Session ID of the login. |
OPEN_E_NONE | if user is authenticated. |
OPEN_E_FAIL | if user is not authenticated due to invalid username/password or if the user is configured with blocked access level |
OPEN_E_ERROR | if all configured Authentication methods failed to provide response due to timeout, etc. |
OPEN_E_INTERNAL | if internal error has occurred. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_FULL | if maximum login sessions exist already. |
OpEN API Version: 1.6
open_error_t openapiWebSessionValidate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sessionId, | ||
open_buffdesc * | logintype, | ||
open_buffdesc * | inetaddr, | ||
uint32_t * | accessLevel | ||
) |
validate session for an existing user.
[in] | client_handle | Client handle from registration API |
[in] | sessionId | Session ID of the login. |
[in] | logintype | Login protocol HTTP/HTTPS |
[in] | inetaddr | Client IP address |
[out] | accessLevel | Access Level of the session |
OPEN_E_NONE | if session is valid. |
OPEN_E_FAIL | if session is not valid. |
OpEN API Version: 1.6