Reference Information › CA AppLogic Support Knowledge Base › Overview of Support Knowledge Base › Command Syntax - Undocumented › 3tctl CMD Reference

3tctl CMD Reference

Quick reference guide to 3tctl(executed from ctl VM only) usage(USE WITH ABSOLUTE CAUTION):

Note: not ALL of these switches are implemented, I would advise which ones are not, but I would prefer you test them on our lab grid(s) first so you have hands-on experience if not already.

3tctl <cmd> [<entity>] [<prop>=<val>]* [-batch] [-verbose]

AppLogic Commands (<entity> is applogic or sys)

start - start AppLogic

stop - stop AppLogic

reboot - reboot the cluster

info - get AppLogic information

exec - execute external utility

Server Control Commands (<entity> is server, srv, or s)

list - list servers

info - retrieve server information

reboot - reboot server

shutdown - shutdown server

power_on - power on a server

power_off - power off a server

enable - enable server for scheduling

disable - disable server for scheduling

refresh - refresh server set

System Volume Control Commands (<entity> is sysvolume, sysvol, or sv)

list - list virtual volumes

info - retrieve virtual volume information

create - create virtual volume

destroy - destroy virtual volume

copy - copy virtual volume

rename - rename virtual volume

mount - mount virtual volume

unmount - unmount virtual volume

migrate - migrate volume

repair - repair volume mirrors

Application Control Commands (<entity> is application, app, or a)

list - list applications

info - retrieve application information

create - create application

destroy - destroy application

alloc - allocate application resources

free - free application resources

start - start application

stop - stop application

continue - continue application start

build - build application

check - check application

Component Control Commands (<entity> is component, comp, or c)

list - list components

info - retrieve component information

start - start component

stop - stop component

continue - continue component start

check - check component

ssh - ssh into component's virtual machine

Interface Control Commands (<entity> is interface, iface, or i)

list - list interfaces

info - retrieve interface information

enable - enable interface

disable - disable interface

reset - reset interface

ctld cfgfile=/etc/applogic/applogic.conf >>/var/log/applogic 2>&1 &

syntax : 3tctl start applogic

description: Start AppLogic

syntax : 3tctl stop applogic

description: Stop AppLogic

syntax : 3tctl reboot applogic

description: Reboot the applogic cluster

syntax : 3tctl info applogic [--batch | -b]

description: Retrieve AppLogic information

--batch : Display output in UDL format

syntax : 3tctl exec <utility> [<args>]*

description: Execute 3rd party utility named <utility> and pass all specified arguments (<args>) on its command line.

syntax : 3tctl list servers [-batch | -b] [-map | -m]

description: List servers

--batch : Display output in UDL format

--map : Include list of components running on each server

syntax : 3tctl info server <name> [--batch | -b] [-map | -m]

description: Retrieve server information

<name> : Name of server for which to retrieve information for

--batch : Display output in UDL format
--map : Include list of components running on the server

syntax : 3tctl reboot server <name>

description: Reboot server

<name> : Name of server to reboot or * to reboot all servers

syntax : 3tctl shutdown server <name>

description: Shutdown server

<name> : Name of server to shutdown or * to shutdown all servers

syntax : 3tctl power_on server <name>

description: Power-on server

<name> : Name of server to power-on or * to power-on all servers

syntax : 3tctl power_off server <name>

description: Power-off server

<name> : Name of server to power-off or * to power-off all servers

syntax : 3tctl enable server <name>

description: Enable server for scheduling

<name> : Name of server to enable or * to enable all servers

syntax : 3tctl disable server <name>

description: Disable server for scheduling

<name> : Name of server to disable or * to disable all servers

syntax : 3tctl refresh server

description: Refresh the set of available servers from cluster descriptor

syntax : 3tctl list sysvolume [--batch | -b]

description: List system volumes

--batch : Display output in UDL format

syntax : 3tctl info sysvolume <name> [--batch | -b]

