mmafmconfig command

Can be used to manage home caching behavior and mapping of gateways, home NFS exported servers, and GPFS NSD backend or cloud object storage endpoint URLs.
This command also creates multi-target map that are used for multi-site replication. This command also creates a multi-target map that is used for multi-site replication.

Synopsis

mmafmconfig {add | update} MapName {--export-map | --multi-target-map} ExportServerMap [--no-server-resolution]

or

mmafmconfig delete {MapName | all}

or

mmafmconfig show [-Y] [MapName | all]

or

mmafmconfig {enable | disable} ExportPath

Availability

Available on all IBM Storage Scale editions. Available on AIX® and Linux®.

Description

You can use the mmafmconfig command for the following purpose:
  • Set up or update mapping for parallel data transfers by using add, update, or delete options.
  • Enable or disable extended attributes/sparse file support from the AFM cache.

On the home cluster, this command is used to enable support of extended attributes, sparse files on an AFM cache fileset pointing to this home. You must run the mmafmconfig enable command on the home export or target path. Running this command creates the .afm directory that contains the control-enabled, directio '.afmctl' file.

The mmafmconfig disable command removes the .afm directory from the home export or target path and subsequently, the cache will no longer support synchronization of sparse files and files with extended attributes.

On the cache cluster, you can use the mmafmconfig command with the add, update, delete, or show options to manage the mapping of gateway nodes with home NFS or cloud object servers for parallel data transfers.

Before you enable multi-site replication, you must use the mmafmconfig --multi-target-map command to create a multi-target map.

mmafmconfig supports IPv4 and IPv6 addresses. To create mapping by using IPv6, the addresses must be specified in the square brackets. When the hostname resolves to IPv6 address, there is no need to specify hostnames in the square brackets. To verify that the hostnames resolves to IPv6 addresses, use mmcmi host <hostname> command

You must run the mmafmconfig enable command at a home fileset path before you link the AFM fileset at the cache site.

If the AFM cache fileset was linked without running the mmafmconfig enable command at the home export path, you need to issue the following commands:
  1. Issue the following command at the home:
    # mmafmconfig enable HOME_EXPORT_PATH
  2. Issue the following commands at the cache:
    # mmafmctl FS stop -j AFM_Fileset
    # mmafmctl FS start -j AFM_Fileset

Parameters

MapName
Specifies the name that uniquely identifies the mapping of the gateway nodes with the home NFS exported servers.
--export-map ExportServerMap
Specifies a comma-separated list of pairs of home NFS exported server nodes (ExportServer) and gateway nodes (GatewayNode), in the following format: 
[ExportServer/GatewayNode][,ExportServer/GatewayNode][,...]
where:
ExportServer
Is the IP address or host name of a member node in the home cluster MapName.
GatewayNode
Specifies a gateway node in the cache cluster (the cluster where the command is issued).
--multi-target-map ExportServer
Creates a multi-target replication map, which can be used as a target for replication of objects to multiple S3 bucket with AFM to cloud object storage manual updates (MU) mode.
ExportServerMap
Is a comma separated list of endpoints without HTTP or HTTPS and gateways/nodes name pairs. An example of the endpoints and gateways/nodes name pairs format is as follows:
s3.us-east.cloud-object-storage.appdomain.cloud/Gateway1NodeName,s3.us-east-1.amazonaws.com/Gateway2NodeName
where:
s3.us-east.cloud-object-storage.appdomain.cloud
Is an IBM Cloud® Object Storage endpoint without HTTP or HTTPS.
s3.us-east-1.amazonaws.com
Is an Amazon S3 endpoint without HTTP or HTTPS.
Gateway1NodeName and Gateway2NodeName
Are gateways/nodes name pairs.
--no-server-resolution
When this option is specified, AFM skips the DNS resolution of a specified hostname and creates the mapping. The specified hostname in the mapping must not be replaced with an IP address. The hostname is collected after the DNS resolution during the creation of mapping. Ensure that the specified hostname is resolvable while the mapping is in operation.
-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.
enable
Enables extended attributes or sparse files functions on the AFM cache. Run at the home cluster only.
disable
Disables extended attributes or sparse files functions on the AFM cache. Run at the home cluster only.
ExportPath
Specifies the root of the home exported directory for enabling or disabling the AFM features.
add
Sets up maps for parallel data transfers. Run at cache only.
delete
Deletes maps for parallel data transfers. Run at cache only.
update
Updates maps for parallel data transfers. Run at cache only.
show
Displays all the existing maps. Each map displays the mapping of a gateway node and home NFS server pair that is separated by a comma ','.

