- Console Command List

Most commands can be entered on both the Console screen (reached through the Launch IBM Alphablox Console link on the General page under the Administration tab) and the IBM Alphablox command screen. However, a few commands are supported only from one or the other. Additionally, not all commands are supported through telnet. For a list of console commands for the IBM Alphablox Cube Server, see the Administering Alphablox Cubes. For a list of commands that are specific to clustering, see Cluster Console Commands.

The following console commands apply to Alphablox only. For example, if you delete an application from Alphablox installed on a WebSphere^(R) server, the application listing is removed from Alphablox only. To remove the application from the WebSphere server, you must remove it using the WebSphere Application Server's Administrative Console.

Command and Example	Purpose and Explanation
ADD object value object value add group admin user radams	Adds the second object to the first object Adds the user named radams to the group named admin
CREATE object value(s) create user radams haggis create data source TBC hyperion essbase adapter server essbaseserver1 catalog demo schema basic username user1 password password1 maxrows 1000 maxcols 1000 useaasuserauth false	Creates an object such as a user or group. Creates a new user with values of radams for name and haggis for password Creates a data source named TBC that accesses the TBC (demo/basic) application on the Hyperion Essbase server named essbaseserver1.
DELETE object value delete user radams delete outlinecache...	Deletes an object from IBM Alphablox and the Alphablox Repository. Deleting an application from Alphablox does not remove the corresponding application from WebSphere server. Deletes the user named radams from Alphablox. Deletes an entry from the Essbase cache.
EXIT	Stops IBM Alphablox and exits the Console screen. This can only be done from the IBM Alphablox command screen; it cannot be done from the Console screen reached through the IBM Alphablox home page.
GET object value get get user radams	Displays information about an object Displays information about the Server (because Server is the default object) Displays the properties for the user named radams
HELP object help help create	Displays help information for the named command Displays a list of all commands Displays a description and syntax for the create command
KILL object kill 1046976892932726235	Kills the current instance of the named object (usually a user session) Kills the session with the ID 1046976892932726235.
LOAD object value load user <userName> load theme load license	Loads an object into the server workspace Loads user <userName> into the server workspace Loads all available themes into the server workspace. (Note that the command does not support loading only a named theme.) Loads (updates) license file (`license.xml`), located in IBM Alphablox `bin` directory.
LOCK	Locks the local access to the server. To access IBM Alphablox after entering this command, you need to enter your user name and password. This can only be done from the IBM Alphablox Console screen and telnet.
MESSAGE object value(s) message review 20 message review debug 20 message C2 Testing	Sends a system message to other consoles or log files Sends the last 20 messages to the current console Sends the last 20 DEBUG messages to the current console Sends the message "Testing" to console C2
OBJECTS object objects objects user	Displays information about manageable objects Displays a hierarchy of manageable objects Displays information about users
RELEASE	Releases the remote server console from which this command is entered. This can only be done from the IBM Alphablox Console screen.
REMOVE object object REMOVE group admin user radams	Removes the source object from the target object. Removes user radams from the group admin.
REPORT object report debug	Sets the message level for the current console to DEBUG, VERBOSE, INFO, SYSTEM, WARNING, ERROR, or FATAL. Sets the message level to debug.
RESUME object resume user	Starts the named service from a suspended state. Starts the User Manager from the previous suspended state.
RUN object run abc.console run createUsers.txt	Runs the command file named by target. Runs the abc.console command file. Runs the createUsers.txt file. (This file might be a batch file containing a series of create user commands for creating new users and establishing their initial passwords. See Note 2 for an example.)
SAVE object value save save user radams	Saves the target's properties Saves all General properties now (because General is the default object). Changes entered on the Console are for the current session only and are lost unless this command is issued, or IBM Alphablox's Save on Exit property is set to `yes`. Saves the properties of user radams
SET object value object value set user radams password castle set smtpserver mail set resolveAliasesToBaseMembers	Sets a value on the object. Sets the password for user radams to castle. Sets the SMTP server to the mail server named mail.
SHOW object show topics show server show user radams show theme show outlinecache show hosts show	Gets information for the target. Lists all the topics for which information is available. Displays all server topics, including users. Displays information about the user named radams. Displays theme name and descriptions. Displays all the entries in the Essbase cache. Displays the name of each machine in the cluster if clustering is enabled. Displays a list of objects. The SHOW command also displays, if it has not already been loaded, the version of the Hyperion Essbase client library API loaded.
START object start user	Starts a service from a stopped state. Starts the User Manager from the previous stopped state.
STATISTICS object value statistics user statistics user radams	Displays available statistics about the target. Displays statistics for all users. Displays statistics for user radams.
STOP object stop user	Stops a running or suspended service. Use START to take a service out of a stopped state. Note: Do not use the STOP command to stop the Cube Manager unless all of the running IBM^(R) Alphablox cubes have been stopped. Stops the User Manager.
SUSPEND object suspend user	Suspends a service. For example, suspending the User Manager prevents new user sessions from instantiating. Use RESUME to take a service out of a suspended state. Suspends the User Manager