description: Retrieve volume information

<name> : Name of volume for which to retrieve information

--batch : Display output in UDL format

syntax : 3tctl create sysvolume <name> (<prop>=<val>)*

description : Create new volume

<name> : Name of volume to create. If running in cluster configuration,name must have the following format: <srv name>.<volume name>.

<prop>=<val>: Volume creation parameters:

size=<val> - Size of volume to create in MB.

mirrored=<val>- Set to 1 for mirrored volume

The default is: 1 for multi-server configuration comment=<val> - (optional) Volume comment

syntax : 3tctl destroy sysvolume <name>

description: Destroy volume

<name> : Name of volume to destroy

syntax : 3tctl rename sysvolume <name> <new name>

description: Rename volume

<name> : Name of existing volume

<new name> : New name for volume

syntax : 3tctl copy sysvolume <name> <new name> [(<prop>=<val>)] [--keepcomment]*

description : Copy volume

<name> : Name of volume to copy

<new name> : Name of copied volume. If running in cluster configuration, <new name> must have the following format: <srv name>.<volume name>.

<prop>=<val> : Volume copy parameters

message=<val> - Message to display when reporting progress. The message should contain all text with the exception of the percent completion.

mirrored=<val> Set to 1 for mirrored volume.

comment=<val> - Comment to be set on the new volume --keepcomment: If specified, propagate the comment from the source volume to the new volume.

If neither --keepcomment or comment=<val> are specified, the comment for the new volume is set to empty.

syntax : 3tctl mount sysvolume <name> [<prop>=<val>]*

description : Mount volume as a block device

<name> : Name of volume to mount

<prop>=<val>: Volume mount parameters

ro=<val> - Set to 1 for read-only access

rw=<val> - Set to 1 for read-write access

excl=<val> - Set to 1 for exclusive access

syntax : 3tctl (unmount | umount) sysvolume <name>

description: Unmount volume

<name> : Name of volume to unmount

syntax : 3tctl migrate sysvolume <name> [-batch] [-stop]

description: Migrate volume

<name> : Name of volume to migrate

--batch : Return immediately and don't wait for operation to complete.

--stop : Stop migration of volume

syntax : 3tctl repair sysvolume <name> [-move] [batch] [-stop]

description: Repair volume

<name> : Name of volume to repair

--move : Allow mirrors to be moved during repair

--batch : Return immediately and don't wait for operation to complete.

--stop : Stop repair of volume

syntax : 3tctl list applications [--batch | -b]

description: List applications

--batch : Display output in UDL format

syntax : 3tctl info application <name> [-batch | -b] [-verbose | -v]

description: Retrieve application information

<name> : Name of application for which to retrieve information

--batch : Display output in UDL format

--verbose : Display list of components for the application

syntax : 3tctl create app <name>

description : Create application

<name> : Name of the application

syntax : 3tctl destroy app <name>

description : Destroy application

<name> : Name of the application to destroy

syntax : 3tctl alloc app <name> [<prp>=<val>]*

description : Allocate application resources

<name> : Name of the application

<prop>=<val>: Application scheduling parameters

sched=<val> - String specifying scheduling parameters.

cpu=<val> - Cpu allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

servers=<val>- Number of servers on which application is to run

sandbox=<val>- set to 1 to allow scheduling of components with less than minimum resources

syntax : 3tctl free app <name>

description : Free application resources

<name> : Name of the application

syntax : 3tctl continue app <name>

description : Continue application start

<name> : Name of the application

syntax : 3tctl start app <name> [-no-volprep] [<prp>=<val>]* [-batch | -b]

description : Start application

<name> : Name of the application to start

--no-volprep: Skip volume preparation

<prop>=<val>: Application scheduling parameters

sched=<val> - String specifying scheduling parameters.

cpu=<val> - Cpu allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

--batch : Return immediatly and don't wait for operation to complete

