mmcloudgateway command

Availability

Available with IBM Spectrum Scale Advanced Edition, IBM Spectrum Scale Data Management Edition, or IBM Spectrum Scale Erasure Code Edition.

Description

Use the mmcloudgateway command to manage and administer the Transparent cloud tiering feature. This CLI has an extensive set of options organized by categories like account, service, files, etc. You can receive category-based command usage by typing the category with the help option. For example mmcloudgateway <category> -h and only that category usage is displayed.

Parameters

account

Manages cloud storage accounts with one of the following actions:

create

Creates a cloud storage account.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--account-name AccountName

Specifies a name that uniquely identifies the cloud object storage account on the node class.

Note: No special characters are allowed in the name except for “-” and “_”.

--cloud-type CloudType

Specifies the name of the object storage provider.

--username Name

Specifies the user name of the cloud object storage account. For Amazon S3 and IBM Cloud™ Object Storage, it represents the access key.

Note: Skip this parameter for locked vaults.

--pwd-file PasswordFile

Specifies a file that includes the password.

Note: Skip this parameter for locked vaults.

--src-keystore-path SourceKeystorePath

Specifies the keystore path for the X.509 certificate and the private key that is used to authenticate the vault.

--src-keystore-alias-name SourceKeystoreAliasName

Specifies the alias name that needs to be imported to the Transparent cloud tiering keystore from the specified keystore.

--src-keystore-type SourceKeystoreType

Specifies the type of source keystore. Allowed keystore types are JKS, JCEKS.

--src-keystore-pwd-file SourceKeystorePasswordFile

Specifies the password file of the source keystore.

--tenant-id Tenant ID

Specifies the tenant ID for the cloud storage provider account.

Note: Optional for cloud type “S3” but mandatory for cloud types “Swift3” and “Swift-Keystone.”

update

Updates the cloud storage account information.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--account-name AccountName

Specifies a name that uniquely identifies the cloud object storage account on the node.

Note: No special characters are allowed in the name except for “-” and “_”.

--username Name

Specifies the user name of the cloud object storage account. For Amazon S3 and IBM Cloud Object Storage, it represents the access key.

Note: Skip this parameter for locked vaults.

--pwd-file PasswordFile

Specifies a file that includes the password.

Note: Skip this parameter for locked vaults.

--src-keystore-path SourceKeystorePath

Specifies the keystore path for the X.509 certificate and the private key that is used to authenticate the vault.

--src-keystore-alias-name SourceKeystoreAliasName

Specifies the alias name that needs to be imported to the Transparent cloud tiering keystore from the specified keystore.

--src-keystore-type SourceKeystoreType

Specifies the type of source keystore. Allowed keystore types are JKS, JCEKS.

--src-keystore-pwd-file SourceKeystorePasswordFile

Specifies the password file of the source keystore.

delete

Removes a cloud storage account.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--account-name AccountName

Specifies the unique name that was provided to the cloud object storage account on the Transparent cloud tiering node.

list

Lists the registered cloud accounts. Displays more information about the configured cloud account such as the cloud provider name, cloud provider tenant ID, cloud provider URL.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--name-list

When this option is specified, the output will include only the names of the cloud accounts (without other details) that are configured in a node class.

--account-name AccountName

Specifies the account name that you want to list. The output will display the details of the cloud account that is specified here.

cloudStorageAccessPoint

Manages cloud storage access points (CSAPs) with one of the following actions:

create

Creates one or more cloud storage access points.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--cloud-storage-access-point-name CloudStorageAccessPointName

Specifies the CSAP name that needs to be associated with the node class.

--account-name AccountName

Specifies the cloud account name that needs to be associated with the CSAP.

--url URL

Specifies the cloud endpoint with which Cloud services open up a network connection. For S3, the URL is implicit (derived from the region parameter automatically).

--region Region

Specifies the geographic region where the cloud service is installed and running.

