odm-user-setup

odm-user-setup is installed with the Python Client Library and can be accessed from a terminal by typing odm-user-setup.

Usage

This script can be used both in interactive shell mode and in static command-line mode:

usage: odm-user-setup [-H <host>] [-u <user>] [-p <password>]
                    [--token <api-token>] [--access-token <access-token>]
                    [--debug] [--show-logs] [-h] [-v]
                    [<command>]

Genestack user management application.

positional arguments:
  <command>                   "init", "list", "add", "default", "change-
                              password", "change-token", "path", "remove",
                              "rename" or empty to use shell

options:
  -h, --help                  show this help message and exit
  -v, --version               show version

connection:
  -H, --host <host>           server host
  -u, --user <user>           user alias from settings or email
  -p, --password <password>   user password
  --token <api-token>         API token to be used instead of the login and
                              password
  --access-token <access-token>
                              Access token or environment variable with its
                              value to be used instead of the login and password
  --debug                     include server stacktrace into error messages
                              (implies --show-logs)
  --show-logs                 print application logs received from server to
                              stdout

You can get a description for every command by typing:

$ odm-user-setup command -h

In shell mode, type help to get a list of available commands. Use help command to get help for a specific command.

See Connecting to a Genestack instance for more information about connection arguments.

odm-user-setup exits with 0 return code in case of success, 1 in case of various nondescript errors, and 13 if server requires newer Python Client version.

Commands

• add:

  usage: odm-user-setup add [-h]
  
  Add new user.
  
  options:
    -h, --help  show this help message and exit
  

• change-password:

  usage: odm-user-setup change-password [-h] [<alias>]
  
  Change password for user.
  
  command arguments:
    <alias>     Alias for user to change password
  
  options:
    -h, --help  show this help message and exit
  

• change-token:

  usage: odm-user-setup change-token [-h] [<alias>]
  
  Change token for user.
  
  command arguments:
    <alias>     Alias for user to change token for
  
  options:
    -h, --help  show this help message and exit
  

• default:

  usage: odm-user-setup default [-h] [<alias>]
  
  Set default user.
  
  command arguments:
    <alias>     Alias for user to change password
  
  options:
    -h, --help  show this help message and exit
  

• init:

  usage: odm-user-setup [-h] [-H <host>]
  
  Create default settings.
  
  command arguments:
    -H, --host <host>  ODM host address
  
  options:
    -h, --help         show this help message and exit
  

• list:

  usage: odm-user-setup list [-h]
  
  List all users.
  
  options:
    -h, --help  show this help message and exit
  

• path:

  usage: odm-user-setup path [-h]
  
  Show path to configuration file.
  
  options:
    -h, --help  show this help message and exit
  

• remove:

  usage: odm-user-setup remove [-h] [<alias>]
  
  Remove user.
  
  command arguments:
    <alias>     Alias for user to change password
  
  options:
    -h, --help  show this help message and exit
  

• rename:

  usage: odm-user-setup rename [-h] [<alias>] [<new_alias>]
  
  Rename user.
  
  command arguments:
    <alias>      Alias to be renamed
    <new_alias>  New alias
  
  options:
    -h, --help   show this help message and exit