Configuring Control-M in the aft_configurable.properties File
This procedure describes how to configure Control-M in the aft_configurable.properties file.
Begin
-
Navigate to one of the following directories:
- Linux: ~/ctm/cm/AFT/data
- Windows: Control-M Agent\Default\CM\AFT\data
-
Open the aft_configurable.properties file.
-
Edit the parameters as required, as described in aft_configurable.properties File Parameters.
aft_configurable.properties File Parameters
The following table describes some of the aft_configurable.properties file parameters:
You can access the aft_configurable.properties file in ~/ctm/cm/AFT/data (Linux) or Control-M Agent\Default\CM\AFT\data (Windows).
Parameter |
Description |
---|---|
com.bmc.aft.configurable.ftp.disableUnixPass |
(Linux only) Enables a password for a specified user for the local host in the Connection Profile. Values:
Default: false After setting the parameter, you can use any dummy password for local accounts and bypass password maintenance for local accounts for Linux machines. The Agent must run in Root mode. |
com.bmc.aft.configurable.ftp.failOnDestCloseDataChannel |
The job fails when Control-M for AFT or Control-M MFT fails to close the data channel after the transfer completes. Values:
Default: false |
com.bmc.aft.configurable.disableFileSystemRequests |
Enables you to set authorizations to perform actions such as mkdir, rename, and delete from the AFT remote browser dialog. Values:
Default: false |
com.bmc.aft.configurable.disablePrePostCommandOutput |
(Control-M MFT only) Enables you to avoid printing pre/post commands in the job output. Values:
Default: false |
com.bmc.aft.configurable.ffdc.enable |
(Control-M MFT only) Enables FFDC (First Failure Data Capture) mechanism for AFT. Values:
Default: true |
com.bmc.aft.configurable.ccm.static.check.interval |
(Control-M MFT only) Sets the interval time when the file watcher checks if the file is static. This parameter is also used when the Transfer all matching files checkbox is checked in the Control-M client. Values: 1-999 Default: 2 (seconds) |
com.bmc.aft.configurable.ccm.Proxy.Type |
Determines the protocol of the proxy when the proxy is used in Configuration Management. Valid Values:
Default: HTTP |
com.bmc.aft.configurable.maxConcurrentJobs |
Determines the maximum number of concurrent running jobs. Default: 300 If you want to raise the default value, be aware that it might consume more resources and module performance. |
com.bmc.aft.configurable.ccm.pgp.handle.extension |
Determines whether to automatically add or remove extensions to a file that is encrypted/decrypted using PGP template. The extension is added when files are copied to a directory. If a specific target file name is specified, the destination file name does not change. Default: false |
com.bmc.aft.configurable.ccm.pgp.file.extension |
Determines which extension is added or removed to or from files that are encrypted/decrypted when com.bmc.aft.configurable.ccm.pgp.handle.extension is set to true. Default: .pgp |
com.bmc.cm.aft.client.filecopy.mineventlimit |
Determines the minimum number of milliseconds for File Transfer updates sent to Control-M/EM. Default: 2000 By default, an event is sent on every progress value change, but not more than one In Progress event is sent per file every 2 seconds. |
com.bmc.cm.aft.client.filecopy.maxeventlimit |
Determines the maximum number of milliseconds for File Transfer updates sent to Control-M/EM. Default: 20000 By default, an event is sent on every progress value change, but since large files progress may take time to change, an event is sent every 20 seconds even if progress wasn’t changed. For example, from 42% to 43%. |
com.bmc.aft.configurable.ftp.bufferSize |
Determines the buffer size for every chunk sent during a file transfer. Default: 32768 |
com.bmc.aft.configurable.createEventOnFileWatcherFailedWhenTransferExist |
Determines whether a failed file transfer record must be added to the MFT Search view and dashboard in case of File Watcher failure. For example, if a file was not found. Default: false |
com.bmc.aft.configurable.printTransferDefinitions |
Determines whether to print transfer definition details to the job output. This can be valuable if you use variablesA name and value pair that you can reference in your job processing definition, which Control-M resolves for the current execution of the job in job definitionsThe set of parameters that defines what the job does, when it must run, its prerequisites to run, and post-processing actions for Control-M to perform after its completion (also called a job processing definition) and want to see the resolved values (watch pattern includes an Auto-Edit variable). Default: false |
com.bmc.aft.configurable.renameDestOnPrefix |
Renames the <prefix><filename> to the target file name in a rename post action. If false, the prefix is removed and then <file> is renamed to the target file name. Default: true |
com.bmc.aft.configurable.actions.overwriteIfExists |
Determines whether to overwrite an existing target name in a rename post action. When set to false, the rename operation fails with a message that the file already exists. Default: true |
com.bmc.aft.configurable.actions.moveToDirectoryIfExists |
Determines whether to move a file under the target directory (even if trailing slash wasn’t specified), When set to false, it treats the target name as a file (when trailing slash is not specified). Default: false |
com.bmc.aft.configurable.file.filterRegex |
Determines whether to support filtering by regular expression. When set to true, the source file name is treated as a regular expression.
Default: false |
com.bmc.aft.configurable.performRenameActionWhenOptFieldIsMissingAndNewNameFieldExist |
Determines whether to perform a rename on source or destination file even when the option is Left as is. but there is a new file name specified in the job definition. These jobs can be created by users using an old Control-M/EM Desktop version (7.0.00 or before). Default: false |
com.bmc.aft.configurable.sftp.prependPrecedingSlashToPathWhenMissing |
Determines where to prepend preceding slash to source or destination path when it is missing (SFTP Connection Profiles only). Default: false |
com.bmc.aft.configurable.linux.impersonation.enabled |
Determines whether to do full impersonation on Linux when the Control-M/Agent is running as root. When value is false (default), the container, which runs as root, still checks file permissions for every transfer and sets the owner according to the Connection Profile user. The transfer itself is done as root. Default: false |
com.bmc.aft.configurable.performPreCommandAfterFileWatcherActionSucceeded |
Determines whether to execute the pre-command when defining File Watcher job with Pre-Command, after the file watcher operation (if watch operation succeeded). Default: false |
com.bmc.aft.configurable.ftp.os2200.retrieveFromSourceDir |
Determine whether to change the working directory to the source directory before opening the file to read from (on OS2200). Default: true |
com.bmc.aft.configurable.ignoreFilesControlCharacter |
Determines whether to ignore files containing a control character in the name. Default: false |
com.bmc.aft.configurable.security.ftp.checkAlgorithmConstraints |
Determines whether to ignore checking algorithm constraints. When set to true, Control-M MFT doesn't fail connections for deprecated signature algorithm used for certificates. (MD2 algorithm, or a server that uses key size with length lower than 1024). Default: false |
com.bmc.aft.configurable.publish.doNotStoreEvents |
Determines whether to store File Transfer updates in Control-M MFT database (Updates don't appear in Dashboard or Search view). If set to true, new file transfer records do not appear in the MFT Dashboard and search results. Default: false |
com.bmc.aft.configurable.publish.doNotPublishEvents |
Determines whether to publish File Transfer updates to Control-M/EM (Updates don't appear in Dashboard or Search view). If set to true, new file transfer records do not appear in the MFT Dashboard and search results. Default: false |
com.bmc.aft.configurable.sftp.allow.authentication.failure.on.host.authorization |
Determines whether to ignore failing authentications while authorizing an SSH host, and proceed with storing the host key in the known_hosts file. Default: false |
com.bmc.aft.configurable.sftp.NewLine.CRLF.Servers= |
Defines this server to hold files with <CR><LF> at the end of line. |
com.bmc.aft.configurable.sftp.NewLine.LF.Servers= |
Defines this server to hold files with <LF> at the end of line. |
com.bmc.aft.configurable.local.transfer.files.in.use |
Determines whether the file is in use before a transfer. Files that are in use are skipped. Default: false |
com.bmc.aft.configurable.verify.file.size.has.not.changed.before.transfer |
Determines whether to verify if the file size has changed since the file(s) were marked for transfer. Default: false |
com.bmc.aft.configurable.file.stream.operations.number.of.retries |
Determines the number of retries to perform when file streams fails to open or close. Default: 0 |
com.bmc.aft.configurable.file.stream.operations.time.between.retries.in.seconds |
Determines the number of seconds to wait before each retry. Default: 0 |
com.bmc.aft.configurable.destNameUseSymbolicLinkName |
Determines whether the destination file uses the symbolic link name. Default: true |
com.bmc.aft.configurable.ftp.remoteVerificationControlVsDataEnabled |
Determines whether to enable server verification of an FTP server that is defined with a virtual IP. Default: true |
com.bmc.aft.configurable.failJobOnPrePostExecCmdFailure |
Determines whether to fail the File Transfer job if either the pre or post execution command fails. Default: false |
com.bmc.aft.configurable.forceRestartOnDisconnectionDuringDownload |
Determines whether to restart the transfer from the beginning when there is a disconnection during the transfer. Default: false |
com.bmc.aft.configurable.fileWatcherFailIfSourceDirectoryMissing |
Determine the ID of the return code when the directory that you are watching does not exist. Default: true (Return code = 1 instead of 7) |
com.bmc.aft.configurable.transferFailedIfDestinationDirectoryMissing |
Determines whether to fail the job if the destination directory doesn't exist. Default: true |
com.bmc.cm.aft.client.filecopy.outputPrintPercentageChange |
Prints a file transfer progress update to the job output when every X percent of the file is transferred. Default: 10 |
com.bmc.cm.aft.client.filecopy.eventGenerationPercentageChange |
Generates a file transfer progress event to the MFT dashboard when every X percent of the file is transferred. Default: 10 |
com.bmc.aft.configurable.localBufferSize |
Determines the default buffer size, in bytes, used for local->local file transfers. The size can be overwritten also in the connection profile level. The minimum size between both source & destination connection profiles is being used. Default: 1048576 |
com.bmc.aft.configurable.ftp.setFileTypeToBinaryBeforeListFilesInMVSFTPForEbcidicFileType |
Determines whether to perform directory listing in binary when the transfer is defined in EBCDIC. Default: false |
com.bmc.aft.configurable.sftp.Kex |
Determines the list of key exchange algorithms to be used by MFT as SFTP client. This can be overwritten in a specific connection profile |
com.bmc.aft.configurable.sftp.Mac |
Determines the List of Message Authentication Codes (MACs) to be used by MFT as SFTP client. This can be overwritten in a specific connection profile |
com.bmc.aft.configurable.sftp.Signatures |
Determines the list of key Signature algorithms to be used by MFT as SFTP client. This can be overwritten in a specific connection profile |
com.bmc.aft.configurable.s3.handle.content.type |
Determines whether the header content type is updated when uploading a file to S3. For adding customized mapping (instead of auto-detection), s3_content_type_policy.properties file should be updated Default: false |
com.bmc.aft.configurable.ftp.remoteVerificationControlVsDataEnabled |
Determines whether to verify if the FTP server address in the data channel is similar to the one used in the control channel. Default: true |
com.bmc.aft.configurable.run.os.command.timeout |
Determines the timeout, in seconds, for an OS command running by an MFT client to finish. Default: 600 |
com.bmc.cm.events.publisher.interval |
Determines the time, in milliseconds, to wait before each publishing of an MFT file transfer event. Default: 5000 |
com.bmc.cm.events.publisher.maxEventsNum |
Determines the maximum number of MFT file transfer events to be sent in a single chunk. Default: 1000 |
com.bmc.aft.configurable.events.sendInQueuePolicy |
Determines whether to send events for identified files to be transferred, although the transfer hasn’t started. Possible values:
Default: NEVER |
com.bmc.aft.configurable.fileWatcherFailIfSourceDirectoryMissing |
Determines if the MFT file watcher fails the job (with RC = 1) when the watch pattern contains a non-exist path. Default: false |
com.bmc.aft.configurable.azure.useMultipartUpload |
Determines if a multipart (multi-threaded) transfer is used when you upload a file to Azure Blob storage. Default: true |
com.bmc.aft.configurable.azure.useMultipartDownloadOnDownloadToLocal |
Determines whether to use multipart (multi-threaded) transfer when downloading file from Azure to a local path Default: true |
com.bmc.aft.configurable.azure.maxThreadsForMultipartTransfer |
Determines the number of concurrent threads when uploading blocks to azure or downloading from azure to local. Default: 10 |
com.bmc.aft.configurable.azure.maxFileSizeForSinglePartTransfer |
Determines the maximum size for uploading/Downloading a file in a single part. Default: 8388608 |
com.bmc.aft.configurable.azure.bufferDownloadSize |
Determines the buffer size when downloading/uploading file from/to azure. Default: 131072 |
com.bmc.aft.configurable.azure.blockSize |
Determines the block size when downloading/uploading file from/to azure. Default: 4194304 |
com.bmc.aft.configurable.azure.requestMaxAttempts |
Determines the maximum attempts to perform action on azure storage. Default: 3 |
com.bmc.aft.configurable.azure.requestRetryDelay |
Determines the delay, in milliseconds, between retries for Azure requests. Default: 1000 |
com.bmc.aft.configurable.azure.connectionTimeout |
Determines the connection timeout to Azure. Default: 60000 |
com.bmc.aft.configurable.azure.responseTimeout |
Determines the response timeout duration used when waiting for a server to reply. Default: 600000 |
com.bmc.aft.configurable.azure.readTimeout |
Determines, in milliseconds, the read timeout used when reading a response from Azure. Default: 600000 |
com.bmc.aft.configurable.azure.writeTimeout |
Determines, in milliseconds, the write timeout used when waiting for a request to be sent to Azure. Default: 600000 |
com.bmc.aft.configurable.azure.copyBlobOperationTimeoutInSeconds |
Determines, in seconds, the timeout for copy blob operation. Default: 60 |
com.bmc.aft.configurable.gcs.requestMaxAttempts |
Determines the maximum number of retries for a failing operation against Google Cloud Storage. Default: 3 |
com.bmc.aft.configurable.gcs.requestRetryDelay |
Determines, in milliseconds, the interval between operation retries against Google cloud storage. Default: 1000 |
com.bmc.aft.configurable.gcs.connectionTimeout |
Determines, in milliseconds, the connection timeout to Google cloud storage. Default: 20000 |
com.bmc.aft.configurable.gcs.readTimeout |
Determines, in milliseconds, the read timeout for Google cloud storage to read operations. Default: 60000 |
com.bmc.aft.configurable.notifyAgentDuringJobRun |
Determines whether MFT sends Agent track notifications during a job run (when starting/finishing file watch operations). Default: false |
com.bmc.aft.configurable.zos.useFullDatasetName |
Determines whether to show or set the z/OS full DataSet names as the transferred filename. Default: false |
com.bmc.aft.configurable.ftp.failOnSourceCloseDataChannel |
Determines whether to fail the job if closing the source FTP server’s data channel after the transfer completes. Default: true |
com.bmc.aft.configurable.ssl.requireCloseNotify |
Determines whether to fail the job if the close_notify response is received from the FTP server when using SSL. Default: true |
com.bmc.aft.configurable.s3.multipart.upload.threads.count |
Determines the number of threads to use when performing multipart uploads to Amazon S3. Default: 3 |
com.bmc.aft.configurable.s3.maximum.multipart.uploads.count |
Determines the maximum number of concurrent jobs performing multipart uploads to Amazon S3. Default: 5 |
com.bmc.aft.configurable.s3.maxConnections |
Determines the maximum total number of connections that can be opened to S3 account |
com.bmc.aft.configurable.pre.post.execution.commands.copyTempScripts |
Determines whether to generate copies of temporary scripts for pre and post execution commands. Use this parameter to troubleshoot issues in the execution of pre or post commands when multiple File Transfer jobs run at the same time. Default: false |