Previous Topic: message setNext Topic: Group Management


Grid Control

This section describes commands that control the grid.

This section contains the following topics:

grid get

grid get_acl

grid info

grid modify_acl

grid net_discover

grid power_cycle

grid put_acl

grid reboot

grid set

grid shutdown

grid get

Retrieve grid configuration parameter.

Syntax
grid get/tt> param | --all [--batch] grid get <param> | --all [--batch]
Arguments
param

Name of grid configuration parameter to get. The following parameters may be retrieved:- recovery_password: Recovery GUI password

--all

Retrieve all configurable grid parameters

--batch

Display output in UDL format

Example
grid get recovery_password  

Retrieve recovery GUI password

Grid Get Output

The output of this command is the following:

<parameter>   : <val>
...
If --batch option is specified, the output is the following: 
configuration
   {
   <parameter> = "<val>"
   ...
   }

grid get_acl

Display the grid ACL or that portion of the grid ACL which relates to a particular principal or internal ID.

Syntax
grid get_acl [ <principal> ] [ --batch ]  
Parameters
<principal>

Display only that portion of the grid ACL which pertains to the specified principal. <principal> is in the following form:

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where where <scope> is 'global' or 'local', <type> is 'group' or 'user', and <name> is the group or user name.

--batch

Display output in UDL format.

Examples
grid get_acl

Display the grid ACL.

grid get_acl local:user:admin

Display the grid ACL entry for local user 'admin'.

grid get_acl admin

Display the grid ACL entry for local user 'admin'.

Output

The output of this command is as follows:

1. Non-batch output:

--- Owner Information ---
ID                                    Scope    Type    Name
-------------------------------------------------------------------------
val                                   val      val     val
--- Entry Information ---
ID                                    Scope    Type    Name              Access
--------------------------------------------------------------------------------
val                                   val      val     val               val
...

The value of Scope is local or global. The value of Type is user or group. The value of Access is a comma separated list of access levels or permissions.

1. Batch output:

acl
   {
   owner       : id="val"   # scope type name
   entries
      [
	id="val", access_level1, ... access_levelN, permission1, 	... permissionN   # scope type name
      ...
      ]
   }
grid info

Retrieve grid status and information

Syntax
grid info [ --batch ] [ --verbose ] 
Arguments
--batch

Display output in UDL format

--verbose

Display additional information

Examples
grid info  

Retrieve grid status and information

Note:
Typical Output
Grid Name                   : petunia
Grid Description            :

SysteCA 3Tera AppLogic Version   : 3.0.12 eja_JPm Uptime               : 4 days, 3 hours, 2 minutes
Controller Uptime           : 4 days, 2 hours, 55 minutes
Last Server Failure Time    : Thu 24 Mar 2011 11:21:55 AM PDT (srv1)
Grid Reboot Required        : no
Controller Reboot Required  : no
HA State                    : ok
   Application HA State     : ok
   Controller HA State      : ok
   Backbone Network HA State: disabled
   External Network HA State: disabled
Total Servers               : 2
Servers Running             : 2
Servers Enabled             : 2
Applications Running        : 1
Resource Information        :
Pool   Resource Count     Total        Alloc      Hypervisor         Free
------------------------------------------------------------------------------
grid   CPU      4         16.00         0.05               -        15.85
       MEM      -         64.00 GB    128.00 MB            -        61.39 GB
       BW       -          4.00 Gbps  100.00 Mbps          -         3.90 Gbps
       DISK     2          3.40 TB    667.13 GB            -         2.73 TB

Grid Info Output

The output of this command is the following:

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')
Last Metadata Backup        : val
Grid Reboot Required        : val (yes/no)
Controller Reboot Required  : val (yes/no)
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
   Application HA State     : val
   Controller HA State      : val
   Backbone Network HA State: val
   External Network HA State: val
Switches                    : (only displayed if --verbose is specified)
   ID       Name   Network  Mode   Detection Method
   -------------------------------------------------------
   <val>    <val>  <val>    <val>  <val>
   ...
(network may be "backbone", "external" or "mixed")
(mode may be "active", "passive", or "mixed")
VLAN ID                     : val  (only displayed if --verbose is specified)
Application VLAN ID Ranges  :      (only displayed if --verbose is specified)
Interface    Start       End
Public       <val>       <val>
             <val>       <val>
Private      <val>       <val>
             <val>       <val>

Default Locale              : val (only displayed if --verbose is specified)
Available Locales           : (only displayed if --verbose is specified)
   ID            Description
   ----------------------------------------
   <val>         <val>

Server Management Mode      : val
Total servers               : val
Servers running             : val
Servers enabled             : val
Applications running        : val
Hyperthreading              : val (on, off, or mixed)
Bandwidth Oversubscription  : val (on, off, or mixed)
Disk NCQ Enabled            : val (on, off, or mixed)
Jumbo Frames Mode           : val (auto, enabled, or disabled)
Jumbo Frames Status        : val (on, off, or mixed)
Volume Repair Speed         : val (num KB/sec or mixed)

Resource Information               : (per hypervisor info is only displayed if --verbose is specified and there
are different hypervisors running on the servers of the grid.)
Entity   Resource  Count   Total       Reserved        Alloc      Service       Free      Load
-----------------------------------------------------------------------------------------------
Grid     CPU       val       val            val          val            -        val       val
         MEM       -         val GB         val GB       val MB         -        val GB      -
         BW        -         val Gbps       val Mbps     val Mbps       -        val Gbps    -
         DISK      val       val TB         val GB       val TB         -        val TB      -
<hvisor> CPU       val       val            val          val            -        val        val
         MEM       -         val GB         val GB       val MB         -        val GB      -
         BW        -         val Gbps       val Mbps     val Mbps       -        val Gbps    -
         DISK      val       val TB         val GB       val TB         -        val TB      -
... (next hypervisor)

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

