rmserver.properties file

The rmserver.properties file contains various configuration settings for Copy Services Manager server.

The default location of the rmserver.properties file is the install dir\liberty\wlp\usr\servers\csmServer\properties directory on distributed systems, and the path_prefix/opt/IBM/CSM/wlp/usr/servers/csmServer/properties directory on z/OS®.
Note: You can use the chsystem command with the -f server parameter to change the properties. For more information, see chsystem.

Restart Copy Services Manager to activate the property changes. Properties are not synchronized between the Copy Services Manager management servers and must be maintained on each Copy Services Manager management server.

The file contains the following parameters that you might need to customize for your environment:
log.file
The name of the Copy Services Manager server log file. The default value is csmTrace.log.

The newest log file is the name the same as this value. Subsequent log files have a number that is appended to the file name. For example, csmTrace1.log and csmTrace2.log.

This log file is in the install dir\liberty\wlp\usr\servers\csmServer\logs\CSM directory on distributed systems, and the path_prefix/opt/IBM/CSM/wlp/usr/servers/csmServer/logs/CSM directory on z/OS.

log.file.maxFiles
The maximum number of Copy Services Manager server log files that are created before old log files are overwritten. The default value is 50.
log.file.maxFileSize
The maximum size, in KB, of each Copy Services Manager server log file. The default value is 10240.
communications.port
The client port that is used by the GUI and CLI to communicate with the Copy Services Manager server. The default value is 9560.
Tip: This value must match the port property in the install dir\CLI\repcli.properties file and the install dir\libery\wlp\usr\servers\csmServer\properties\csm.Connection.properties file on distributed systems; and it must match the port property in the path_prefix/opt/IBM/CSM/CLI/repcli.properties file and the path_prefix/opt/IBM/CSM/wlp/usr/servers/csmServer/properties/csmConnection.properties file on z/OS.
communications.haPort
The standby management server port that is used for communication between the active and standby management server. The default value is 9561.
csm.server.snmp_community_string
The SNMP community name. The default value is public.
csm.server.sus_gc_pairs_on_gm_pause
A flag that indicates whether to suspend the Global Copy pairs when a Global Mirror session is suspended. The valid values are true and false.
db.backup.location
The directory that is used by the mkbackup command to store a backup copy of the IBM® Copy Services Manager database. By default, the backup file is stored in the install dir\liberty\wlp\usr\servers\csmServer\database\csmdb directory for distributed systems, or in the path_prefix/opt/IBM/CSM/wlp/usr/servers/csmServer/database/csmdb directory for z/OS.
server.logpackages.maxpackages
The maximum number of log packages that is maintained by the server.
server.backup.maxbackups
The maximum number of backups that is maintained by the server.
csm.server.notification.sender.address: <email address>
Specifies the email address from which to send outgoing email alerts. By default, outgoing email alerts are set to come from the generated email address csmServer@<server hostname>. However, for some SMTP server software or configurations, this email address is not accepted. Therefore, you can change the outgoing server email address to something that meets the requirements of your environment.
csm.server.ldap.enabled
Enables LDAP in your environment when set to true.
Note: The default value for csm.server.ldap.enabled is set to false for z/OS systems and true for distributed systems.
com.ibm.csm.<sessionName>.<rolepair>.userpfc
Specifies which of the Metro Mirror relationships for the Preserve Mirror feature to use. When the Metro Mirror pairs are established, any pairs that are marked with this property are set up so that when the source is flashed the Preserve Mirror feature knows to use these pairs. For example, setting the property to com.ibm.csm.MySess.H1-H2.userpfc indicates that session "MySess" and the role pair "H1-H2" should be used for Preserve Mirror.
Notes:
  • This property default is set to false. It must be set to true to enable the option on the role pair.
  • Use underscores to indicate any spaces in the property setting. For example, for the session "My Sess" you would specify My_Sess in the property.
For more information about using Preserve Mirror, see the Preserve Mirror option.
com.server.svc.fc.cleanrate =<cleanrate>
com.server.svc.fc.cleanrate.<sessionName>=<cleanrate>
A cleaning rate can be specified for a FlashCopy session (or a session that contains a FlashCopy sequence) that is independent of the background copy rate. The clean rate controls the rate at which the cleaning process operates. The cleaning process copies data from the target volume of a mapping to the target volumes of other mappings that depend on this data.
Notes:
  • For older storage systems running IBM Spectrum Virtualize, the <cleanrate> range is 0-100. For new storage systems at release 7.8.1 and higher, the range is 0-150. If this property is not specified, the default rate is 50. For more information on the clean rate, see your storage system user's guide.
  • This property is only valid for storage systems running IBM Spectrum Virtualize. If a <sessionName> is not specified, the cleaning rate value is applied to all FlashCopy sessions, and sessions that contain a FlashCopy sequence, for storage systems running IBM Spectrum Virtualize.
csm.auto.restart.after.swap=<true>
After a swap occurs, this option automatically restarts replication from the site that was swapped to, to the alternative site without user intervention.

When HyperSwap is enabled on multi-target sessions with Metro Mirror relationships, by default a HyperSwap command or event results in all I/O being swapped to the Metro Mirror secondary. And then the Copy Services Manager session moves to a Target Available state.

After the swap, no replication occurs, and a manual Start command must be issued for replication to run again.

If HyperSwap is enabled on the role pair that is automatically started, as soon as all pairs in the role pair reach a Prepared state, the HyperSwap configuration is automatically loaded as well. This option helps to ensure that replication is started quickly after a HyperSwap command or event to provide continual disaster recovery and high availability needs.

When this option is set, synchronization starts automatically, which causes the alternative site to be inconsistent until all pairs in the role pair reach a Prepared state.