Volume Management Commands
The following commands are supported:
| Command | Description |
|---|
| list | Retrieve list of volumes |
| info | Retrieve detailed information for a volume |
| set | Set volume information |
| create | Create a new volume for an application |
| destroy | Remove an existing volume from an application |
| format | Format an application user volume |
| rename | Rename an application user volume |
| resize | Resize a volume. |
| copy | Copy a volume |
| move | Move a volume to another application |
| manage | Manage a volume |
| check | List volumes in the grid than may need fixing |
| fscheck | Check the file system on a volume |
| fsrepair | Repair the file system on a volume |
| repair | Repair volume |
| migrate | Migrate volume |
| clean | Destroy unsynchronized/orphaned volume(s) |
| export | Export volume Supported in AppLogic 2.4+ |
| import | Import volume Supported in AppLogic 2.4+ |
list
| Description: | List volumes in the specified scope |
| Syntax: | volume list --sys [--verbose][--batch] [--mounted] |
| volume list server=name [--verbose][--batch] [--mounted] |
| volume list name [--all] [--verbose] [--batch] [--mounted] |
| Arguments: | name | application, catalog, class, cache, or server name. |
| For global catalogs, the format of name is /catalog. |
| For application volumes, the format of name is application. |
| For application class volumes, the format of name is application:class. |
| For local catalogs, the format of name is application/catalog. |
| For local catalog class volumes, the format of name is application/catalog:class. |
| For cached volumes, the format of name is application/volcache. |
| If server is specified, name is the name of a server. |
| --verbose | Include volume comment in the list |
| --batch | Display output in UDL format |
| --mounted | Display only those volumes that are mounted on the controller. |
| Examples: | volume list --sys - list all volumes |
| volume list server=srv2 - list all volumes with a mirror on 'srv2' |
| volume list sugarcrm - list volumes for application 'sugarcrm' |
| volume list sugarcrm:config - list volumes for class 'config' in application 'sugarcrm' |
| volume list sugarcrm/local - list volumes for local catalog of application 'sugarcrm' |
| volume list sugarcrm/volcache - list instance volumes for application 'sugarcrm' |
| volume list /system - list all volumes in global catalog 'system' |
| volume list /system:NAS - list all volumes for 'system' catalog class 'NAS' |
| Notes: | If no name is specified and the --sys option is specified, all volumes in the grid are listed. |
| If an application name is specified and the --all option is specified, ALL volumes for the application are listed. |
| A specification of the output of this command can be found here. |
Typical Output
Scope Name Size(MB) Server State Filesystem Mirrored Mount State
---------------------------------------------------------------------------------------------------------------------
perf perf 2500 srv2,srv3 ok ext3 Y available
perf perf1 2500 srv2 ok ext3 N available
perf PERF1.boot 1650 srv2,srv3 ok ext3 Y available
sugarcrm code 50 srv2,srv3 ok ext3 Y in_use
sugarcrm config 50 srv1,srv2 ok ext3 Y in_use
sugarcrm data 50 srv3,srv1 ok ext3 Y in_use
sugarcrm logs 50 srv2,srv3 ok ext3 Y in_use
test uservol 10 srv2,srv3 ok ext3 Y available
applfc/local in1.boot 80 srv1,srv2 ok ext3 Y available
applfc/local in1.usr 200 srv2,srv3 ok ext3 Y available
jsperf/catalog PERF.boot 1650 srv2,srv3 ok ext3 Y available
newcat/catalog HLB.boot 80 srv3,srv1 ok ext3 Y available
newcat/catalog HLB.usr 200 srv2,srv3 ok ext3 Y available
newcat/catalog IN.boot 80 srv2,srv3 ok ext3 Y available
newcat/catalog IN.usr 200 srv2,srv3 ok ext3 Y available
applfc/volcache main.T_DRN.boot 901 srv1,srv3 ok ext3 Y available
applfc/volcache main.T_SRC.boot 1101 srv1,srv3 ok ext3 Y available
bh/volcache main.LUX.boot 80 srv3,srv1 ok ext3 Y available
jsperf/volcache main.PERF.boot 1650 srv2 degraded ext3 Y available
jsperf/volcache main.PERF1.boot 1650 srv3 degraded ext3 Y available
jsperf/volcache main.T_DRN.boot 901 srv1,srv2 ok ext3 Y available
perf/volcache main.PERF.boot 1650 srv3,srv2 ok ext3 Y available
qa_app1/volcache main.comp1.boot 901 srv1,srv2 degraded ext3 Y available
qa_app1/volcache main.comp2.boot 901 srv2,srv3 degraded ext3 Y available
qa_app1/volcache main.comp3.boot 901 srv3,srv1 ok ext3 Y available
qa_app1/volcache main.comp4.boot 901 srv1,srv2 degraded ext3 Y available
qa_app1/volcache main.comp5.boot 901 srv3,srv1 ok ext3 Y available
qa_app1/volcache main.comp6.boot 901 srv2,srv3 degraded ext3 Y available
qa_app1/volcache main.comp7.boot 901 srv1,srv2 degraded ext3 Y available
qa_app1/volcache main.comp8.boot 901 srv2,srv3 degraded ext3 Y available
qa_gway/volcache main.in1.boot 80 srv3,srv1 ok ext3 Y available
qa_gway/volcache main.in2.boot 80 srv1,srv2 ok ext3 Y available
qa_gway/volcache main.out1.boot 80 srv1,srv2 ok ext3 Y available
qa_gway/volcache main.out2.boot 80 srv3,srv1 ok ext3 Y available
qa_gway/volcache main.prc1.boot 901 srv2,srv3 ok ext3 Y available
qa_gway/volcache main.prc2.boot 901 srv2,srv3 ok ext3 Y available
sugarcrm/volcache main.admin.boot 80 srv2,srv3 ok ext3 Y in_use
sugarcrm/volcache main.config.boot 80 srv1,srv2 ok ext3 Y in_use
sugarcrm/volcache main.dbase.boot 80 srv3,srv1 ok ext3 Y in_use
sugarcrm/volcache main.logs.boot 80 srv3,srv1 ok ext3 Y in_use
sugarcrm/volcache main.mail.boot 80 srv1,srv2 ok ext3 Y in_use
sugarcrm/volcache main.srv1.boot 110 srv3,srv1 ok ext3 Y in_use
sugarcrm/volcache main.srv2.boot 110 srv1,srv2 ok ext3 Y in_use
sugarcrm/volcache main.usr.boot 80 srv2,srv3 ok ext3 Y in_use
sugarcrm/volcache main.webs.boot 80 srv2,srv3 ok ext3 Y in_use
/proto LINUX.boot 2048 srv2,srv3 ok ext3 Y available
/system HLB.boot 80 srv1,srv2 ok ext3 Y available
/system HLB.usr 200 srv3,srv1 ok ext3 Y in_use
/system IN.boot 80 srv2,srv3 ok ext3 Y available
/system IN.usr 200 srv1,srv2 ok ext3 Y in_use
/system LUX.boot 80 srv3,srv1 ok ext3 Y available
/system LUX.usr 200 srv2,srv3 ok ext3 Y available
/system MYSQL.boot 80 srv1,srv2 ok ext3 Y available
/system MYSQL.usr 200 srv3,srv1 ok ext3 Y in_use
/system NAS.boot 80 srv2,srv3 ok ext3 Y available
/system NAS.usr 200 srv1,srv2 ok ext3 Y in_use
/system NET.boot 80 srv2,srv3 ok ext3 Y available
/system NET.usr 200 srv1,srv2 ok ext3 Y available
/system OUT.boot 80 srv3,srv1 ok ext3 Y available
/system OUT.usr 200 srv2,srv3 ok ext3 Y in_use
/system WEB.boot 110 srv1,srv2 ok ext3 Y available
/system WEB.usr 400 srv3,srv1 ok ext3 Y in_use
/test LINUX.boot 2048 srv1,srv2 ok ext3 Y available
/test PERF.boot 1650 srv1,srv2 ok ext3 Y available
info
| Description: | Retrieve detailed information for an existing volume |
| Syntax: | volume info name [--batch] |
| Arguments: | name | name of the volume for which to retrieve information The format of name is the following: |
| application:volume - application volume |
| application:class.volume - singleton class volume |
| application/catalog:class.volume � application catalog class volume |
| /catalog:class.volume � global catalog class volume |
| application/volcache:subordinate.volume - application instance volume |
| --batch | Display output in UDL format |
| Examples: | volume info sugarcrm:data - Retrieve information for application user volume |
| volume info sugarcrm:NAS1.boot - Retrieve information for application singleton class volume |
| volume info sugarcrm/catalog:NAS1.boot - Retrieve information for application local catalog class volume |
| volume info /system:NAS.boot - Retrieve information for global catalog class volume |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
Name : sugarcrm:data
Link : no
Comment :
Size : 50 MB
State : ok
Filesystem : ext3
Mount State : in_use
Mounted Device : none
Current Users : 1
Attributes : rw
Time Created : Sat May 27 08:16:24 2006
Time Written : Sat May 27 08:16:24 2006
Time Accessed : Sat May 27 10:58:53 2006
Number Mirrors : 2
Mirrors :
Server State
srv3 ok
srv1 ok
set
| Description: | Set volume information |
| Syntax: | volume set name comment=comment |
| Arguments: | name | name of volume The format of name is the following: |
| application:volume - application volume |
| application:class.volume - singleton class volume |
| application/catalog:class.volume � application catalog class volume |
| /catalog:class.volume � global catalog class volume |
| comment | volume comment |
| Examples: | volume set sugarcrm:data comment="My comment" - Set information for application user volume |
| volume set sugarcrm:NAS1.boot comment="My comment" - Set information for application singleton class volume |
| volume set sugarcrm/catalog:NAS1.boot comment="My comment" - Set information for application local catalog class volume |
| volume set /system:NAS.boot - Set information for global catalog class volume |
| Notes: | None. |
create
| Description: | Create a new volume for an application |
| Syntax: | volume create name [size=size] [comment=comment] [link=link] [mkfs=|fs=fstype [fs_options=fs_options] [ mirrored=mirrored] [--prefill][-n] [--batch] |
| Arguments: | name | Name of the volume to create. The format of name is the following: application:[class.]volume |
| size | volume size, units may be specified (e.g., 128M[B], 2G[B]). If units are not specified, it is assumed that the size is specified in MB. |
| comment | volume comment |
| fstype | file system type |
| fs_options | file system-specific options used when installing the file system. This option is only valid if fstype is specified. Applogic 2.3+. |
| link | name of application user volume to which volume is to be linked |
| mirrored | volume is mirrored. default is 1 if multi-server grid is configured |
| --prefill | Allocate ALL blocks of the volume. |
| -n | Skip verification that volume reference is in the class descriptor if adding an application singleton class volume. |
| Examples: | volume create sugarcrm:data1 size=128M fs=ext3 - create application user volume |
| volume create sugarcrm:NAS1:data1 size=128M fs=ext3 - create application singleton class volume |
| Notes: | If the volume size is not specified, the default volume size of 1GB is used. |
| See this topic for a list of supported file systems. |
| The value specified for the fs_options parameter is a space-separated list, is file system specific, and is valid only in conjunction with the mkfs parameter. The following are the options available for each supported filesystem: |
| ext3-snapshot | vol_group_name : string specifying the name of the LVM volume group to create on the volume. If not specified, a volume group name is randomly generated. |
|---|
| data_percentage : percentage of the volume that is used to store data, remaining portion of the volume is for snapshots. If not specified, 80% of the volume is used for data. |
| zfs | pool_name : the name of the pool - defaults to volume name if this is not set |
|---|
| mountpoint : mount path of the pool root (or "legacy" or "none", i.e., mountpoint=legacy) - defaults to /pool_name |
| autoreplace : on/off - controls automatic device replacement - defaults to off |
| delegation : on/off - controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset - defaults to on |
| failmode : wait/continue/panic - defaults to wait |
| version : 1-10 - defaults to 10 (current) |
| A specification of the output of this command can be found here. |
destroy
| Description: | Remove an existing volume from an application |
| Syntax: | volume destroy name |
| Arguments: | name | Name of the volume to remove. format of name is the following: application:[class.]volume |
| Examples: | volume destroy sugarcrm:data - Destroy application user volume |
| volume destroy sugarcrm:NAS1.boot - Destroy application singleton class volume |
| Notes: | The destroy command will fail if the volume is currently in use. |
format
| Description: | Format an existing application user volume |
| Syntax: | volume format name [mkfs=|fs=fstype [fs_options=fs_options] [--force] |
| Arguments: | name | Name of the volume to format. The format of name is the following: application:volume |
| fstype | file system type |
| fs_options | file system-specific options used when installing the file system. This option is only valid if fstype is specified. |
| --force | Skip verification of format operation. |
| Examples: | volume format sugarcrm:data fs=ext3 - format application user volume |
| Notes: | See this topic for a list of supported file systems. |
| The value specified for the fs_options parameter is a space-separated list, is file system specific, and is valid only in conjunction with the mkfs parameter. The following are the options available for each supported filesystem: |
| ext3-snapshot | vol_group_name : string specifying the name of the LVM volume group to create on the volume. If not specified, a volume group name is randomly generated. |
|---|
| data_percentage : percentage of the volume that is used to store data, remaining portion of the volume is for snapshots. If not specified, 80% of the volume is used for data. |
| zfs | pool_name : the name of the pool - defaults to volume name if this is not set |
|---|
| mountpoint : mount path of the pool root (or "legacy" or "none", i.e., mountpoint=legacy) - defaults to /pool_name |
| autoreplace : on/off - controls automatic device replacement - defaults to off |
| delegation : on/off - controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset - defaults to on |
| failmode : wait/continue/panic - defaults to wait |
| version : 1-10 - defaults to 10 (current) |
rename
| Description: | Rename a volume in an application |
| Syntax: | volume rename name new-name |
| Arguments: | name | Name of the existing volume to rename. |
| new-name | New name for the volume. |
| Examples: | volume rename sugarcrm:data data2 - rename application user volume |
| Notes: | name must specify an application volume. new-name is simply the new volume name in the same application. The format for name is application:volume. The format for new-name is or application:volume. |
| If the volume is currently in use, this command will fail. |
resize
| Description: | resize a volume for an application |
| Syntax: | volume resize name size=val [--prefill] |
| Arguments: | name | name of the volume to resize. May specify an application user or singleton class voluem. |
| size=val | Specify new size for the volume. Units may be specified (e.g., 128M[B], 2G[B]). If units are not specified, it is assumed that the size is in MB. The content of the volume must fit within the specified size. |
| --prefill | Allocate ALL blocks of the volume. |
| Notes: | This operation resizes the volume by performing a file-level copy preserving permissions, ownersheip, links, special attributes, etc. |
copy
| Description: | Copy a volume to an application |
| Syntax: | volume copy source destination [comment= val [ mirrored=val ] [ -n ] [--overwrite [--force]] |
| volume copy source destination [--keepcomment] [ mirrored=val ] [--overwrite [--force]] |
| volume copy source destination [comment= val] [ mirrored=val ] [size=val] [--fscpy [--prefill] [fs_options=fs_options]] [ -n ] [--overwrite [--force]] |
| volume copy source destination [--stripcomment] [mirrored=val] [size=val] [--fscpy [--prefill][fs_options=fs_options]] [ -n ] [--overwrite [--force]] |
| Arguments: | source | name of the existing volume to copy. May specify any volume. |
| destination | Name of the new copied volume in the application. Must specify an application user or singleton class volume. |
| comment=val | Comment that is to be set for the destination volume. |
| mirrored=val | Set to 1 if volume is to be mirrored. Default is 1 if multi-server grid is configured. |
| --keepcomment | If specified, the comment from the source volume is set for the destination volume. |
| size=val | Specify size for new volume. Units may be specified (e.g, 128M[B], 2G[B]). If units are not specified, it is assumed that the specified value is in MB. If not specified, the destination volume is created with the same size as the source volume. |
| --fscpy | Perform file-level copy when copying the volume. If this option is not specified, block-level copy is performed. |
| fs_options | file system-specific options used when installing the file system. This option is only valid if --fscpy is specified. Applogic 2.3+. |
| --prefill | Allocate ALL blocks of the volume. |
| --stripcomment | If specified, the comment from the source volume is not copied to the destination volume and the comment for the destination volume is set to empty. |
| -n | Skip verification that volume reference is in the class descriptor if the destination volume is an application singleton class volume |
| Examples: | volume copy sugarcrm:data sugarcrm:data2 - Copy application user volume |
| volume copy /system:NAS.boot sugarcrm:NAS2.boot - Copy global catalog class volume to application singleton class volume |
| Notes: | If neither comment=val or --keepcomment arguments are specified, the comment for the new volume is set to the comment of the source volume with "copy of:" prepended to the comment if the comment of the source volume is non-empty. |
| If the --overwrite option is specified and the destination volume exists, the destination volume is overwritten, otherwise the copy is failed. |
| If the --force option is specified, the user is not asked to confirm the overwriting of the volume if --overwrite was specified. |
| If either the source or destination volume is currently in use, this command will fail. |
| If size=val argument is specifies, the destination volume must be an application user of singleton class volume and must not already exist. |
| If --fscpy and --overwrite options are provided, the destination volume is destroyed and re-created. |
| The value specified for the fs_options parameter is a space-separated list, is file system specific, and is valid only in conjunction with the --fscpy parameter. The following are the options available for each supported filesystem: |
| ext3-snapshot | vol_group_name : string specifying the name of the LVM volume group to create on the volume. If not specified, a volume group name is randomly generated. |
|---|
| data_percentage : percentage of the volume that is used to store data, remaining portion of the volume is for snapshots. If not specified, 80% of the volume is used for data. |
| zfs | pool_name : the name of the pool - defaults to volume name if this is not set |
|---|
| mountpoint : mount path of the pool root (or "legacy" or "none", i.e., mountpoint=legacy) - defaults to /pool_name |
| autoreplace : on/off - controls automatic device replacement - defaults to off |
| delegation : on/off - controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset - defaults to on |
| failmode : wait/continue/panic - defaults to wait |
| version : 1-10 - defaults to 10 (current) |
move
| Description: | Move a volume to another application |
| Syntax: | volume move src dest |
| Arguments: | src | Name of the existing volume to move. Must specify an application user volume. |
| dst | Name of the destination volume. Must specify an application user volume. |
| Examples: | volume move sugarcrm:data newapp:data - Move volume from application 'sugarcrm' to application 'newapp' |
| Notes: | This command is not supported in single workstation mode. |
| If the volume is currently in use, this command will fail. |
manage
| Description: | Manage a volume |
| Syntax: | volume manage name [--ro | --rw] [ --nossh ] [ prop=val ]* |
| Arguments: | name | name of the volume to be manage. |
| --ro | access to volume is read-only. |
| --rw | access to volume is read-write. |
| --nossh | do not provide SSH access to the managed volume. |
| prop=val | Specifies settings to configure external network access for use with the volume manager GUI/shell. The following values are supported: |
| ip - Specifies the IP address. |
| netmask - Specifies the network mask. This must be specified if ip is specified. |
| gateway - Specifies the IP address of the default network gateway. It can be left blank only if the remote host is on the same subnet; must be specified otherwise. |
| dns1 - Specifies the IP address of the primary DNS server used to resolve domain names. This allows the user to specify hostnames when uploading/downloading files to/from a volume. |
| dns2 - Specifies the IP address of the secondary DNS server, which will be used if the primary DNS server does not respond. |
| Examples: | volume manage sugarcrm:data --rw - manage application user volume |
| volume manage /system:NAS.boot --ro - manage global catalog class volume |
| volume manage /myapp:myvol --rw ip=192.168.1.100 netmask=255.255.255.0 gateway=192.168.1.254 - manage application user volume and set up external network access from within the volume manager. This allows the user to upload/download files to/from the specified volume to/from a remote location, all from within the volume manager GUI/shell. |
| Notes: | By default, the user is SSH'd into the volume manager shell. The volume is accessible under /mnt/vol. In addition, a URL is provided to access the visual interface (eXtplorer) through which the volume can be accessed and modified (files may be uploaded, downloaded, created, edited, etc). |
| Note that the GUI does have a 10MB file upload limitation. To upload larger files to your volume, use the volume manager shell. |
fscheck
| Description: | Check the health of the file system on a volume |
| Syntax: | volume fscheck name |
| Arguments: | name | name of the volume to be checked |
| Examples: | volume fscheck sugarcrm:data - Check file system on application user volume |
| volume fscheck /system:NAS.boot - Check file system on global catalog class volume |
| Notes: | This operation is similar to running the Linux fsck utility over a volume. |
fsrepair
| Description: | Check and repair the file system on a volume |
| Syntax: | volume fsrepair name |
| Arguments: | name | name of the volume to be repaired |
| Examples: | volume fsrepair sugarcrm:data - Check and repair file system on application user volume |
| volume fsrepair /system:NAS.boot - Check and repair file system on global catalog class volume |
| Notes: | This operation is similar to running the Linux fsck utility with the repair option over a volume. |
check
| Description: | List volumes that may need repair |
| Syntax: | volume check [ --all | --migrate | --repair | --error | --link | --sync | --orphan ] [ --batch ] |
| Arguments: | --all | lists all logical volumes in the grid that need to be migrated, all logical volumes that need to be repaired, all inaccessible volumes, all logical volumes that are unsynchronized (belong to no entity), and all orphan volumes (mirrors that do not belong to any volume). |
| --migrate | list all volumes in the grid that need to be migrated |
| --repair | list all degraded volumes in the grid |
| --error | list all inaccessible volumes in the grid |
| --link | list all volumes with broken symbolic links. |
| --sync | list all unsynchronized volumes in the grid |
| --orphan | list all orphan virtual volumes in the grid |
| Examples: | volume check --all - list all volumes that need fixing |
| volume check --migrate - list all volumes that need migration |
| volume check --sync - list all unsynchronized volumes |
| Notes: | A specification of the output of this command can be found here. |
Typical Output
--- System Volumes ---
Name Scope Type Size(MB) State Mirrored Linked
---------------------------------------------------------------------------------------------------
main.in2.boot qa_conn2/volcache REPAIR 80 degraded yes no
main.out.boot qa_conn2/volcache REPAIR 80 degraded yes no
main.comp8.boot qa_app1/volcache REPAIR 901 degraded yes no
main.drn3.boot qa_app1/volcache REPAIR 901 degraded yes no
main.comp6.boot qa_app1/volcache REPAIR 901 degraded yes no
main.comp1.boot qa_app1/volcache REPAIR 901 degraded yes no
main.src2.boot qa_app1/volcache REPAIR 1101 degraded yes no
main.drn2.boot qa_app1/volcache REPAIR 901 degraded yes no
main.src3.boot qa_app1/volcache REPAIR 1101 degraded yes no
main.comp4.boot qa_app1/volcache REPAIR 901 degraded yes no
main.comp2.boot qa_app1/volcache REPAIR 901 degraded yes no
main.comp7.boot qa_app1/volcache REPAIR 901 degraded yes no
main.PERF.boot jsperf/volcache REPAIR 1650 degraded yes no
main.PERF1.boot jsperf/volcache REPAIR 1650 degraded yes no
boot SYSTEM REPAIR 1023 degraded yes no
meta SYSTEM REPAIR 1023 degraded yes no
impex SYSTEM REPAIR 10239 degraded yes no
--- Orphan Volumes ---
Name Size(MB) State
---------------------------------------------------------------------
srv1.v-213a6474-31ca-4144-8c65-9562f0f39acb 1101 available
srv1.v-ce5a30d4-e8f1-48f5-92a4-d352645c2183 901 available
srv1.v-f009b607-e7ae-4de8-824f-2269b6d08c1d 901 available
srv2.v-0e976f26-b6e4-4d1f-9637-5b1bac06477d 901 available
srv2.v-27cc7a10-cae7-4ed2-b49b-c104ab829be4 1101 available
srv2.v-60746655-8cef-4337-8e4e-12577f4be09a 901 available
srv2.v-84b8c2d0-12d2-4361-a1bd-a304de154143 1101 available
srv2.v-8e30bbb8-6068-487a-bc93-25969103bd8e 901 available
srv3.v-56ddebf5-735c-49fd-9348-7c5a28b44d8c 1101 available
srv3.v-ba38ba35-b1df-49fa-bb3a-02416a7594db 1101 available
migrate
| Description: | Migrate volume(s) |
| Syntax: | volume migrate name | --all [ n=n-vols ] [ --nowait ] [ --force ] [ --stop ] |
| Arguments: | name | Name of the volume(s) to migrate. |
| --all | Migrate all volumes that need migration. |
| n-vols | number of volumes to simultaneously migrate. If not specified, one volume at a time is migrated. |
| --nowait | Perform operation in the background - do not wait for it to complete. |
| --force | Ignore failures and continue with migration |
| --stop | Cancel migration operation for volume(s) currently being migrated. |
| Examples: | volume migrate --all - Migrate all volumes |
| volume migrate --all --nowait - Migrate all volumes in the background |
| volume migrate sugarcrm - Migrate all volumes in an application |
| volume migrate sugarcrm:data - Migrate an application user volume |
| volume migrate /system - Migrate all volumes in a global catalog |
| volume migrate --all --stop - Stop migration for all volumes currently being migrated. |
| Notes: | None. |
repair
| Description: | Repair volume(s) |
| Syntax: | volume repair name | --all [ n=n-vols ] [ --nowait ][ --force ] [ --stop ] |
| Arguments: | name | Name of the volume(s) to repair. |
| --all | Repair all volumes that need repair. |
| n-vols | number of volumes to simultaneously repair. If not specified, one volume at a time is repaired. |
| --nowait | Perform operation in the background - do not wait for it to complete. |
| --force | Ignore failures and continue with repair |
| --stop | Cancel repair operation for volume(s) currently being repaired. |
| Examples: | volume repair --all - Repair all volumes |
| volume repair --all --nowait - Repair all volumes in the background |
| volume repair sugarcrm - Repair all volumes in an application |
| volume repair sugarcrm:data - Repair an application user volume |
| volume repair /system - Repair all volumes in a global catalog |
| volume repair --all --stopt - Stop repair for all volumes currently being repaired |
| Notes: | None. |
clean
| Description: | Destroy unsynchronized/orphaned volume(s) |
| Syntax: | volume clean [ --sync | --orphan | --link ] [ --force ] |
| Arguments: | --sync | Destroy unsynchronized volumes |
| --orphan | Destroy orphan volumes |
| --link | Destroy volumes with broken symbolic links |
| --force | Ignore failures and continue with clean operation |
| Examples: | volume clean - Destroy all broken link, unsynchronized and orphan volumes |
| volume clean --sync - Destroy all unsynchronized volumes |
| volume clean --orphan - Destroy all orphan volumes |
| Notes: | If no arguments are specified, both unsynchronized and orphan volumes are destroyed. |
export
| Description: | Export volume |
| Syntax: | volume export name image file [ --nocompress ] [ --force ] |
| Arguments: | name | Name of volume to export. |
| image file | Name of the exported volume image residing within the root of the /vol/_impex directory. If the --nocompress option is not specified, a ‘.gz’ extension is added to the image file name if not already specified. |
| --nocompress | Do not compress the exported volume image. |
| --force | Overwrite the volume image already residing within the root of the /vol/_impex directory. |
| Examples: | vol export myapp:myvol myvol.img - export application user volume creating compressed image file with name of myvol.img.gz. |
| vol export myapp:myclass.boot myclass.boot.img --nocompress - export application singleton class boot volume without compression. |
| Notes | Supported in AppLogic 2.4+ |
import
| Description | Import a volume to an application |
| Syntax | vol import name image file [prop=val]* [--overwrite[--force]] [ -n] |
| Arguments | name | Name of the volume to import. The format of name is the following: application:[class.]volume |
| image file | Name of the volume image residing within the root directory of the /vol/_impex folder. |
| prop=val | Volume parameters. The following parameters may be set: |
| size - optional volume size, units may be specified (e.g., 128M[B], 2G[B]). If units are not specified, it is assumed that the value is in MB. |
| comment - (optional) volume comment |
| mirrored - (optional) volume is mirrored |
| --overwrite | Overwrite existing volume. |
| --force | Do not prompt for confirmation of overwrite |
| -n | Skip verification that volume reference is in the class descriptor if adding an application singleton class volume. |
| Examples | vol import myapp:myvol myvol.img.gz size=1G – import an application user volume |
| vol import myapp:myclass.cdrom os.iso – import an operating system ISO image to an application singleton class volume. |
| Notes | Supported in AppLogic 2.4+ |
| If the --overwrite option is specified, the existing volume and the volume to be imported must be the same size. |
| If the volume image is compressed, it is advisable to specify the size argument so that the image file does not have to be uncompressed twice (once to determine the size of the actual image and once for the actual import operation). |
AppLogic23 Web
AppLogic 2.3 Beta Documentation The latest production release is AppLogic 2.1.1