User Management Commands

The following commands are supported:

Notes:

• anyone can add/remove users
• only name & password are required to create a new user, all other values are optional
• anyone can modify the settings of any user (i.e., there's no user privilege levels, any user is an 'admin')

list

Typical Output

   eric@example.com      UFO
   jessie@example.com    Jessie
   lion@example.com      Maybe Nameless
   peter@example.com     My Number Is 123

Output Example in --batch Mode

   user: id='eric@example.com', realname='UFO'
   user: id='jessie@example.com', realname='Jessie'
   user: id='lion@example.com', realname='Maybe Nameless', lockout=287
   user: id='peter@example.com', realname='My Number Is 123'

info

Typical Output

comment      =
lockout      = 287 sec (time remaining until user can make another login attempt)
realname     = Maybe Nameless

create

destroy

set

Description:	Modify a user profile
Syntax:	user set name [key1=value1] [key2=value2] ...
Arguments:	name	Name of the user to modify
	keyN=ValueN	One or more profile property settings. The table below explains the available settings.
Examples:	user set myuser pwd=- - Set new password for 'myuser' by asking the user for it
pwd	Password. The password can be set either directly, by supplying the password string on the command line, or typed to a 'shadow-display' password prompt that does not reveal the entered characters. The shadow entry option is selected by using a single '-' character as the password, i.e. pwd=- . The 'shadow display' mode works differently depending on whether the input is a terminal device or not. For a terminal, a prompt is displayed and the password has to be entered twice. For non-terminal input nothing is displayed and the password string is simply read from the input stream once. The pwd=- option should ALWAYS be used to prevent others from potentially seeing the password by hitting the up arrow key.
	The user password is case-sensitive, may consist of any standard keyboard characters [a-z,A-Z,0-9,and special characters] with the exception of ' ' (space), and must have a length between 6 and 64 characters inclusive.
realname	The real name of the user. This is intended as the 'display' name, used to address the user in GUI prompts.
comment	Arbitrary text, saved with the user's profile.
sshkey	an SSH public key to install as the user's access key to the CLI. The string provided for this property must be of the form ssh-rsa base-64 encoded key or ssh-dsa base-64 encoded key . This is the form found in the "public key" file produced by the ssh-keygen command from the OpenSSH tool set. Note that SSH clients other than the one from OpenSSH can be used as well - most of them have the ability to export a public key in the OpenSSH format. Note that since the key string contains a space, the entire value has to be enclosed in quotes, e.g. "sshkey=ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAm1g4ZHEPwKDGDrNfBIK30jhkHv? ..." (the example is truncated, the SSH keys are usually a few hundred characters in length. Using copy-and-paste is highly recommended :)

unlock

-- BeckyH - 23 May 2006