Help text

Help text

This is the help text displayed by the default command or using --help. This gives the precise definition of parameters, however, it might be easier to just look at the examples. Note, the information in this section is automatically generated, so if you have edit suggestions, add a comment. Otherwise, your edits will be replaced on the next update.

Tips

  • Use single dash for single letter parameters - example: -v
  • Use double dash for multi-letter parameter - example: --help
  • When parameters are specified, most need a value - example: --action addPage
  • Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
  • Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
  • Some parameters become required once a specific action is chosen. This is indicated in the help text for each value.
  • Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same
  • Some parameters have default values, if so, they are indicated below - example: (default: automation)
  • Some parameters are required - indicated by (...) - example: (-a|--action) <action>
  • Some parameters are optional - indicated by [...] - example: [(-f|--file) <file>]
  • Values that have more than one word must be enclosed by double quotes - example: --title "this is my title"
 

Usage:
  crowd [--help] (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet]
  [--outputFormat <outputFormat>] [--sql <sql>] [--driver <driver>] [--url <url>] [--host <host>] [--port <port>] [--database
  <database>] [--continue] [--simulate] (-s|--server) <server> (-u|--user) <user> (-p|--password) <password> [--login <login>]
  [--service <service>] [-l|--loginFromStandardInput] [--api <api>] [--directory <directory>] [--group <group>] [--userId <userId>]
  [--userFullName <userFullName>] [--userEmail <userEmail>] [--userPassword <userPassword>]


	Provides capability to make requests to a remote server.
	Required parameters: action, server, password.
	Optional parameters: user (likely required for your installation).
	Other required and optional parameters depending on action requested.


  [--help]
        Prints this help message.

  (-a|--action) <action>
        Requested operation to perform. Valid actions (not case sensitive) are:
        
        login - Login is a null operation for this service.
        	 Required parameters: password
        	 Optional parameters: user
        logout - Logout is a null operation for this service.
        run - Run script.
        	 Required parameters: file
        	 Optional parameters: continue, simulate, encoding
        runFromSql - Run script generated from SQL.
        	 Required parameters: sql or file, url or host, driver, database
        	 Optional parameters: host, port, url, continue, simulate, encoding
        getDirecory - Get directory information.
        	 Required parameters: directory
        	 Optional parameters: file
        getUser - Get user information.
        	 Required parameters: directory, userId
        	 Optional parameters: file
        getGroup - Get group information.
        	 Required parameters: directory, userId
        	 Optional parameters: file
        getDirectoryList - Get a list of directories.
        	 Optional parameters: file
        getUserList - Get a list of users from a directory that match the partial userId specified. Defaults to all users in the
        directory.
        	 Required parameters: directory
        	 Optional parameters: userId, file
        getGroupList - Get a list of groups from a directory that match the partial group specified. Defaults to all group in the
        directory.
        	 Required parameters: directory
        	 Optional parameters: group, file
        addUser - Add a new user.
        	 Required parameters: userId
        	 Optional parameters: userFullName, userEmail, userPassword
        addUserWithFile - Add users from comma separated file.
        	 Required parameters: file
        removeUser - Remote a user.
        	 Required parameters: userId
        removeUserWithFile - Remove users from comma separate file.
        	 Required parameters: file
        addGroup - Add a new group.
        	 Required parameters: group
        removeGroup - Remove a group.
        	 Required parameters: group
        	 Optional parameters: defaultGroup
        addUserToGroup - Add user to a group.
        	 Required parameters: userId, group
        	 Optional parameters: autoGroup
        addUserToGroupWithFile - Add users to groups from comma separated file.
        	 Required parameters: file
        	 Optional parameters: autoGroup
        removeUserFromGroup - Remove user from a group.
        	 Required parameters: userId, group
        removeUserFromGroupWithFile - Remove users from groups from comma separated file.
        	 Required parameters: file

  [(-f|--file) <file>]
        Path to file based content or result output

  [--encoding <encoding>]
        Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

  [--debug]
        Requests debug output, example: stack traces.

  [-v|--verbose]
        Requests verbose output.

  [--quiet]
        Limit some output messages.

  [--outputFormat <outputFormat>]
        Specify output format for an action. (default: 1)

  [--sql <sql>]
        SQL select statement used to generate a run script.

  [--driver <driver>]
        JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

  [--url <url>]
        Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

  [--host <host>]
        Database host server for SQL actions. Not used if url is provided. (default: localhost)

  [--port <port>]
        Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

  [--database <database>]
        Database name is required for SQL actions.

  [--continue]
        Continue processing even after errors are encountered.

  [--simulate]
        Simulate running actions. Log the action that would be taken.

  (-s|--server) <server>
        Server URL.

  (-u|--user) <user>
        User name for remote login. (default: automation)

  (-p|--password) <password>
        User password for remote login.

  [--login <login>]
        Login token from previous login request.

  [--service <service>]
        Service address extension. (default: /rest/)

  [-l|--loginFromStandardInput]
        Get login token from standard input.

  [--api <api>]
        API version. Some requests produce different results based on the api version used. Use 0 for latest. (default: 0)

  [--directory <directory>]
        Directory name.

  [--group <group>]
        Group name.

  [--userId <userId>]
        User id for user management and other actions.

  [--userFullName <userFullName>]
        User name for user management actions.

  [--userEmail <userEmail>]
        User email for user management actions.

  [--userPassword <userPassword>]
        User password for user management actions.