Command and Example

Purpose and Explanation

ADD object value object value

add group admin user radams

Adds the second object to the first object

Adds the user named radams to the group named admin

CREATE object value(s)

create user radams haggis

create data source TBC hyperion essbase adapter server essbaseserver1 catalog demo schema basic username user1 password password1 maxrows 1000 maxcols 1000 useaasuserauth false

Creates an object such as a user or group.

Creates a new user with values of radams for name and haggis for password

Creates a data source named TBC that accesses the TBC (demo/basic) application on the Hyperion Essbase server named essbaseserver1.

DELETE object value

delete user radams

delete outlinecache...

Deletes an object from IBM Alphablox and the Alphablox Repository. Deleting an application from Alphablox does not remove the corresponding application from WebSphere server.

Deletes the user named radams from Alphablox.

Deletes an entry from the Essbase cache.

EXIT

Stops IBM Alphablox and exits the Console screen. This can only be done from the IBM Alphablox command screen; it cannot be done from the Console screen reached through the IBM Alphablox home page.

GET object value

get

get user radams

Displays information about an object

Displays information about the Server (because Server is the default object)

Displays the properties for the user named radams

HELP object

help

help create

Displays help information for the named command

Displays a list of all commands

Displays a description and syntax for the create command

KILL object

kill 1046976892932726235

Kills the current instance of the named object (usually a user session)

Kills the session with the ID 1046976892932726235.

LOAD object value

load user <userName>

load theme

load license

Loads an object into the server workspace

Loads user <userName> into the server workspace

Loads all available themes into the server workspace. (Note that the command does not support loading only a named theme.)

Loads (updates) license file (license.xml), located in IBM Alphablox bin directory.

LOCK

Locks the local access to the server. To access IBM Alphablox after entering this command, you need to enter your user name and password. This can only be done from the IBM Alphablox Console screen and telnet.

MESSAGE object value(s)

message review 20

message review debug 20

message C2 Testing

Sends a system message to other consoles or log files

Sends the last 20 messages to the current console

Sends the last 20 DEBUG messages to the current console

Sends the message "Testing" to console C2

OBJECTS object

objects

objects user

Displays information about manageable objects

Displays a hierarchy of manageable objects

Displays information about users

RELEASE

Releases the remote server console from which this command is entered. This can only be done from the IBM Alphablox Console screen.

REMOVE object object

REMOVE group admin user radams

Removes the source object from the target object.

Removes user radams from the group admin.

REPORT object

report debug

Sets the message level for the current console to DEBUG, VERBOSE, INFO, SYSTEM, WARNING, ERROR, or FATAL.

Sets the message level to debug.

RESUME object

resume user

Starts the named service from a suspended state.

Starts the User Manager from the previous suspended state.

RUN object

run abc.console

run createUsers.txt

Runs the command file named by target.

Runs the abc.console command file.

Runs the createUsers.txt file. (This file might be a batch file containing a series of create user commands for creating new users and establishing their initial passwords. See Note 2 for an example.)

SAVE object value

save

save user radams

Saves the target's properties

Saves all General properties now (because General is the default object). Changes entered on the Console are for the current session only and are lost unless this command is issued, or IBM Alphablox's Save on Exit property is set to yes.

Saves the properties of user radams

SET object value object value

set user radams password castle

set smtpserver mail

set resolveAliasesToBaseMembers

Sets a value on the object.

Sets the password for user radams to castle.

Sets the SMTP server to the mail server named mail.

SHOW object

show topics

show server

show user radams

show theme

show outlinecache

show hosts

show

Gets information for the target.

Lists all the topics for which information is available.

Displays all server topics, including users.

Displays information about the user named radams.

Displays theme name and descriptions.

Displays all the entries in the Essbase cache.

Displays the name of each machine in the cluster if clustering is enabled.

Displays a list of objects. The SHOW command also displays, if it has not already been loaded, the version of the Hyperion Essbase client library API loaded.

START object

start user

Starts a service from a stopped state.

Starts the User Manager from the previous stopped state.

STATISTICS object value

statistics user

statistics user radams

Displays available statistics about the target.

Displays statistics for all users.

Displays statistics for user radams.

STOP object

stop user

Stops a running or suspended service. Use START to take a service out of a stopped state.

Note:

Do not use the STOP command to stop the Cube Manager unless all of the running IBM^(R) Alphablox cubes have been stopped.

Stops the User Manager.

SUSPEND object

suspend user

Suspends a service. For example, suspending the User Manager prevents new user sessions from instantiating. Use RESUME to take a service out of a suspended state.

Suspends the User Manager