usermgmt::UserManager Interface Reference

User manager interface More...

import"UserManager.idl";

Public Member Functions
vector< string >	getAccountNames ()
	Get a list of account names available on the system. More...
int	createAccount (in string username, in string password)
	Create a new account. More...
int	renameAccount (in string username, in string newUsername)
	Rename an account. More...
int	deleteAccount (in string username)
	Deletes an account. More...
vector< Account >	getAllAccounts ()
	Get information about all available user accounts. More...
int	createAccountFull (in string username, in string password, in UserInfo info)
	Create a new account with defined settings. More...
vector< Account >	getAccountsByRole (in string roleName)
	Get a list of accounts that have a given role. More...
Preferences	getDefaultPreferences ()
	Get default user preferences. More...
int	setDefaultPreferences (in Preferences prefs)
	Set default user preferences. More...

Public Attributes
constant int	ERR_USER_DOESNT_EXIST = 1
	A user with the given name does not exist.
constant int	ERR_USER_NOT_DELETABLE = 2
	The user is not deletable.
constant int	ERR_USER_ALREADY_EXISTS = 1
	A user with the given name already exists.
constant int	ERR_MAX_USERS_REACHED = 2
	Maximum number of users reached.
constant int	ERR_PASSWORD_TOO_SHORT_FOR_SNMP = 3
	The password is too short to be used as SNMPv3 passphrase.
constant int	ERR_INVALID_VALUE = 4
	Invalid arguments.
constant int	ERR_PASSWORD_EMPTY = 5
	The password must not be empty.
constant int	ERR_PASSWORD_TOO_SHORT = 6
	The password is too short.
constant int	ERR_PASSWORD_TOO_LONG = 7
	The password is too long.
constant int	ERR_PASSWORD_CTRL_CHARS = 8
	The password must not contain control characters.
constant int	ERR_PASSWORD_NEED_LOWER = 9
	The password must contain at least one lower-case character.
constant int	ERR_PASSWORD_NEED_UPPER = 10
	The password must contain at least one upper-case character.
constant int	ERR_PASSWORD_NEED_NUMERIC = 11
	The password must contain at least one numeric character.
constant int	ERR_PASSWORD_NEED_SPECIAL = 12
	The password must contain at least one special character.
constant int	ERR_SSH_PUBKEY_DATA_TOO_LARGE = 14
	The ssh public key data is too large.
constant int	ERR_SSH_PUBKEY_INVALID = 15
	The ssh public key is invalid.
constant int	ERR_SSH_PUBKEY_NOT_SUPPORTED = 16
	The ssh public key is not supported.
constant int	ERR_SSH_RSA_PUBKEY_TOO_SHORT = 17
	The ssh RSA public key is too short.
constant int	ERR_USERNAME_INVALID = 18
	The user name contains one or more invalid character(s).
constant int	ERR_NEW_USER_ALREADY_EXISTS = 19
	A user with the new (renamed) user name already exists.

Detailed Description

User manager interface

Member Function Documentation

createAccount()

int usermgmt::UserManager::createAccount	(	in string	username,
		in string	password
	)

Create a new account.

Parameters

username	New user name
password	New password

Returns

0 if OK

1 if a user with the given name already exists

2 if the maximum number of users is reached

3 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).

5 The password must not be empty.

6 The password is too short.

7 The password is too long.

8 The password must not contain control characters.

9 The password has to contain at least one lower case character.

10 The password has to contain at least one upper case character.

11 The password has to contain at least one numeric character.

12 The password has to contain at least one printable special character.

18 if the user name is invalid.

createAccountFull()

int usermgmt::UserManager::createAccountFull	(	in string	username,
		in string	password,
		in UserInfo	info
	)

Create a new account with defined settings.

Parameters

username	New user name
password	New password
info	New user information

Returns

0 if OK

1 if a user with the given name already exists

2 if the maximum number of users is reached

3 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).

4 if any value in the user info is invalid.

5 The password must not be empty.

6 The password is too short.

7 The password is too long.

8 The password must not contain control characters.

9 The password has to contain at least one lower case character.

10 The password has to contain at least one upper case character.

11 The password has to contain at least one numeric character.

12 The password has to contain at least one printable special character.

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.

18 if the user name is invalid.

deleteAccount()

int usermgmt::UserManager::deleteAccount

(

in string

username

)

Deletes an account.

Parameters

username

Name of user to delete

Returns

0 if OK

1 if a user with the given name does not exist

2 if the user cannot be deleted

getAccountNames()

vector<string> usermgmt::UserManager::getAccountNames

(

)

Get a list of account names available on the system.

Returns

List of account names

getAccountsByRole()

vector<Account> usermgmt::UserManager::getAccountsByRole

(

in string

roleName

)

Get a list of accounts that have a given role.

Parameters

roleName

Role name

Returns

List of accounts

getAllAccounts()

vector<Account> usermgmt::UserManager::getAllAccounts

(

)

Get information about all available user accounts.

Returns

List of accounts

getDefaultPreferences()

Preferences usermgmt::UserManager::getDefaultPreferences

(

)

Get default user preferences.

Returns

Default user preferences.

renameAccount()

int usermgmt::UserManager::renameAccount	(	in string	username,
		in string	newUsername
	)

Rename an account.

Parameters

username	Current name of user
newUsername	New name of the user

Returns

0 if OK

1 if a user with the given name does not exist

19 if a user with the new name already exists

setDefaultPreferences()

int usermgmt::UserManager::setDefaultPreferences

(

in Preferences

prefs

)

Set default user preferences.

Parameters

prefs

Default user preferences.

Returns

0 if OK

---

The documentation for this interface was generated from the following file:

• UserManager.idl