Note: This parameter is only applicable for Swift and S3. To know the supported regions for Amazon S3, see Amazon S3.

--mpu-parts-size MPUPartsSize

Specifies multi-part upload size in bytes. Any value expressed in bytes between 5 MB and 4 GB is allowed. Default being 128 MB.

--server-cert-path ServerCertPath

Specifies the certificate path for the self-signed certificates that are presented by the private object storage servers. This is required only when the cloud URL uses HTTPS.

--slice-size SliceSize

Specifies the internal unit of transferring data within Cloud service modules. Higher slice size indicates better performance. Default value is 512 KB.

--proxy-ip ProxyIP

If you require a proxy server to access your cloud over the network, specify the proxy server IP address in dotted decimal format. You must specify the --proxy-port option when enabling a proxy server.

Note: This supports only IPv4.

--proxy-port ProxyPort

Specifies the port number that the proxy server listens to.

update

Updates the CSAP details.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--cloud-storage-access-point-name CloudStorageAccessPointName

Specifies the CSAP name that needs to be associated with the node class.

--url URL

Specifies the cloud endpoint with which Cloud services open up a network connection. For S3, the URL is implicit (derived from the region parameter automatically).

--region Region

Specifies the geographic region where the cloud service is installed. Applicable only for Swift.

--server-cert-path ServerCertPath

Specifies the certificate path for the self-signed certificates that are presented by the private object storage servers. This is required only when the cloud URL uses HTTPS.

--slice-size SliceSize

Specifies the internal unit of transferring data within Cloud service modules. Higher slice size indicates better performance. Default value is 512 KB.

--proxy-ip ProxyIP

If you require a proxy server to access your cloud over the network, specify the proxy server IP address in dotted decimal format. You must specify the --proxy-port option when enabling a proxy server.

Note: This supports only IPv4.

--proxy-port ProxyPort

Specifies the port number that the proxy server listens to.

delete

Delete the CSAPs.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--cloud-storage-access-point-name CloudStorageAccessPointName

Specifies the CSAP that needs to be deleted.

list

Lists the CSAP details including account name, URL, and MPU part size.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the CSAP.

--name-list

When this option is specified, the output will include only the CSAP names.

--cloud-storage-access-point-name CloudStorageAccessPointName

Specifies the CSAP whose details need to be listed.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

cloudService

Manages s a cloud service that can be used either for tiering or sharing. The cloud service caters to a specific file system or a fileset and to a specific cloud account:

create

Creates a cloud service.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the cloud service.

--cloud-service-name CloudServiceName

Specifies a name to identify the cloud service.

--cloud-service-type CloudServiceType{Sharing | Tiering}

Specifies whether the cloud service is used for tiering or sharing operation. If it is used for tiering, then "Tiering" should be specified, and if it is used for sharing, then "Sharing" should be specified.

--account-name AccountName

Specifies the cloud account that is associated with the cloud service.

update

Updates the cloud service details.

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the cloud service whose details need to be updated.

--cloud-service-name CloudServiceName

Specifies the cloud service whose details need to be updated.

--enable | --disable

Specifies whether the cloud service needs to be enabled or disabled.

delete

Deletes the cloud service that no longer needs to be used.

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the cloud service that you want to delete.

--cloud-service-name CloudServiceName

Specifies the name of the cloud service that needs to be removed.

list

Lists the cloud service information such as name, cloud account name, and the type of cloud service (tiering/sharing).

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the cloud service that you want to list.

--name-list

When this option is specified, the output will include only the CSAP names.

--cloud-service-name CloudServiceName

Specifies the name of the cloud service that needs to be listed.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

keyManager

Manages a key manager for encrypting data between local file system and the cloud storage tier, with the following options:

create

Uses an SKLM key manager with Cloud services.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the Cloud services.

--key-manager-name KeyManagerName

Specifies the key manager name.

--key-manager-type

Specifies the type of the key manager. If it is a remote key manager, specify "RKM," and if it is a local key manager, specify "LKM".

--alias Alias

Specifies the alias name of the local key manager.

--sklm-hostname SKLMHostname

Specifies the host name or IP address of the IBM® Security Lifecycle Manager server.

--sklm-port SKLMPort

Specifies the port number on which the IBM Security Key Lifecycle Manager server listens for requests. Default value is 9080.

--sklm-adminuser SKLMAdminUser

Specifies the administrator user name of the IBM Security Key Lifecycle Manager server REST Global Admin. Default value is SKLMAdmin.

--sklm-groupname SKLMGroupname

Specifies the group user name of the IBM Security Key Lifecycle Manager server REST Global Admin.

--sklm-pwd-file SKLMPasswordFile

Specifies the password file of the IBM Security Key Lifecycle Manager server REST Global Admin.

update

Updates the key manager details.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--key-manager-name KeyManagerName

Specifies the key manager name.

--sklm-port SKLMPort

Specifies the port number on which the IBM Security Key Lifecycle Manager server listens for requests. Default value is 9080.

--sklm-adminuser SKLMAdminUser

Specifies the administrator user name of the IBM Security Key Lifecycle Manager server REST Global Admin. Default value is SKLMAdmin.

--sklm-pwd-file SKLMPasswordFile

Specifies the password file of the IBM Security Key Lifecycle Manager server REST Global Admin.

--update-certificate

Specifies this parameter if you want to update the REST certificate.

rotate

Rotates the existing key and creates a new SKLM key.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

--key-manager-name KeyManagerName

Specifies the key manager name.

list

Lists the key manager information such as name, location of the certificate, admin user ID..

--cloud-nodeclass CloudNodeClass

Specifies the node class.

--name-list

When this option is specified, the output will include only the account names.

--key-manager-name KeyManagerName

Specifies the key manager name.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

clientAssist

Allows administrators to enable or disable a node with outbound cloud access as a client-assist node. This node assists in recalls from a Cloud services client node. This is a special node performing recall operations from client nodes directly, without redirecting requests to Cloud services server node.

containerPairSet

Manages the cloud containers (data and metadata) that are associated with the cloud storage accounts, with these options:

create

Creates a container pair set.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the containers that are going to be created.

--container-pair-set-name ContainerPairSetName

Specifies a name that uniquely identifies the containers.

--cloud-service-name CloudServiceName

Specifies the cloud service that is going to be associated with the containers you are going to create.

--scope-to-filesystem | scope-to-fileset

Specifies whether the containers are going to be associated with a file system or a fileset. Default value is --scope-to-filesystem.

--path Path

Specifies the path to the file system or fileset.

--data-container DataContainer

Specifies a name for the data container. If you do not specify a value here, the --container-pair-set-name is used by default.

--meta-container MetaContainer

Specifies a name for the metadata container. If you do not specify a value here, the --container-pair-set-name is used by default.

--cloud-directory-path CloudDirectoryPath

Specifies the path where the database (cloud directory) is maintained.

Note: By default, the database is maintained inside the .mcstore folder in file system which is associated with the cloud service.

--etag-enable{ENABLE|DISABLE}

Specifies whether you want to enable an integrity check on the data that is migrated to or recalled from the cloud storage. Disabled by default.

--enc-enable{ENABLE|DISABLE}

Specifies whether you want to enable encryption on the data that is transferred to the object storage. Disabled by default.

--data-location DataLocation

Specifies the location ID of the data container. This parameter is applicable only to IBM Cloud™ Object Storage.

--meta-location MetaLocation

Specifies the location ID of the metadata container. This parameter is applicable only to IBM Cloud™ Object Storage.

--key-manager KeyManager

Specifies the key manager that needs to be chosen for encryption.

--active-key Activekey

Specifies the current active encryption key.

--thumbnail-size ThumbnailSize

