Command Line Shell Reference

CONTENTS

Overview

The AppLogic command-line shell gives you control of all aspects of an AppLogic grid. The shell is located in the AppLogic controller and can be accessed over SSH using any suitable SSH client package. The shell commands are designed with the following objectives in mind:

• make the shell easy to use by humans
• provide simple means for scripting automation
• support advanced web interfaces and datacenter management systems

This section specifies the command line usage of the AppLogic Shell. Each shell command is executed using one of the following three command line forms:

command [ args ]*

object command [ args ]*

command object [ args ]*

Where

• object - specifies the type of object and may be: grid, server, application, component, interface, volume, catalog, class, appclass, user, or log.
• command - specifies the command that is to be executed
• args - specifies additional command-specific arguments.

The "object command" and "command object" forms are interchangeable, e.g. volume mount and mount volume are both valid and will produce the same result. This is done to avoid religious wars over which comes first and promote your freedom of choice.

The following simple commands are supported:

• help - Retrieve top-level help or help for a specific object and/or command
• ca - Set current application
• clear - Clear screen
• ls - List applications or components of current application
• exit - Exit shell

AppLogic Shell Commands

The AppLogic shell commands are sub-divided into the following major groups:

• Grid Control - used to control the AppLogic grid as a whole.
• Server Management - used to manage the set of servers within a grid.
• Application Control - used to control an n-tiered application running on the grid.
• Component Control - used to manage the components of the application.
• Interface Control - used to control the interfaces for a component.
• Volume Management - used to manage the set of volumes accessible to the grid.
• Catalog Management - used to manage catalogs.
• Class Management - used to manage catalog and application classes.
• User Management - used to manage users on the grid controller.
• Log Management - used to view and manage the sytem log on the grid controller.
• Dashboard Message Management - used to view and manage the messages displayed on the AppLogic dashboard.

Note: Some commands are replicated between object groups, consistent with the view that different objects may implement the same operation. Whenever the same operation is executed with a different object, the results are likely to be similar, but not identical. The following table describes which commands belong to which groups:

Simple Shell Commands

help

ca

clear

ls

exit

Advanced Usage

for those who use GNU bash: ClientSideMacros - an alternative way to access the AppLogic shell commands directly from your local command prompt.

-- BeckyH - 23 May 2006