Using WLST Commands with Oracle Managed File Transfer

9 Using WLST Commands with Oracle Managed File Transfer

Learn how to use the WLST (Oracle WebLogic Scripting Tool) commands that perform Oracle Managed File Transfer (MFT) operations.

This chapter includes the following sections:

For more detailed descriptions and examples of the MFT WLST commands, see the Oracle Managed File Transfer Custom WLST Commands in WLST Command Reference for SOA Suite.

9.1 Running WLST Commands

Before you can run WLST commands, you must start WLST and connect to the Oracle WebLogic Server Managed Server dedicated to Oracle Managed File Transfer.

The steps for this process are:

Go to the Oracle WebLogic Server command directory for MFT:
```
cd ${MW_HOME}/mft/common/bin
```
Run the Oracle WebLogic Scripting Tool:
```
./wlst.sh
```

Connect to the Oracle WebLogic Server Managed Server dedicated to MFT:

connect("username","password","t3://hostname:port")

For example:

connect("weblogic","weblogic1","t3://localhost:7011")

Run WLST commands as needed.
Use this command to list MFT WLST commands:
```
help("mft")
```
Use this command to list short names for MFT WLST commands:
```
help("mft-shortcuts")
```
The commands work in the same way whether you use the long or short names.
Disconnect and exit.
```
disconnect()
exit()
```

9.2 MFT WLST Command Summary

Use WLST (Oracle WebLogic Scripting Tool) commands to perform various Oracle Managed File Transfer operations.

Table 9-1 summarizes the MFT WLST commands. It is intended as a quick reference and not as a complete description of each command. For a complete description of these commands, see Oracle Managed File Transfer Custom WLST Commands in WLST Command Reference for SOA Suite.

Table 9-1 MFT WLST Command Summary

Command	Shortcut	Syntax	Description
`bulkDeployArtifact`	`buDepAF`	`bulkDeployArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_names', 'comment')`	Deploys a comma-separated list of source, transfer, or target artifacts or * for all. A comment is optional.
`createMftCredential`	N/A	`createMftCredential(password, key)`	Creates the credential for `mftapp`. Enter the password for which the credential needs to be created and the key for the credential.
`deleteArtifact`	`delAF`	`deleteArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_name')`	Deletes a source, transfer, or target artifact.
`deleteArtifactDeployment`	`delDepAF`	`deleteArtifactDeployment('TRANSFER\|SOURCE\|TARGET', 'artifact_name', 'label')`	Deletes an undeployed source, transfer, or target artifact. Also use to delete old configuration history. Use Show Deployment Details on the Deployment tab to view the `label`.
`deployArtifact`	`depAF`	`deployArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_name', 'comment')`	Deploys a source, transfer, or target artifact. A comment is optional.
`disableArtifact`	`disAF`	`disableArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_name', 'comment')`	Disables a deployed and previously enabled source, transfer, or target artifact. A comment is optional.
`enableArtifact`	`enAF`	`enableArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_name', 'comment')`	Enables a deployed and previously disabled source, transfer, or target artifact. A comment is optional.
`exportDeployedArtifact`	`expDepAF`	`exportDeployedArtifact('artifact_type','artifact_name',label,'archive_file_path', generate_config_plan, long_format)`	Exports a deployed source, transfer, or target artifact to a ZIP file. Use Show Deployment Details on the Deployment tab to view the `label`. If you are connecting to WLST remotely, the ZIP file is created on the remote server. `generate_config_plan` (optional): Indicates whether to generate the mftConfig XML. Config plan is generated in same folder where archive file is generated. Default is `FALSE`. `long_format` (optional): If `TRUE`, most of the attributes will be included in the config plan xml; otherwise, only the key attributes will be listed in the config plan XML. Default is `FALSE`.
`isArtifactInMDS`	`isAFinMDS`	`isArtifactInMDS('TRANSFER\|SOURCE\|TARGET', 'artifact_name')`	Checks whether a source, transfer, or target artifact exists in the MDS (Metadata Store) and returns `TRUE` or `FALSE`.
`undeployArtifact`	`undepAF`	`undeployArtifact('TRANSFER\|SOURCE\|TARGET', 'artifact_name', 'comment')`	Undeploys a source, transfer, or target artifact without deleting it from the configuration. A comment is optional.
`exportMftMetadata`	`expMD`	`exportMetadata('archive_file', generate_config_plan, long_format)`	Exports the entire MFT configuration, excluding passwords, to a ZIP file. If you are connecting to WLST remotely, the ZIP file is created on the remote server. `generate_config_plan` (optional): Indicates whether to generate the mftConfig XML. Config plan is generated in same folder where archive file is generated. Default is `FALSE`. `long_format` (optional): If `TRUE`, most of the attributes will be included in the config plan xml; otherwise, only the key attributes will be listed in the config plan XML. Default is `FALSE`.
`exportTransferMetadata`	`expXfrMD`	`exportTransferMetadata('archive_file', 'transfer_name', generate_config_plan, long_format)`	Exports a transfer artifact and related metadata to a ZIP file. If you are connecting to WLST remotely, the ZIP file is created on the remote server. `generate_config_plan` (optional): Indicates whether to generate the mftConfig XML. Config plan is generated in same folder where archive file is generated. Default is `FALSE`. `long_format` (optional): If `TRUE`, most of the attributes will be included in the config plan xml; otherwise, only the key attributes will be listed in the config plan XML. Default is `FALSE`.
`importMftMetadata`	`impMD`	`importMetadata('archive_file', generate_config_plan, previewMode)`	Imports a previously exported MFT configuration from a ZIP file. `generate_config_plan` (optional): Indicates whether to generate the mftConfig XML. Config plan is generated in same folder where archive file is generated. Default is `FALSE`.
`resetMetadata`	`resMD`	`resetMetadata('preserve_preferences')`	Resets the MFT configuration, deleting all artifacts and resetting all administrative settings to their defaults. Example: `MW_HOME/oracle_common/common/bin/wlst.sh connect("weblogic","weblogic1","t3://mftserver:mftport") resetMetadata(FALSE)`
`deleteCSFKey`	`delKey`	`deleteCSFKey('SSH\|PGP\|PEM', 'PRIVATE\|PUBLIC', 'alias')`^Foot 1	Deletes a key alias from the MFT keystore. Example: `deleteCSFKey('SSH', 'PRIVATE', 'my-alias')`
`exportCSFKey`	`expKey`	`exportCSFKey('SSH\|PGP\|PEM', 'PRIVATE\|PUBLIC', 'zip_file_path')`^Foot 1	Exports keys from the MFT keystore to a zip file containing the keys. Example: `exportCSFKey('SSH', 'PRIVATE', '/export/ssh/my_private_keys.zip')` Unzip the file to extract the keys.
`generateKeys`	`genKeys`	`generateKeys('SSH\|PGP', 'password', 'key_file_path')`	Generates keys and saves them to one or more key files. The key type is RSA and the key size is 1024 bits. The private key password is optional. For SSH, the path must include the key file name. For PGP, two files are generated under the specified path: the `secret.asc` file contains the PGP private key, and the `pub.asc` file contains the PGP public key. To generate a private RSA key of PEM format, which is used to connect to Oracle Cloud Infrastructure when the OCI Storage Cloud Service type is selected as a source or target, you cannot use the Oracle Managed File Transfer console or the WSLT `generateKeys` command. Instead, you can use an external key generation application, such as `ssh-keygen`, or follow the steps in How to Generate an API Signing Key in the Oracle Cloud Infrastructure documentation. Then, you can import the RSA key of PEM format. ^Foot 1 Example: `generateKeys('SSH', '','/export/ssh/ssh-pvt-keys.ppk')`
`importCSFKey`	`impKey`	`importCSFKey('SSH\|PGP\|PEM', 'PRIVATE\|PUBLIC', 'alias', 'key_file_path')`^Foot 1	Imports a key to the MFT keystore from a key file and creates an alias. Example: `importCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my_private_keys.ppk'` Before you can use the OCI Storage Cloud Service type as a source or target, you must import RSA key of PEM format to connect to Oracle Cloud Infrastructure.^Foot 1 Example: `importCSFKey(PEM, 'PRIVATE', 'my-alias', '/export/pem/my_private_keys.pem`
`listCSFKeyAliases`	`lsKeyAliases`	`listCSFKeyAliases('SSH\|PGP\|PEM', 'PRIVATE\|PUBLIC', 'alias')`^Foot 1	Lists key aliases in the MFT keystore. Example: `listCSFKeyAliases('SSH', 'PRIVATE')`
`updateCSFKey`	`updKey`	`updateCSFKey('SSH\|PGP\|PEM', 'PRIVATE\|PUBLIC', 'alias', 'key_file_path')`^Foot 1	Deletes a key alias from the MFT keystore and generates a new key file. Example: `updateCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my-private-key.ppk')`
`getSourceDeploymentHistory`	`getSrcDH`	`getSourceDeploymentHistory('source_name')`	Returns the deployment history of a source artifact.
`getTargetDeploymentHistory`	`getTrgtDH`	`getTargetDeploymentHistory('target_name')`	Returns the deployment history of a target artifact.
`getTransferDeploymentHistory`	`getXfrDH`	`getTransferDeploymentHistory('transfer_name')`	Returns the deployment history of a transfer artifact.
`getTransferInfo`	`getXfrInfo`	`getTransferInfo('transfer_name', 'label')`	Returns information about a transfer artifact. Use Show Deployment Details on the Deployment tab to view the `label`.
`pauseTransfer`	`pauseXfr`	`pauseTransfer('instance_id', 'comment')`	Pauses an in-progress transfer. Open the Advanced section of the target report to view the instance ID. For information about the target report, see Interpreting Source, Transfer, and Target Reports. A comment is optional.
`resubmit`	`resub`	`resubmit('resubmit_type', 'instance_id', 'comment', 'IsSync')`	Resubmits a transfer. The `resubmit_type` is the type of artifact for which resubmit is invoked. Possible values are `SOURCE`, `TRANSFER_INSTANCE`, `TARGET`, or `TARGET_INSTANCE`. Open the Advanced section of the target report to view the instance ID. `IsSync` is a Boolean value for synchronous execution of resubmit. It is optional and the default value is `FALSE`. For information about the target report, see Interpreting Source, Transfer, and Target Reports. A comment is optional. Example: `wls:/mydomain/serverConfig> resubmit('SOURCE','3D48B12B-295A-4F52-A8EE-BD1CC1A20246', 'comments_for_resubmit', FALSE)`
`resubmitMessages`	`resMsgs`	`resubmitMessages(resubmit_type, state, artifact_name, start_date, end_date, chunk_size, chunk_delay, ignore_ids, comments, preview_mode)`	Resubmits transfers in bulk. The `resubmit_type` is the type of artifact for which resubmit is invoked. Possible values are `SOURCE`, `TRANSFER_INSTANCE`, `TARGET`, or `TARGET_INSTANCE`. The `state` (optional) can be `ACTIVE`, `FAILED`, or `COMPLETED`. The `start_date` and `end_date` enable you to resubmit all failed messages within a specified date range in format `dd-MM-yyyy H:m:s:S`. When the command is run in preview mode (default=`true`), it lists the count of messages that will be resubmitted for given criteria. For more information, see Bulk Resubmit.
`resumeTransfer`	`resXfer`	`resumeTransfer('instance_id', 'comment')`	Resumes a paused transfer. Open the Advanced section of the target report to view the instance ID. For information about the target report, see Interpreting Source, Transfer, and Target Reports. A comment is optional.
`configureHomeDir`	`confHmDir`	`configureHomeDir('directory_path', 'user_name')`	Assigns the specified directory to the user as home directory where that user is located on login to embedded servers.
`grantPermissionToDirectory`	`grPermDir`	`grantPermissionToDirectory('directory_path', 'principal_name', 'principal_type', 'permissions', 'server_type', 'include_subfolder')`	Grants permission to an embedded server directory. Users and groups can be assigned a set of permissions to an existing directory on an embedded server.
`listAllPermissions`	`lsPerms`	`listAllPermissions(principal_name, server_types)`	Lists all permissions available for a given principal and server type. The server type can be FTP or sFTP. For example: `wls:/mydomain/serverConfig> listAllPermissions("weblogic","FTP")`
`createArtifacts`	`crtAF`	`createArtifacts('xml_file_fath', previewMode, updateIfExists)`	Creates Artifacts from an input xml file containing artifact definition.
`revokePermissionForDirectory`	`revPermDir`	`revokePermissionForDirectory('directory_path', 'principal_name', 'principal_type', 'permissions', 'server_type', 'include_subfolder')`	Revokes a set of permissions from an embedded server directory.
`startEmbeddedServer`	`startES`	`startEmbeddedServer('FTP\|FTPS\|SFTP')`	Starts an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that was stopped.
`stopEmbeddedServer`	`stopES`	`stopEmbeddedServer('FTP\|FTPS\|SFTP')`	Stops an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that is running.
`updatePorts`	`updPorts`	`updatePorts('server_instance_name', 'FTP\|FTPS\|SFTP', 'port')`	Updates the port for an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server, which is a service of an Oracle WebLogic Server managed server dedicated to MFT.
`createCallouts`	`crtCalls`	`createCallouts('def_file_path')`	Creates callouts based on an XML file that defines them.
`deleteCallout`	`delCalls`	`deleteCallout('callout_name')`	Deletes a callout.
`listCallouts`	`lsCalls`	`listCallouts()`	Lists callouts.
`updateCallouts`	`updCalls`	`updateCallouts('def_file_path')`	Updates callouts with the same names based on an XML file that defines them.
`addContactToNotification`	`addContNote`	`addContactToNotification('event', 'Email\|PHONE\|FAX\|SMS', 'value')`	Adds a contact to a specific event notification. The `value` is an email address or phone number. The `event` is `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT`, `PURGE_EVENT`, or `ARCHIVE_RESTORE_EVENT`.
`createContact`	`crtCont`	`createContact('Email\|PHONE\|FAX\|SMS', 'value')`	Creates a contact for event notifications. The `value` is an email address or phone number.
`deleteContact`	`delCont`	`deleteContact('Email\|PHONE\|FAX\|SMS', 'value')`	Deletes a contact. The `value` is an email address or phone number.
`listContacts`	`lsConts`	`listContacts('Email\|PHONE\|FAX\|SMS')`	Lists contacts.
`removeContactFromNotification`	`remContNote`	`removeContactFromNotification('event', 'Email\|PHONE\|FAX\|SMS', 'value')`	Removes a contact from a specific event notification. The `value` is an email address or phone number. The `event` is `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT`, `PURGE_EVENT`, or `ARCHIVE_RESTORE_EVENT`.
`updateEvent`	`updEvt`	`updateEvent('event', 'enabled')`	Enables or disables a specific event notification. Set `enabled` to `TRUE` or `FALSE`. The `event` is `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT`, `PURGE_EVENT`, or `ARCHIVE_RESTORE_EVENT`.
`archiveInstanceData`	`arcData`	`archiveInstanceData(archiveFileName='filename', startDate='date', endDate='date', batchId='batchId', status='C\|F\|A\|*', testMode='TRUE\|FALSE', comments='text', runInSync='FALSE\|TRUE', fsArchiveFolderPath='path')`	Archives runtime instances to a `.dmp` file. The `archiveFileName` is required. Dates are in `dd-MM-yyyy H:m:s:S` format. The `batchId` is an identifier in the output of a previous `archiveInstanceData` command. The `status` is completed (default), failed, active, or all. To archive runtime instances, set `testMode=FALSE`. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands. The `fsArchiveFolderPath` is required if archiving the corresponding payloads.
`restoreInstanceData`	`resData`	`restoreInstanceData(archiveFilePath='path', fileNamePrefix='prefix', fsFolderPath='path', runInSync='FALSE\|TRUE')`	Restores previously archived runtime instances. The `archiveFilePath` is required.The `fileNamePrefix` (usually `batchId`) and `fsFolderPath` are required if restoring the corresponding payloads. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands.
`archivePayloads`	`arcPLs`	`archivePayloads(batchId='batchId', archivePath='path', runInSync='FALSE\|TRUE')`	Archives payloads corresponding to runtime instances to `batchId_n.zip` files. The `batchId` is an identifier in the output of a previous `archiveInstanceData` command and is required. The `archivePath` to the payload archive directory is also required. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands.
`restorePayloadsByName`	`resPLbyN`	`restorePayloadsByName(fileNames='filename', folderPath='path', runInSync='FALSE\|TRUE')`	Restores previously archived payloads by file name. The `fileNames` argument (usually `batchId`) is required. The `folderPath` to the payload archive directory is also required. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands.
`restorePayloadsByPrefix`	`resPLbyP`	`restorePayloadsByPrefix(fileNamePrefix='prefix', folderPath='path', runInSync='FALSE\|TRUE')`	Restores previously archived payloads by file name prefix. The `fileNamePrefix` argument (usually `batchId`) is required. The `folderPath` to the payload archive directory is also required. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands.
`purgeInstanceData`	`prgData`	`purgeInstanceData(startDate='date', endDate='date', batchId='batchId', status='C\|F\|A\|*', testMode='TRUE\|FALSE', comments='text', runInSync='FALSE\|TRUE', runPayloadPurge='FALSE\|TRUE', transfer_names, names_delimiter)`	Purges runtime instances. All arguments are optional. Dates are in `dd-MM-yyyy H:m:s:S` format. The `batchId` is an identifier in the output of a previous `archiveInstanceData` or `purgeInstanceData` command. The `status` is completed (default), failed, active, or all. To archive runtime instances, set `testMode=FALSE`. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands. Set `runPayloadPurge=TRUE` to purge the corresponding payloads. Set `purgeTransactionTimeOut` MBean from EM to override the default time-out limit for purge operation.
`purgePayloads`	`prgPLs`	`purgePayloads(batchId='batchId', detailedAudit='TRUE\|FALSE', runInSync='FALSE\|TRUE')`	Purges payloads corresponding to runtime instances. The `batchId` is an identifier in the output of a previous `archiveInstanceData` or `purgeInstanceData` command and is required. Set `detailedAudit=FALSE` to turn off auditing of purged files. Set `runInSync=TRUE` to run immediately and block execution of other WLST commands.
`createUserContact`	`crtUCont`	`createUserContact(user_name, delivery_channel)`	Create a new user contact, which can be used for event notification. . `delivery_channel` (optional): possible values are `EMAIL` or `SMS`. If not specified, it will use the user preferred delivery channel configured in the WebLogic user.
`createUserGroupContact`	`crtUGCont`	`createUserGroupContact(user_group_name,delivery_channel)`	Create a new user group contact, which can be used for event notification. `delivery_channel` (optional): possible values are `EMAIL` or `SMS`. If not specified, it will use the user preferred delivery channel configured in the WebLogic user.
`addUserContactToNotification`	`addUContNote`	`addUserContactToNotification(event, user_name, delivery_channel)`	Add user contact for notification event. Event values: `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT` `delivery_channel` (optional): possible values are `EMAIL` or `SMS`. Note: Before adding an internal contact make sure that the email address/contact number is present in the user setting.
`addUserGroupContactToNotification`	`addUGContNote`	`addUserGroupContactToNotification(event, user_name, delivery_channel)`	Add user group contact for notification event. Event values: `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT` `delivery_channel` (optional): possible values are `EMAIL` or `SMS`.
`deleteUserContact`	`delUCont`	`deleteUserContact(user_name, delivery_channel)`	Delete an existing user contact. Note: If the contact is in use (assigned to an event), the user will get an error message. `delivery_channel` (optional): possible values are `EMAIL` or `SMS`.
`deleteUserGroupContact`	`delUGCont`	`deleteUserGroupContact(user_group_name,delivery_channel)`	Delete an existing user group contact. Note: If the contact is in use (assigned to an event), the user will get an error message. `delivery_channel` (optional): possible values are `EMAIL` or `SMS`.
`removeUserContactfromNotification`	`remUContNote`	`removeUserContactFromNotification(event, user_name, delivery_channel)`	Remove the given user contact from the notification event. Event values: `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT` `delivery_channel` (optional): possible values are `EMAIL` or `SMS`.
`removeUserGroupContactfromNotification`	`remUGContNote`	`removeUserGroupContactFromNotification(event, user_group_name, delivery_channel)`	Remove the given user group contact from the notification event. Event values: `RUNTIME_ERROR_EVENT`, `DELETE_ARTIFACT_EVENT`, `DEPLOY_ARTIFACT_EVENT`, `EXPORT_IMPORT_EVENT` `delivery_channel` (optional): possible values are `EMAIL` or `SMS`.
`triggerEvent`	`trgEvt`	`triggerEvent('source_name', 'properties')`	Trigger an Event on JCA/OCS/RIDC sources to initiate the file transfer. `source_name`: The name of the JCA/OCSS/RIDC source for which Event option is enabled. `properties`: Additional properties in the form of comma-separated `name=value` pairs.
`updateTriggerEventStatus`	`updTrgEvtSt`	`updateTriggerEventStatus(status, source_name, event_session_id)`	Update the `TriggerEvent` status of the specified `event_session_id`. If no `event_session_id` is provided, then most recent event status of the given source is updated.
`activatePurgeSchedule`	`actPurgeSch`	`activatePurgeSchedule(schedule_name)`	Activate a purge schedule. Provide the purge schedule name to activate. Default `schedule_name` is the default purge schedule. If no purge schedule name is provided, the command will activate the default purge schedule. Only one purge schedule can be activated using this command.
`deactivatePurgeSchedule`	`deactPurgeSch`	`deactivatePurgeSchedule(schedule_name)`	Deactivate a purge schedule. Provide the purge schedule name to deactivate it. Default `schedule_name` is the default purge schedule. If no purge schedule name is provided, the command will deactivate the default purge schedule. Only one purge schedule can be deactivated using this command.
`modifyPurgeSchedule`	`modifyPurgeSch`	`modifyPurgeSchedule(start_date, end_date, schedule_time, frequency, retention_period, status, transfer_names, names_delimiter, include, comment)`	Modify an existing purge schedule. `start_date` is in `dd-mm-yyyy` format, `schedule_time` is in `hh:mm:ss` format, `frequency` values are `DAILY`, `WEEKLY`, `MONTHLY`, or `YEARLY`. `retention_period` values are any non-negative number, `status` values are `COMPLETED` and/or `FAILED`, `transfer_names` can be Transfer names whose instances need to be purged, `names_delimiter` is a single character string, `include` values are `TRUE` or `FALSE`, `comment` value is any string.
`updateAppProperties`	`updAppPrt`	`updateAppProperties('properties_name_value_pair', 'delimiter')`	Update Application properties of MFT. The supported properties are Server, HA, Performance and Advanced properties. Allows to update more than one property at a time where property is a name/value pair, name is the property name and value is the property value and each separated by a delimiter. Supported parameters are: `physicalstoragedirectory:`String - Directory Path, `calloutdirectory`: String - Directory Path, `storeonlinepayload`: String - {fileSystem, database}, `storereferencepayload`: Boolean - true/false, `generatechecksum`: Boolean - true/false, `sourceprocessors`: Number - non zero, non negative number, `instanceprocessors`: Number - non zero, non negative number,`targetprocessors`: Number - non zero, non negative number, `controldirectory`: String - Directory Path,`inbounddatasource`: String - MFT Data Source Name, `outbounddatasource`: String - MFT Data Source Name, `internaladdress`: String - IP Address of Load Balancer (LB), `internalFTPS`: Number - Port number of FTPS in LB, `internalSFTP`: Number - Port number of SFTP in LB, `internalFTP`: Number - Port number of FTP in LB, `externaladdress`: String - IP Address of LB, `externalFTPS`: Number - Port number of FTPS in LB, `externalSFTP`: Number - Port number of SFTP in LB, `externalFTP`: Number - Port number of FTP in LB.
`updateSFTPServer`	`updSFTPSvr`	`updateSFTPServer('enable_SFTP', 'key_alias', 'private_key_password')`	Used to enable/disable the Embedded SFTP Server. To enable SFTP server, SSH key alias name is mandatory along with the optional private key password. If the key is not password protected, then private key password is not required. To disable, both key alias and password are not required. Supported parameters are: `enable_SFTP`: Boolean to enable/disable SFTP, `key_alias`: SSH private key alias,`private_key_password`: Optional password of the SSH private key.

^Footnote 1

An RSA key of PEM format is used to connect to Oracle Cloud Infrastructure when the OCI Storage Cloud Service type is selected as a source or target.

For an RSA key of PEM format, only PRIVATE is valid.

The OCI Storage Cloud Service type and the PEM key format is available in 12c (12.2.1.4) only if you have installed patch 32395225. Sign in to My Oracle Support and search for the patch number to locate and download the patch.

9.3 Oracle Managed File Transfer EJBs

WLST commands are also exposed as Enterprise Java Beans (EJB) and the commands are available in one of the following EJBs:

oracle.tip.mft.j2ee.ejb.KeyManagerService
oracle.tip.mft.j2ee.ejb.MDSService
oracle.tip.mft.j2ee.ejb.RuntimeService