AppLogic 2.4 Documentation The latest production release is AppLogic 3.0.30
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 |
| get_desc | Display catalog package descriptor |
| put_desc | Modify catalog package descriptor |
| migrate | Migrate a catalog |
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
system
user
dynamic
filer
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 : 26
Total Diskspace : 14.90 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 [user=user [pwd=-]] [ --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 from which the catalog is to be imported. The directory may be one of the following:
- directory relative to /vol/_impex
- URL with the following format 'http://path'. |
| user | user name to use for authentication with the remote server |
| pwd=- | (Optional) Prompt for password to use for authentication purposes when importing the catalog from a URL. 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). |
| --force | Option to allow importing of catalog class even if it is already present (i.e., the 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. |
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: | None. |
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: | The new descriptor is obtained from standard input. |
| The name of the catalog may not be changed in the new descriptor. |
| Description: | Migrate a catalog from/to a remote grid |
| Syntax: | catalog migrate remote_grid catalog [ .name=new-name] [ --export | --import ] [ --nocompress ] [ --nocleanup ] [ --debug ] |
| Arguments: | remote_grid | Name of the remote grid |
| catalog | Name of catalog to migrate. It may a global or application local catalog. |
| new-name | New name for the migrated catalog. It may be a global or application local catalog. |
| --export | Migrate the catalog TO the remote grid |
| --import | Migrate the catalog FROM the remote grid |
| --nocompress | Do not compress volumes when migrating the catalog |
| --nocleanup | skip cleanup upon failure or completion (troubleshooting) |
| --debug | show debug information during migration (troubleshooting) |
| Examples: | catalog migrate myoldgrid.3tera.net /mycat - migrate global catalog to the current grid. |
| catalog migrate myoldgrid.3tera.net /mycat .name=/mynewcat - migrate global catalog to the current grid and rename it. |
| catalog migrate mynewgrid.3tera.net myapp/local .name=/newlocal - migrate application catalog to the current grid as a global catalog. |
| Notes: | The catalog MUST NOT exist on the destination grid. |
| If neither the --export or --import options are specified, the catalog is migrated FROM the remote grid. |
| When accessing the grid via SSH, SSH agent and agent forwarding must be enabled on the client machine for the remote grid access to work. In addition, either the user's and/or the grid's public SSH key must also be installed on the remote grid in order to set up a "trust" between the two grids. |
| The --nocompress option is useful when migrating catalogs that have very large volumes. |
-- BeckyH - 23 May 2006
Copyright © CA 2005-2011. All Rights Reserved.
AppLogic24 Web