Reference Information › Command Line Shell Reference Guide › Shell Commands › Class Management › list (Class Management)--Retrieve List of Classes in a Package

list (Class Management)--Retrieve List of Classes in a Package

List classes in a package

Syntax

class list package [ --batch ] [ --verbose ]  

Parameters

package

Name of package for which to list classes. package may be one of the following:

application - list singleton classes of application

application/catalog - list classes in local catalog

/catalog - list classes in global catalog

--batch

Display output in UDL format

--verbose

Display total volume size for each class and protocols.

Examples

class list sugarcrm

List classes of application

class list sugarcrm/local

List classes of application local catalog

class list /system

List classes of global catalog

Notes: A specification of the output of this command can be found here.

Typical Output

Classes in catalog 'system':
   Class     Category              		Description
   --------------------------------------------------------------------------------
   HALB      Switches           		Reliable, high-performance TCP/HTTP load balancer with HTTP session 					support based on HAProxy 1.2.28 (v1.0.1-1)
   HLB       Switches             		Session-aware HTTP Load Balancer (v2.4.0-1)
   IN        Gateways         		Input Gateway Appliance - iptables based incoming connection 						gateway with firewall (v2.4.0-1)
   INSSL     Gateways           		Input Gateway Appliance  - iptables based incoming connection 						gateway with firewall and SSL support (v1.3.0-1)
   INSSLR    Gateways            		Redundant Input Gateway Appliance  - iptables based incoming 						connection gateway with firewall, SSL and failover support (v1.0.1-1)
   LINUX5    Generic               		Generic Linux Server - based on CentOS 5 (v1.2.0-1)
   LINUX64   Generic               		Generic Linux Server - based on CentOS 5 (64bit) (v1.2.0-1)
   LOAD      Misc. Appliances     	Load Generator (v1.2.0-1)
   LUX5      Generic               		Generic CentOS 5 Linux-based appliance (v1.2.0-1)
   LUX64     Generic               		Generic 64-bit Centos 5-based appliance (v1.2.0-1)
   MON       Monitoring            		Monitoring appliance (v1.3.2-1)
   MYSQLR    Database Appliances   	MYSQL database appliance with replication capabilities based on 						mysql 5.0.45 (v1.4.1-1)
   MYSQL5    Database Appliances   	MYSQL Database appliance based on mysql 5.0.22 (v1.2.0-1)
   MYSQL64   Database Appliances   	64-bit MYSQL appliance based on mysql 5.0.22 (v1.2.0-1)
   NAS       Misc. Appliances      	NAS Appliance - provides file storage accessible over HTTP and CIFS 					file protocols (v2.4.0-1)
   NET       Gateways              		Subnet Output Gateway Appliance - iptables based output gateway 					with firewall (v2.4.0-1)
   OSOL64    Generic               		Generic OpenSolaris Server - based on OpenSolaris build 2008.05 					(v1.0.4-1)
   OUT       Gateways              		Single Host Output Gateway Appliance - iptables based output 						gateway with firewall (v2.4.0-1)
   PGSQL     Database Appliances   	PGSQL Database appliance based on PostgreSQL 8.2.9 (v1.1.0-1)
   PS8       Switches              		Cascadable Port switch for distributing TCP and UDP traffic to different 					outputs depending on the TCP/UDP port (v1.2.0-1)
   RPL       Switches              		Replicator appliance - replicates HTTP requests received on its input 					terminal to all its output terminals (v1.2.0-1)
   SOL10     Generic               		Generic Solaris 10 Server - based on Solaris 10 build GA (v1.0.3-1)
   WEBx4     Web Servers           	Scalable web server (v1.1.2-1)
   WEBx8     Web Servers           	Scalable web server (v1.1.2-1)
   WEB4      Web Servers           	Simple Web Server - based on CentOS 5; Apache, PHP4, mod_perl, 					and MYSQL Client libs installed (v1.2.0-1)
   WEB5      Web Servers           	Simple Web Server - based on CentOS 5; Apache, PHP5, 						mod_perl,and  MYSQL Client libs installed (v1.2.0-1)
   WEB64     Web Servers           	Simple Web Server - based on CentOS 5 64-bit; Apache, PHP5, 						mod_perl, and MYSQL Client libs installed (v1.2.0-1)

This section contains the following topics:

class list Output

class list Output

The output of this command when listing the contents of a catalog is a table with the following headings:

• 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

If --batch option is specified, the output is the following (volume size and protocols are listed if --verbose is specified):

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

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

class lock

Lock a class.

Syntax

class lock class [pwd=->/tt> ]  

Parameters

class

name of class to be locked May specify one of the following:

application:class - lock application singleton class

/catalog:class - lock global catalog class

pwd=- Prompt for the password used to unlock the class. If the standard input is not a terminal device, it will not print a prompt and expect only one copy of the password on 'stdin' (this can be used for batch operations, to set the password from a file).

Examples

