AppLogic Shell - Command outputs

Grid Control Command outputs

grid info

If AppLogic is running, the following information is displayed:
Grid Name               : val
Grid Description        : val
Grid Tag                : val (only displayed  if --verbose is specified)
AppLogic Version        : val 
System Uptime           : val
Controller Uptime       : val
Last Server Failure Time: val (srv)  (srv is only displayed if last server failure time is not 'none')
Controller IP           : val (only displayed if --verbose is specified)
Grid ID                 : val (only displayed if --verbose is specified)
Current Time            : val (only displayed if --verbose is specified)
System Uptime           : val (only displayed if --verbose is specified)
Grid Public SSH Key     : val (only displayed if --verbose is specified)
HA State                : val
Server Management Mode  : val
Total servers           : val
Servers running         : val
Servers enabled         : val
Applications running    : val
Total CPUs              : val
Reserved CPUs           : val (only displayed if --verbose is specified)
Free CPUs               : val
CPU Load                : val
Allocated CPUs          : val
Total Memory            : val MB/GB
Reserved Memory         : val MB/GB (only displayed if --verbose is specified)
Free Memory             : val MB/GB
Allocated Memory        : val MB/GB
Service Memory          : val MB
Total Bandwidth         : val Mbps
Reserved Bandwidth      : val Mbps (only displayed if --verbose is specified)
Free Bandwidth          : val Mbps
Allocated Bandwidth     : val Mbps
Total Disks             : val
Total Storage           : val MB/GB/TB
Reserved Storage        : val MB (only displayed if --verbose is specified)
Free Storage            : val MB/GB/TB
SSL SHA1 Fingerprint    : val  (only displayed if --verbose is specified and present)
Application DNS1        : val  (only displayed if --verbose is specified)
Application DNS2        : val (only displayed if --verbose is specified)
Application DNS3        : val (only displayed if --verbose is specified)
Application IP Ranges   : (only displayed if --verbose is specified)
   Start        End        Netmask     Gateway
   Val          val        val         val

grid <name>          
   {          
   description          = "val"
   tag                  = "val"  (only displayed if --verbose is specified)
   version              = "val"
   controller_ip        = val (only displayed if --verbose is specified)
   grid_id              = val (only displayed if --verbose is specified)
   current_time         = n_secs (only displayed if --verbose is specified)
   timezone             = "val" (only displayed if --verbose is specified)
   system_uptime        = n_secs
   controller_uptime    = n_secs
   last_srv_failure_time= tstamp
   last_failed_srv      = val
   grid_public_ssh_key  = "val"  (only displayed if --verbose is specified)
   ha_state             = "val"
   srv_mgmt_mode        = "val"
   srv_total            = val 
   srv_running          = val 
   srv_enabled          = val 
   app_running          = val 
   cpu_total            = val 
   cpu_reserved         = val
   cpu_free             = val 
   cpu_load             = val 
   cpu_alloc            = val 
   mem_total            = val 
   mem_reserved         = val 
   mem_free             = val 
   mem_alloc            = val 
   mem_service         = val 
   bw_total             = val 
   bw_reserved          = val
   bw_free              = val 
   bw_alloc             = val 
   disk_n               = val 
   disk_total           = val 
   disk_reserved        = val 
   disk_free            = val 
   ssl_sha1_fingerprint = "val" (only displayed if --verbose is specified and present)
   app_dns1             = val  (only displayed if --verbose is specified)
   app_dns2             = val (only displayed if --verbose is specified)
   app_dns3             = val (only displayed if --verbose is specified)
   app_ip_ranges (only displayed if --verbose is specified)
      [
      start = val, end = val, netmask = val, gateway = val
      ...
      ]

   }

grid get

<parameter>   : <val>
...

configuration
   {
   <parameter> = "<val>"
   ...
   }

Server Management Command outputs

server list

• name - name of server
• state - current state of server (up, down, booting, etc.)
• CPU Alloc/Free - allocated and free CPU in whole CPUs
• mem(MB)Alloc/Free - allocated and free memory usage
• bandwidth(Mbps) Alloc/free - allocated and free bandwidth usage
• Role - Server's HA role

If --map is specified on the command line, the output of this command is the following for each server:
      server name: role role, state state(enabled), val CPU, val MB mem, val Mbps bandwidth

and a list of application components running on the server:
      name : val CPU, val MB, val Mbps

