Parameters for the db2mtool command

The db2mtool command has many parameters.

The following parameters are required for most db2mtool actions:

setupSrcAddress: IP address or hostname for the setup source node
setupSrcUser: IBM® i user profile name for the setup source node
setupSrcSysName: the system name of the setup source node
setupCpySysName: the system name of the setup copy node

All cloning action commands typically require setup tools to read the JSON configuration files from the setup source node. The parameters that are listed above allow setup tools to connect to the setup source node and read those files. Specifying the optional parameters setupSrcUUID and setupCpyUUID is highly recommended but not required. If the system names of the setup source and copy nodes are not unique in your network, then it is recommended to specify the UUIDs to uniquely identify each node.

For some actions, such as poweron, setup tools cannot be able to retrieve the JSON configuration files from the setup source node because the node is powered down. In this case, the config parameter can be used to pass the path and file name of a JSON configuration file instead. The JSON is read by setup tools from this file instead of retrieving it from the setup source node.

Table 1. db2mtool parameters
Parameter	Description
action	Action	Type of action
	action=checksysbas	cloning action
	action=cleanup	cloning action
	action=cluster	cluster action
	action=flashcopy	cloning action
	action=geoiaspcopy	cloning action
	action=help	command help
	action=iaspcopy	cloning action
	action=installCertificate	cloning action
	action=listCertificate	cloning action
	action=new	configuration file action
	action=postiaspcopy	cloning action
	action=poweroff	cloning action
	action=poweron	cloning action
	action=precheck	cloning action
	action=preiaspcopy	cloning action
	action=reclonereplicatedobjects	cloning action
	action=remotecopy	cloning action
	action=restore	configuration file action
	action=retrieveuuid	configuration file action
	action=reversecloneinfo	configuration file action
	action=save	configuration file action
	action=start	cloning action
	action=startengine	cloning action
	action=startiaspwarmclone	cloning action
	action=startsaverestoreclone	cloning action
	action=startwarmclone	cloning action
	action=update	configuration file action
	action=verifymasterkey	cloning action
