Previous Topic: Command ReferenceNext Topic: configure-esm


ALDO Command Reference Overview

Command Line Syntax Summary

The install command line has one of the following forms:

Installing a new grid:
aldo new grid=grid_name servers=Server Controller IP address ext_gateway=gway_ip account_id=id account_key=key [file=name] [opt=val ...]
Commands that affect the entire grid:
aldo clean | rekey grid=grid_name
Grid configuration:
aldo set grid=grid_name controller=n1
aldo set grid=grid_name [file=name] [opt=val ...] 
Information and Status:
aldo list
aldo info grid=grid_name
Supported Commands

ALDO functions

Description

prepare

Create a virtual machine definition that defines the server controller for a grid.

new

Install, configure and start a new grid.

clean

Disable and uninstall an entire grid.

set

Change grid parameters.

addip,remip,setip,listip

View and change application IP address ranges.

rekey

Update the administrator access keys for the grid.

list

Display a list of grids.

info

Display configuration of a gird.

reset, ai, ci

Special-purpose and advanced commands, used primarily for recovery from failures.

Standalone Commands

Description

configure-dmexits

Configure the exit for CA VM:Director.

aldo-fix

Apply hotfix.

upgrade (1,2)

Upgrade software to newer version.

downgrade

Downgrade software to previous version.

Invocation

The ALDO command line tool (aldo) must be started from the directory where the distribution files are located. Unless you have the current directory listed in your PATH environment variable, use ./aldo as the command name.

Note: Except for noninteractive execution, always start a command from an interactive ssh session or use the -t option of ssh (allocate a terminal). aldo can then prompt you for confirmation as needed. Specifying answer=yes on the command line usually allows it to complete noninteractively, except where prompting for passwords is needed or a time-out occurs. In such cases, an interactive invocation stops and prompts; while a noninteractive one aborts with an error.

Important: If you use agent forwarding, do not send a running ALDO command to the background and log out from ssh. These actions remove the agent socket and cause the command to fail on the next attempt to connect to a server.

Common Command Line Arguments for All Commands

grid=name

Unique name of the grid (for example, grid=alphabet-soup). This argument is mandatory for all commands except for the command 'list', which works with all grids. Specify a new unused name for the 'new' command, or the name of a previously installed grid for all other commands. Allowed characters in the grid name are: [A-Za-z0-9-].

file=filename

Specifies a configuration file containing lines in the form opt=val, or opt='val' (similar to bash env var settings). More than one file can be specified, if desired. If multiple occurrences of the same option are found in different files, the last one takes effect. Options that are specified on the command line override the ones in all the files.

A configuration file can include other configuration files using the ' source filename' directive.

If a default configuration file, found at /var/local/ald/defaults, is present, aldo reads that file. The default file is read first, and any other configuration files that are specified on the command line can override settings in the defaults file. To change the default settings to use for all grids that the distribution server maintains, create and edit this file.

Note: Using a configuration file is optional, all settings can be specified on the command line. Conversely, any command line parameter defined in the detailed syntax descriptions can be specified in a file.

answer=yes

If set, assumes 'yes' answer to all interactive prompts (for unattended operation).

Note: This setting does not actually ensure that an unattended setup completes successfully. Other prompts can require an answer other than yes or no (login passwords to the servers, for example).