If --batch is specified on the command line, the output of this command is the following:
      server name : role=val, state= val , enabled=val, cpu_alloc=val, cpu_free=val, mem_alloc=val, mem_free=val, bw_alloc=val
bw_free=val
            {
            component name : state=val, cpu=val, mem=val, mem_service=val, bw=val
            }

If --verbose is specified on the command line, the output of this command is the same as the server info command except that the information is displayed for each server.

server info

Name                : val
State               : val | val (disabled) if server is disabled
   Reason           : val (only if state is not 'up' and not empty
   User Responsible : val (only if state is not 'up' and not empty
HA Role             : val (only if --extended)
UID                 : val (only if --extended)
Current Time     : val (only if --extended)
Uptime              : val (only if --extended)
Boot ID             : val (only if --extended)
Management Enabled  : val (only if --extended)

--- IP Information
Private             : val (only if maintainer)
Public              : val (only if maintainer)

-- BIOS Information --- (only if --extended)
Vendor              : val
Version             : val
Date                : val

-- Motherboard Information --- (only if --extended)
Manufacturer        : val
Model               : val
Version             : val

--- CPU Information ---
Type                : val
Frequency           : val
Bogomips            : val
Load                : val

--- Disk Check Information ---
Supported               :  val (displayed only if --extended is specified)
Enabled                 :  val (displayed only if --extended is specified)

--- Resource Information ---
Resource  Count   Total       Reserved        Alloc      Service       Free
--------------------------------------------------------------------------------
CPU       val       val            val          val            -        val
MEM       -         val unit       val unit     val unit     val unit   val unit
BW        -         val unit       val unit     val unit       -        val unit
DISK      val       val unit       val unit     val unit       -        val unit

If --map is specified, a list of application components running on the server is displayed with the following information specified for each component:

--- Components ---
   (Table with the following headings: Name, CPU, Memory(MB)Alloc/Service, Bandwidth(Mbps) 

If --batch is specified, the output is as follows:

server <name>
   {
   state                    = "val"
   down_reason              = "val" (only if state is not 'up' and not empty)
   user_responsible         = "val" (only if state is not 'up' and not empty)) 
   enabled                  = val
   ha_role                  = val (only if --extended)
   uid                      = "val" (only if --extended)
   current_time           = val (only if --extended)
   uptime                   =  val (only if --extended)
   boot_id                  = "val" (only if --extended)
   mgmt_enabled             = val (only if --extended)
   ip1                      = xxx.xxx.xxx.xxx
   ip2                      = xxx.xxx.xxx.xxx
   bios_vendor              = "val" (only if --extended)
   bios_version             = "val" (only if --extended)
   bios_date                = "val" (only if --extended)
   motherboard_manufacturer = "val" (only if --extended)
   motherboard_model        = "val" (only if --extended)
   motherboard_version      = "val" (only if --extended)
   hvm_support              = val
   cpu_phy_total            = val
   cpu_total                = val
   cpu_type                 = "val"
   cpu_freq                 = val
   cpu_bogomips             = val
   cpu_load                 = val
   cpu_reserved             = val
   cpu_free                 = val
   cpu_alloc                = val
   mem_total                = val
   mem_reserved             = val
   mem_free                 = val
   mem_alloc                = val
   mem_service             = val
   bw_total                 = val 
   bw_reserved              = val
   bw_free                  = val
   bw_alloc                 = val
   n_disks                  = val
   disk_total               = val
   disk_reserved            = val
   disk_free                = val
   disk_check_supported     =  val (only displayed if --extended is specified)
   disk_check_enabled       =  val (only displayed if --extended is specified)

   component <name>: cpu =  val , mem =  val ,  mem_service = val, bw =  val 
   }

Application Mangement Command outputs

application list

CPU, Memory, and Bandwidth columns are displayed in Applogic 2.1.1 and later. Locked column is displayed in applogic 2.1.1 with hotfix e2106 and later.

If --batch option is specified, the output of this command is the following for each application:

      application name : state=val, id=val, template=val, [locked,] user1=val, user2=val, cpu=val , mem=val , bw=val, incomplete=val, tag="val", description="val", doc_url="url", destroy_on_stop=val

state may be stopped, standby, starting, maintenance, running, stopping, restarting, restart_stopping, building, failed, unknown

cpu, mem, bw, and incomplete values are displayed in Applogic 2.1.1 and later. locked value is displayed in AppLogic 2.1.1 with hotfix e2106 and later.

application info

Name                    : val
Description             : val
Tag                       : val
ID                      : val
Documentation URL       : val
Template                : yes/no
Locked                  : yes/no
User1                   : val
User2                   : val
Destroy on Stop         : yes/no
State                   : state
Target State            : val
CPU                     : val
Memory                  : val MB/GB
Service Memory       : val MB/GB
Bandwidth               : val Mbps
Default Login Appliance : val

The following is also displayed for each component if --verbose is specified:

   Name, CPU, Memory(MB)Alloc/Service, Bandwidth, Server, State
 

If --batch option is specified, the output of this command is the following:

application <name>  
   {
   description     = "val"
   tag               = "val"
   id              = val
   doc_url         = "val"
   template        = val
   locked          = val
   user1           = "val"
   user2           = "val"
   destroy_on_stop = val
   state           = val
   target_state    = val
   cpu             = val
   mem             = val
   mem_service  = val
   bw              = val
   dflt_appliance  = "val"
   dflt_appliance_opts = "val"
   incomplete      = val
   }

   component name : cpu=val, mem=val, bw=val, server=val, state=val 
   }

application config

The output is the following when --batch is not specified:

application : <app>
<name>      : <val>
...

The output is the following when --batch is specified:

appconfig <app>
   {
   <name> = <val>
   ...
   }

can be one of the following:

• .name - attribute
• name - property
• resource.val - resource, resource can be cpu, mem, val can be min, max, dflt
• vol. name - volume
• servers. val - set servers, val can be min, max, set.

Show application boundary

boundary main
   {
   property <name> : type=<type>, dflt=<val>
   property <name> : type=<type>, mandatory
   ...

   resource <name> : min=<min>, max=<max>, dflt=<abs>
   ...
   }

Set configuration from stdin

Component Control Command outputs

component list

state may be stopped, standby, starting, maintenance, running, stopping, restarting, restart_stopping, moving, failed, unknown

component info

    name              :  val 
    state             :  val  
    default IP address: xxx.xxx.xxx
    console options : val
    time started      :  val 
    server            :  val 
    cpu               :  val 
    mem               :  val 
    service mem   : val
    bw                :  val 
    OS type            : val
    OS name            : val
    OS version         : val
    OS kernel          : val
    PV driver          : val
    class              : val

    Interfaces        :
    (table with the following headings: Name and State)

component name 
   {
   state           = val
   dflt_ip         = val
   console_options = "val"
   t_start         = val
   t_state_chg     = val
   server          = val
   cpu             = val
   mem             = val
   mem_service  = val
   bw              = val
   n_int_ifc       = val (only if --extended)
   n_ext_ifc       = val (only if --extended)
   n_volumes       = val (only if --extended)
   pinned          = val (only if --extended)
   is_hvm          = val (only if --extended)
   failover_grp    = "val" (only if --extended)
   os_guess        = "val"
   os_type         : "val"
   os_name         : "val"
   os_version      : "val"
   os_kernel       : "val"
   pv_driver       : "val"
   class           : "val"

   interface  name : state = val 
   }

Interface Control Command outputs

interface list

interface info

Name   : val 
Type   : val 
State  : val 
IP     : x.x.x.x
MAC    : xx:xx:xx:xx:xx:xx
Device : val
Connections:
  (Table with the following columns: Local IP, Remote IP, Type, Local Addr, and Remote Addr)

Interface  name 
   {
   type   = val 
   state  = val 
   ip     = x.x.x.x
   mac    = "xx:xx:xx:xx:xx:xx"
   device = val
   connections
      [
      loc_vip = x.x.x.x, rem_vip = x.x.x.x, type =  val , loc_addr = val , rem_addr = val
      ]
   }

Volume Management Command outputs

volume list

Scope Name, Volume Name, Size(MB), State, Filesystem, Mirrored and Mount State

For application, catalog, and cache scopes, the Scope Name column is not included in the output.

If the --verbose option is specified, Link and Comment columns are included in the output.
The states for a volume are:

• "ok" - all mirrors are available and synchronized
• "degraded" - volume is accessible, but at least one mirror is down
• "repairing" - volume is being repaired
• "migrating" - volume is being migrated
• "error" - all mirrors are invalid

• "available" - volume is available
• "in-use" - volume is in use by a running application
• "mounted" - volume is mounted on the controller

If the --batch option is specified, the output of this command is the following:
volume name : scope_type=val, scope_name=val, size=val, \
              state=val, filesystem=val, n_mirrors=val, \
              mount_state=val,[link=volume,] comment=val

The output specifies a single volume per line.

volume info

Name             : val
Link              : val (display only if volume is a symbolic link)
Comment          : val
Size             : val
State            : val
Progress         : val% (displayed only if in transitional state)
Filesystem       : val
Mount State      : val
Mounted Device   : val
Current Users    : val
Attributes       : val
Time Created     : val
Time Written     : val
Time Accessed    : val
Number Mirrors   : val
Mirrors          :
   (Table containing the following columns: Server, State)

If the --batch option is specified, the output of this command is the following:

volume name      
   {
   link           = val
   comment       = "val"
   size          = val
   state         = val
   progress      = val (displayed only if in transitional state)
   filesystem    = val
   mount_state   = val
   mount_path    = val
   n_users       = val
   attributes    = val
   time_created  = val
   time_written  = val
   time_accessed = val
   n_mirrors     = val
   mirror <name> : server = val, state = val
   ...
   }

volume create

If the --batch option is specified, the output of this command is the following:

volume name
   {
   size     = val
   comment  = "val"
   fs_type  = "val"
   }

volume clean

-- Unused Volumes ---
Table with the following columns: Name, Scope, Type, State, Size(MB), Mirrored, Linked
(type can be: unused, broken)

---Unused Volume Streams ---
Table with the following headings: Name, State, Size(MB)

The output of the clean command is the following when invoked with --batch option:
volume name : scope_name=scope, state=state, type=type, size=size, mirrored=(yes|no|?), [link,] sysvol=logical-vol-name
...

* type can be: unused, broken or unused_stream
* name is either the volume name or vrid if unused volume stream
* scope_name and sysvol values are omitted when listing unused volume streams

volume repair --status

Last Volume Repair Check: val Hrs ago
Next Volume Repair Check: <date/time> | in progress

---Error Volumes---
(table with the following columns: Scope, Name)

---Failed Volumes---
(table with the following columns: Scope, Name, Start Time, End Time, End State, Failure #)

---Repairing Volumes---
(table with the following columns: Scope, Name, Size(MB), Progress, Start Time, Elapsed Time)

---Queued Volumes---
(table with the following columns: Scope, Name, Priority)

---Suspended Volumes---
(table with the following columns: Scope, Name, Queue Time)

---Complete Volumes---
(table with the following columns: Scope, Name, Start Time, End Time)

volume_status
   {
   last_check        = val 
   t_next_check      = val
   check_in_progress = yes|no

   error
      {
      volume <name> : scope_type=val, scope_name=val
      ...
      }
   failed
      {
      volume <name> : scope_type=val, scope_name=val, t_start=val, t_end=val, end_state=val, failure_num=val
      ...
      }
   repairing
      {
      volume <name> : scope_type=val, scope_name=val, size=val, progress=val, t_start=val, t_elapsed=val, server=val
      ...
      }
   queued
      {
      volume <name> : scope_type=val, scope_name=val, priority=val
      ...
      }
   suspended
      {
      volume <name> : scope_type=val, scope_name=val, t_queue=val
      ...
      }
   complete
      {
      volume <name> : scope_type=val, scope_name=val, t_start=val, t_end=val 
      ...
      }
   }

Catalog Management Command outputs

catalog list

• name - name of catalog
• description - catalog description

catalog <name> : description="<val>"
...

catalog info

Name                : val
Description         : val
Total classes       : val
Total diskspace     : val GB
Protocols           :
   (table containing the following columns: Name, Filter)

catalog <name>          
   {          
   description      =  "val"    
   total_classes    =  val  
   total_diskspace  =  val  
   protocol <name>  : filter="<val>"
   }

Class Management Command outputs

class list

• class - name of class
• category - class category
• volume size(MB) - size of class volume(s) (if --verbose specified)
• locked - class is locked (if --verbose is specified)
• description - class description

catalog <name>
   {
   class <name> : category="<val>", vol_sz=<val>, [locked,] description="<val>"
   ...

   protocol <name> : filter="<val>"
   ...
   }

-- BeckyH - 23 May 2006