User interface
More...
User interface
Definition at line 110 of file User.idl.
◆ getCapabilities()
Gets the user capabilities.
- Returns
- capabilities
◆ getInfo()
Get user information.
- Returns
- User information
◆ getInfoAndPrivileges()
Get information and a list of granted privileges for a user.
- Parameters
-
info | User information |
privileges | List of granted privileges |
◆ setAccountPassword()
int usermgmt::User::setAccountPassword |
( |
in string |
password | ) |
|
Set the account password.
- Parameters
-
- Returns
- 0 OK
-
1 The new password has to differ from old password.
-
2 The password must not be empty.
-
3 The password is too short.
-
4 The password is too long.
-
5 The password must not contain control characters.
-
6 The password has to contain at least one lower case character.
-
7 The password has to contain at least one upper case character.
-
8 The password has to contain at least one numeric character.
-
9 The password has to contain at least one printable special character.
-
10 The password already is in history.
-
11 SNMPv3 USM is activated for the user and the password shall be used as auth passphrase. For this case, the password is too short (must be at least 8 characters).
◆ setPreferences()
int usermgmt::User::setPreferences |
( |
in Preferences |
prefs | ) |
|
Sets the user preferences.
- Parameters
-
- Returns
- 0 OK
-
ERR_INVALID_ARGUMENT An argument is invalid or out of range
◆ updateAccountFull()
int usermgmt::User::updateAccountFull |
( |
in string |
password, |
|
|
in UserInfo |
info |
|
) |
| |
Update user information.
- Parameters
-
password | The new password; empty to leave unchanged |
info | The new user information |
- Returns
- 0 OK
-
1 The new password has to differ from old password.
-
3 The password is too short.
-
4 The password is too long.
-
5 The password must not contain control characters.
-
6 The password has to contain at least one lower case character.
-
7 The password has to contain at least one upper case character.
-
8 The password has to contain at least one numeric character.
-
9 The password has to contain at least one printable special character.
-
10 The password already is in history.
-
11 SNMPv3 USM is activated for the user and the password shall be used as auth passphrase. For this case, the password is too short (must be at least 8 characters).
-
12 An argument is invalid or out of range
-
13 The password passed in as SNMPv3 authentication pass phrase was wrong.
-
14 The ssh public key data is too large.
-
15 The ssh public key is invalid.
-
16 The ssh public key is not supported.
-
17 The ssh RSA public key is too short.
◆ ERR_INVALID_ARGUMENT
constant int usermgmt::User::ERR_INVALID_ARGUMENT = 12 |
Invalid arguments.
Definition at line 123 of file User.idl.
◆ ERR_PASSWORD_CTRL_CHARS
constant int usermgmt::User::ERR_PASSWORD_CTRL_CHARS = 5 |
The password must not contain control characters.
Definition at line 116 of file User.idl.
◆ ERR_PASSWORD_EMPTY
constant int usermgmt::User::ERR_PASSWORD_EMPTY = 2 |
The password must not be empty.
Definition at line 113 of file User.idl.
◆ ERR_PASSWORD_IN_HISTORY
constant int usermgmt::User::ERR_PASSWORD_IN_HISTORY = 10 |
The password is already in the password history.
Definition at line 121 of file User.idl.
◆ ERR_PASSWORD_NEED_LOWER
constant int usermgmt::User::ERR_PASSWORD_NEED_LOWER = 6 |
The password must contain at least one lower-case character.
Definition at line 117 of file User.idl.
◆ ERR_PASSWORD_NEED_NUMERIC
constant int usermgmt::User::ERR_PASSWORD_NEED_NUMERIC = 8 |
The password must contain at least one numeric character.
Definition at line 119 of file User.idl.
◆ ERR_PASSWORD_NEED_SPECIAL
constant int usermgmt::User::ERR_PASSWORD_NEED_SPECIAL = 9 |
The password must contain at least one special character.
Definition at line 120 of file User.idl.
◆ ERR_PASSWORD_NEED_UPPER
constant int usermgmt::User::ERR_PASSWORD_NEED_UPPER = 7 |
The password must contain at least one upper-case character.
Definition at line 118 of file User.idl.
◆ ERR_PASSWORD_TOO_LONG
constant int usermgmt::User::ERR_PASSWORD_TOO_LONG = 4 |
The password is too long.
Definition at line 115 of file User.idl.
◆ ERR_PASSWORD_TOO_SHORT
constant int usermgmt::User::ERR_PASSWORD_TOO_SHORT = 3 |
The password is too short.
Definition at line 114 of file User.idl.
◆ ERR_PASSWORD_TOO_SHORT_FOR_SNMP
constant int usermgmt::User::ERR_PASSWORD_TOO_SHORT_FOR_SNMP = 11 |
The password is too short to be used as SNMPv3 passphrase.
Definition at line 122 of file User.idl.
◆ ERR_PASSWORD_UNCHANGED
constant int usermgmt::User::ERR_PASSWORD_UNCHANGED = 1 |
The new password must differ from the old password.
Definition at line 112 of file User.idl.
◆ ERR_SSH_PUBKEY_DATA_TOO_LARGE
constant int usermgmt::User::ERR_SSH_PUBKEY_DATA_TOO_LARGE = 14 |
The ssh public key data is too large.
Definition at line 125 of file User.idl.
◆ ERR_SSH_PUBKEY_INVALID
constant int usermgmt::User::ERR_SSH_PUBKEY_INVALID = 15 |
The ssh public key is invalid.
Definition at line 126 of file User.idl.
◆ ERR_SSH_PUBKEY_NOT_SUPPORTED
constant int usermgmt::User::ERR_SSH_PUBKEY_NOT_SUPPORTED = 16 |
The ssh public key is not supported.
Definition at line 127 of file User.idl.
◆ ERR_SSH_RSA_PUBKEY_TOO_SHORT
constant int usermgmt::User::ERR_SSH_RSA_PUBKEY_TOO_SHORT = 17 |
The ssh RSA public key is too short.
Definition at line 128 of file User.idl.
◆ ERR_WRONG_PASSWORD
constant int usermgmt::User::ERR_WRONG_PASSWORD = 13 |
The passed-in password was wrong.
Definition at line 124 of file User.idl.
The documentation for this interface was generated from the following file: