mmafmcosaccess command

Maps a directory in an AFM to cloud object storage fileset to the bucket on a cloud object storage.

Synopsis

mmafmcosaccess Device FilesetName Path set
               [--bucket bucket --endpoint endpoint --prefix prefix 
                {--akey AccessKey --skey SecretKey | --keyfile filePath}]

mmafmcosaccess Device FilesetName Path get

mmafmcosaccess Device FilesetName Path delete

mmafmcosaccess Device FilesetName Path get --report

Availability

Available on all IBM Storage Scale editions.

Description

This command is used to map individual directories to a bucket on the cloud object storage.

Parameters

Device: Specifies a device name of a file system to contain a new fileset.

FilesetName: Specifies a name of the AFM to cloud object storage enabled fileset that has an existing relationship.
Path: Specifies a path of a directory under an AFM to cloud object storage fileset that needs to be mapped to a cloud object storage.
set: Stores the credentials and maps a directory and a bucket.

get: Retrieves the stored credentials that were set for a directory. AFM shows an error if the bucket and server name combination does not exist.
delete: Deletes the mapping of a directory and a bucket.

--akey AccessKey: Specifies an access key that is used for communication with a cloud object storage.

--skey SecretKey: Specifies a secret key that is used for communication with a cloud object storage.

--bucket: Specifies a unique bucket on a cloud object storage. AFM will use this bucket as a target for a directory and it will synchronize the data between the bucket and the directory by using the stored credentials.

--endpoint: Specifies an endpoint that is the address of a cloud object storage server on which it receives requests from the clients. An endpoint can be either HTTP or HTTPS. It can either be a DNS qualified hostname or an IP address. An endpoint also contains a port number on which a cloud object storage server is running.
The endpoint is not a required parameter. The endpoint is required if the bucket is at another location otherwise, the mapped directory inherits the connection information from the relationship that is used by the parent fileset. You cannot use an export map as an endpoint target for the mmafmcosaccess command.

--prefix: Specifies a prefix for an object on a specified directory on an AFM to cloud object storage fileset.

--keyfile

Specifies a key file that contains an access key and a secret key. Instead of providing the access key and the secret key on the command line, a key file can be used. The key file must contain two lines for akey and skey separated by a colon. An example of the format of a key file /root/keyfile1 is as follows:

akey:AccessKey
skey:SecretKey

--report: This option must be used with the get option. It generates a report of a specified directory that is mapped to a cloud object storage.

Exit status

0: Successful completion.
nonzero: A failure occurred.

Security

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

Examples

To map a directory inside an AFM to cloud object storage fileset, issue the following command:

# mmafmcosaccess fs1 SW1 /gpfs/fs1/SW1/dir1 set --bucket vault1 --endpoint http://IP:port --keyfile /root/keyfile1

To retrieve a directory that is mapped inside an AFM to cloud object storage fileset, issue the following command:
```
# mmafmcosaccess fs1 SW1 /gpfs/fs1/SW1/dir1 get
```
To delete a directory that is mapped inside an AFM to cloud object storage fileset, issue the following command:
```
# mmafmcosaccess fs1 SW1 /gpfs/fs1/SW1/dir1 delete
```
To generate a report of a mapped directory, issue the following command:
```
# mmafmcosaccess fs1 SW1 /gpfs/fs1/SW1/dir1 get --report
```
To map a directory inside an AFM to cloud object storage fileset to the prefix at the COS bucket , issue the following command:
```
# mmafmcosaccess fs1 SW1 /gpfs/fs1/SW1/dir1 set --bucket vault1 --endpoint http://IP:port --prefix data1 --keyfile /root/keyfile1
```
The preceding command synchronizes all the data under the /gpfs/fs1/SW1/dir1 to the cloud object storage bucket vault1/data1.

Location

/usr/lpp/mmfs/bin