rmserver.properties file

Edit online

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.

You can also access and manually edit the rmserver.properties file from within the Copy Services Manager GUI under Settings > Server Properties.

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.
csm.server.suspend_all_shared_gm_sessions
A flag that indicates whether to keep all shared Global Mirror sessions in a suspended state and not restart the sessions automatically, when the Suspend command is issued. 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 or failed over, 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" to 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 "MySess" 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 that run 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 guide.
  • This property is only valid for storage systems that run 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 that are 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.

com.ibm.csm.zconsole.logging=none (default) | all | error
Specifies the standard out logging level to the syslog, where the possible values are none, all, or error.
  • When none is specified, Copy Services Manager does not log to the syslog at all (default).
  • When all is specified, Copy Services Manager logs all I, W, and E messages to the syslog.
  • When error is specified, Copy Services Manager logs all W and E messages to the syslog.
Example: To log all messages 
com.ibm.csm.zconsole.logging=all
com.ibm.csm.zconsole.logging.includechildren=true | false (default)
Specifies whether to log child messages to the syslog or not. By default, only high-level messages are logged. Child messages are not logged. Use this property setting to override this behavior and enable child messages to be logged.
Notes:
  • Be aware that setting the logging to all messages, including the child messages, can result in a large number of messages. Only set the includechildren property to true when it is important to see the child messages.
  • When you set the includechildren property to true, all child messages are printed to the syslog, including any in the excludedmsgs list, as discussed next.
Example: To log all child messages
com.ibm.csm.zconsole.logging.includechildren=true
com.ibm.csm.zconsole.logging.excludedmsgs=<messages to exclude in comma-separated list>
Specifies which messages to exclude from writing to the syslog, where the values are a comma-separated list of message IDs. Any ID in the list does not appear in the syslog.
Note: The excludedmsgs property is only for parent messages.
Example: To exclude the IWNR1028I and IWNR6000I messages from being logged:
com.ibm.csm.zconsole.logging.excludedmsgs=IWNR1028I,IWNR6000I
csm.disable.mm.mode.sessionname=true | false (default)
Specifies whether to disable Metro Mirror mode, where session_name is the name of the session on which you want to disable it or not. This property affects Metro Mirror Failover/Failback sessions only.
  • Replace any spaces in session_name with an underscore symbol ("_").
  • This property is case-sensitive.
Note: If you do not see the option take effect right away in the GUI, you can either restart the Copy Services Manager server, or issue a command, such as Stop, to have the GUI refresh the available commands list.
Example: To disable Metro Mirror mode in session "My MM:"
csm.disable.mm.mode.My_MM=true
csm.percent.complete.warning.threshold=<percent from 0-100> | 0 (default)
Specifies the percent of completion of a Global Copy session before a warning is issued. This property affects Metro Mirror Failover/Failback sessions only, and after a StartGC H1->H2 or StartGC H2->H1 command. The percentage (<percent from 0-100>) option must be an integer in the range 0 - 100.
  • If the current progress on the session is less than or equal to the value specified in the property, then a warning status message appears on the session, and the session stays in a Preparing or Warning state.
  • If the progress is greater than the value specified in the property, then no status message (IWNR2768W) displays, and the session shows Preparing or Normal status.
  • The status message that appears:
    IWNR2768W
    [May 21, 2020 3:43:49 PM] Session MM and role pair H1-H2 is at or below the warning threshold of x percent complete.
Example: A session is started with the StartGC H1->H2 command. The percent complete specified is 80. While the progress for the session shows anything in the range 0 - 80, the session shows Preparing or Warning with a status message. When the progress is 80% or greater, the status message goes away, and the session goes into Preparing or Normal state.
csm.percent.complete.warning.threshold=80
csm.server.audit.login=false | true (default)
Specifies whether to log successful and failed user login messages to the console or not. Use this property setting to disable logging successful and failed user login messages to the console.
Example: To disable logging IWNR4005I. 
csm.server.audit.login=false
csm.server.startmm_in_gcmode=false | true (default)
Specifies whether to automatically start all Metro Mirror pairs in Global Copy mode or not. By default, the Copy Services Manager starts all Metro Mirror pairs in Global Copy mode and converts to Metro Mirror when the role pair reaches a certain percentage of completion. Use this property setting to disable automatically starting all Metro Mirror pairs in Global Copy mode.
Example: To disable automatically starting all Metro Mirror pairs in Global Copy mode.
csm.server.startmm_in_gcmode=false
csm.server.startmm_in_gcmode_percent=<percent from 0-100> | 99 (default)
Specifies the percent of completion of the role pair before Copy Services Manager automatically converts the relationships from Global Copy to Metro Mirror mode. The percentage (<percent from 0-100>) option must be an integer in the range 0 - 100.
Example: The percent complete specified is 97. When the role pair completion progress reaches 97%, Copy Services Manager automatically converts the relationships from Global Copy to Metro Mirror mode.
csm.server.startmm_in_gcmode_percent=97
csm.server.validate_sources_for_primary_migration.sessionname=false
This property disables the auto session generation and allows you to setup HyperSwap for migration to new storage system.
csm.server.validate_sources_for_primary_migration.sessionname=false

The sessionname is the name of the migration session.

csm.server.standby.updatefiles=false | true (default)
Specifies whether to transfer files and user management to the standby management server or not. Use this property to disable the transfer of files and user management to the standby management server.
Example: To disable transfer of files and user management to the standby management server.
csm.server.standby.updatefiles=false
csm.server.ha.fileupdate.interval= 300000 (default)
Specifies the time interval, in milliseconds, at which files on the active server are checked for updates and synced to the standby server. Use this property to increase or decrease the time interval.
Example: To change the time interval to 10 minutes.
csm.server.ha.fileupdate.interval=600000