December 24 - AppLogic 2.4.7 is now available and is the latest production release!
Component Control Commands
The following commands are supported:
| Command | Description |
|---|
| list | Retrieve list of components for a particular application |
| info | Retrieve detailed information for a component |
| start | Start a component |
| stop | Stop a component |
| continue | Continue starting of a component |
| restart | Restart a component |
| ssh | Access the shell in a component's virtual machine (over ssh) |
| login | Login to a component. (Supported in Applogic 2.3+) |
list
| Description: | List all components for the specified running application |
| Syntax: | component list name [ --batch ] |
| Arguments: | name | Name of application for which to retrieve list of components |
| --batch | Display output in UDL format |
| Examples: | component list sugarcrm - List components for application 'sugarcrm' |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
Name Server State CPU Mem(MB) Bandwidth(Mbps)
main.mail srv1 running 0.01 32.00 1.00
main.logs srv2 running 0.01 32.00 1.00
main.config srv3 running 0.01 32.00 1.00
main.dbase srv1 running 0.01 128.00 1.00
main.srv2 srv2 running 0.10 64.00 1.00
main.srv1 srv3 running 0.10 64.00 1.00
main.webs srv1 running 0.01 32.00 1.00
main.admin srv2 running 0.01 32.00 1.00
main.usr srv3 running 0.01 32.00 1.00
info
| Description: | Retrieve detailed information for a specific component |
| Syntax: | component info name [ --batch ][ --verbose ] |
| Arguments: | name | Name of component for which to retrieve information. name should be of the form application name:component name |
| --batch | Display output in UDL format |
| --verbose | Include list of interfaces for the component |
| Examples | component info sugarcrm:main.config - Display information for component 'main.config' in application 'sugarcrm' |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
name : main.config
state : running
default IP address : 10.160.6.29
time started : Sat May 27 11:48:47 2006
server : srv3
cpu : 0.01
mem : 32.00 MB
bw : 1.00 Mbps
start
| Description: | Start a component |
| Syntax: | component start name (prop=val)* [ --debug ] |
| Arguments: | name | Name of component to start. name should be of the form application name:component name |
| prop=val | Parameters for initial scheduling of component. The following parameters may be specified: |
| cpu - (optional) CPU allocation (val[%]) |
| mem - (optional) Memory allocation (val[M[B]|G[B]]). If units are not specified, memory is in MB. |
| bw - (optional) Bandwidth allocation (val[M[b]|G[b]]). If units are not specified, bandwidth is in Mbps. |
| --debug | Start component in debug mode. |
| Examples | component start sugarcrm:main.config - Start component 'main.config' in 'application sugarcrm' |
| Notes: | This command will fail if the application is not running. |
stop
| Description: | Stop a component |
| Syntax: | component stop name [ --force ] |
| Arguments: | name | Name of component to stop. name should be of the form application name:component name |
| --force | Force the stopping of the component (i.e., abort). |
| Examples | component stop sugarcrm:main.config - Stop component 'main.config' in application 'sugarcrm' |
| Notes: | None. |
continue
| Description: | Continue starting of a component |
| Syntax: | component continue name |
| Arguments: | name | Name of component to continue starting. name should be of the form application name:component name |
| Examples | component stop sugarcrm:main.config - Continue starting component 'main.config' in application 'sugarcrm' |
| Notes: | This command is useful following the failed start of a component started with --debug option. |
restart
| Description: | Restart a component |
| Syntax: | component restart name (prop=val)* [ --debug ] [ --force ] |
| Arguments: | name | Name of component to restart. name should be of the form application name:component name |
| prop=val | Parameters for scheduling of component. The following parameters may be specified: |
| cpu - (optional) CPU allocation (val[%]) |
| mem - (optional) Memory allocation (val[M[B]|G[B]]). If units are not specified, memory is in MB. |
| bw - (optional) Bandwidth allocation (val[M[b]|G[b]]). If units are not specified, bandwidth is in Mbps. |
| --debug | Start component in debug mode. |
| --force | Force the stopping of the component (i.e., abort) prior to restart. |
| Examples | component restart sugarcrm:main.config - Restart component 'main.config' in 'application sugarcrm' |
| Notes: | This command will fail if the application is not running. |
| This command combines component stop and start commands. |
ssh
| Description: | ssh into a component's virtual machine |
| Syntax: | [component] ssh name [command] |
| Arguments: | name | Name of component to ssh into |
| command | optional command to execute on the appliance. |
| Examples | component ssh sugarcrm:main.config - SSH into component 'main.config' in application 'sugarcrm' |
| Notes: | This command will fail if the component is not running. |
| | The ssh login is performed using a special appliances ssh key installed on your grid. This key does not need a passphrase -- it is assumed that if you are logged in on the controller, you are authorized to log in on the appliances. Contact Technical Support if you cannot log in on an appliance or if you believe your appliance key has been compromised and want to have it replaced. |
login
| Description: | Login to or view the boot console of a component's virtual machine |
| Syntax: | component login name [--ssh | [ [console=console [ --force ]] | --abort ] |
| Arguments: | name | Name of component to login to or view boot console of. |
| --ssh | SSH into a component's virtual machine |
| console | Specifies the type of boot console to access. May be text or graphic. |
| --force | Take control of console (kill existing console if there is one). |
| --abort | Kill existing console if there is one. |
| Examples | component login sugarcrm:main.config --ssh - SSH into component 'main.config' in application 'sugarcrm' |
| Notes: | This command will fail if the component is not started. |
| | If no arguments are specified, --ssh is assumed. |
| | The ssh login is performed using a special appliances ssh key installed on your grid. This key does not need a passphrase -- it is assumed that if you are logged in on the controller, you are authorized to log in on the appliances. Contact Technical Support if you cannot log in on an appliance or if you believe your appliance key has been compromised and want to have it replaced. |
--
BeckyH - 23 May 2006
AppLogic2 Web