Specifies the number of bytes that Transparent cloud tiering must store on the local file system for displaying thumbnail of files that are migrated to a storage tier. The value that you specify is applicable to each file in the file system that is managed by Transparent cloud tiering. Valid range is 1 - 1048576 bytes (1 MB). If you specify a value that is lower than the file system block size, then the file system block size is used. For example, if you specify a value of 128 KB and the file system block size is 256 KB, then 256 KB data of each file is stored locally and used for thumbnail.

After the thumbnail-size parameter is enabled with a filesystem, you can verify the setting by using the mmcloudgateway filesystem list command, and additionally, the thumbnails are displayed when you browse the files on Windows Explorer or a similar tool.

Note: Thumbnail is disabled by default. If you do not specify a valid value, then thumbnail is not enabled for the file system. You should judiciously make a decision to enable this option, as once enabled, you cannot disable this.

--transparent-recalls {ENABLE|DISABLE}

Specify whether or not you want to enable or disable transparent recalls for the container that you create. Enabled by default.

--destroy-event-handling {ENABLE|DISABLE}

Specify whether or not you want to enable or disable this function. It will install the policy partition to handle the destroy events when files are deleted. Enabled by default.

--policy-tmp-dir

Specify the folder where the policy file needs to be temporarily stored.

--auto-spillover {ENABLE|DISABLE}

Specify whether you want to enable or disable automatic creation of a new container, after the default limit or the specified limit in terms of number of files for an existing container is reached. Enabled by default.

--auto-spillover-threshold AutoSpilloverThreshold

Specify the number of files after which you want a new container to be automatically created. Default value is 100M (100,000,000).

test

Validates the cloud storage account and the CSAPs before you proceed with cloud operations.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the containers that are created.

--container-pair-set-name ContainerPairSetName

Specifies a name that uniquely identifies the cloud object storage account on the node.

update

Updates the information that is used for creating a container pair set.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the containers that are created.

--container-pair-set-name ContainerPairSetName

Specifies a name that uniquely identifies the cloud object storage account on the node.

--etag {ENABLE|DISABLE}

Specifies whether you want to enable an integrity check on the data that is migrated to or recalled from the cloud storage. To enable, specify "ENABLE". To disable, specify "DISABLE".

--enc {ENABLE|DISABLE}

Specifies whether you want to enable encryption on the data that is transferred to the object storage. To enable, specify "ENABLE". To disable, specify "DISABLE".

--active-key Activekey

Specifies the current active encryption key.

--transparent-recalls {ENABLE|DISABLE}

Specifies whether you want to enable or disable transparent recalls for the container pair set associated with the specified node class. To enable, specify "ENABLE". To disable, specify "DISABLE".

--destroy-event-handling {ENABLE|DISABLE}

Specifies whether you want to enable or disable the destroy event handling. To enable, specify "ENABLE". To disable, specify "DISABLE".

--policy-tmp-dir

Specify the folder where the policy file needs to be temporarily stored.

--auto-spillover {ENABLE|DISABLE}

Specify whether you want to enable or disable automatic creation of a new container, after the default limit or the specified limit in terms of number of files for an existing container is reached. Enabled by default.

--auto-spillover-threshold AutoSpilloverThreshold

Specify the number of files after which you want a new container to be automatically created. Default value is 100M (100,000,000).

delete

Deletes the container pair set associated with a specific node class.

--cloud-nodeclass CloudNodeClass

Specifies the node class that is associated with the containers that are created.

--container-pair-set-name ContainerPairSetName

Specifies a name that uniquely identifies the cloud object storage account on the node.

--policy-tmp-dir

Specify the folder where the policy file needs to be temporarily stored.

list

Lists the container pair set.

--cloud-nodeclass CloudNodeClass

Specifies the node class.

--cloud-service-name CloudServiceName

Specifies the name of the cloud service that needs to be listed.

