December 24 - AppLogic 2.4.7 is now available and is the latest production release!
Catalog Management Commands
The following commands are supported:
| Command | Description |
|---|
| list | Retrieve list of global catalogs |
| info | Retrieve detailed information for a catalog |
| create | Create a new catalog |
| destroy | Remove an existing catalog |
| export | Export a catalog |
| import | Import a catalog |
| rename | Rename a global catalog Supported in AppLogic 2.0.7+ |
| get_desc | Display catalog package descriptor Supported in AppLogic 2.3.0+ |
| put_desc | Modify catalog package descriptor Supported in AppLogic 2.3.0+ |
list
| Description: | List global catalogs |
| Syntax: | catalog list [ --batch ] |
| Arguments: | --batch | Display output in UDL format |
| Examples: | catalog list - List global catalogs |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
Global Catalogs
Name Description
--------------------
proto
test
system
user
gbl1
info
| Description: | Display information for a local application or global catalog. |
| Syntax: | catalog info package [ --batch ] [ --verbose ] |
| Arguments: | package | Name of the package for which to display information. |
| application/catalog - Display information for a local catalog of an application |
| /catalog - Display information for a global catalog |
| --batch | Display output in UDL format |
| --verbose | Include list of protocols |
| Examples: | catalog info /system - Display information for global catalog |
| catalog info sugarcrm/local - Display information for local application catalog |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
Name : system
Description :
Total Classes : 8
Total Diskspace : 2.41 GB
create
| Description: | Create a new application or global catalog |
| Syntax: | catalog create catalog |
| Arguments: | catalog | Name of the catalog to create. It may be in one of the following formats: |
| application/catalog - Create a local catalog of an application |
| /catalog - Create a global catalog |
| Examples: | catalog create /system2 - Create global catalog |
| catalog create sugarcrm/local2 - Create local application catalog |
| Notes: | None. |
destroy
| Description: | Destroy an application or global catalog |
| Syntax: | catalog destroy catalog [ --force ] |
| Arguments: | catalog | Name of the catalog to destroy. It may be in one of the following formats: |
| application/catalog - Destroy a local catalog of an application |
| /catalog - Destroy a global catalog |
| --force | skip asking verification to destroy the catalog |
| Examples: | catalog destroy /system - Destroy global catalog |
| catalog destroy sugarcrm/local - Destroy local application catalog |
| Notes: | None. |
export
| Description: | Export a catalog |
| Syntax: | catalog export catalog dir [ --force ] [ --nocompress ] |
| Arguments: | catalog | name of catalog to be exported. May specify one of the following: |
| application/catalog - export local application catalog |
| /catalog - export global catalog |
| dir | Name of exchange directory relative to /vol/_impex where catalog is to be exported to |
| --force | Option to allow exporting of catalog class even if it is already present (i.e., each class is removed and then exported) |
| --nocompress | Do not compress the volume images. |
| Examples: | catalog export /system system - Export global catalog |
| catalog export sugarcrm/local localcat - Export local application catalog |
| Notes: | None. |
import
| Description: | Import a catalog |
| Syntax: | catalog import catalog dir [ --force ] |
| Arguments: | catalog | name of catalog to be imported. May specify one of the following: |
| application/catalog - import local application catalog |
| /catalog - import global catalog |
| dir | Name of exchange directory relative to /vol/_impex where catalog is to be imported from |
| --force | Option to allow importing of catalog even if it is already present (i.e., each class is removed and then imported) |
| Examples: | catalog import /system newcat - Import global catalog |
| catalog import sugarcrm/local localcat - Import local application catalog |
| Notes: | None. |
rename
| Description: | Rename a global catalog |
| Syntax: | catalog rename catalog new-catalog |
| Arguments: | catalog | Name of the catalog to rename. It may be in one of the following formats: |
| /catalog - Rename a global catalog |
| new-catalog | New name for the catalog. It must be in the form of /catalog. |
| Examples: | catalog rename /system /system-old - Rename system catalog to system-old |
| Notes: | The renaming of catalog does not update any references to the old catalog within existing applications. |
| This command will fail if any of the catalog volumes are in use. |
| Supported in AppLogic 2.0.7+ |
get_desc
| Description: | Display application or global catalog package descriptor |
| Syntax: | catalog get_desc catalog |
| Arguments: | catalog | Name of the catalog for which to display package descriptor. It may be in one of the following formats: |
| application/catalog - Display application local catalog package descriptor |
| /catalog - Display global catalog package descriptor |
| Examples: | catalog get_desc /system - Display global catalog package descriptor |
| catalog get_desc sugarcrm/local - Display local application catalog package descriptor |
| Notes: | Supported in Applogic 2.3.0+ |
put_desc
| Description: | Modify application or global catalog package descriptor |
| Syntax: | catalog put_desc catalog |
| Arguments: | catalog | Name of the catalog for which to modify package descriptor. It may be in one of the following formats: |
| application/catalog - Modify application local catalog package descriptor |
| /catalog - Modify global catalog package descriptor |
| Examples: | catalog put_desc /system - Modify global catalog package descriptor |
| catalog put_desc sugarcrm/local - Modify local application catalog package descriptor |
| Notes: | Supported in Applogic 2.3.0+ |
| The new descriptor is obtained from standard input. |
| The name of the catalog may not be changed in the new descriptor. |
--
BeckyH - 23 May 2006
AppLogic2 Web