If --batch option is specified, the output is the following:

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
   last_metadata_backup_time= tstamp
   grid_reboot_required = val
   ctl_reboot_required  = val
   grid_public_ssh_key  = "val"  (only displayed if --verbose is specified)
   ha_state             = "val"
   ha_state_apps        = "val"
   ha_state_controller  = "val"
   ha_state_backbone    = "val"
   ha_state_network     = "val"
   switches
      [
      id = <val>, name = <val>, network = <val>, mode = <val>, manufacturer = <val>, model = <val>, detection_method = "<val>"
      ...
      ]
   vlan_id              = val  (only displayed if --verbose is specified)
   app_vlan_id_ranges          (only displayed if --verbose is specified)
      {
      public
         [
         start=<val>, end=<val>
         ...
         ]
      private
         [
         start=<val>, end=<val>
         ...
         ]
      }
   dflt_locale          = "val" (only displayed if --verbose is specified)
   locales (only displayed if --verbose is specified)
      [
      id = <val>, description = "<val>"
      ...
      ]
   srv_mgmt_mode        = "val"
   srv_total            = val
   srv_running          = val
   srv_enabled          = val
   app_running          = val
   vol_repair_speed       = val
   jumbo_frames_mode   = val
   jumbo_frames_status   = val
   cpu_total              = val
   cpu_reserved           = val
   cpu_free               = val
   cpu_load               = val
   cpu_ht_enabled         = val  (on, off, or mixed)
   cpu_alloc              = val
   mem_total              = val
   mem_reserved           = val
   mem_free               = val
   mem_alloc              = val
   mem_hypervisor         = val
   bw_total               = val
   bw_reserved            = val
   bw_free                = val
   bw_alloc               = val
   bw_oversubscription    = val
   disk_n                 = val
   disk_total             = val
   disk_reserved          = val
   disk_free              = val
   disk_ncq_enabled       = val
   resources (pool name is name of hypervisor - per hypervisor information is only displayed if --verbose is specified and not all grids run the same hypervisor)
      {
      pool <name> : 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_hypervisor=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 modify_acl

Replace that portion of the grid ACL which relates to the owner or a principal.

Syntax
grid modify_acl [ <principal>=owner ] [ <principal1>=<val1> ... <principalN>=<valN> ] [ --test_only ]  
Parameters
<principal>=owner

Set the owner attribute of the grid ACL to the specified principal.

<principal>=<val>

Add or replace the specified principal in the grid ACL with access level <val>. <principal> is in the following form:

<name>

Local user or group.

/<name>

Global user or group

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user', and <name> is the group or user name. Valid access levels are: 'monitor', 'app_operator', 'app_developer', 'grid_operator', and 'grid_administrator'. If the access level is specified as 'none' the principal is removed from the grid ACL if it is present.

--test_only

Do not replace any portion of the grid ACL but rather test if the operation can succeed.

Examples
grid modify_acl local:user:admin=grid_administrator

Replace that portion of the grid ACL which relates to the local user 'admin', providing grid_administrator access level permissions to this user.

grid modify_acl admin=grid_administrator

Replace that portion of the grid ACL which relates to the local user 'admin', providing grid_administrator access level permissions to this user.

Notes
grid net_discover

Initiate network topology discovery for the grid as a whole.

Syntax
grid net_discover   
Example
grid net_discover  

Initiate network topology discovery for the grid as a whole.

Notes:

grid power_cycle

Power cycle CA AppLogic grid.

Syntax
grid power_cycle [--kill] [--force] [--restartapps] [reason=text] 
Arguments
--kill

Skip trying to stop any applications that have been started.

--force

Do not prompt for user confirmation.

--restartapps

Restart all running applications upon next reboot of the grid. The applications are not stopped prior to power cycle if this option is specified.

reason=text

Free-form text specifying the reason for the grid power cycle.

Examples
grid power_cycle

Stop all applications and power cycle the grid

grid power_cycle --kill

Power cycle the grid without stopping running applications.

Note: If there are applications running on the grid, they should be stopped prior to executing this command or this command should be executed with --kill option due to the possibility that a server may crash under high I/O load when stopping all applications in parallel.

grid put_acl

Replace the entire grid ACL.

Syntax
grid put_acl <principal>=owner [ <principal1>=<val> ... <principalN>=<val> ] [ --test_only | --force ]  
Parameters
<principal>=owner

Set the owner attribute of the grid ACL to the specified principal.

<principal>=<val>

Add the specified principal to the grid ACL with access level <val>. <principal> is in the following form:

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user', and <name> is the group or user name. Valid access levels are: 'monitor', 'app_operator', 'app_developer', 'grid_operator', and 'grid_administrator'.

--test_only

Do not replace the grid ACL but rather test if the operation can succeed.

--force

Skip prompting the user for verification.

Examples
grid put_acl local:user:admin=owner local:user:admin=grid_administrator

Replace the grid ACL such that the owner is the local user 'admin' and local user 'admin' has grid_administrator access level permissions.

grid put_acl admin=owner admin=grid_administrator

Replace the grid ACL such that the owner is the local user 'admin' and local user 'admin' has grid_administrator access level permissions.

Notes
grid reboot

Reboot grid.

Syntax
grid reboot [--controller] [--force] [--kill]
grid reboot [reason=<text>] [--force] [--restartapps] [--kill]
grid reboot [--controller] [--flag] [--force] 
Arguments
--controller

Reboot the controller VM only. If this option is not specified, the entire grid is rebooted.

reason=text

Free-form text that describes the reason why the grid is being rebooted. The reason is displayed within the dashboard message following the grid reboot.

--kill

Do not try to stop any applications that are started and do not prompt for verification.

--restartapps

Restart all running applications upon the next reboot of the grid.

--force

Skip prompting user for verification.

--flag

Flag the entire grid or grid controller for reboot (do not actually reboot).

Examples
grid reboot

Reboot the entire grid

grid reboot --restartapps

Reboot the entire grid and restart all running applications.

grid reboot --controller

Reboot the grid controller VM

grid reboot --flag

Flag the entire grid for reboot

Notes:

grid set

Set grid configuration parameter.

Syntax
grid set <prop>=<val> 
Arguments
<prop>=<val>

Grid parameter to modify. The following parameters may be set:

Examples
grid set recovery_password=-

Set recovery GUI password.

grid set ha_network=1

Enable network HA for the grid on both the backbone and external networks.

grid set ha_external=1

Enable network HA for the grid on the external network.

grid set ha_backbone=1

Enable network HA for the grid on the backbone network.

grid set backbone=01:02:03:04:05:06

Set switch with an ID of 01:02:03:04:05:06 as active, all backbone network traffic on the servers passes through the NIC connected to that switch.

grid set external=07:08:09:0A:0B:0C

Set switch with an ID of 07:08:09:0A:0B:0C as active, all external network traffic on the servers passes through the NIC connected to that switch.

grid set locale=en_US

Set the default locale to U.S. English.

grid set disk_ncq_enabled=0

Disable NCQ on all servers.

grid set bw_oversubscription=1

Enable bandwidth oversubscription.

grid set vol_repair_speed=1024

Set the volume repair speed to 1024 KB/sec on all servers.

grid set vol_repair_speed=10M

Set the volume repair speed to 10 MB/sec on all servers.

grid set overcommit.cpu_sched_limit=2x

Set the number of CPU cores for scheduling to be twice the physical number of CPU cores.

Notes:

You must be a grid maintainer for the following:

CA AppLogic uses the UTF-8 character set for the encoding of all localized messages.

grid shutdown

Shutdown grid.

Syntax
grid shutdown [--kill] [--force] 
Arguments
--kill

Skip trying to stop any applications that have been started.

--force

Do not prompt for user confirmation.

reason=text

Free-form text specifying the reason for the grid shutdown.

Examples
grid shutdown  

Shutdown all started applications and shutdown the grid

grid shutdown --kill  

Shutdown the grid without stopping any running applications.

Notes: