Command Reference - SuperADMIN

This section describes the SuperADMIN commands.

  • accountThis command allows you to create and manage users and groups.
  • catUse this command to configure the catalogue; the collection of datasets and folders available to SuperSERVER.
  • serverThis command maintains the settings for the registered and available SuperSERVERs.
  • auth, authenticationThis command controls user authentication. Use it to configure an external authentication service, such as LDAP or Active Directory.
  • cfgThis command is used to change configuration properties that are stored in the SuperSTAR configuration server.
  • connectionThis command configures the settings used to connect to the administration domain.
  • consoleThis command controls the SuperADMIN display output and sets scripting options.
  • createdatabaselistThis command creates a text file containing a list of all the databases in the catalogue.
  • displayoptionsThis command is used to set the display precision for summation options in SuperWEB2.
  • domainThis command displays and edits the current settings of the SuperSTAR domain administration server. If you have multiple SuperSTAR domains running on the same network, then you can use this command to manage the connections to those domains.
  • exit, quitThis command closes the SuperADMIN console.
  • exportThis command exports the current database catalogue to a macro file. 
  • exportswcThis command has been deprecated and is no longer used. It was previously used to export the SuperWEB1 configuration to a macro file.
  • gc, config, globalconfigurationThis command manages some global configuration properties, most of which relate to the creation of personal folders in the discontinued SuperWEB1 product. The personal folder settings do not apply to SuperWEB2.
  • helpThis command displays a list of currently available commands and details of what they do.
  • loginLogs in to SuperADMIN. You must login to start configuring users and permissions.
  • logoutLogs the current user out of the console.
  • macroWhen performing repetitive tasks, instead of entering each command at the command line, you can enter the commands in a macro and then run the macro. 
  • methodThe method command is used to set parameters for data control plugins and apply the plugins to a database.
  • modeThis command sets one of the SuperADMIN commands as the current "mode" of the console. The specified command is then automatically prefixed to future commands so you do not have to type it each time.
  • rangesThis command configures the limits for the custom range and quantile user defined fields available in SuperWEB2.
  • swc, swconf, swconfigurationThis command has been deprecated and is no longer used. It was previously used for managing the configuration properties for SuperWEB1.
  • userThis command displays the name of the currently logged in user.
  • userregThis command allows you to check whether an email address is blocked by the user registration system and manually block or unblock an address.

Command Syntax

The following command syntax is used throughout these instructions:

{ }
Indicates a set of possible choices.

Separates two mutually exclusive choices in a syntax line. Type one of the choices (do not type the | symbol).

< >
Specifies some information you must provide (such as a path or filename). Replace with the relevant value for your system.
Indicates that an argument can be repeated several times in a command line. Type only the information, not the ellipsis.
[ ]
Indicates optional items.
" "

Whenever you specify a value or argument that contains a space (for example an ID or a display name) you must enclose it in quotes.

You must also use quotes for a value or argument that is alphanumeric but starts with a numeric character.