cterasdk.edge.users module#
- class cterasdk.edge.users.Users(edge)#
Bases:
BaseCommand
Edge Filer Users configuration APIs
- add(username, password, full_name=None, email=None, uid=None)#
Add a user of the Gateway
- Parameters:
username (str) – User name for the new user
password (str) – Password for the new user
full_name (str,optional) – The full name of the new user, defaults to None
email (str,optional) – E-mail address of the new user, defaults to None
uid (str,optional) – The uid of the new user, defaults to None
- add_first_user(username, password, email='')#
Add the first user of the Edge Filer and login
- Parameters:
username (str) – User name for the new user
password (str) – Password for the new user
email (str,optional) – E-mail address of the new user, defaults to an empty string
- delete(username)#
Delete an existing user
- Parameters:
username (str) – User name of the user to delete
- get(name=None)#
Get User. If a user name was not passed as an argument, a list of all local users will be retrieved
- Parameters:
name (str,optional) – Name of the user
- modify(username, password=None, full_name=None, email=None, uid=None)#
Modify an existing user of the Gateway
- Parameters:
username (str) – User name to modify
password (str,optional) – New password, defaults to None
full_name (str,optional) – The full name of the user, defaults to None
email (str,optional) – E-mail address of the user, defaults to None
uid (str,optional) – The uid of the user, defaults to None