--name-list

When this option is specified, the output will include only the account names.

--container-pair-set-name ContainerPairSetName

Specifies a name that uniquely identifies the cloud object storage account on the node.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

maintenance

Configure the Transparent cloud tiering for maintenance activities. For more information, see Configuring the maintenance windows.

create

Creates a maintenance window, overriding the default values:

--cloud-nodeclass CloudNodeClass

Specifies the node class.

--maintenance-name MaintenanceName

Specifies a name for the maintenance window. All maintenance operations are considered within a maintenance window. For example, daily_maintenance.

--daily HH:MM-HH:MM

Indicates that the maintenance window is run daily. Specify the time interval in the hh:mm-hh:mm format. For example, 03:00-03:30. If the end time equals the start time, the maintenance logic will only execute once. If the end time is less than the start time, it is assumed that the end time refers to that time on the following day. Therefore, 03:00-02:59 for instance will extend to 2:59 on the following day.

--weekly W:HH:MM-W:HH:MM

Indicates that the maintenance window is run weekly. Specify the time interval in the w:hh:mm-w:hh:mm format, where w represents the day of the week. Day of the week can be a number from 0 to 7 (both 0 and 7 are included and they represent Sunday). For example, 01:03:00-01:03:30. Maintenance window 1:03:00-1:02:59 will extend until 2:59 the following week, and similarly, 1:03:00-0:03:00 will extend for 6 days (Monday through Sunday).

update

Modifies the maintenance window, overriding the previous values:

--cloud-nodeclass CloudNodeClass

Specifies the node class.

--maintenance-name MaintenanceName

Specifies a name to the maintenance window that you delete. For example, daily_reconcile.

--daily HH:MM-HH:MM

Indicates that the maintenance window is run daily. Specify the time interval in the hh:mm-hh:mm format. For example, 03:00-03:30.

--weekly W:HH:MM-W:HH:MM

Indicates that the maintenance window is run weekly. Specify the time interval in the w:hh:mm- w:hh:mm format, where w represents the day of the week. For example, 01:03:00-01:03:30.

delete

Deletes the maintenance window that is no longer needed.

--cloud-nodeclass CloudNodeClass

Specifies the node class.

--maintenance-name MaintenanceName

Specifies a name to the maintenance window that you create. For example, window_for_reconcile.

list

Lists the frequencies for the tasks and the maintenance windows for the node class.

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the maintenance window that you want to list.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

setState

Specify this option to change the state of a maintenance window that is created for a specified container. For example, you can have multiple maintenance tasks for a container but can disable or enable them according to your requirements. If a maintenance task is disabled, this task will no more be run from the next maintenance window. If a maintenance window is disabled, maintenance operations will not be executed for this window. Once enabled, maintenance will begin executing at the start of the window.

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the maintenance window whose state needs to be changed.

--maintenance-name MaintenanceName

Specifies the name of the maintenance window.

--state {disable | enable}

Specify one of the options listed here (disable or enable).

setFrequency

Use this option to modify the default frequency of the maintenance operations such as reconcile, backup, and delete. By default, reconcile is done monthly, backup is done weekly, and deletion is done daily. Use this option to change the frequency of any of these operations. For example, you want to run the reconcile and delete operations as per the default schedule but want to change the backup frequency to monthly. In this case, you can set the frequency of the backup operation to "monthly".

--cloud-nodeclass CloudNodeClass

Specifies the node class associated with the maintenance task.

--task {reconcile | backup | delete}

Specifies the name of the maintenance task whose frequency needs to be changed.

--frequency {never|daily|weekly|monthly}

Specify one of the options listed here.

status

Lists the summary of the maintenance schedule for a specified node class.

--cloud-nodeclass CloudNodeClass

Specifies the node class for which to display the maintenance status information.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

config

Configures and tunes the Transparent cloud tiering node parameters with one of the following actions:

set