Exit status

0
Successful completion.
Nonzero
A failure has occurred.

Security

You must have root authority to run the mmafmconfig command.

The node on which the command is issued must be able to run 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.

Examples

The following is an example of a mapping for NFS targets, adding all gateway nodes and NFS servers, and using this mapping for creating AFM filesets. In this example, hs22n18, hs22n19, hs22n20, and hs22n21 nodes are assumed as cache gateway nodes. The gateway nodes are mapped to two home NFS servers, js22n01 with an IP address 192.168.200.11, and js22n02 with an IP address 192.168.200.12.
  1. Create an export map.
    # mmafmconfig add mapping1 --export-map js22n01/hs22n18,js22n02/hs22n19,
js22n01/hs22n20,js22n02/hs22n21
    A sample output is as follows:
    mmafmconfig: Command successfully completed.
  2. Check the created export map.
    # mmafmconfig show
    A sample output is as follows:
    
Map name:              mapping1
Export server map:     192.168.200.11/hs22n18.gpfs.net,192.168.200.12/hs22n19.gpfs.net,92.168.200.11/hs22n20.gpfs.net,192.168.200.12/hs22n21.gpfs.net
  3. Create an export map by specifying the --no-server-resolution option.
    # mmafmconfig add map1 --export-map nfs1.net/gateway1.net,nfs2.net/gateway2.net
    A sample output is as follows:
    mmafmconfig: Command successfully completed
mmafmconfig: 6027-1371 Propagating the cluster configuration data to all
affected nodes.  This is an asynchronous process.
  4. Check the export map that is created by specifying the --no-server-resolution option.
    # mmafmconfig show all
    A sample output is as follows:
    Map name:             map1
Export server map:    nfs1.net/gateway1.net,nfs2.net/gateway2.net
  5. Create an export map without the --no-server-resolution option.
    # mmafmconfig add map2 --export-map nfs1.net/gateway1.net,nfs2.net/gateway2.net
  6. Check the export map that is created without --no-server-resolution option.
    # mmafmconfig show all
    A sample output is as follows:
    Map name:             map2
Export server map:    192.168.1.10/gateway1.net,192.168.1.11/gateway2.net
  7. Issue the following commands to create filesets by using mapping1: 
    # mmcrfileset gpfs1 sw1 –p afmmode=sw,afmtarget=nfs://mapping1/gpfs/gpfs2/swhome --inode-space new
    # mmcrfileset gpfs1 ro1 –p afmmode=ro,afmtarget=nfs://mapping1/gpfs/gpfs2/swhome --inode-space new
  8. Start of changeIssue the following command to add an export map for an AFM to cloud object storage mode fileset:
    # mmafmconfig add amazonwest2 --export-map s3.us-west-2.amazonaws.com/gateway1,s3.us-west-2.amazonaws.com/gateway2
    A sample output is as follows:
    mmafmconfig: Command successfully completed
mmafmconfig: Propagating the cluster configuration data to all
 affected nodes. This is an asynchronous process.
    End of change
  9. To enable the multi-target replication, complete the following steps:
    1. Create mapping of multiple targets by using the mmafmconfig --multi-target-map command.
    2. Add the multi-target mapping.
      # mmafmconfig add multisitemap1 --multi-target-map s3.us-east.cloud-object-storage.appdomain.cloud/Gateway1,s3.us-east-1.amazonaws.com/Gateway2
      where:
      s3.us-east.cloud-object-storage.appdomain.cloud
      Is an IBM Cloud Object Storage endpoint.
      s3.us-east-1.amazonaws.com
      Is an Amazon S3 endpoint.
      Gateway1 and Gateway2
      These gateway nodes belong to a cache cluster where an AFM to cloud object storage fileset will be created.
    3. List the multi-target mapping.
      # mmafmconfig show all
      A sample output is as follows:
      Map name: multisitemap1 
Multi target map: s3.us-east.cloud-object-storage.appdomain.cloud/Gateway1,s3.us-east-1.amazonaws.com/Gateway2
    Note: The multi-target map is supported on IBM Storage Scale Advanced Edition, IBM Storage Scale Data Management Edition, or IBM Storage Scale Erasure Code Edition.

See also

Location

/usr/lpp/mmfs/bin