List of Agent Commands and Equivalents

  To display a list of available Agent commands, press Enter in the operating system window where you started Essbase Server in the foreground.

Table 133 describes each Agent command, and the MaxL, ESSCMD, or Administration Services equivalents:

Table 133. Agent Commands and MaxL, ESSCMD, or Administration Services Equivalents

Agent Command

Function

MaxL, ESSCMD, or Administration Services Equivalent

START appname

Starts the specified application.

  • MaxL: alter system load application appname;

  • ESSCMD: LOADAPP

  • Administration Services: Start, then Application on the application node in Enterprise View

STOP appname

Stops the specified application.

  • MaxL: alter system unload application appname;

  • ESSCMD: UNLOADAPP

  • Administration Services: Stop, then Application on application node in Enterprise View

USERS

Displays a list of users connected to the Essbase Server. The following information is displayed:

  • Names of users connected to the Essbase Server

  • Number of ports installed

  • Number of connections

  • Application to which each user is connected

  • Database to which each user is connected

  • MaxL: display user;

    (lists all users and shows which users are logged on)

  • ESSCMD: LISTUSERS

    (lists all users)

  • Administration Services: Edit, then Sessions on the server node in Enterprise View

PORTS

Displays the number of ports installed on the Essbase Server and the number of ports in use.

  • MaxL: display system;

    (to display available unused ports)

  • ESSCMD: N/A

  • Administration Services: Edit, then Properties (Essbase Server Properties window, Statistics tab) on the server node in Enterprise View

LOGOUTUSER user

Disconnects a user from the Essbase Server and frees a port.

This command requires the Essbase system password.

  • MaxL: alter system logout session by user username;

  • ESSCMD: LOGOUTUSER

  • Administration Services: Edit, then Sessions on the server node in Enterprise View

PASSWORD

Changes the system password that is required to start the Essbase Server.

This command requires the Essbase system password.

  • MaxL: alter user system_administrator set password password;

  • ESSCMD: SETPASSWORD

  • Administration Services: N/A

COMPACT

Enables compaction of the security file when the Agent is running. See Managing Essbase Security File Fragmentation.

Note:

Essbase compacts the security file automatically each time the Agent is stopped.

  • MaxL: alter system compact security file;

  • ESSCMD: N/A

  • Administration Services: Compact security file on the server's security node in Enterprise View

DUMP filename

Dumps information from the Essbase security file (essbase.sec) to a specified file in text (ASCII) format. If you do not supply a path with the filename, the file is saved to the ARBORPATH/bin directory.

This command requires the Essbase system password.

Note:

You cannot use the DUMP command against an Essbase Server that is run as a service. If the server is running as a service, use the Export Security File command in Administration Services or the export security_file MaxL statement.

  • MaxL: export security_file;

  • ESSCMD: N/A

  • Administration Services: Export Security File on the server's security node in Enterprise View

See Exporting the Essbase Security File to a Readable Format.

Note:

You can use the export security file command against an Essbase Server that is run as a service.

VERSION

Displays the Essbase Server software version number.

  • MaxL: display system;

  • ESSCMD: GETVERSION

  • Administration Services: Edit, then Properties (Essbase Server Properties window, License tab) on the server node in Enterprise View

HELP

Lists all valid Agent commands and their respective functions. Same as pressing Enter.

N/A

QUIT and EXIT

Shuts down all open applications and stops Essbase Server.

  • MaxL: alter system shutdown;

  • ESSCMD: SHUTDOWNSERVER

  • Administration Services: Stop on the server node in Enterprise View