Sets the following system parameters, overriding the default values:

--cloud-nodeclass CloudNodeClass

Specifies the node class.

Attribute=value

Specifies the attribute that you want to change and the value that you want to set. For example, if you want to change the default value of the recalls-thread attribute and set it to 20, specify "recalls-threads=20." Similarly, you can set the value of other attributes also.

Note: If you want to set an attribute back to its default value, specify "DEFAULT" as the value of the attribute. For example, if you want to set the value of recalls-thread attribute back to its default value, specify, "recalls-thread=DEFAULT".

For a list of available attributes and their description, see Tuning Cloud services parameters.

list

Lists the current configurations such as IP address, port number, thread-pool size, tracing level, slice size.

--cloud-nodeclass CloudNodeClass

Specifies the node class that was created by using the mmcrnodeclass command.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

node

Enables administrators to manage registration of Cloud services within a cluster and also display the node class the nodes are part of.

list

Lists the nodes that are identified for enabled for Cloud services.

--nodeclass-sort

Use this option to display the node list sorted according to the node class.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

service

Manages the Transparent cloud tiering service with these options:

start

Starts the Transparent cloud tiering service for a node or set of nodes and make the service available for file movement.

-N

Specifies the nodes.

alltct

Indicates that the service will be stopped on all Transparent cloud tiering nodes within the cluster.

Node[,Node...]

Specifies the list of nodes where the service needs to be started.

NodeFile

Specifies a file, containing the list of nodes where the service needs to be started.

NodeClass

Specifies the node class.

stop

Stops the Transparent cloud tiering service for a node or set of nodes.

-N

Specifies the nodes.

alltct

Indicates that the service will be stopped on all Transparent cloud tiering nodes within the cluster.

Node[,Node...]

Specifies the list of nodes where the service needs to be stopped.

NodeFile

Specifies a file, containing the list of nodes where the service needs to be started.

NodeClass

Specifies the node class.

status

Displays detailed status of the Transparent cloud tiering service including running state of the daemon service, cloud account name, and its connectivity status. For more information on various statuses that are associated with the Transparent cloud tiering service, see Transparent cloud tiering status description.

-N

Specifies the nodes.

alltct

Indicates that the service will be stopped on all Transparent cloud tiering nodes within the cluster.

Node[,Node...]

Specifies the list of nodes where the status of the service needs to be checked.

NodeFile

Specifies a file, containing the list of nodes where the status of the service needs to be started.

NodeClass

Specifies the node class.

--cloud-storage-access-point-name

Specifies the CSAP. The report will include the status of all Cloud services associated with the specified CSAP.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

version

Displays the Transparent cloud tiering version number associated with each node in a node class. This also includes the type of the node (server or client).

Note: This command can run on all nodes in the cluster and will display if a node is a cloud node or not. If it is, it will show more column-based details. This makes this command different from others since normally the commands act only on cloud nodes for report generation.

-N

Use this option before specifying any node or node class.

all

Indicates that the service version will be displayed for all nodes.

alltct

Indicates that the service version will be displayed for all Transparent cloud tiering nodes within the cluster.

Node[,Node...]

Specifies the list of nodes for which the versions need to be checked.

NodeFile

Specifies a file, containing the list of nodes for which the versions need to be started.

NodeClass

Specifies the node class whose version is displayed at a cluster level.

-Y

Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.

Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.

backupConfig

Backs up the Cloud services configuration from the Clustered Configuration Repository (CCR). For more information, see Backing up the Cloud services configuration.

--backup-file BackupFile

Specifies a name to be used for the backup file. The system generates a tar file by pulling all Cloud services-specific configuration files from the Clustered Configuration Repository (CCR). The backed up file will be stored on your local machine at a specified location. The backupConfig command also accepts a location on a GPFS file system that would be available on all GPFS nodes.

restoreConfig

Restores the Cloud services configuration data in the event of any system outage or crash. For more information, see Restoring Cloud services configuration.

