Command reference (mmdas command)

Examples

• mmdas service examples:
  1. To create an IBM Storage Scale DAS S3 service instance and accept the IBM Storage Scale license with the IP address range and the scale factor specified, issue the following command:

     mmdas service create s3 --acceptLicense --ipRange "192.0.2.12-192.0.2.14" --scaleFactor 1

     A sample output is as follows:

     Create request for Spectrum Scale Data Access Service: 's3' is accepted

  2. To create an IBM Storage Scale DAS S3 service instance and accept the IBM Storage Scale license while specifying the CSI fileset for the S3 service database and the file system for the data backend for the S3 service, issue the following command:

     mmdas service create s3 --acceptLicense --ipRange "192.0.2.12-192.0.2.14" --scaleFactor 1 --dbStorageClass ibm-spectrum-scale-csi-fileset --scaleDataBackend /mnt/fs1

     A sample output is as follows:

     Create request for Spectrum Scale Data Access Service: 's3' is accepted

  3. To list the information of IBM Storage Scale DAS service instances, issue the following command:

     mmdas service list

     A sample output is as follows:

     Name   Enable  Phase 
     -----  -----   ------ 
     s3     true    Ready 

     • The Enable column shows whether the S3 service instance is enabled or disabled.
     • The deployment phase of the service instance shown in the Phase column can be one of the following values:
       • Ready: The service instance is ready to be used for S3 account creation or export creation.
       • Configuring: The service instance configuration is in progress.
       • Connecting: The service instance is trying to establish communication between the S3 endpoints and the S3 database.
       • Failed: The service instance configuration has failed.
       Attention: Once you issue the service creation command, for a brief period of time, the Phase column might be empty.
  4. To list the detailed information for the IBM Storage Scale DAS S3 service instance, issue the following command:

     mmdas service list s3

     A sample output is as follows:

     Name   AcceptLicense   DbStorageClass                  Enable  EnableMD5
     -----  -----           --------------                  ------
     s3     true            ibm-spectrum-scale-sample       true    true
     
     ScaleDataBackend       Phase   S3Endpoints
     -----                  -----   --------------
     [/mnt/remote-sample]   Ready   [https://s3-endpoints.example.com https://192.0.2.12 https://192.0.2.13 https://192.0.2.14]
     
     IpRange                EnableAutoHA    ScaleFactor
     -----                  -----           --------------
     192.0.2.12-192.0.2.14    true            1

  5. To update the scale factor for an IBM Storage Scale DAS service instance, issue the following command:

     mmdas service update s3 --scaleFactor 2

     A sample output is as follows:

     Update request for Spectrum Scale Data Access Service: 's3' is accepted

  6. To enable md5sum calculation for S3 objects at the S3 service level, issue the following command:

     mmdas service update s3 --enableMD5

     A sample output is as follows:

     Update request for Spectrum Scale Data Access Service: 's3' is accepted

  7. To disable automatic IP address failover and failback, issue the following command:

     mmdas service update s3 --disableAutoHA

     A sample output is as follows.

     Update request for Spectrum Scale Data Access Service: 's3' is accepted

  8. To delete an IBM Storage Scale DAS service instance, issue the following command:

     mmdas service delete s3

     A sample output is as follows:

     IBM Spectrum Scale DAS service s3 delete request accepted

• mmdas account examples:
  1. To create an IBM Storage Scale DAS S3 user account, issue the following command:

     mmdas account create s3user --gid 777 --uid 888 --newBucketsPath "mnt/fs1/fset1/user1_buckets"

     A sample output is as follows:

     Account is created successfully. The secret and access keys are as follows. 
     
     Secret Key					  Access Key 
     ----------			                ----------- 
     q2F4l5tt8/8mFXt8YOroVrUPx80TW6dlrVYm/zGO	47al0MTOuj98WkgHWmti 

  2. To list the account information for all IBM Storage Scale DAS user accounts, issue the following command:

     mmdas account list

     A sample output is as follows:

     Name       UID	GID	New buckets path 
     ----       ---	---	-----------------	 
     s3user1    888	777	/mnt/fs1/fset1/user1_buckets/s3user1_buckets	 
     
     s3user2    679	629	/mnt/fs1/fset1/user1_buckets/s3user2_buckets	 
     
     s3user3    478	128	/mnt/fs1/fset1/user1_buckets/s3user3_buckets	 
     
     s3user4    471	127	/mnt/fs1/fset1/user1_buckets/s3user4_buckets 
     
     s3user5    431	124	/mnt/fs1/fset1/user1_buckets/s3user5_buckets

  3. To list the account information for a specified S3 user account in the JSON format, issue the following command:

     mmdas account list s3user1 -o json

     A sample output is as follows:

     {"name":"s3user1","uid":888,"gid":777,"new_buckets_path":"/mnt/fs1/fset1/user1_buckets/s3user1_buckets",
     "access_key":"47al0MTOuj98WkgHWmti","secret_key":"q2F4l5tt8/8mFXt8YOroVrUPx80TW6dlrVYm/zGO"}

  4. To delete an IBM Storage Scale DAS S3 user account by specifying the account name, issue the following command:

     mmdas account delete s3user1

     A sample output is as follows:

     Account is successfully deleted

     Note: Before deleting the S3 user account, you must delete the associated exports.
  5. To delete an IBM Storage Scale Data Access Services (DAS) S3 user account by specifying the group ID and user ID, issue the following command:

     mmdas account delete 888:777

     A sample output is as follows:

     Account is successfully deleted

     Note: Before deleting the S3 user account, you must delete the associated exports.
  6. To update the bucket path and reset the access and secret keys for an IBM Storage Scale DAS S3 user account, issue the following command:

     mmdas account update s3user2 --newBucketsPath "mnt/fs1/fset1/sharedBuckets" --resetKeys

     A sample output is as follows:

     Account is successfully updated

• mmdas export examples:
  1. To create an IBM Storage Scale DAS S3 export, issue the following command:

     mmdas export create bucket2 --filesystemPath /mnt/fs1/fset1/bucket1

     A sample output is as follows:

     Export is successfully created

  2. To list all IBM Storage Scale DAS S3 exports, issue the following command:

     mmdas export list

     A sample output is as follows:

     Name 
     ------ 
     bucket2 
     bucket2user1 
     user1bucket1

  3. To list the information of an IBM Storage Scale DAS S3 export, issue the following command:

     mmdas export list bucket2

     A sample output is as follows:

     Name       Filesystem Path         		 
     -----      -----------------       		 
     
     bucket2   /mnt/fs1/fset1/bucket1 

  4. To delete an IBM Storage Scale DAS S3 export, issue the following command:

     mmdas export delete bucket3

     A sample output is as follows:

     Export is successfully deleted