Command Line Interface

CloudGatewayAddFilesystem

This command adds a new filesystem to the Storage Manager configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayAddFilesystem
Id, type, cache-root, full-threshold, and file parameters are mandatory.
Usage: CloudGatewayAddFilesystem [OPTIONS] [<instance name>] ...
Required options are:
        -i --id                        Filesystem ID
        -t --type                      Filesystem type, eg Single, Mirroring or Striping
        -c --cache-root                Filesystem cache root directory
        -u --full-threshold            Full Threshold, in percent
        -f --file                      Configuration file
        -m --mount-point               Mount Point
Optional options are:
        -o --io-block-size             Preferred I/O block size, in bytes
        -s --clean-min-file-size       The minimum file size in bytes for an object
                                       to be considered by the cache cleaning process
        -a --clean-max-access-offset   Only files that have been not been accessed for
                                       at least this value (in seconds) might be cleaned

Parameters

  • Filesystem identifier (-i –id) the new filesystem’s identifier, or name.

  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to update.

  • Filesystem type (-t –type) the new filesystem’s type. Three modes are available:

    • Single, where the filesystem uses only on instance ;
    • Mirroring, where data are mirrored on each instance associated with the filesystem ;
    • Striping, where data are distributed over all instance associated with the filesystem.

    See Configuration/FileSystems/FileSystem/Type.

  • Cache root (-c –cache-root) the root cache directory of the new filesystem.

    See Configuration/FileSystems/FileSystem/CacheRoot.

  • Full threshold (-u –full-threshold) the full threshold of the new filesystem, over which the cleaner begins to expunge cache entries.

    See Configuration/FileSystems/FileSystem/FullThreshold.

  • I/O block size (-o –io-block-size) the new filesystem’s preferred I/O block size, in bytes.

    See Configuration/FileSystems/FileSystem/IOBlockSize.

  • Cleaner minimum file size (-s –clean-min-file-size) the new filesystem’s cleaner minimum file size. Files smaller than this size won’t get expunged from the cache.

    See Configuration/FileSystems/FileSystem/CleanMinFileSize.

  • Cleaner maximum access offset (-a –clean-max-access-offset) the new filesystem’s cleaner maximum offset. Only files that have not been accessed for at least as many seconds are considered for cleaning.

    See Configuration/FileSystems/FileSystem/CleanMaxAccessOffset.

  • Configuration file (-m –mount-point) the mount point where the filesystem will be mounted.

CloudGatewayAddFilterToInstance

This command adds a filter to an existing instance.

$ ${INSTALL_PREFIX}/bin/CloudGatewayAddFilterToInstance
Name, type and file parameters are mandatory.
Usage: CloudGatewayAddFilterToInstance [OPTIONS]
Required options are:
        -i --instance-name                       Instance name
        -t --type                                Filter type (Compression, Encryption)
        -f --file                                Configuration file
Optional options are:
        -l --level                               Compression Level (required for
                                                 Compression filter)
        -c --cipher                              Cipher (required for Encryption filter)
        -d --digest                              Digest used to derive an encryption key
                                                 (required for Encryption filter)
        -k --key-iteration-count                 Count of iterations used to derive an encryption
                                                 key (required for Encryption filter)
        -p --password                            Password used to derive an encryption key
                                                 (required for Encryption filter)
Please look at the product documentation for more information.

Parameters

CloudGatewayAddInstance

This command adds a new instance to the Storage Manager configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayAddInstance
Name, provider and file parameters are mandatory.
Usage: CloudGatewayAddInstance [OPTIONS]
Required options are:
        -n --name                                Instance name
        -P --provider                            Provider type (Amazon, Openstack)
        -f --file                                Configuration file
Optional options are:
        -a --access-key-id                       Access Key ID (required for type Amazon)
        -s --secret-access-key                   Secret Access Key (required for type Amazon)
        -e --endpoint                            Endpoint (required for type Amazon)
        -g --endpoint-port                       Endpoint port (required for type Amazon)
        -b --bucket                              Bucket (required for type Amazon)
        -S --secure-transaction                  Whether to use HTTPs (required for Amazon)
        -i --identity-version                    Identity Version for Openstack (required for Openstack)
        -u --user-name                           Username (required for Openstack)
        -p --password                            Password (required for Openstack v2)
        -t --tenant-id                           Tenant ID
        -T --tenant-name                         Tenant Name
        -I --api-access-key                      API Access Key (required for Openstack v1)
        -A --authentication-endpoint             Authentication Endpoint (required for Openstack)
        -c --container                           Container (required for Openstack)
        -r --preferred-region                    Preferred region to use with Openstack, if any
        -m --authentication-max-life-time        Authentication max lifetime for an Openstack token
        -R --authentication-token-recent-delay   An Openstack authentication error with a token older than
                                                 this delay will trigger a re-authentication
        -F --authentication-format               Authentication format (optional for Openstack)
        -k --allow-insecure                      Allow insecure (invalid certificate) communication
Please look at the product documentation for more information.

Parameters

CloudGatewayListFilesystems

This command lists all filesystems (also known as volumes) present in the given configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayListFilesystems
File parameter is mandatory.
Usage: CloudGatewayListFilesystems [OPTIONS]
Required options are:
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to read information from.

CloudGatewayListInstances