--backup-file BackupFile

Specifies the file name of the backed-up file including the path. The system restores the Cloud services-specific configuration setting to the CCR by using this file.

files

Manages files, with the following options:

migrate

Migrates the specified files to the cloud storage tier.

-v

Specifies the verbose message.

--co-resident-state

Indicates that the files are migrated in the co-resident status, which means that files will be available both locally and on the cloud after migration. You can open such files from the local file system without recalling them from the cloud storage tier.

--File [File...]

Specifies multiple files that need to be migrated to the cloud storage tier. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

recall

Recalls the specified files from the cloud storage tier.

-v

Specifies the verbose message.

--local-cluster

Indicates that cluster from where the recall is done.

--remote-cluster

Indicates the remote cluster.

--File [File...]

Specifies multiple files that need to be recalled from the storage tier. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

restore

Restores a file or list of files from the cloud storage tier when the local files are lost. The files to be restored along with their options can be either specified at the command line, or in a separate file provided by the -F option. For more information, see Restoring files.

-v

Specifies the verbose message.

--overwrite

Overwrite the files if needed. If this option is not set, files will not be overwritten, and the files that are retrieved from the cloud will remain in temporary locations.

--restore-stubs-only

Restores only the file stubs.

-F

Loads file arguments from the given file name.

--dry-run

Queries the local database and prints what would have been sent to the server. Does not contact the server. This is intended for debugging.

--restore-location RestoreLocation

Specifies the target location of the files to be restored.

--id Id

Specifies the version ID of a file if the file has multiple versions.

File

Specifies the files to be restored.

delete

Deletes the specified files or file sets.

--delete-local-file

Deletes the local files and the corresponding cloud objects.

--recall-cloud-file

Recalls the files from the cloud before they are deleted on the cloud. The status of local files becomes resident after the operation.

--require-local-file

Removes the extended attributes from a co-resident file and makes it resident, without deleting the corresponding cloud objects. The option requires the file data to be present on the file system and will not work on a non-resident file.

--keep-last-cloud-file

This option deletes all the versions of the file except the last one from the cloud. For example, if a file has three versions on the cloud, then versions 1 and 2 are deleted and version 3 is retained.

--File [File...]

Specifies multiple files. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

destroy

Manually cleans up the cloud objects of the deleted files before the retention period expires. This cleanup will occur for all objects from the root of the file system provided by the --filesystem-path option. For more information, see Deleting cloud objects.

--cloud-retention-period-days

Specifies the number of days for which the deleted files from the file system need to be retained on the cloud. For example, you delete 100 files from the file system and need to keep them on the cloud for 20 days, specify the value as 20.

--preview

Displays how many objects will be cleaned up and how much space will be reclaimed.

--timeout

Specifies the duration (in minutes) for which the command should run. If this value is not specified, the command will run until all the candidate files are deleted, and it can be resource-intensive.

--container-pair-set-name

Specifies the cloud container where the objects are stored.

--filesystem-path

The path to the file system where the files are migrated from. All objects under the root of the file system of the specified file system path will be cleaned.

reconcile

Reconciles files between your file system and the cloud storage tier. For more information, see Reconciling files between IBM Spectrum Scale file system and cloud storage tier.

--container-pair-set-name

Specifies the cloud container where the objects are stored.

Device

Specifies the device name associated with the file system.

cloudList

Lists the files on the cloud.

--path Path

Lists files and directories under the specified path.

--recursive

List all files in all directories under the current directory.

--depth Depth

List directories up to the specified depth under the specified path. Default is to list up to the full depth. Specify 0 to list only the current directory.

--file [File]

Specifies the names of the files that need to be listed. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

--file-versions File

Displays information about all versions of the files specified by the full path.

--files-usage --path Path

Displays cloud data and metadata space usage under the specified path.

--reconcile-status --path Path

Displays the progress of the reconcile operation.

--start YYYY-MM-DD[-HH:mm]

Specifies the starting time.

--end YYYY-MM-DD[-HH:mm]

Specifies the ending time.

backupDB

Backs up the Transparent cloud tiering database to the cloud storage tier. For more information, see Backing up the Cloud services database to the cloud.

--container-pair-set-name

Specifies the container associated with the database that needs to be backed up.

checkDB

Verifies the integrity of the Transparent cloud tiering database after a power outage or a system crash. For more information, see Checking the Cloud services database integrity.

--container-pair-set-name

Specifies the container associated with the database that needs to be verified.

rebuildDB

Manually rebuilds the database.

--container-pair-set-name

Specifies the container associated with the database that needs to be rebuilt.

Device

Specifies the device name associated with the file system whose database is corrupted and which is in need of manual recovery.

defragDB

Defragment the database and release the capacity occupied by the empty spaces.

--container-pair-set-name

Specifies the container associated with the database that needs to be rebuilt.

list

Lists the files and the associated states.

--File [File]

Specifies the names of the files that need to be listed. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

import

Imports data from a storage server.

--cloud-service-name

Specifies the cloud service.

--container Container

Specifies the name of the cloud container to import from. If no container option is specified, the default configured container name is used.

--import-only-stub

Creates only a stub file, data in the file is not imported.

--import-metadata

Attempts to restore metadata of the file from the cloud object. The data is in IBM Spectrum Scale format. The cloud object must have been exported using the --export-metadata option. If metadata is not attached to the cloud object, this option has no effect.

--directory

Imports files into the given directory using only the file name from the cloud. Mutually exclusive with the --target-name and --directory-root options.

--directory-root

Imports files starting at the given directory, keeping the cloud naming hierarchy intact. Mutually exclusive with the --directory and --target-name options.

--target-name

Imports a single file from the cloud to the specified target name. Mutually exclusive with the --directory and --directory-root options.

--File [File]

Specifies the names of the files that need to be imported. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

export

Exports files to the cloud.

--tag Tag

Specifies an optional identifier to associate with the files. This ID will be stored in the manifest file if one is specified.

--target-name TargetName

Export a single file to the cloud to the specified target name.

--container Container

Specifies the name of the cloud container to export to. If no container option is specified, the default configured container name will be used.

--manifest-file ManifestFile

Specifies a manifest file that will contain an entry for each file exported to the cloud. Entries will be in the CSV format of : Tag, Container, TimeStamp of Blob on cloud, or file name.

--export-metadata

Attempts to attach a file's metadata to the cloud object. This is IBM Spectrum Scale specific data and format, and it contains the user-defined attributes, ACLs, etc. A file exported with this option can be fully restored by the corresponding import command. This metadata is stored in the blob metadata, and as such there is limited space available, and the metadata might not be written if it is too large.

--fail-if-metadata-too-big

If the metadata of the file is very large, it causes the entire export to fail. Valid only with the --export-metadata option.

--strip-filesystem-root

Removes the root of the IBM Spectrum Scale file system from the name as stored on the cloud. This could be used to export /filesystem1/dir/file and then import that file into a differently named file system root directory.

--File [File]

Specifies the names of the files that need to be exported. This parameter must be a complete file name. It cannot be a fragment of a file name and it cannot be a path.

checkCloudObject

Displays true if the specified object or container is present on cloud, false otherwise. If you specify the cloud service, the container associated with the cloud service is used to search the object. Use the -Y option for parsable output.

deleteCloudObject

Deletes the specified object or container on cloud. If you specify the cloud service, the container associated with the cloud service is used to search the object for deletion.

Security

You must have root authority to run the mmcloudgateway command.

The node on which the command is issued must be able to execute remote shell commands on any other node in the cluster without the use of a password and without producing any extraneous messages. For more information, see Requirements for administering a GPFS file system.

See also

Location