class lock /system:MYCLASS

Lock global catalog class

class lock myapp:MYCLASS

Lock application singleton class

class lock my-app:MYSQL2 pwd=-

lock singleton class and prompt for password

Note: The 'pwd' argument is required when executed by a non-maintainer.

If the 'pwd' argument is specified, it is required to unlock the class.

When a class is locked, the following operations cannot be executed by non-maintainers:

• * Class branch
• * Class copy
• * Class move
• * Class get_desc
• * Export of class or catalog/application containing the class
• * Managing/modifying/reading of class volumes

See Application and Class Locking Reference for more information.

class migrate

Migrate a class from/to a remote grid.

Syntax

class migrate <remote_grid> <class> [ .name=<new name>] [.store=<store>] [<option>]*

Arguments

<remote_grid>

Name of remote grid

<class>

Name of the class to migrate. The class may be in a global or local catalog or may be a singleton.

.name=<new name>

New name for the migrated class. The name may refer to a global or local catalog or may refer to a singleton.

.store=<store>

Specifies the volume store where volumes are created. May be set to one of the following values:

local - store volumes on local server storage

san - store volumes on a SAN

Note: the .store option is not available on AppLogic® for System z.

--export

Migrate the class TO the remote grid.

--import

Migrate the class FROM the remote grid.

--nocompress

Do not compress class volumes during migration.

--nocleanup

skip cleanup upon failure or completion (troubleshooting)

--debug

show debug information during migration (troubleshooting)

Examples

class migrate myoldgrid.3tera.net /mycat:myclass

migrate catalog class to the current grid.

class migrate myoldgrid.3tera.net /mycat:myclass .name=myapp:myclass

migrate catalog class to the current grid as an application singleton.

class migrate mynewgrid.3tera.net /myapp/local:myclass .name=/mycat:myclass --export

migrate local catalog class to the remote grid as a global catalog class.

Notes:

• The class MUST NOT exist on the destination grid.
• If neither the --export or --import options are specified, the class is migrated FROM the remote grid.
• SSH agent and agent forwarding must be enabled on the client machine for the remote grid access to work.
• The --nocompress option is useful when migrating classes that have very large volumes.

class move

Move an appliance class from one catalog to another.

The move command can move a class:

1. from one catalog to another;
2. from a catalog to a singleton;
3. from singleton to application catalog class.

The move command can be used to rename a class within a catalog, or the application package, or both.

Syntax

class move <src> <dest> [--force]

Parameters

<src>

Name of class that is to be moved

<dst>

New class name

--force

Skip confirmation prompt if the class is referenced by another class or application.

Examples

class move my-app/local:DBASE /system:DBASE

move class from one catalog to another

class move /system:MYSQL5 my-app:MYSQL

move class from global catalog to singleton

class move my-app:MYSQL /system:MYSQL2

move class from singleton to global catalog

class move my-app:MYSQL my-app:MYSQL2

rename class

Notes:

• A singleton assembly (an assembly class in the application package) cannot be moved to a catalog if any of its subordinates is a singleton. This is because having a singleton subordinate would prevent the instantiation of such class.
• Moving a class will not automatically change the .class attribute of subordinates using this class - this needs to be done manually in all affected assemblies.

class put_desc

Modify class descriptor.

Syntax

class put_desc class  

Parameters

class

name of class for which to modify descriptor May specify one of the following:

application:class - modify application singleton class descriptor

application/catalog:class - modify application local catalog class descriptor

/catalog:class - modify global catalog class descriptor

Examples

class put_desc /system:MYCLASS

modify global catalog class descriptor

class put_desc myapp:MYCLASS

modify application singleton class descriptor

Note: The new descriptor is obtained from standard input. The user can type in or paste the new descriptor contents followed by typing CTRL-d to terminate the input.

The name of the class may not be changed within the new descriptor.

The locked attribute may not be changed within the new descriptor if executed by a non-maintainer.

If the operation is executed remotely, the command can be specified as follows, where newdesc is a file containing the modified descriptor:

ssh root@controllerhost class put_desc myapp:MYCLASS <newdesc>

class unlock

Unlock a class.

Syntax

class unlock class [ pwd=- ] [ --override ]  

Parameters

class

name of class to be unlocked May specify one of the following:

application:class - lock application singleton class

/catalog:class - lock global catalog class

pwd=-

Prompt the user for the password that was provided when the class was locked. If the standard input is not a terminal device, it will not print a prompt and expect only one copy of the password on 'stdin' (this can be used for batch operations, to set the password from a file).

--override

(for maintainers only) Override the lock on the class.

Examples

class unlock /system:MYCLASS

Unlock global catalog class

class unlock myapp:MYCLASS

Unlock application singleton class

class unlock my-app:MYSQL2 pwd=-

Unlock singleton class and prompt for password

Notes:

• If the class was locked with a password, the passwords must match
• If the class was locked without a password, then only a maintainer may unlock the class