config	Specifies the path and file name of a JSON configuration file on the current node. This file is used to perform the requested action instead of using the JSON configuration information stored in the QMRDBJSON file in QUSRSYS on the setup source node. This parameter is ignored if both setupSrcSysName and setupCpySysName parameters are specified.
csmUser	Optional parameter used to specify the user ID for Copy Services Manager (CSM). To be prompted for the CSM user's password, also specify parameter promptPasswords=csm.
dbIaspAutoVaryOff	Optional parameter used to indicate whether the DB IASPs are automatically varied off at the beginning of the cloning process. This parameter is ignored for warm clone.
dbIaspAutoVaryOn	Optional parameter used to indicate whether the DB IASPs are automatically varied on at the end of the cloning process.
dbIaspName	Optional parameter used to specify the names of the primary DB IASPs to clone. Multiple IASPs can be listed separated by a comma without any spaces. The specified IASPs and all its secondary IASPs must already be added to the JSON configuration file. If this parameter is omitted, then all DB IASPs defined in the JSON file are cloned.
jsonDB	The DB information where the JSON configuration file is stored.
jsonFile	The JSON configuration file path and file name.
jsonType	Specify the JSON file type. The following are valid values: `clone_info` and `meta_data`
lclIBMiUser	Optional parameter used to specify the setup source node's IBM i user profile. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for this user's password, also specify parameter promptPasswords=lclibmi.
lclPowerHMCUser	Optional parameter used to specify the setup source node's HMC user profile name. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for this user's password, also specify parameter promptPasswords=lclhmc.
lclStgFile	Optional parameter used to specify the setup source node's storage server SSH key file. Used for IBM Storage Virtualize storage only. If specified, this value overrides the value that is stored in clone_info.json. To specify the user ID associated with this SSH key file, also specify parameter lclStgUser.
lclStgUser	Optional parameter used to specify the setup source node's storage server user ID. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for a DS8000® storage user's password, also specify parameter promptPasswords=lclstg. To provide an IBM Storage Virtualize storage user's SSH key file, also specify parameter lclStgFile.
logFile	Optional parameter for specifying the path and file name to use for the log file. If this parameter is not specified, then the default path /QIBM/UserData/QDB2MIR/MRDB/TOOLS/toolkit.setup.log is used.
lpar	Parameter used for actions poweroff and poweron to indicate which partition you want to power on or off. The following are the valid values: `source`, `copy`, `both`, `uuid`.
operation	Optional parameter used to indicate the type of shutdown to perform. If specified, this value overrides the value that is stored in clone_info.json. The following are the valid values: `osshutdown_immed` Immediate IBM i shutdown `osshutdown_cntrld` Controlled IBM i shutdown `shutdown` HMC shutdown
partitionName	Parameter used for action=retrieveuuid to specify the partition name.
powerHMCHost	Parameter used for action=retrieveuuid to specify the HMC hostname or IP address.
powerHMCUser	Parameter used for action=retrieveuuid to specify the HMC username.
poweroffCopy	Optional parameter used for action=cleanup to specify whether to power off the setup copy node if it is active. Valid values are `yes` and `no`. The default value is `yes`.
promptPasswords	Optional parameter used to enable prompting for certain credentials. To enable prompting for multiple credentials, separate the values with a comma without any spaces. A credential that is provided by using prompts overrides the value that is stored in clone_info.json. The following are the valid values: `csm` Used to prompt for the password for CSM. To provide the CSM user ID, also specify parameter csmUser. `ibmiks` Used to prompt for the Digital Certificate Manager (DCM) *SYSTEM keystore password. `keystore` Used to prompt for the Java™ keystore file password. `lclhmc` Used to prompt for the password for the setup source node's HMC. To provide the setup source node's HMC user profile name, also specify parameter lclPowerHMCUser. `lclibmi` Used to prompt for the password for the setup source node's IBM i user profile. To provide the setup source node's IBM i user profile name, also specify parameter lclIBMiUser. `lclstg` Used to prompt for the password for the setup source node's DS8000 storage server user ID. To provide the setup source node's DS8000 storage server user ID, also specify parameter lclStgUser. `presharedkey` Used to prompt for a list of pre-shared keys for encrypted RDMA IKE policies. `quorum` Used to prompt for the password for the quorum node's user ID. To provide the quorum node's user profile, also specify parameter quorumUser. `rmthmc` Used to prompt for the password for the setup copy node's HMC. To provide the setup copy node's HMC user profile name, also specify parameter rmtPowerHMCUser. `rmtibmi` Used to prompt for the password for the setup copy node's IBM i user profile. To provide the setup copy node's IBM i user profile name, also specify parameter rmtIBMiUser. `rmtstg` Used to prompt for the password for the setup copy node's DS8000 storage server user ID. To provide the setup copy node's DS8000 storage server user ID, also specify parameter rmtStgUser.
quorumAddress	Optional parameter for action=installCertifcate to specify the hostname or IP address of the quorum node. Used to install certificates for cluster monitors.
quorumUser	Optional parameter for action=installCertifcate to specify the quorum node's IBM i user profile. Used to install certificates for cluster monitors. To be prompted for the quorum node user profile's password, also specify parameter promptPasswords=quorum.
rmtIBMiUser	Optional parameter used to specify the setup copy node's IBM i user profile. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for this user's password, also specify parameter promptPasswords=rmtibmi.
rmtPowerHMCUser	Optional parameter used to specify the setup copy node's HMC user profile name. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for this user's password, also specify parameter promptPasswords=rmthmc.
rmtStgFile	Optional parameter used to specify the setup copy node's storage server SSH key file. Used for IBM Storage Virtualize storage only. If specified, this value overrides the value that is stored in clone_info.json. To specify the user ID associated with this SSH key file, also specify parameter rmtStgUser.
rmtStgUser	Optional parameter used to specify the setup copy node's storage server user ID. If specified, this value overrides the value that is stored in clone_info.json. To be prompted for a DS8000 storage user's password, also specify parameter promptPasswords=rmtstg. To provide an IBM Storage Virtualize storage user's SSH key file, also specify parameter rmtStgFile.
section	Optional parameter for action=update to indicate which section of the JSON configuration file to be updated. If not specified, the default is to update all sections. If jsonType=clone_info, valid values are: `ibmi`, `storage`, `csm`, `hmc`, and `iasp`. If jsonType=meta_data, valid values are: `systemname`, `hostname`, `hosttable`, `network`, `nrgdb2`, `nrgifs`, `nrgres`, `nrgorm`, and `nrgmgr`.
setupCpySysName	Parameter used to specify the system name of the setup copy node. If setupSrcSysName and setupCpySysName are both specified, the parameter config is ignored.
setupCpyUUID	Optional parameter used to specify the partition UUID of setup copy node.
setupSrcAddress	Parameter used to specify the hostname or IP address of the setup source node.
setupSrcSysName	Parameter used to specify the system name of the setup source node. If setupSrcSysName and setupCpySysName are both specified, the parameter config is ignored.
setupSrcUser	Parameter used to specify an IBM i user profile on the setup source node.
setupSrcUUID	Optional parameter used to specify the partition UUID of setup source node.
svcCleanRate	Optional parameter used to indicate the FlashCopy® clean rate. Valid for IBM Storage Virtualize storage only.
svcCopyRate	Optional parameter used to indicate the FlashCopy copy rate. Valid for IBM Storage Virtualize storage only.
systemName	Parameter used for action=retrieveuuid to specify the Power® system name.
timeout	Optional parameter used to specify the power on and power off timeout interval in seconds. Default value is 10800 seconds (3 hours).