This command lists all instances existing in the given configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayListInstances
File parameter is mandatory.
Usage: CloudGatewayListInstances [OPTIONS]
Required options are:
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to read information from.

CloudGatewayMount

This command mounts the filesystem (also known as volume) specified in the given configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayMount
Usage: $0 [<Mount point>] <Configuration File>

Parameters

  • Mount point the directory where the filesystem should be mounted. This is only required if the MountPoint value does not exist in the configuration file.

    See Configuration/FileSystems/FileSystem/MountPoint.

  • Configuration file the mount point configuration file.

CloudGatewayMountConfigTest

This command parses the given filesystem configuration file, in order to verify that it is valid.

$ ${INSTALL_PREFIX}/bin/CloudGatewayMountConfigTest
CloudGatewayMountConfigTest <Cloud Gateway mount configuration file>

Parameters

  • Configuration file the mount point configuration file.

CloudGatewayRemoveFilesystem

This command removes an existing filesystem definition from the Cloud Gateway configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayRemoveFilesystem
Name, type and file parameters are mandatory.
Usage: CloudGatewayRemoveFilesystem [OPTIONS]
Required options are:
        -i --id                                  Filesystem ID
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Filesystem identifier (-i –id) the name of the filesystem (or volume) to remove.
  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to update.

CloudGatewayRemoveFilterFromInstance

This command removes an existing filter associated to an instance from the Cloud Gateway configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayRemoveFilterFromInstance
Name, type and file parameters are mandatory.
Usage: CloudGatewayRemoveFilterFromInstance [OPTIONS]
Required options are:
        -i --instance-name                       Instance name
        -t --type                                Filter type (Compression, Encryption)
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Instance identifier (-i –instance-name) the name of the instance whose filter has to be removed.

  • Filter type (-f –type) the type of the filter to be removed.

    See Configuration/Instances/Instance/Filters/Filter/Type.

  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to update.

CloudGatewayRemoveInstance

This command removes an existing instance from the Cloud Gateway configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayRemoveInstance
Name and file parameters are mandatory.
Usage: CloudGatewayRemoveInstance [OPTIONS]
Required options are:
        -i --instance-name                       Instance name
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Instance identifier (-i –instance-name) the name of the instance to remove.
  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file to update.

CloudGatewayShowFilesystem

This command displays a filesystem’s configuration.

$ ${INSTALL_PREFIX}/bin/CloudGatewayShowFilesystem
Id and file parameters are mandatory.
Usage: CloudGatewayShowFilesystem [OPTIONS]
Required options are:
        -i --id                                  Filesystem ID
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Filesystem identifier (-i –id) the filesystem identifier.
  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file.

CloudGatewayShowInstance

This command displays an instance’s configuration.

$ ${INSTALL_PREFIX}/bin/CloudGatewayShowInstance
Name and file parameters are mandatory.
Usage: CloudGatewayShowInstance [OPTIONS]
Required options are:
        -i --instance-name                       Instance name
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Instance identifier (-i –instance-name) the instance name.
  • Configuration file (-f –file) the Cloud Gateway Storage Manager configuration file.

CloudGatewayShowMount

This command displays a mount point configuration.

$ ${INSTALL_PREFIX}/bin/CloudGatewayShowMount
File parameter is mandatory.
Usage: CloudGatewayShowMount [OPTIONS]
Required options are:
        -f --file                                Configuration file
Please look at the product documentation for more information.

Parameters

  • Configuration file (-f –file) the mount point configuration file.

CloudGatewayStatus

This command displays the number of files (and optionally the status of each one) that are not synchronised with the cloud storage provider, either because they have been modified (dirty state) or deleted, and the modification has not been repercuted to the storage provider yet.

$ ${INSTALL_PREFIX}/bin/CloudGatewayStatus

Parameters

  • Verbose (-v) displays the status of each deleted or dirty file.

CloudGatewayStorageManager

This command controls the Cloud Gateway Storage Manager.

$ ${INSTALL_PREFIX}/bin/CloudGatewayStorageManager
Usage: ${INSTALL_PREFIX}/bin/CloudGatewayStorageManager \
  [start|stop|graceful-stop|force-stop|restart|reload|status

Options

  • start Start the Storage Manager.
  • stop Stop the Storage Manager using a graceful stop. See on page .
  • graceful-stop Gracefully stop the Storage Manager. See on page .
  • force-stop Alias for graceful-stop.
  • restart Stop the Storage Manager using a force stop, then start it.
  • reload Gracefully reload Storage Manager. See on page .
  • status Print whether the Storage Manager is running or not.

CloudGatewayStorageManagerConfigTest

This command parses the given Storage Manager configuration file, in order to verify that it is valid.

$ ${INSTALL_PREFIX}/bin/CloudGatewayStorageManagerConfigTest
CloudGatewayStorageManagerConfigTest <Cloud Gateway Storage Manager configuration file>

Parameters

  • Configuration file the Storage Manager configuration file.

CloudGatewayStorageManagerUnMount

This command unmounts the filesystem (also known as volume) specified in the given configuration file.

$ ${INSTALL_PREFIX}/bin/CloudGatewayUnmount
Usage: ${INSTALL_PREFIX}/bin/CloudGatewayUnmount [<Mount point>|<Configuration File>]

Parameters