syntax : 3tctl stop app <name> [--batch | -b]

description : Stop application

<name> : Name of the application to stop

--batch : Return immediatly and don't wait for operation to complete

syntax : 3tctl build app <name> [<args>]*

description : Build application

<name> : Name of the application to build

<args> : Build arguments:

--no-volprep - skip volume preparation for all volumes

-clean [-volclean] - clean application - remove all temporary

and optionally remove volumes

--compile - compile application w/o preparing volumes

syntax : 3tctl check app <name>

description : Perform syntax check over application

<name> : Name of application to check

syntax : 3tctl rebalance app <name> [<prp>=<val>]*

description : Rebalance application

<name> : Name of the application to rebalance

<prp>=<val> : Rebalance parameters

sched=<val> - String specifying scheduling parameters.

cpu=<val> - Cpu allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

The "rebalance" command is currently not supported.

syntax : 3tctl crunch app <name>

description : Reduce the allowed resource allocation for application to the minimum allowed

<name> : Name of the application to crunch

The "crunch" command is currently not supported.

syntax : 3tctl expand app <name>

description : Increase the allowed resource allocation for application to the maximum allowed

<name> : Name of the application to expand

The "expand" command is currently not supported.

syntax : 3tctl list components <name> [--batch | -b]

description : List components for an application

<name> : Name of application for which to list components

--batch : Display output in UDL format

syntax : 3tctl info comp <name> [-batch | -b] [-verbose | -v]

description : Display component information

<name> : Name of component: <app name>.<comp name>

--batch : Display output in UDL format

--verbose : Display list of interfaces for the component

syntax : 3tctl start comp <name> [<prp>=<val>]*

description : Start component

<name> : Name of component: <app name>:<comp name>

<prop>=<val>: Component resource parameters

cpu=<val> - Cpu allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

syntax : 3tctl stop comp <name>

description : Stop component

<name> : Name of component: <app name>:<comp name>

syntax : 3tctl continue comp <name>

description : Continue component start

<name> : Name of the component

syntax : 3tctl check comp <name>

description : Compile component descriptor

<name> : Name of component: <app name>:<comp name>

syntax : 3tctl rebalance comp <name> [<prop>=<val>]*

description : Rebalance component

<name> : Name of component: <app name>:<comp name>

<prop>=<val>: Component resource parameters

cpu=<val> - Cpu allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

The "rebalance comp" command is currently not supported.

syntax : 3tctl move comp <name> [<prop>=<val>]*

description : move component

<name> : Name of component: <app name>:<comp name>

<prop>=<val>: Component target and resource parameters

server=<val>- Name of server where component is to be moved

cpu=<val> - CPU allocation

mem=<val> - Memory allocation (in MB)

bw=<val> - Bandwidth allocation (in Mbps)

This command is currently not supported.

syntax : 3tctl ssh [component] <name> <args>*

description : ssh into component's virtual machine

<name> : Name of component: <app name>:<comp name>

<args> : Arguments to be passed to ssh.

*The arguments are not interpreted and are passed as is.

syntax : 3tctl list interfaces <name> [-batch | -b] [-verbose | -v]

description : List component interfaces

<name> : Name of component: <app name>:<comp name>

--batch : Display output in UDL format

--verbose : Display additional interface information

syntax : 3tctl info interface <name> [-batch | -b] [-verbose | -v]

description : Display interface information

<name> : Interface name: <app name>:<comp name>.<ifc name>

--batch : Display output in UDL format

--verbose : Display additional interface information

syntax : 3tctl enable interface <name>

description : Enable interface

<name> : Interface name: <app name>:<comp name>.<ifc name>

syntax : 3tctl disable interface <name>

description : Disable interface

<name> : Interface name: <app name>:<comp name>.<ifc name>

syntax : 3tctl reset interface <name>

description : Reset interface state

<name> : Interface name: <app name>:<comp name>.<ifc name>